REST Resource: customers

משאב: לקוח

כשחשבון של לקוח Google רשום אצל מפיץ, המפיץ הזה מנהל את המינויים של הלקוח לשירותי Google. לקוח מתואר באמצעות שם דומיין ראשי וכתובת פיזית.

ייצוג ב-JSON 
{
  "customerId": string,
  "customerDomain": string,
  "postalAddress": {
    object (Address)
  },
  "phoneNumber": string,
  "alternateEmail": string,
  "resourceUiUrl": string,
  "customerDomainVerified": boolean,
  "kind": string,
  "customerType": enum (CustomerType),
  "primaryAdmin": {
    object (PrimaryAdmin)
  }
}
שדות
customerId

string

המאפיין הזה תמיד יוחזר בתגובה כמזהה הייחודי שנוצר על ידי Google. בבקשה, הנכס הזה יכול להיות הדומיין הראשי או המזהה הייחודי שנוצר על ידי Google.
customerDomain

string

מחרוזת שם הדומיין הראשי של הלקוח. השדה customerDomain נדרש כשיוצרים לקוח חדש. כשמוסיפים לקוח, לא כוללים את הקידומת www בדומיין.
postalAddress

object (Address)

פרטי הכתובת של הלקוח. בכל שדה יש מגבלה של 255 תווים.
phoneNumber

string

מספר הטלפון של איש הקשר של הלקוח. המספר חייב להתחיל בסימן '+' ואחריו קוד המדינה. שאר המספר יכול להיות רצף של מספרים או לפעול לפי כללי הפורמט המקומיים של הטלפון, אבל הוא חייב להיות מספר טלפון אמיתי ולא, למשל, '123'. אם השדה לא חוקי, המערכת מתעלמת ממנו ללא הודעה.
alternateEmail

string

בדומה לכתובת האימייל של הלקוח בכלים של המפיץ, כתובת האימייל הזו היא כתובת האימייל המשנית ליצירת קשר במקרה שמשהו קורה לשירות של הלקוח, למשל הפסקה זמנית בשירות או בעיית אבטחה. המאפיין הזה נדרש כשיוצרים לקוח 'דומיין' חדש, ואסור להשתמש באותו דומיין כמו customerDomain. אין צורך בשדה alternateEmail כדי ליצור לקוח 'ללא דומיין'.
resourceUiUrl

string

כתובת ה-URL של מרכז הבקרה של מסוף Admin של הלקוח. כתובת ה-URL לקריאה בלבד נוצרת על ידי שירות ה-API. משתמשים באפשרות הזו אם באפליקציית הלקוח שלכם הלקוח צריך להשלים משימה במסוף Admin.
customerDomainVerified

boolean

אם הדומיין הראשי של הלקוח אומת.
kind

string

מזהה את המשאב כלקוח. ערך: reseller#customer
customerType

enum (CustomerType)

מזהה את סוג הלקוח. ערכים קבילים כוללים:

  • domain: המשמעות היא לקוח שמאומת באמצעות דומיין (ברירת המחדל).
  • team: מציין לקוח שאומת באמצעות אימייל.

מידע נוסף זמין במאמר צוותים מנוהלים.
primaryAdmin

object (PrimaryAdmin)

פרטי האדמין הראשונים של הלקוח, שמוצגים במקרה של לקוח צוות.

כתובת

תבנית JSON לכתובת של לקוח.

ייצוג ב-JSON 
{
  "countryCode": string,
  "kind": string,
  "region": string,
  "addressLine2": string,
  "locality": string,
  "addressLine3": string,
  "postalCode": string,
  "addressLine1": string,
  "organizationName": string,
  "contactName": string
}
שדות
countryCode

string

מידע על countryCode זמין במאמר רכיבי קוד המדינה לפי תקן ISO 3166. מוודאים שהמדינה אושרה למכירה חוזרת של מוצרי Google. צריך לציין את המאפיין הזה כשיוצרים לקוח חדש.
kind

string

מזהה את המשאב ככתובת של לקוח. ערך: customers#address
region

string

דוגמה לערך של region היא CA עבור מדינת קליפורניה.
addressLine2

string

שורה 2 בכתובת.
locality

string

דוגמה לערך של locality היא העיר San Francisco.
addressLine3

string

שורה 3 בכתובת.
postalCode

string

דוגמה ל-postalCode היא מיקוד, כמו 94043. צריך לציין את המאפיין הזה כשיוצרים לקוח חדש.
addressLine1

string

הכתובת הפיזית של הלקוח. כתובת יכולה להיות מורכבת משורה אחת עד שלוש שורות. הערכים addressline2 ו-addressLine3 הם אופציונליים.
organizationName

string

שם החברה או שם המחלקה בחברה. זהו שדה חובה.
contactName

string

שם איש הקשר של הלקוח. זהו שדה חובה.

CustomerType

סוג הלקוח

טיפוסים בני מנייה (enum)
customerTypeUnspecified סוג הלקוח לא ידוע
domain לקוחות עם דומיין או לקוחות שבבעלותם דומיין
team לקוחות ללא דומיין או לקוחות שאומתו באימייל

PrimaryAdmin

תבנית JSON לאדמין הראשי במקרה של לקוחות TEAM

ייצוג ב-JSON 
{
  "primaryEmail": string
}
שדות
primaryEmail

string

כתובת האימייל העסקית של האדמין הראשי של הלקוח.

קישור האימות באימייל נשלח לכתובת האימייל הזו בזמן יצירת הלקוח. לאדמינים ראשיים יש גישה למסוף Admin של הלקוח, כולל היכולת להזמין משתמשים ולהוציא אותם, ולנהל את הצרכים הניהוליים של הלקוח.

Methods

get

 אחזור של חשבון לקוח.

insert

 הזמנת חשבון של לקוח חדש.

patch

 עדכון ההגדרות של חשבון לקוח.

update

 עדכון ההגדרות של חשבון לקוח.