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

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