Method: people.batchUpdateContacts

قم بتحديث مجموعة من جهات الاتصال وإرجاع خريطة لأسماء الموارد إلى PersonResponses لجهات الاتصال التي تم تحديثها.

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

طلب HTTP

POST https://people.googleapis.com/v1/people:batchUpdateContacts

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

نص الطلب

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

تمثيل JSON
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
الحقول
contacts

map (key: string, value: object (Person))

مطلوبة. خريطة لأسماء الموارد لبيانات الأشخاص التي سيتم تعديلها. السماح بما يصل إلى 200 جهة اتصال في طلب واحد

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

updateMask

string (FieldMask format)

مطلوبة. قناع حقل لتقييد الحقول التي يتم تعديلها على المستخدم يمكن تحديد عدة حقول من خلال الفصل بينها بفواصل. سيتم استبدال جميع الحقول المحدّدة أو محوها إذا تُركت فارغة لكل مستخدم. القيم الصالحة هي:

  • عنوان واحد
  • السير الذاتية
  • أعياد الميلاد
  • calendarUrls
  • clientData
  • emailAddresses
  • الفعاليات
  • externalIds
  • أنواع
  • imClients
  • الاهتمامات
  • locales
  • المواقع الجغرافية
  • للقناة
  • miscKeywords
  • names
  • الألقاب
  • المهن
  • organizations
  • phoneNumbers
  • علاقات
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

مطلوبة. قناع حقل لتقييد الحقول التي يتم عرضها لكل مستخدم يمكن تحديد عدة حقول من خلال الفصل بينها بفواصل. في حال ترك قناع القراءة فارغًا، يتم تخطي مرحلة post-mutate-get ولن يتم عرض أي بيانات في الردّ. القيم الصالحة هي:

  • عنوان واحد
  • ageRanges
  • السير الذاتية
  • أعياد الميلاد
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • الفعاليات
  • externalIds
  • أنواع
  • imClients
  • الاهتمامات
  • locales
  • المواقع الجغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • names
  • الألقاب
  • المهن
  • organizations
  • phoneNumbers
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

اختياريّ. قناع لأنواع المصادر المطلوب عرضها. ويتم ضبط الإعدادات التلقائية على READ_SOURCE_TYPE_CONTACT وREAD_SOURCE_TYPE_PROFILE إذا لم يتم ضبطها.

نص الاستجابة

في حال عدم نجاح العملية، سيتم عرض الخطأ BatchUpdateContactsErrorDetails، وهي قائمة بالأخطاء المقابلة لكل جهة اتصال.

الاستجابة لطلب تحديث مجموعة من جهات الاتصال.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
الحقول
updateResult

map (key: string, value: object (PersonResponse))

خريطة لأسماء الموارد لجهات الاتصال التي تم تعديلها، ما لم يكن الطلب readMask فارغًا

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

نطاقات التفويض

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

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

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