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
  • الاهتمامات
  • اللغات
  • مواقع جغرافية
  • للقناة
  • miscKeywords
  • الأسماء
  • الألقاب
  • المهن
  • المؤسسات
  • phoneNumbers
  • علاقات
  • sipAddresses
  • عناوين url
  • userDefined
readMask

string (FieldMask format)

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

  • عناوين
  • ageRanges
  • السير الذاتية
  • أعياد الميلاد
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • الفعاليات
  • externalIds
  • أنواع
  • imClients
  • الاهتمامات
  • اللغات
  • مواقع جغرافية
  • للقناة
  • البيانات الوصفية
  • miscKeywords
  • الأسماء
  • الألقاب
  • المهن
  • المؤسسات
  • phoneNumbers
  • صور
  • علاقات
  • sipAddresses
  • مهارات
  • عناوين url
  • 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

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