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

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

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

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

مخاطب

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

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

شروع به کار

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

رابط برنامه‌نویسی کاربردی تنظیمات مدیریت برای حساب‌های کاربری گوگل ورک‌اسپیس فعال است. برای اهداف آزمایشی، یک حساب کاربری گوگل ورک‌اسپیس ایجاد کنید. سرویس تنظیمات مدیریت از حساب‌های کاربری گوگل استفاده می‌کند، بنابراین اگر از قبل حسابی در دامنه گوگل ورک‌اسپیس دارید، همه چیز آماده است.

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

رابط برنامه‌نویسی کاربردی تنظیمات مدیریت به شما امکان می‌دهد این دسته از تنظیمات دامنه را مدیریت کنید:

تنظیمات ورود یکپارچه

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

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

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

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

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

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

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

نمونه‌ای از درخواست و پاسخ XML مربوط به تنظیمات ادمین API

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

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

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

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

<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 تنظیمات مدیریت مشترک هستند.

عنصر 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>

مدیریت تنظیمات ورود یکپارچه

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

بازیابی تنظیمات ورود یکپارچه

برای بازیابی تنظیمات ورود یکپارچه، یک 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
آدرسی که کاربران هنگام خروج از برنامه وب به آن هدایت می‌شوند.
تغییر رمز عبور
آدرسی که کاربران هنگام تغییر رمز عبور SSO خود برای برنامه وب به آن هدایت می‌شوند.
فعال کردنSSO
SSO مبتنی بر SAML را برای این دامنه فعال می‌کند. اگر قبلاً تنظیمات SSO را پیکربندی کرده‌اید و متعاقباً enableSSO روی enableSSO=false تنظیم کرده‌اید، تنظیماتی که قبلاً وارد کرده‌اید همچنان ذخیره می‌شوند.
لیست سفید sso
یک ssoWhitelist یک آدرس IP ماسک شبکه در قالب مسیریابی بین دامنه‌ای بدون کلاس (CIDR) است. ssoWhitelist تعیین می‌کند که کدام کاربران با استفاده از SSO و کدام کاربران با استفاده از صفحه احراز هویت حساب Google Workspace وارد سیستم می‌شوند. اگر هیچ ماسکی مشخص نشده باشد، همه کاربران با استفاده از SSO وارد سیستم می‌شوند. برای اطلاعات بیشتر، به نحوه کار ماسک‌های شبکه مراجعه کنید.
useDomainSpecificIssuer
می‌توان از یک صادرکننده‌ی خاص دامنه در درخواست SAML به ارائه‌دهنده‌ی هویت استفاده کرد. اگرچه این ویژگی برای اکثر پیاده‌سازی‌های SSO ضروری نیست، اما در شرکت‌های بزرگی که از یک ارائه‌دهنده‌ی هویت واحد برای احراز هویت کل یک سازمان با چندین زیردامنه استفاده می‌کنند، مفید است. ارائه صادرکننده‌ی خاص دامنه، زیردامنه‌ی مرتبط با درخواست را تعیین می‌کند. برای اطلاعات بیشتر، به بخش «عنصر صادرکننده در درخواست SAML چگونه کار می‌کند؟» مراجعه کنید.

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

به‌روزرسانی تنظیمات ورود یکپارچه

برای به‌روزرسانی تنظیمات SSO یک دامنه، ابتدا تنظیمات SSO را با استفاده از عملیات بازیابی تنظیمات ورود یکپارچه (Retrieving Single Sign-On settings) بازیابی کنید، آن را تغییر دهید و سپس یک درخواست PUT به URL فید SSO ارسال کنید. مطمئن شوید که مقدار <id> در ورودی به‌روزرسانی‌شده شما دقیقاً با <id> ورودی موجود مطابقت دارد. یک هدر Authorization همانطور که در بخش «احراز هویت به سرویس API تنظیمات ادمین» توضیح داده شده است، اضافه کنید. و برای پیام‌های خطا، به بخش «عیب‌یابی SSO» مراجعه کنید.

هنگام به‌روزرسانی تنظیمات ورود یکپارچه، یک HTTP PUT به آدرس فید عمومی 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 برمی‌گرداند.

پاسخ PUT به صورت XML به صورت زیر است:

<?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 مراجعه کنید.

تغییرات در تنظیمات ورود یکپارچه (SSO) زمانی که مشتری هدف، تأیید چندجانبه (Multi-party approval) را برای اقدامات حساس فعال کرده باشد، مجاز نیستند. درخواست‌ها با errorCode="1811" و reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" با شکست مواجه می‌شوند.

بازیابی کلید امضای ورود یکپارچه

برای بازیابی کلید امضای Single Sign-On، یک HTTP GET به URL فید کلید امضای 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 مراجعه کنید.

به‌روزرسانی کلید امضای ورود یکپارچه

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

هنگام به‌روزرسانی کلید امضای ورود یکپارچه، یک HTTP PUT به آدرس اینترنتی فید کلید امضای SSO ارسال کنید: 

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

درخواست PUT در XML به صورت زیر است: 

<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>

تغییرات در تنظیمات ورود یکپارچه (SSO) زمانی که مشتری هدف، تأیید چندجانبه (Multi-party approval) را برای اقدامات حساس فعال کرده باشد، مجاز نیستند. درخواست‌ها با 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

درخواست PUT در 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>

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

هاست هوشمند
آدرس IP یا نام میزبان سرور SMTP شما. Google Workspace ایمیل‌های خروجی را به این سرور هدایت می‌کند.
حالت smtp
مقدار پیش‌فرض 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 باید برای گوگل قابل ترجمه باشد. برای جزئیات بیشتر در مورد ترجمه نام میزبان ایمیل، به Pilot Google Workspace with email routing مراجعه کنید.
مسیرRewriteTo
اگر مقدار آن درست باشد، فیلد to: در پوشه SMTP پیام به نام میزبان مقصد (user@destination's hostname) تغییر می‌کند و پیام به این آدرس کاربر در سرور ایمیل مقصد تحویل داده می‌شود. اگر false ، ایمیل به آدرس ایمیل to: پوشه SMTP پیام اصلی (user@original hostname) در سرور ایمیل مقصد تحویل داده می‌شود. این مشابه تنظیم 'Change SMTP envelope' در کنسول مدیریت است. برای اطلاعات بیشتر، به تنظیمات دامنه برای مسیریابی ایمیل مراجعه کنید.
مسیر فعال شد
اگر true ، قابلیت مسیریابی ایمیل فعال است. اگر false ، این قابلیت غیرفعال است.
اعلان‌های bounce
اگر true ، Google Workspace فعال می‌شود تا در صورت عدم موفقیت در تحویل، اعلان‌های بازگشتی را به فرستنده ارسال کند.
مدیریت حساب

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

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

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

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

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

غروب نقاط پایانی در ۳۱ اکتبر ۲۰۱۸

ما به عنوان بخشی از این اطلاعیه، نقاط پایانی زیر را منسوخ کردیم. آنها در تاریخ ۳۱ اکتبر ۲۰۱۸ از رده خارج شدند و دیگر در دسترس نیستند.

  • 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