Method: people.batchCreateContacts

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

請依序傳送對同一位使用者的變動要求,以免增加延遲時間和失敗。

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)

必要欄位。欄位遮罩可限制回應中傳回的欄位。如要指定多個欄位,請以半形逗號分隔。如果讀取遮罩為空白,就會略過 post-mut-get,且回應中不會傳回任何資料。有效值如下:

  • addresses
  • ageRanges
  • 傳記
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活動
  • externalIds
  • 性別
  • imClients
  • 興趣
  • locales
  • 位置
  • 會籍
  • 中繼資料
  • miscKeywords
  • 名稱
  • 暱稱
  • 職業
  • 機構組織
  • phoneNumbers
  • 相片
  • 關係
  • sipAddresses
  • skills
  • 網址
  • userDefined
sources[]

enum (ReadSourceType)

選用設定。遮罩會在修改後 Mu 讀取中傳回哪些來源類型。如果未設定,預設為 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)

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