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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
deleted

boolean

النتائج فقط. صحيح إذا تم حذف مورد مجموعة جهات الاتصال. تتم تعبئة هذا الحقل فقط لطلبات contactGroups.list التي تتضمّن رمزًا مميّزًا للمزامنة.

GroupType

نوع مجموعة جهات الاتصال

عمليات التعداد
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

 تعديل اسم مجموعة جهات اتصال حالية يملكها مستخدم تمت مصادقته.