Directory API: Mengelola Pelanggan

Anda dapat menggunakan Directory API untuk mengelola pelanggan secara terprogram. Metode dalam API ini memungkinkan Anda memperbarui informasi kontak di domain Google Workspace, serta mengubah domain utama untuk instance Anda.

Mengambil Pelanggan

Untuk mengambil pelanggan yang sudah ada, gunakan permintaan HTTP GET berikut dan sertakan token otorisasi yang dijelaskan dalam mengotorisasi permintaan. customerKey dapat berupa customerId unik, atau my_customer untuk menunjukkan pelanggan saat ini.

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

Respons yang berhasil akan menampilkan kode status HTTP 200. Selain kode status, respons JSON menyertakan informasi pelanggan:

{
  "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"
}

Memperbarui pelanggan lama

Untuk memperbarui pelanggan yang ada, gunakan permintaan HTTP PUT berikut dan sertakan token otorisasi yang dijelaskan dalam mengotorisasi permintaan. customerKey dapat berupa customerId unik pelanggan, atau my_customer untuk menunjukkan pelanggan saat ini.

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

Respons yang berhasil akan menampilkan kode status HTTP 200. Selain kode status, respons JSON menyertakan informasi pelanggan yang baru diperbarui:

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

Respons yang berhasil akan menampilkan kode status HTTP 200. Selain kode status, respons JSON menyertakan informasi pelanggan:

{
  "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"
}

Mengubah nama domain primer pelanggan

Untuk mengubah domain utama pelanggan, gunakan permintaan HTTP PUT berikut dan sertakan token otorisasi yang dijelaskan dalam mengotorisasi permintaan. customerKey harus berupa customerId yang unik, atau my_customer.

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

Isi permintaan JSON harus menyertakan nilai customerDomain baru:

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

Respons yang berhasil akan menampilkan kode status HTTP 200. Selain kode status, respons JSON menyertakan informasi pelanggan:

{
  "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"
}