تحديث مجموعة من جهات الاتصال وإعادة خريطة أسماء الموارد إلى PersonResponses لجهات الاتصال المحدثة.
يجب إرسال طلبات التغيير للمستخدم نفسه بشكل تسلسلي لتجنُّب زيادة وقت الاستجابة وحالات الإخفاق.
طلب HTTP
POST https://people.googleapis.com/v1/people:batchUpdateContacts
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "contacts": { string: { object ( |
الحقول | |
---|---|
contacts |
مطلوب. خريطة لأسماء الموارد لبيانات الأشخاص المراد تحديثها. يتيح هذا الإعداد إضافة ما يصل إلى 200 جهة اتصال في الطلب الواحد. عنصر يحتوي على قائمة بأزواج |
updateMask |
مطلوب. قناع حقل لتقييد الحقول التي يتم تعديلها في المستخدم. يمكن تحديد حقول متعددة من خلال الفصل بينها بفواصل. سيتم استبدال جميع الحقول المحدّدة أو محوها إذا تُركت فارغة لكل مستخدم. القيم الصالحة هي:
|
readMask |
مطلوب. قناع حقل لتقييد الحقول التي يتم عرضها في كل شخص. يمكن تحديد حقول متعددة من خلال الفصل بينها بفواصل. في حال ترك قناع القراءة فارغًا، يتم تخطي عملية ما بعد mutate-get ولن يتم عرض أي بيانات في الرد. القيم الصالحة هي:
|
sources[] |
اختياريّ. قناع لأنواع المصدر المطلوب عرضها. ويتم ضبط القيمة التلقائية على |
نص الاستجابة
وإذا لم تنجح، سيتم عرض BatchUpdateContactsErrorDetails
، وهي قائمة بالأخطاء المقابلة لكل جهة اتصال.
الاستجابة لطلب تعديل مجموعة من جهات الاتصال
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"updateResult": {
string: {
object ( |
الحقول | |
---|---|
updateResult |
خريطة لأسماء الموارد لجهات الاتصال التي تم تعديلها، ما لم يكن الطلب عنصر يحتوي على قائمة بأزواج |
نطاقات الأذونات
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/contacts
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.