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

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

boolean

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

string

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

enum (CustomerType)

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

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

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

object (PrimaryAdmin)

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

כתובת

תבנית 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

שורה שנייה בכתובת.
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 של הלקוח, כולל היכולת להזמין ולהסיר משתמשים ולנהל את צורכי הניהול של הלקוח.

שיטות

get

 מקבל חשבון לקוח.

insert

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

patch

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

update

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