نظرة عامة على واجهة برمجة تطبيقات إعدادات المشرف

تسمح Admin Settings API لمشرفي نطاقات Google Workspace باسترداد إعدادات نطاقاتهم وتغييرها على شكل خلاصات Google Data API.

تتضمن إعدادات النطاق هذه العديد من الميزات المتوفرة في وحدة تحكّم مشرف Google Workspace. ومن أمثلة استخدامات واجهة برمجة التطبيقات هذه إنشاء لوحة تحكُّم مخصَّصة أو دمج نطاقات Google Workspace في بيئة قديمة حالية.

تنفّذ واجهة برمجة تطبيقات إعدادات المشرف بروتوكول Google Data API. تتوافق واجهة برمجة تطبيقات Google Data API مع نموذج النشر والتعديل لبروتوكول Atom للنشر (AtomPub). تستخدم طلبات AtomPub HTTP أسلوب تصميم المجموعة التمثيلية (RESTful) لخدمات الويب. لمزيد من المعلومات، اطّلِع على دليل مطوّري بيانات Google.

الجمهور

هذا المستند مخصَّص للمطوّرين الذين يريدون كتابة تطبيقات عميل يمكنها تعديل معلومات عن نطاقات Google Workspace واستردادها. ويوفر أمثلة على تفاعلات Admin Settings API الأساسية باستخدام XML وHTTP الأولي.

يفترض هذا المستند أنك تفهم الأفكار العامة وراء بروتوكول Google Data API، وأنك على دراية بوحدة تحكُّم المشرف في Google Workspace. لمزيد من المعلومات حول "وحدة تحكُّم المشرف"، يُرجى الاطّلاع على استخدام "وحدة تحكُّم المشرف".

البدء

إنشاء حساب

تم تفعيل واجهة برمجة التطبيقات Admin Settings API في حسابات Google Workspace. اشترِك للحصول على حساب Google Workspace لأغراض الاختبار. تستخدم خدمة "إعدادات المشرف" حسابات Google، لذا إذا كان لديك حساب على نطاق Google Workspace من قبل، لن يكون عليك اتّخاذ إجراء آخر.

لمحة عن أنواع خلاصات واجهة برمجة التطبيقات لإعدادات المشرف

تسمح لك Admin Settings API بإدارة الفئات التالية من إعدادات النطاق:

إعدادات الدخول الموحّد

يسمح تسجيل الدخول الأحادي المستند إلى SAML للمستخدمين باستخدام معلومات تسجيل الدخول وكلمة المرور نفسها لكلٍ من الخدمات المستضافة في Google Workspace والخدمات الأخرى التي قد تستضيفها داخل مؤسستك. على وجه التحديد، عند استخدام الدخول المُوحَّد (SSO)، وهو تطبيق ويب مستضاف، مثل Google Workspace، يعيد توجيه المستخدمين إلى موفِّر هوية مؤسستك لمصادقة المستخدمين عند تسجيل الدخول. للحصول على معلومات تفصيلية، يُرجى الاطِّلاع على مقالة فهم الدخول المُوحَّد (SSO) المستنِد إلى SAML لتطبيق Google Workspace.

يتضمّن إعداد الدخول المُوحَّد (SSO) إدخال المعلومات اللازمة لخدمة Google Workspace للتواصل مع موفِّر الهوية الذي يخزِّن معلومات تسجيل الدخول للمستخدمين، بالإضافة إلى إعداد الروابط التي يجب أن يتم توجيه المستخدمين إليها لتسجيل الدخول وتسجيل الخروج وتغيير كلمات المرور. تتيح لك واجهة برمجة التطبيقات لإعدادات المشرفين تعديل هذه الإعدادات واستردادها بشكل آلي. تستخدم Google مفتاحك العام الذي تم إنشاؤه للتحقّق من طلب الدخول المُوحَّد (SSO) هذا من خلال موفِّر الهوية وأنّه لم يتم تعديل استجابة SAML للمفتاح الخاص أثناء نقل الشبكة.

للحصول على ملخّص قصير محدَّد لواجهة برمجة التطبيقات حول استخدام إعدادات الدخول المُوحَّد (SSO)، احصل على شهادة المفتاح العام من موفِّر الهوية، وسجِّل المفتاح العام في Google، ثم اضبط إعدادات طلب الدخول المُوحَّد (SSO) المستنِد إلى SAML. بالنسبة إلى رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها:

  • إنشاء المفاتيح -- باستخدام موفِّر الهوية، يمكنك إنشاء مجموعة من المفاتيح العامة والخاصة باستخدام خوارزميات DSA أو RSA. المفتاح العام في شهادة بتنسيق X.509. لمزيد من المعلومات عن مفاتيح توقيع الدخول الموحَّد المستنِدة إلى SAML، يُرجى الاطّلاع على مقالة إنشاء المفاتيح والشهادات لخدمة الدخول الموحَّد في Google Workspace.
  • التسجيل في Google -- استخدم إعدادات الدخول الموحّد لواجهة برمجة تطبيقات إعدادات المشرف لتسجيل شهادة المفتاح العام لدى Google.
  • ضبط إعدادات الدخول الموحَّد (SSO) -- استخدم إعدادات الدخول الموحَّد لواجهة برمجة تطبيقات Admin Settings (واجهة برمجة تطبيقات المشرف) لضبط الإعدادات المستخدمة للاتصال بخوادم موفر هوية النطاق.

إعدادات المدخل والتوجيه

تتيح هذه الخلاصة لمشرفي النطاقات التحكم في توجيه البريد الإلكتروني لنطاقاتهم.

تسمح عمليات توجيه البريد الإلكتروني للمشرفين بتحديد إعدادات توجيه البريد الإلكتروني على مستوى النطاق. يعتبر ذلك مشابهًا لوظيفة توجيه البريد الإلكتروني في إعدادات Gmail ضمن وحدة تحكُّم المشرف. لمزيد من المعلومات، يُرجى الاطِّلاع على توجيه البريد الإلكتروني وضبط التسليم الثنائي لميزة توجيه البريد الإلكتروني.

نموذج لطلب وردّ XML من Admin Settings API

يقدِّم هذا المستند أمثلة على رموز لطلبات واستجابات واجهة برمجة التطبيقات لإعدادات المشرف الأساسية باستخدام XML وHTTP الأولي. يوضح مثال اللغة التلقائية للنطاق هذا بنية XML وHTTP الكاملة لنص الطلب وإدخال الاستجابة الشائع لكل عملية:

لتغيير إعداد مدخل البريد الإلكتروني الصادر للنطاق، يمكنك إرسال رمز HTTP PUT إلى عنوان URL لخلاصة المدخل:

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

اللغة التلقائية للنطاق PUT لطلب AtomPub entry 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 زوجًا واحدًا من المفاتيح والقيم يحتوي على معلومات حول الخاصية التي تريد استردادها أو تعديلها، باستثناء الخصائص والقيم الخاصة بالعملية. وهي شائعة في جميع نصوص طلبات واجهة برمجة تطبيقات إعدادات المشرف.

يعرض عنصر استجابة اللغة التلقائية للنطاق entry الخاصيتين smartHost وsmtpMode إلى جانب بنية XML الشائعة لكل نصوص ردود واجهة برمجة تطبيقات إعدادات المشرف:

<?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 للمستخدمين تسجيل الدخول إلى خدمات متعددة مع الحاجة إلى إدخال معلومات تسجيل الدخول وكلمة المرور مرة واحدة فقط. يتم تخزين كلمة المرور هذه من خلال موفِّر هوية النطاق، وليس من خلال Google Workspace. لمزيد من المعلومات، اطلع على صفحة الدخول الموحَّد (SSO) في مركز المساعدة. توضح الأقسام التالية تنسيق XML المستخدم لإعدادات الدخول الموحّد.

استرداد إعدادات الدخول الموحّد

لاسترداد إعدادات الدخول الموحّد، أرسِل GET HTTP إلى عنوان URL للخلاصة العامة للدخول الموحَّد (SSO)، وضمِّن العنوان Authorization كما هو موضَّح في المصادقة على خدمة إعدادات المشرف. وبالنسبة إلى رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها:

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

لا تحتوي هذه العملية على أي معلمات في نص الطلب.

تعرض الاستجابة الناجحة رمز حالة HTTP 200 OK مع خلاصة AtomPub مع إعدادات الدخول الموحَّد (SSO) للنطاق.

يعرض XML لاستجابة GET الخصائص 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
عنوان URL لموفِّر الهوية الذي ترسل Google Workspace من خلاله طلب SAML لمصادقة المستخدم.
معيار SAMLLogoutUri
العنوان الذي سيتم إرسال المستخدمين إليه عند تسجيل خروجهم من تطبيق الويب
تغيير كلمة المرور Uri
العنوان الذي سيتم توجيه المستخدمين إليه عندما يريدون تغيير كلمة مرور خدمة الدخول المُوحَّد (SSO) لتطبيق الويب.
تفعيل الدخول المُوحَّد (SSO)
يؤدي هذا الإعداد إلى تفعيل الدخول المُوحَّد (SSO) المستنِد إلى SAML لهذا النطاق. إذا سبق لك ضبط إعدادات الدخول المُوحَّد (SSO)، ثم ضبطت enableSSO على enableSSO=false بعد ذلك، ستظل الإعدادات التي سبق أن أدخلتها محفوظة.
إضافة إلى القائمة البيضاء
رابط القائمة البيضاء هو عنوان IP لقناع الشبكة بتنسيق "التوجيه بين النطاقات غير الفئوي" (CIDR). وتحدّد ssoالقائمة البيضاء المستخدمين الذين يسجلون الدخول باستخدام خدمة الدخول الموحَّد (SSO) والمستخدمين الذين يسجّلون الدخول باستخدام صفحة مصادقة حساب Google Workspace. في حال عدم تحديد أي أقنعة، سيسجِّل جميع المستخدمين الدخول باستخدام الدخول المُوحَّد (SSO). لمزيد من المعلومات، راجِع آلية عمل أقنعة الشبكة.
استخدام مُصنِّف المجال المحدَّد
يمكن استخدام جهة إصدار مُحدَّدة للنطاق في طلب SAML إلى موفِّر الهوية. على الرغم من أنها ليست ضرورية لمعظم عمليات نشر خدمة الدخول الموحَّد (SSO)، تُعد هذه الميزة مفيدة في الشركات الكبيرة التي تستخدم موفِّر هوية واحدًا لمصادقة المؤسسة بالكامل من خلال نطاقات فرعية متعددة. ومن خلال منح جهة إصدار النطاق المحدّدة، يتم تحديد النطاق الفرعي الذي تريد ربطه بالطلب. للحصول على مزيد من المعلومات، راجع كيف يعمل عنصر جهة الإصدار في طلب SAML؟

إذا تعذّر طلبك لسبب ما، يتم عرض رمز حالة مختلف. لمزيد من المعلومات عن رموز حالة Google Data API، يُرجى الاطّلاع على رموز حالة HTTP.

تحديث إعدادات الدخول الموحّد

لتعديل إعدادات الدخول المُوحَّد (SSO) لنطاق، أولاً يمكنك استرداد إعدادات الدخول المُوحَّد (SSO) باستخدام عملية استرداد إعدادات الدخول المُوحَّد، وتعديلها، ثم إرسال طلب PUT إلى عنوان URL لخلاصة الدخول المُوحَّد (SSO). تأكد من أن قيمة <id> في الإدخال المحدّث تتطابق تمامًا مع <id> للإدخال الحالي. ضمِّن عنوان Authorization على النحو الموضّح في قسم المصادقة على خدمة Admin Settings API. وبالنسبة إلى رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها.

عند تعديل إعدادات الدخول الموحّد، أرسل طلب HTTP PUT إلى عنوان URL للخلاصة العامة للدخول الموحّد:

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.

استرداد مفتاح توقيع الدخول الأحادي

لاسترداد مفتاح توقيع الدخول الموحَّد، أرسِل GET HTTP إلى عنوان URL لخلاصة مفتاح توقيع الدخول الموحَّد (SSO)، وضمِّن العنوان Authorization كما هو موضَّح في المصادقة على خدمة إعدادات المشرف. وبالنسبة إلى رسائل الخطأ، يُرجى الاطِّلاع على تحديد مشاكل الدخول المُوحَّد (SSO) وحلّها:

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

لا تحتوي هذه العملية على أي معلمات في نص الطلب.

تعرض الاستجابة الناجحة رمز حالة HTTP 200 OK مع خلاصة AtomPub مع مفتاح التوقيع.

يعرض XML للاستجابة GET السمة 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) لنطاق ما، عليك أولاً استرداد مفتاح التوقيع باستخدام عملية استرداد مفتاح توقيع الدخول الموحَّد، ثم تعديل هذا المفتاح ثم إرسال طلب PUT إلى عنوان URL لخلاصة مفتاح توقيع الدخول الموحَّد (SSO). تأكد من أن قيمة <id> في الإدخال المحدّث تتطابق تمامًا مع <id> للإدخال الحالي. لمزيد من المعلومات عن مفاتيح توقيع الدخول الموحَّد المستنِدة إلى SAML، يُرجى الاطّلاع على مقالة إنشاء المفاتيح والشهادات لخدمة الدخول الموحَّد في Google Workspace.

عند تحديث مفتاح توقيع الدخول الموحّد، أرسل PUT HTTP إلى عنوان URL لخلاصة مفتاح توقيع الدخول الموحّد:

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>

إدارة مدخل البريد الإلكتروني وتوجيهه

يعرض قسم مدخل البريد الإلكتروني الصادر كيفية دعم واجهة برمجة التطبيقات لإعدادات المشرف لتوجيه البريد الصادر من المستخدمين في نطاقك. يعرض قسم "توجيه البريد الإلكتروني" كيفية توجيه الرسائل إلى خادم بريد آخر.

استرداد إعدادات مدخل البريد الإلكتروني الصادر

لاسترداد إعدادات مدخل البريد الإلكتروني الصادر، أرسل GET HTTP إلى عنوان URL لخلاصة المدخل، وضمِّن رأس 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 إلى عنوان URL لخلاصة المدخل:

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 البريد الصادر إلى هذا الخادم.
وضع 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 لصالح Google. لمزيد من التفاصيل عن حل أسماء مضيفي البريد، يُرجى الاطِّلاع على الإصدار التجريبي من Google Workspace مع توجيه البريد الإلكتروني.
إعادة كتابة المسار
في حال الضبط على "صحيح"، سيتم تغيير الحقل to: لمغلف SMTP للرسالة إلى اسم المضيف الوجهة (اسم مضيف user@destination)، وسيتم تسليم الرسالة إلى عنوان المستخدم هذا على خادم البريد الوجهة. في حال false، يتم تسليم الرسالة الإلكترونية إلى عنوان البريد الإلكتروني to: للرسالة الأصلية (اسم المضيف user@الأصلي) على خادم البريد الوجهة. ويعتبر هذا مشابهًا لإعداد "تغيير مغلف SMTP" في وحدة تحكم المشرف. لمزيد من المعلومات، راجِع إعدادات النطاق لتوجيه البريد الإلكتروني.
التوجيه تم التفعيل
في حال true، سيتم تفعيل وظيفة توجيه البريد الإلكتروني. في حال false، سيتم إيقاف الوظيفة.
إشعارات الارتداد
في حال true، سيتم تفعيل Google Workspace لإرسال إشعارات مرتدة إلى المُرسِل عند تعذُّر التسليم.
التعامل مع الحساب

يحدد هذا الإعداد كيفية تأثر الأنواع المختلفة من المستخدمين في النطاق بتوجيه البريد الإلكتروني:

  • allAccounts -- تسليم كل الرسائل الإلكترونية إلى هذه الوجهة.
  • provisionedAccounts -- تسليم البريد إلى هذه الوجهة إذا كان المستخدم موجودًا في Google Workspace.
  • unknownAccounts -- تسليم البريد إلى هذه الوجهة إذا لم يكن المستخدم موجودًا في Google Workspace. ويعد هذا مشابهًا لإعداد "تسليم البريد الإلكتروني لـ" في وحدة تحكم المشرف. لمزيد من المعلومات حول المتطلبات الأساسية وكيفية استخدام توجيه البريد، راجع إعدادات النطاق لتوجيه البريد الإلكتروني. ~ لنشر هذا الطلب، أرسِل POST HTTP إلى عنوان URL لخلاصة توجيه البريد الإلكتروني، مع تضمين عنوان 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