Directory API: ניהול לקוחות

אתם יכולים להשתמש ב-Directory API כדי לנהל את הלקוחות שלכם באופן פרוגרמטי. השיטות ב-API הזה מאפשרות לעדכן את הפרטים ליצירת קשר בדומיין של Google Workspace, וגם לשנות את הדומיין הראשי של המופע.

אחזור פרטי לקוח

כדי לאחזר לקוח קיים, משתמשים בבקשת HTTP‏ GET הבאה וכוללים את טוקן ההרשאה שמתואר במאמר בנושא הרשאת בקשות. ‫customerKey יכול להיות מספר הלקוח הייחודי, או 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"
}

שינוי שם הדומיין הראשי של לקוח

כדי לשנות את הדומיין הראשי של לקוח, משתמשים בבקשת ה-HTTP‏ PUT הבאה וכוללים את טוקן ההרשאה שמתואר במאמר בנושא הרשאת בקשות. הערך של customerKey צריך להיות מזהה הלקוח הייחודי או 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"
}