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

النتائج فقط. صحيح إذا تم حذف مورد مجموعة جهات الاتصال. تتم تعبئة هذا الحقل فقط لطلبات 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

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