نمای کلی API تنظیمات مدیریت

Admin Settings API به سرپرستان دامنه های Google Workspace اجازه می دهد تا تنظیمات دامنه خود را در قالب فیدهای Google Data API بازیابی و تغییر دهند.

این تنظیمات دامنه شامل بسیاری از ویژگی‌های موجود در کنسول Google Workspace Admin می‌شود. نمونه‌ای از کاربردهای این API شامل ایجاد یک کنترل پنل سفارشی یا ادغام دامنه‌های Google Workspace در یک محیط قدیمی موجود است.

Admin Settings API پروتکل Google Data API را پیاده سازی می کند. Google Data API با مدل انتشار و ویرایش پروتکل انتشار اتم (AtomPub) مطابقت دارد. درخواست‌های AtomPub HTTP از رویکرد طراحی انتقال مجموعه‌های نمایندگی (RESTful) برای خدمات وب استفاده می‌کنند. برای اطلاعات بیشتر، به راهنمای برنامه‌نویس Google Data مراجعه کنید.

مخاطب

این سند برای توسعه دهندگانی است که می خواهند برنامه های مشتری بنویسند که می توانند اطلاعات مربوط به دامنه های Google Workspace را تغییر دهند و بازیابی کنند. این نمونه‌هایی از تعاملات API تنظیمات Admin با استفاده از XML خام و HTTP را ارائه می‌کند.

این سند فرض می‌کند که ایده‌های کلی در پشت پروتکل Google Data API را می‌دانید و با کنسول Google Workspace Admin آشنا هستید. برای اطلاعات بیشتر در مورد کنسول مدیریت، به استفاده از کنسول مدیریت خود مراجعه کنید.

شروع به کار

ایجاد یک حساب کاربری

Admin Settings API برای حساب‌های Google Workspace فعال است. برای اهداف آزمایشی برای یک حساب Google Workspace ثبت نام کنید. سرویس تنظیمات سرپرست از حساب‌های Google استفاده می‌کند، بنابراین اگر قبلاً یک حساب در دامنه Google Workspace دارید، همه چیز آماده است.

درباره انواع فید API تنظیمات Admin

Admin Settings API به شما امکان می دهد این دسته از تنظیمات دامنه را مدیریت کنید:

تنظیمات Single Sign-On

ورود به سیستم یکپارچه (SSO) مبتنی بر SAML به کاربران امکان می‌دهد از ورود و رمز عبور یکسانی برای سرویس‌های میزبان Google Workspace و همچنین سایر سرویس‌هایی که ممکن است در سازمان خود میزبانی می‌کنید استفاده کنند. به ویژه هنگام استفاده از SSO، یک برنامه وب میزبانی شده، مانند Google Workspace، کاربران را به ارائه دهنده هویت سازمان شما هدایت می کند تا کاربران را هنگام ورود به سیستم احراز هویت کنند. برای اطلاعات دقیق، به درک SSO مبتنی بر SAML برای Google Workspace مراجعه کنید.

پیکربندی SSO شامل وارد کردن اطلاعات لازم برای سرویس Google Workspace برای برقراری ارتباط با ارائه‌دهنده هویتی است که اطلاعات ورود کاربران شما را ذخیره می‌کند، و همچنین راه‌اندازی پیوندهایی که کاربران باید برای ورود به سیستم، خروج از سیستم و تغییر رمز عبور به آن‌ها ارسال شوند. . Admin Settings API به شما امکان می دهد این تنظیمات را به صورت برنامه ریزی شده به روز رسانی و بازیابی کنید. Google از کلید عمومی تولید شده شما برای تأیید این درخواست SSO با ارائه دهنده هویت شما استفاده می کند و اینکه پاسخ SAML کلید خصوصی در طول انتقال شبکه تغییر نکرده است.

برای یک خلاصه کوتاه خاص API از استفاده از تنظیمات SSO، گواهی کلید عمومی خود را از ارائه دهنده هویت خود دریافت کنید، کلید عمومی را در Google ثبت کنید و تنظیمات جستجوی SSO مبتنی بر SAML خود را تنظیم کنید. برای پیام های خطا، عیب یابی SSO را ببینید:

  • کلیدهای خود را ایجاد کنید -- با ارائه دهنده هویت خود، مجموعه ای از کلیدهای عمومی و خصوصی را با استفاده از الگوریتم های DSA یا RSA ایجاد کنید. کلید عمومی در گواهی فرمت X.509 است. برای اطلاعات بیشتر درباره کلیدهای امضای Single Sign-On مبتنی بر SAML، به ایجاد کلیدها و گواهینامه‌ها برای سرویس Google Workspace Single Sign-On مراجعه کنید.
  • ثبت نام با Google -- از تنظیمات API Admin Settings Single Sign-On برای ثبت گواهی کلید عمومی خود در Google استفاده کنید.
  • تنظیمات SSO خود را تنظیم کنید -- از تنظیمات API Admin Settings Single Sign-On برای پیکربندی تنظیمات مورد استفاده برای ارتباط با سرورهای ارائه دهنده هویت دامنه استفاده کنید.

تنظیمات دروازه و مسیریابی

این فید به مدیران دامنه امکان می دهد مسیریابی ایمیل را برای دامنه های خود کنترل کنند.

عملیات مسیریابی ایمیل به مدیران اجازه می دهد تا تنظیمات مسیریابی ایمیل در سطح دامنه را مشخص کنند. این شبیه به عملکرد مسیریابی ایمیل در تنظیمات Gmail کنسول Admin است. برای اطلاعات بیشتر، به پیکربندی تحویل دوگانه ویژگی مسیریابی ایمیل و مسیریابی ایمیل مراجعه کنید.

نمونه درخواست و پاسخ Admin Settings API XML

این سند نمونه‌های کدی از درخواست‌ها و پاسخ‌های اولیه API تنظیمات Admin را با استفاده از XML خام و HTTP ارائه می‌کند. این مثال زبان پیش‌فرض دامنه، سینتکس کامل XML و HTTP را برای متن درخواست و پاسخ نشان می‌دهد که برای هر عملیات مشترک است:

برای تغییر تنظیمات دروازه ایمیل خروجی دامنه، یک HTTP PUT به نشانی اینترنتی فید دروازه ارسال کنید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

زبان پیش‌فرض دامنه درخواست PUT entry AtomPub XML این است:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

به جز ویژگی‌ها و مقادیر خاص عملیات، عناصر atom:property نشان‌دهنده یک جفت کلید-مقدار واحد است که حاوی اطلاعاتی درباره ویژگی‌هایی است که می‌خواهید بازیابی یا به‌روزرسانی کنید. اینها برای همه بدنه‌های درخواست API تنظیمات Admin مشترک هستند.

عنصر entry پاسخ زبان پیش‌فرض دامنه، ویژگی‌های smartHost و smtpMode را به همراه نحو XML مشترک برای همه بدنه‌های پاسخ API تنظیمات مدیریت برمی‌گرداند: 

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

مدیریت تنظیمات Single Sign-On

ویژگی Google Workspace Single Sign-On (SSO) به کاربران این امکان را می دهد که به چندین سرویس وارد شوند در حالی که فقط باید یک بار ورود و رمز عبور را وارد کنند. این رمز عبور توسط ارائه‌دهنده هویت دامنه ذخیره می‌شود، نه توسط Google Workspace. برای اطلاعات بیشتر، به صفحه SSO مرکز راهنمایی مراجعه کنید. بخش های زیر فرمت XML مورد استفاده برای تنظیمات Single Sign-On را نشان می دهد.

بازیابی تنظیمات Single Sign-On

برای بازیابی تنظیمات Single Sign-On، یک HTTP GET به نشانی اینترنتی فید عمومی SSO ارسال کنید و یک سرصفحه Authorization را همانطور که در تأیید هویت به سرویس تنظیمات مدیریت توضیح داده شده است اضافه کنید. و برای پیام های خطا، عیب یابی SSO را ببینید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

این عملیات هیچ پارامتری در بدنه درخواست ندارد.

یک پاسخ موفق یک کد وضعیت HTTP 200 OK را به همراه یک فید AtomPub با تنظیمات SSO دامنه برمی گرداند.

پاسخ GET XML ویژگی‌های samlSignonUri ، samlLogoutUri ، changePasswordUri ، enableSSO ، ssoWhitelist و useDomainSpecificIssuer را برمی‌گرداند:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

خواص عبارتند از:

samlSignonUri
نشانی وب ارائه‌دهنده هویت که در آن Google Workspace درخواست SAML را برای احراز هویت کاربر ارسال می‌کند.
samlLogoutUri
آدرسی که کاربران هنگام خروج از برنامه وب به آن ارسال خواهند شد.
changePasswordUri
آدرسی که کاربران زمانی که می خواهند رمز عبور SSO خود را برای برنامه وب تغییر دهند به آن ارسال می شود.
فعال کردنSSO
SSO مبتنی بر SAML را برای این دامنه فعال می کند. اگر قبلاً تنظیمات SSO را پیکربندی کرده‌اید و متعاقباً enableSSO را روی enableSSO=false تنظیم کرده‌اید، تنظیماتی که قبلاً وارد کرده‌اید همچنان ذخیره می‌شوند.
ssoWhitelist
ssoWhitelist یک آدرس IP ماسک شبکه در قالب مسیریابی بین دامنه‌ای بدون کلاس (CIDR) است. ssoWhitelist تعیین می کند که چه کاربرانی با استفاده از SSO وارد شوند و چه کاربرانی با استفاده از صفحه احراز هویت حساب Google Workspace وارد شوند. اگر هیچ ماسکی مشخص نشده باشد، همه کاربران با استفاده از SSO وارد سیستم خواهند شد. برای اطلاعات بیشتر، نحوه عملکرد ماسک های شبکه را ببینید.
useDomainSpecificIssuer
یک صادرکننده خاص دامنه می‌تواند در درخواست SAML به ارائه‌دهنده هویت استفاده شود. اگرچه برای اکثر استقرارهای SSO ضروری نیست، این ویژگی در شرکت‌های بزرگ که از یک ارائه‌دهنده هویت واحد برای احراز هویت کل یک سازمان با چندین زیردامنه استفاده می‌کنند، مفید است. دادن به صادرکننده دامنه خاص، تعیین می‌کند که کدام زیر دامنه با درخواست مرتبط شود. برای اطلاعات بیشتر، به نحوه عملکرد عنصر صادرکننده در درخواست SAML مراجعه کنید؟

اگر درخواست شما به دلایلی با شکست مواجه شود، یک کد وضعیت متفاوت برگردانده می شود. برای اطلاعات بیشتر درباره کدهای وضعیت Google Data API، کدهای وضعیت HTTP را ببینید.

به روز رسانی تنظیمات Single Sign-On

برای به روز رسانی تنظیمات SSO دامنه، ابتدا تنظیمات SSO را با استفاده از عملیات تنظیمات Retrieving Single Sign-On بازیابی کنید، آن را تغییر دهید و سپس یک درخواست PUT به URL feed SSO ارسال کنید. مطمئن شوید که مقدار <id> در ورودی به روز شده شما دقیقاً با <id> ورودی موجود مطابقت دارد. همانطور که در Authentication to Admin Settings API سرویس توضیح داده شده است، یک عنوان Authorization اضافه کنید. و برای پیام های خطا، عیب یابی SSO را ببینید.

هنگام به‌روزرسانی تنظیمات Single Sign-On، یک HTTP PUT به URL فید عمومی SSO ارسال کنید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

بدنه XML درخواست PUT عبارت است از:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

یک پاسخ موفق یک کد وضعیت HTTP 200 OK را به همراه یک فید AtomPub با تنظیمات SSO برمی گرداند.

XML پاسخ PUT عبارت است از:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

اگر درخواست شما به دلایلی با شکست مواجه شود، یک کد وضعیت متفاوت برگردانده می شود. برای اطلاعات بیشتر درباره کدهای وضعیت Google Data API، کدهای وضعیت HTTP را ببینید.

هنگامی که مشتری هدف تأیید چند جانبه را برای اقدامات حساس فعال کرده باشد، تغییرات در تنظیمات Single Sign-On مجاز نیست. درخواست‌ها با errorCode="1811" و reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" ناموفق خواهند بود.

بازیابی کلید امضای Single Sign-On

برای بازیابی کلید امضای Single Sign-On، یک HTTP GET به نشانی اینترنتی فید کلید امضای SSO ارسال کنید، و یک سرصفحه Authorization را همانطور که در احراز هویت به سرویس تنظیمات مدیریت توضیح داده شده است اضافه کنید. و برای پیام های خطا، عیب یابی SSO را ببینید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

این عملیات هیچ پارامتری در بدنه درخواست ندارد.

یک پاسخ موفق یک کد وضعیت HTTP 200 OK را به همراه یک فید AtomPub با کلید امضا برمی‌گرداند.

پاسخ GET XML ویژگی signingKey را برمی گرداند:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

اگر درخواست شما به دلایلی با شکست مواجه شود، یک کد وضعیت متفاوت برگردانده می شود. برای اطلاعات بیشتر درباره کدهای وضعیت Google Data API، کدهای وضعیت HTTP را ببینید.

به روز رسانی کلید امضای Single Sign-On

برای به روز رسانی کلید امضای SSO دامنه، ابتدا کلید امضا را با استفاده از عملیات کلید امضای Retrieving Single Sign-On بازیابی کنید، آن را تغییر دهید و سپس یک درخواست PUT به URL فید کلید امضای SSO ارسال کنید. مطمئن شوید که مقدار <id> در ورودی به روز شده شما دقیقاً با <id> ورودی موجود مطابقت دارد. برای اطلاعات بیشتر درباره کلیدهای امضای Single Sign-On مبتنی بر SAML، به ایجاد کلیدها و گواهینامه‌ها برای سرویس Google Workspace Single Sign-On مراجعه کنید.

هنگام به‌روزرسانی کلید امضای Single Sign-On، یک HTTP PUT به URL فید کلید امضای SSO ارسال کنید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

XML درخواست PUT عبارت است از:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

هنگامی که مشتری هدف تأیید چند جانبه را برای اقدامات حساس فعال کرده باشد، تغییرات در تنظیمات Single Sign-On مجاز نیست. درخواست‌ها با errorCode="1811" و reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" ناموفق خواهند بود.

مدیریت دروازه و مسیریابی ایمیل

بخش دروازه ایمیل خروجی نشان می‌دهد که چگونه API تنظیمات مدیریت از مسیریابی خروجی نامه‌های کاربران در دامنه شما پشتیبانی می‌کند. بخش مسیریابی ایمیل نحوه مسیریابی پیام ها به سرور ایمیل دیگر را نشان می دهد.

بازیابی تنظیمات دروازه ایمیل خروجی

برای بازیابی تنظیمات دروازه ایمیل خروجی، یک HTTP GET به نشانی اینترنتی فید دروازه ارسال کنید و یک سرصفحه Authorization را همانطور که در احراز هویت به سرویس تنظیمات مدیریت توضیح داده شده است اضافه کنید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

این عملیات هیچ پارامتری در بدنه درخواست ندارد.

یک پاسخ موفق یک کد وضعیت HTTP 200 OK را به همراه یک فید AtomPub به همراه اطلاعات وضعیت دروازه ایمیل برمی گرداند.

پاسخ GET ویژگی های smartHost و smtpMode را برمی گرداند. برای اطلاعات بیشتر درباره این ویژگی‌ها، به به‌روزرسانی تنظیمات دروازه ایمیل خروجی را ببینید.

نمونه ای از پاسخ احتمالی این است:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

اگر درخواست شما به دلایلی با شکست مواجه شود، یک کد وضعیت متفاوت برگردانده می شود. برای اطلاعات بیشتر درباره کدهای وضعیت Google Data API، کدهای وضعیت HTTP را ببینید.

به روز رسانی تنظیمات دروازه ایمیل خروجی

برای به‌روزرسانی تنظیمات دروازه ایمیل خروجی دامنه، یک درخواست HTTP PUT به نشانی اینترنتی فید دروازه ارسال کنید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

XML درخواست PUT عبارت است از:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

ویژگی های درخواست عبارتند از:

هاست هوشمند
آدرس IP یا نام میزبان سرور SMTP شما. Google Workspace نامه های خروجی را به این سرور هدایت می کند.
smtpMode
مقدار پیش فرض SMTP است. مقدار دیگر، SMTP_TLS، اتصال با TLS را هنگام تحویل پیام ایمن می کند.

یک پاسخ موفق یک کد وضعیت HTTP 200 OK را به همراه فید AtomPub با وضعیت تنظیمات دروازه ایمیل برمی گرداند.

اگر درخواست شما به دلایلی با شکست مواجه شود، یک کد وضعیت متفاوت برگردانده می شود. برای اطلاعات بیشتر درباره کدهای وضعیت Google Data API، کدهای وضعیت HTTP را ببینید.

مدیریت تنظیمات مسیریابی ایمیل

ابتدا یک درخواست XML ایجاد کنید:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

ویژگی های درخواست عبارتند از:

مسیر مقصد
این مقصد، نام میزبان یا آدرس IP سرور ایمیل SMTP-In است که ایمیل در آن مسیریابی می شود. نام میزبان یا آدرس IP باید برای Google حل شود. برای جزئیات بیشتر در مورد حل نام میزبان ایمیل، پایلوت Google Workspace با مسیریابی ایمیل را ببینید.
routeRewriteTo
اگر درست باشد، قسمت SMTP پیام to: به نام میزبان مقصد تغییر می کند (نام میزبان user@destination)، و پیام به این آدرس کاربر در سرور ایمیل مقصد تحویل داده می شود. در صورت false ، ایمیل به پیام اصلی to: آدرس ایمیل (user@original hostname) در سرور ایمیل مقصد تحویل داده می شود. این شبیه به تنظیمات "تغییر پاکت SMTP" کنسول Admin است. برای اطلاعات بیشتر، تنظیمات دامنه برای مسیریابی ایمیل را ببینید.
route Enabled
اگر true ، عملکرد مسیریابی ایمیل فعال است. اگر false باشد، عملکرد غیرفعال می شود.
BounceNotifications
اگر true ، Google Workspace فعال می‌شود تا در صورت عدم موفقیت، اعلان‌های برگشت را برای فرستنده ارسال کند.
حسابداری

این تنظیم تعیین می کند که چگونه انواع مختلف کاربران در دامنه تحت تأثیر مسیریابی ایمیل قرار می گیرند:

  • allAccounts -- تمام ایمیل ها را به این مقصد تحویل دهید.
  • provisionedAccounts -- اگر کاربر در Google Workspace وجود دارد، نامه را به این مقصد تحویل دهید.
  • unknownAccounts -- اگر کاربر در Google Workspace وجود ندارد، نامه را به این مقصد تحویل دهید. این شبیه به تنظیمات «ایمیل تحویل برای» کنسول مدیریت است. برای اطلاعات بیشتر در مورد پیش نیازها و نحوه استفاده از مسیریابی نامه، به تنظیمات دامنه برای مسیریابی ایمیل مراجعه کنید. ~ برای انتشار این درخواست، یک HTTP POST به نشانی اینترنتی فید مسیریابی ایمیل بفرستید و یک سرصفحه Authorization همانطور که در احراز هویت به سرویس تنظیمات مدیریت توضیح داده شده است اضافه کنید:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

یک پاسخ موفق یک کد وضعیت HTTP 200 OK را به همراه یک فید AtomPub به همراه اطلاعات بایگانی برمی گرداند.

اگر درخواست شما به دلایلی با شکست مواجه شود، یک کد وضعیت متفاوت برگردانده می شود. برای اطلاعات بیشتر درباره کدهای وضعیت Google Data API، کدهای وضعیت HTTP را ببینید.

غروب نقطه پایانی در 31 اکتبر 2018

ما نقاط پایانی زیر را به عنوان بخشی از این اعلامیه منسوخ کردیم. آنها در 31 اکتبر 2018 غروب کردند و دیگر در دسترس نیستند.

  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx