REST Resource: contactGroups

משאב: ContactGroup

קבוצה של אנשי קשר.

ייצוג JSON 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
שדות
resourceName

string

שם המשאב עבור קבוצת אנשי הקשר, שהוקצה על ידי השרת. מחרוזת ASCII, בצורת contactGroups/{contactGroupId}.
etag

string

תג ישות ה-HTTP של המשאב. משמש לאימות מטמון אינטרנט.
metadata

object (ContactGroupMetadata)

פלט בלבד. מטא-נתונים על קבוצת אנשי הקשר.
groupType

enum (GroupType)

פלט בלבד. הסוג של קבוצת אנשי הקשר.
name

string

השם של קבוצת אנשי הקשר שהוגדרו על ידי הבעלים של הקבוצה, או שם שהמערכת סיפקה עבור קבוצות מערכת.

עבור contactGroups.create או contactGroups.update, השם חייב להיות ייחודי לקבוצות אנשי הקשר של המשתמשים. ניסיון ליצור קבוצה עם שם כפול יחזיר שגיאת HTTP 409.
formattedName

string

פלט בלבד. השם שמתורגם ומפורמט בלוקאל של החשבון של הצופה, או בלוקאל של כותרת ה-HTTP של Accept-Language עבור שמות של קבוצות מערכות. שמות קבוצות שהוגדרו על ידי הבעלים זהים לשם.
memberResourceNames[]

string

פלט בלבד. רשימת שמות המשאבים של אנשי קשר שחברים בקבוצת אנשי הקשר. השדה יאוכלס רק בבקשות GET ויחזיר רק את מספר החברים maxMembers בבקשת get.
memberCount

integer

פלט בלבד. המספר הכולל של אנשי קשר בקבוצה, ללא קשר למספר החברים המקסימלי שצוין בבקשה.
clientData[]

object (GroupClientData)

נתוני הלקוחות של הקבוצה.

ContactGroupMetadata

המטא-נתונים של קבוצת אנשי קשר.

ייצוג JSON 
{
  "updateTime": string,
  "deleted": boolean
}
שדות
updateTime

string (Timestamp format)

פלט בלבד. המועד שבו הקבוצה עודכנה לאחרונה.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
deleted

boolean

פלט בלבד. True אם המשאב של קבוצת אנשי הקשר נמחק. נתון זה מאוכלס רק עבור בקשות contactGroups.list הכוללות אסימון סנכרון.

GroupType

סוג של קבוצה של אנשי קשר.

טיפוסים בני מנייה (enums)
GROUP_TYPE_UNSPECIFIED לא צוין.
USER_CONTACT_GROUP קבוצת אנשי קשר בהגדרת המשתמש.
SYSTEM_CONTACT_GROUP קבוצת אנשי קשר בהגדרת המערכת.

GroupClientData

נתוני לקוחות שרירותיים שמולאו על ידי לקוחות. מותר להשתמש במפתחות וערכים כפולים.

ייצוג JSON 
{
  "key": string,
  "value": string
}
שדות
key

string

המפתח של נתוני הלקוח שצוין על ידי הלקוח.
value

string

הערך של נתוני הלקוח שצוין על ידי הלקוח.

שיטות

batchGet

 קבלת רשימה של קבוצות אנשי קשר שבבעלות המשתמש המאומת על ידי ציון רשימה של שמות המשאבים של קבוצת אנשי הקשר.

create

 יצירת קבוצת אנשי קשר חדשה בבעלות המשתמש המאומת.

delete

 מחיקת קבוצת אנשי קשר קיימת שבבעלות המשתמש המאומת על ידי ציון שם משאב של קבוצת אנשי קשר.

get

 כדי לקבל קבוצת אנשי קשר ספציפית שבבעלות המשתמש המאומת, צריך לציין שם משאב של קבוצת אנשי קשר.

list

 הצגת רשימה של כל קבוצות אנשי הקשר שבבעלות המשתמש המאומת.

update

 עדכון השם של קבוצת אנשי קשר קיימת שבבעלות המשתמש המאומת.