Method: people.batchCreateContacts

建立一批新聯絡人,並為新聯絡人傳回 PersonResponses

請為同一位使用者依序傳送 Mutate 要求,以避免延遲時間增加和失敗。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "contacts": [
    {
      object (ContactToCreate)
    }
  ],
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
欄位
contacts[]

object (ContactToCreate)

必要欄位。要建立的聯絡人。每個要求最多可包含 200 位聯絡人。

readMask

string (FieldMask format)

必要欄位。欄位遮罩,用於限制回覆中要傳回每個人的欄位。如要指定多個欄位,請用半形逗號分隔。如果將讀取遮罩留空,系統會略過-change-change-get 參數,也不會在回應中傳回任何資料。以下為有效值:

  • addresses
  • ageRanges
  • 傳記
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活動
  • externalIds
  • 性別
  • imClients
  • 興趣
  • locales
  • 地點
  • 會籍
  • 中繼資料
  • miscKeywords
  • names
  • 暱稱
  • 職業
  • organizations
  • phoneNumbers
  • 相片
  • 關係
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

選用設定。這是指在 mut 讀取後傳回哪些來源類型的遮罩。如未設定,預設值為 READ_SOURCE_TYPE_CONTACTREAD_SOURCE_TYPE_PROFILE

回應主體

如果失敗,則傳回 BatchCreateContactsErrorDetails,其中包含每位無效聯絡人的錯誤清單。

建立大量聯絡人的要求回應。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "createdPeople": [
    {
      object (PersonResponse)
    }
  ]
}
欄位
createdPeople[]

object (PersonResponse)

建立的聯絡人 (除非 readMask 要求空白)。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱授權指南

ContactToCreate

包裝函式內含要填入新建來源的使用者資料。

JSON 表示法
{
  "contactPerson": {
    object (Person)
  }
}
欄位
contactPerson

object (Person)

必要欄位。要填入新建來源的使用者資料。