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 בבקשת השליפה.
memberCount

integer

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

object (GroupClientData)

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

ContactGroupMetadata

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

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

string (Timestamp format)

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

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

boolean

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

GroupType

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

טיפוסים בני מנייה (enum)
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

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