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

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

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

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

الجمهور

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

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

البدء

إنشاء حساب

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

لمحة عن أنواع خلاصات واجهة Admin Settings API

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

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

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

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

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

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

إعدادات البوابة والتوجيه

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

تتيح عمليات توجيه البريد الإلكتروني للمشرفين تحديد إعدادات توجيه البريد الإلكتروني على مستوى النطاق. وهي تشبه وظيفة توجيه البريد الإلكتروني في إعدادات 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

تنسيق XML الخاص بطلب AtomPub PUT للغة التلقائية للنطاق entry هو:

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

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

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

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

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

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

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

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

لتعديل إعدادات الدخول المُوحَّد (SSO) لنطاق معيّن، عليك أولاً استرداد إعدادات الدخول المُوحَّد باستخدام عملية استرداد إعدادات الدخول المُوحَّد، ثم تعديلها، وبعد ذلك إرسال طلب 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 تتضمّن إعدادات تسجيل الدخول الأحادي.

تنسيق 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 كما هو موضّح في المصادقة على خدمة "إعدادات المشرف". بالنسبة إلى رسائل الخطأ، يُرجى الاطّلاع على تحديد مشاكل الدخول المُوحَّد وحلّها:

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 الخاص بخلاصة مفتاح توقيع الدخول المُوحَّد. تأكَّد من أنّ <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".

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

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

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

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

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

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

إيقاف نقاط النهاية نهائيًا في 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