Directory API: مدیریت مشتریان

شما می‌توانید از API دایرکتوری برای مدیریت مشتریان خود به صورت برنامه‌نویسی شده استفاده کنید. متدهای موجود در این API به شما امکان می‌دهند اطلاعات تماس را در دامنه Google Workspace خود به‌روزرسانی کنید و همچنین دامنه اصلی را برای نمونه خود تغییر دهید.

بازیابی مشتری

برای بازیابی یک مشتری موجود، از درخواست HTTP GET زیر استفاده کنید و توکن مجوز شرح داده شده در درخواست‌های مجوز را نیز وارد کنید. 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": "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"
}

تغییر نام دامنه اصلی مشتری

برای تغییر دامنه اصلی مشتری، از درخواست PUT HTTP زیر استفاده کنید و توکن مجوز شرح داده شده در درخواست‌های مجوز را نیز وارد کنید. 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"
}