نظرة عامة على Admin Settings API

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

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

تنفِّذ واجهة برمجة التطبيقات لإعدادات المشرفين بروتوكول Google Data API. تتوافق Google Data API مع نموذج النشر والتحرير في Atom Publishing Protocol (AtomPub). تستخدِم طلبات HTTP في AtomPub نهج تصميم أسلوب نقل البيانات التمثيلية (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

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

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

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

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

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

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

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

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

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

نموذج لطلب وجواب Admin Settings API بتنسيق XML

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

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

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

تنسيق XML لطلب AtomPub entry باللغة التلقائية للنطاق 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>

باستثناء المواقع والقيم الخاصة بالعملية، تمثّل عناصر atom:property زوجًا واحدًا من المفتاح والقيمة يحتوي على معلومات عن موقع تريد استرجاعه أو تعديله. هذه العناصر شائعة في جميع أجسام طلبات Admin Settings API.

يعرض عنصر الاستجابة للغة التلقائية للموقع الإلكتروني entry السمتَين smartHost وsmtpMode بالإضافة إلى بنية XML الشائعة لجميع أجسام استجابة Admin Settings 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>

إدارة إعدادات الدخول المُوحَّد

تتيح ميزة "الدخول المُوحَّد" في Google Workspace للمستخدمين تسجيل الدخول إلى خدمات متعدّدة بدون الحاجة إلى إدخال بيانات تسجيل الدخول وكلمة المرور إلا مرة واحدة. يخزِّن موفِّر الهوية في النطاق كلمة المرور هذه، وليس Google Workspace. لمزيد من المعلومات، يُرجى الاطّلاع على صفحة "تسجيل الدخول المُوحَّد" في "مركز المساعدة". توضّح الأقسام التالية تنسيق XML المستخدَم لإعدادات الدخول المُوحَّد.

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

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

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

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

تعرِض الاستجابة الناجحة رمز حالة HTTP 200 OK، بالإضافة إلى خلاصة AtomPub تتضمّن إعدادات تسجيل الدخول المُوحَّد للنطاقات.

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

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

تعديل إعدادات ميزة "الدخول المُوحَّد"

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

عند تعديل إعدادات الدخول المُوحَّد، أرسِل طلب 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.

لا يُسمح بإجراء تغييرات على إعدادات "تسجيل الدخول بخطوة واحدة" عندما يفعّل العميل المستهدَف موافقة جهات متعددة على الإجراءات الحسّاسة. ستتعذّر الطلبات التي تستخدم errorCode="1811" وreason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

استرداد مفتاح توقيع الدخول المُوحَّد

لاسترداد مفتاح التوقيع الخاص بميزة "تسجيل الدخول المُوحَّد"، أرسِل طلب HTTP GET إلى عنوان URL لخلاصة مفتاح التوقيع الخاص بميزة "تسجيل الدخول المُوحَّد"، وأدرِج رأس 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.

تعديل مفتاح توقيع الدخول المُوحَّد

لتعديل مفتاح التوقيع لخدمة الدخول المُوحَّد لنطاق معيّن، عليك أولاً استرداد مفتاح التوقيع باستخدام عملية استرداد مفتاح التوقيع لخدمة الدخول المُوحَّد، ثم تعديله، ثم إرسال طلب PUT إلى عنوان URL لخلاصة مفتاح التوقيع لخدمة الدخول المُوحَّد. تأكَّد من أنّ قيمة <id> في الإدخال المعدَّل تتطابق تمامًا مع قيمة <id> في الإدخال الحالي. لمزيد من المعلومات عن مفاتيح التوقيع لميزة "الدخول المُوحَّد" المستندة إلى SAML، يُرجى الاطّلاع على مقالة إنشاء مفاتيح وشهادات لخدمة "الدخول المُوحَّد" في Google Workspace.

عند تعديل مفتاح التوقيع الخاص بميزة "الدخول المُوحَّد"، أرسِل طلب HTTP PUT إلى عنوان 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>

لا يُسمح بإجراء تغييرات على إعدادات "تسجيل الدخول بخطوة واحدة" عندما يفعّل العميل المستهدَف موافقة جهات متعددة على الإجراءات الحسّاسة. ستتعذّر الطلبات التي تستخدم errorCode="1811" وreason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

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

يوضّح قسم بوابة البريد الإلكتروني الصادر كيفية توافق Admin Settings API مع توجيه البريد الصادر من المستخدمين في نطاقك. يعرض قسم توجيه الرسائل الإلكترونية كيفية توجيه الرسائل إلى خادم بريد آخر.

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

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

سمات الطلب هي:

smartHost
عنوان 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>

سمات الطلب هي:

routeDestination
هذه الوجهة هي اسم المضيف أو عنوان IP لخادم البريد SMTP-In الذي يتم توجيه الرسالة الإلكترونية إليه. يجب أن تتم ترجمة اسم المضيف أو عنوان IP من قِبل Google. لمزيد من التفاصيل حول حلّ أسماء مضيفي البريد الإلكتروني، يُرجى الاطّلاع على مقالة تجربة Google Workspace مع توجيه الرسائل الإلكترونية.
routeRewriteTo
في حال ضبط القيمة على "صحيح"، يتم تغيير حقل to: في مغلف SMTP للرسالة إلى اسم المضيف الوجهة (اسم المضيف user@destination)، ويتم تسليم الرسالة إلى عنوان المستخدم هذا على خادم البريد الوجهة. إذا كانت القيمة false، يتم تسليم الرسالة الإلكترونية إلى عنوان البريد الإلكتروني to: للرسالة الأصلية (user@original hostname) على خادم البريد الإلكتروني المقصود. يشبه ذلك إعداد "تغيير مغلف SMTP" في "وحدة تحكّم المشرف". لمزيد من المعلومات، يُرجى الاطّلاع على إعدادات النطاق لتوجيه البريد الإلكتروني.
routeEnabled
في حال true، يتم تفعيل وظيفة توجيه البريد الإلكتروني. إذا كانت القيمة false، تكون الوظيفة غير مفعّلة.
bounceNotifications
في حال true، يتم تفعيل Google Workspace لإرسال إشعارات بالارتداد إلى المُرسِل عند تعذُّر إرسال الرسالة.
accountHandling

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

  • 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