Directory API: 顧客の管理

Directory API を使用して、顧客をプログラムによって管理できます。この API のメソッドを使用すると、G Suite ドメインの連絡先情報を更新することに加えて、インスタンスのプライマリ ドメインを変更することもできます。

顧客を取得する

既存の顧客を取得するには、次の 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": "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"
}

既存の顧客を更新する

既存の顧客を更新するには、次の PUT HTTP リクエストを使用し、その際にはリクエストの承認で説明した認証トークンを含めます。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"
}