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

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

استرداد عميل

لاسترداد معلومات عميل حالي، استخدِم طلب GET HTTP التالي وأضِف رمز التفويض الموضّح في طلبات التفويض. يمكن أن تكون قيمة customerKey هي customerId الفريد أو 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": "yuri@example.com",
  "id": "C03xgje4y",
  "customerDomain": "example.com",
  "postalAddress": {
    "organizationName": "Example.com",
    "countryCode": "US"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

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

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

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

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

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "yuri@example.com",
  "id": "C03xgje4y",
  "customerDomain": "example.com",
  "postalAddress": {
    "organizationName": "Example.com",
    "phoneNumber": "+15558675309"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

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

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

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

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

{
  "alternateEmail": "yuri@example.com",
  "customerDomain": "example.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "Example.com",
    "phoneNumber": "+15558675309"
  }
}