Directory API: إدارة العملاء

يمكنك استخدام Directory API لإدارة عملائك آليًا. تتيح لك الطرق الواردة في واجهة برمجة التطبيقات هذه تعديل معلومات الاتصال في نطاق G Suite، بالإضافة إلى تغيير النطاق الأساسي لنسختك.

استرداد عميل

لاسترداد عميل حالي، استخدِم طلب HTTP التالي GET وأضِف رمز التفويض الموضّح في طلبات التفويض. يمكن أن يكون العنصر customerKey هو المعرّف الفريد للعميل، أو my_customer للإشارة إلى العميل الحالي.

GET https://admin.googleapis.com/admin/directory/v1/customers/customerKey

تعرِض الاستجابة الناجحة رمز الحالة HTTP 200. بالإضافة إلى رمز الحالة، تتضمّن استجابة JSON معلومات العميل:

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "marty.mcfly@gmail.com",
  "id": "C03xgje4y",
  "customerDomain": "amatchmadeinspace.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "countryCode": "US"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

تعديل عميل حالي

لتعديل بيانات عميل حالي، استخدِم طلب HTTP التالي PUT وأدرِج رمز التفويض الموضّح في طلبات التفويض. يمكن أن يكون العنصر customerKey هو معرّف العميل الفريد customerId، أو my_customer للإشارة إلى العميل الحالي.

PUT https://admin.googleapis.com/admin/directory/v1/customers/customerKey

تعرِض الاستجابة الناجحة رمز الحالة HTTP 200. إلى جانب رمز الحالة، تتضمّن استجابة JSON معلومات العميل المعدَّلة حديثًا:

{
  "alternateEmail": "marty.mcfly@gmail.com",
  "customerDomain": "amatchmadeinspace.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  }
}

يعرض الطلب الناجح رمز الحالة HTTP 200. بالإضافة إلى رمز الحالة، تتضمّن استجابة JSON معلومات العميل:

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "marty.mcfly@gmail.com",
  "id": "C03xgje4y",
  "customerDomain": "amatchmadeinspace.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

تغيير اسم النطاق الأساسي للعميل

لتغيير النطاق الأساسي للعميل، استخدِم طلب HTTP التالي PUT وأضِف رمز التفويض الموضّح في طلبات التفويض. يجب أن يكون customerKey هو المعرّف الفريد customerId أو my_customer.

PUT https://admin.googleapis.com/admin/directory/v1/customers/customerKey

يجب أن يتضمّن نص طلب JSON القيمة الجديدة customerDomain:

{
  "alternateEmail": "marty.mcfly@gmail.com",
  "customerDomain": "fluxcapacitor.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  }
}

تعرِض الاستجابة الناجحة رمز الحالة HTTP 200. بالإضافة إلى رمز الحالة، يتضمّن ردّ JSON معلومات العميل:

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "marty.mcfly@gmail.com",
  "id": "C03xgje4y",
  "customerDomain": "fluxcapacitor.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}