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

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

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

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

الجمهور

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

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

البدء

لبدء استخدام Admin Settings API، عليك أولاً إعداد حسابك.

إنشاء حساب

تفعيل واجهة برمجة التطبيقات "إعدادات المشرف" لحسابات 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 الخاصة بالمفتاح الخاص أثناء نقلها عبر الشبكة.

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

  • إنشاء المفاتيح: أنشئ مجموعة من المفاتيح العامة والخاصة باستخدام إما خوارزميات DSA أو RSA مع موفّر خدمة تحديد الهوية. المفتاح العام موجود في شهادة بتنسيق X.509. لمزيد من المعلومات حول مفاتيح التوقيع الخاصة بخدمة الدخول المُوحَّد المستندة إلى SAML، يُرجى الاطّلاع على إنشاء مفاتيح وشهادات لخدمة الدخول المُوحَّد في Google Workspace.
  • التسجيل لدى Google: استخدِم إعدادات "تسجيل الدخول مرّة واحدة" في Admin Settings API لتسجيل شهادة المفتاح العام لدى Google.
  • إعداد إعدادات الدخول المُوحَّد: استخدِم إعدادات الدخول المُوحَّد في 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 entry لطلب AtomPub 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 زوج مفتاح/قيمة واحدًا يحتوي على معلومات حول سمة تريد استردادها أو تعديلها. وهي شائعة في جميع نصوص طلبات واجهة برمجة التطبيقات لإعدادات المشرفين.

يعرض العنصر 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>

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

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

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

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

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

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

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

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

تنسيق 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.

لا يُسمح بإجراء تغييرات على إعدادات &quot;الدخول المُوحّد&quot; عندما يكون العميل المستهدف قد فعّل ميزة موافقة جهات متعددة على الإجراءات الحسّاسة. سيتعذّر تنفيذ الطلبات مع ظهور الخطأين 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.

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

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

لا يُسمح بإجراء تغييرات على إعدادات &quot;الدخول المُوحّد&quot; عندما يكون العميل المستهدف قد فعّل ميزة موافقة جهات متعددة على الإجراءات الحسّاسة. سيتعذّر تنفيذ الطلبات مع ظهور الخطأين 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