REST Resource: partners.vendors.customers

משאב: החברה

מפיץ, ספק או לקוח בממשקי ה-API של מפיץ ללא מגע ולקוח.

ייצוג JSON 
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
שדות
name

string

פלט בלבד. השם של משאב ה-API של החברה. שם המשאב יכול להיות באחד מהפורמטים הבאים:

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]

הוקצתה על ידי השרת.
companyId

string (int64 format)

פלט בלבד. המזהה של החברה. הוקצתה על ידי השרת.
companyName

string

חובה. שם החברה. לדוגמה: XYZ Corp. מוצג לעובדי החברה בפורטל ההרשמה דרך הארגון.
ownerEmails[]

string

חובה. קלט בלבד. כתובות האימייל של המשתמשים של הלקוח בתפקיד 'בעלים'. צריך לציין owner_email אחד לפחות. לבעלים יש גישה זהה לזו של אדמינים, אבל הם יכולים גם להוסיף, למחוק ולערוך משתמשים בפורטל של הארגון.
adminEmails[]

string

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

enum (TermsStatus)

פלט בלבד. האם משתמש כלשהו מהחברה אישר את התנאים וההגבלות העדכניים ביותר. TermsStatus.
skipWelcomeEmail

boolean

קלט בלבד. אם המדיניות מוגדרת כ-True, לא תישלח הודעת הצטרפות באימייל ללקוח. מומלץ לדלג על אימייל ההיכרות אם המכשיר ימומש עם שירות DEVICE_PROTECTION נוסף, כי הלקוח יקבל אימיילים נפרדים בזמן תביעת הבעלות על המכשיר. אם זה לא לקוח ללא מגע, המערכת תתעלם מהשדה הזה.
languageCode

string

קלט בלבד. הלוקאל המועדף של הלקוח שמיוצג כקוד שפה BCP47. השדה הזה מאומת בעת הזנת קלט, ובקשות שמכילות קודים של שפות שאינם נתמכים יידחו.

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

פלט בלבד. חשבון Google Workspace שמשויך ללקוח הזה. לשימוש עבור חברות לקוח בלבד.

שיטות

list

 בתיבת הדו-שיח הזו מפורטים הלקוחות של הספק.