Method: people.batchUpdateContacts

دسته ای از مخاطبین را به روز کنید و نقشه ای از نام منابع را برای مخاطبین به روز شده به PersonResponses برگردانید.

درخواست های جهش برای همان کاربر باید به صورت متوالی ارسال شوند تا از افزایش تاخیر و خرابی جلوگیری شود.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی 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
  • کلاینت دیتا
  • آدرس های ایمیل
  • رویدادها
  • شناسه های خارجی
  • جنسیت ها
  • imClients
  • منافع
  • مناطق
  • مکان ها
  • عضویت ها
  • کلمات کلیدی اشتباه
  • نام ها
  • نام مستعار
  • مشاغل
  • سازمان ها
  • شماره تلفن
  • روابط
  • آدرس های sip
  • آدرس های اینترنتی
  • userDefined
readMask

string ( FieldMask format)

مورد نیاز. یک فیلد ماسک برای محدود کردن اینکه کدام فیلد برای هر فرد بازگردانده می شود. چندین فیلد را می توان با جدا کردن آنها با کاما مشخص کرد. اگر ماسک خواندن خالی بماند، دریافت پس از جهش حذف می شود و هیچ داده ای در پاسخ بازگردانده نمی شود. مقادیر معتبر عبارتند از:

  • آدرس ها
  • محدوده سنی
  • بیوگرافی ها
  • تولدها
  • calendarUrls
  • کلاینت دیتا
  • جلدعکس ها
  • آدرس های ایمیل
  • رویدادها
  • شناسه های خارجی
  • جنسیت ها
  • imClients
  • منافع
  • مناطق
  • مکان ها
  • عضویت ها
  • ابرداده
  • کلمات کلیدی اشتباه
  • نام ها
  • نام مستعار
  • مشاغل
  • سازمان ها
  • شماره تلفن
  • عکس ها
  • روابط
  • آدرس های sip
  • مهارت ها
  • آدرس های اینترنتی
  • 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.