Interfejs Directory API: zarządzanie klientami

Za pomocą interfejsu Directory API możesz zarządzać klientami programowo. Metody w tym interfejsie API umożliwiają aktualizowanie informacji kontaktowych w domenie G Suite oraz zmianę domeny podstawowej instancji.

Pobieranie danych o kliencie

Aby pobrać dotychczasowego klienta, użyj tego żądania HTTP GET i dołącz token autoryzacji opisanego w sekcji autoryzowanie żądań. Wartość customerKey może być unikalnym identyfikatorem customerId lub my_customer, aby wskazać bieżącego klienta.

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera też informacje o kliencie:

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

Aktualizowanie dotychczasowego klienta

Aby zaktualizować dotychczasowego klienta, użyj tego PUTżądania HTTP i dołącz token autoryzacji opisany w sekcji autoryzowanie żądań. Wartością parametru customerKey może być unikalny identyfikator klienta (customerId) lub my_customer, aby wskazać bieżącego klienta.

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera również nowo zaktualizowane informacje o kliencie:

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera też informacje o kliencie:

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

Zmienianie nazwy domeny podstawowej klienta

Aby zmienić domenę podstawową klienta, użyj tego żądania HTTP PUT i dołącz token autoryzacji opisanego w sekcji autoryzowanie żądań. Wartością parametru customerKey musi być unikalny identyfikator customerId lub my_customer.

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

Treść żądania JSON musi zawierać nową wartość customerDomain:

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera informacje o kliencie:

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