Method: contactGroups.update

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

يجب أن تكون أسماء مجموعات جهات الاتصال المحدَّثة فريدة لمجموعات جهات اتصال المستخدمين. ستؤدي محاولة إنشاء مجموعة باسم مكرر إلى عرض خطأ HTTP 409.

يجب إرسال طلبات التغيير للمستخدم نفسه بشكل تسلسلي لتجنُّب زيادة وقت الاستجابة وحالات الإخفاق.

طلب HTTP

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
contactGroup.resourceName

string

اسم المورد لمجموعة جهات الاتصال، الذي حدَّده الخادم. تمثّل هذه السمة سلسلة ASCII بحيث تكون على شكل contactGroups/{contactGroupId}.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
الحقول
contactGroup.etag

string

علامة كيان HTTP للمورد. يتم استخدامه للتحقق من ذاكرة التخزين المؤقت على الويب.
contactGroup.metadata

object (ContactGroupMetadata)

النتائج فقط. البيانات الوصفية حول مجموعة جهات الاتصال
contactGroup.groupType

enum (GroupType)

النتائج فقط. نوع مجموعة جهات الاتصال.
contactGroup.name

string

اسم مجموعة جهات الاتصال الذي حدَّده مالك المجموعة أو اسم قدَّمه النظام لمجموعات النظام.

بالنسبة إلى contactGroups.create أو contactGroups.update، يجب أن يكون الاسم فريدًا لمجموعات جهات اتصال المستخدمين. ستؤدي محاولة إنشاء مجموعة باسم مكرر إلى عرض خطأ HTTP 409.
contactGroup.formattedName

string

النتائج فقط. الاسم تمت ترجمته وتنسيقه بلغة حساب المُشاهد أو لغة عنوان HTTP Accept-Language لأسماء مجموعات النظام. أسماء المجموعات التي يعينها المالك هي نفسها الأسماء.
contactGroup.memberResourceNames[]

string

النتائج فقط. قائمة بأسماء موارد أشخاص جهات الاتصال الأعضاء في مجموعة جهات الاتصال. تتم تعبئة الحقل لطلبات GET فقط، ولن يعرض إلا عدد الأعضاء الذين يصل عددهم إلى maxMembers في طلب الحصول على البيانات.
contactGroup.memberCount

integer

النتائج فقط. إجمالي عدد جهات الاتصال في المجموعة بغض النظر عن الحد الأقصى للأعضاء المحدّدين في الطلب.
contactGroup.clientData[]

object (GroupClientData)

بيانات العميل للمجموعة.
updateGroupFields

string (FieldMask format)

اختياريّ. قناع حقل لتقييد الحقول التي يتم تعديلها في المجموعة. يمكن تحديد حقول متعددة من خلال الفصل بينها بفواصل. ويتم ضبط القيمة التلقائية على name في حال ترك السياسة بدون ضبط أو ضبطها على "فارغة". تم استبدال الحقول المعدَّلة. القيم الصالحة هي:

  • clientData
  • الاسم
readGroupFields

string (FieldMask format)

اختياريّ. قناع حقل لتقييد الحقول التي يتم عرضها في المجموعة. ويتم ضبطها تلقائيًا على metadata وgroupType وname في حال عدم ضبطها أو ضبطها على "فارغة". الحقول الصالحة هي:

  • clientData
  • groupType
  • memberCount
  • البيانات الوصفية
  • الاسم

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال ContactGroup.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/contacts

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.