Method: people.batchCreateContacts

دسته ای از مخاطبین جدید ایجاد کنید و PersonResponses را برای جدیدا برگردانید

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

درخواست HTTP

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

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

درخواست بدن

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

نمایندگی JSON 
{
  "contacts": [
    {
      object (ContactToCreate)
    }
  ],
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
فیلدها
contacts[]

object ( ContactToCreate )

مورد نیاز. مخاطب برای ایجاد. اجازه می دهد تا 200 مخاطب در یک درخواست واحد.

readMask

string ( FieldMask format)

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

  • آدرس ها
  • محدوده سنی
  • بیوگرافی ها
  • تولدها
  • calendarUrls
  • کلاینت دیتا
  • جلدعکس ها
  • آدرس های ایمیل
  • رویدادها
  • شناسه های خارجی
  • جنسیت ها
  • imClients
  • منافع
  • مناطق
  • مکان ها
  • عضویت ها
  • ابرداده
  • کلمات کلیدی اشتباه
  • نام ها
  • نام مستعار
  • مشاغل
  • سازمان ها
  • شماره تلفن
  • عکس ها
  • روابط
  • آدرس های sip
  • مهارت ها
  • آدرس های اینترنتی
  • userDefined
sources[]

enum ( ReadSourceType )

اختیاری. ماسکی از نوع منبعی که باید در جهش پست بازگردانده شود خوانده می شود. در صورت تنظیم نشدن، پیش‌فرض READ_SOURCE_TYPE_CONTACT و READ_SOURCE_TYPE_PROFILE است.

بدن پاسخگو

در صورت عدم موفقیت، BatchCreateContactsErrorDetails را برمی گرداند که حاوی لیستی از خطاها برای هر مخاطب نامعتبر است.

پاسخ به درخواست ایجاد دسته ای از مخاطبین.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "createdPeople": [
    {
      object (PersonResponse)
    }
  ]
}
فیلدها
createdPeople[]

object ( PersonResponse )

مخاطبین ایجاد شده، مگر اینکه درخواست readMask خالی باشد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

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

تماس برای ایجاد

بسته‌بندی حاوی داده‌های شخص برای پر کردن منبع جدید ایجاد شده.

نمایندگی JSON 
{
  "contactPerson": {
    object (Person)
  }
}
فیلدها
contactPerson

object ( Person )

مورد نیاز. داده های شخص برای پر کردن منبع جدید ایجاد شده.