Method: people.batchCreateContacts

新しい連絡先のバッチを作成し、新しい連絡先の PersonResponses を返します。

レイテンシの増加や失敗を避けるため、同じユーザーに対する DoFn リクエストは順次送信する必要があります。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "contacts": [
    {
      object (ContactToCreate)
    }
  ],
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
フィールド
contacts[]

object (ContactToCreate)

必須。作成する連絡先。1 回のリクエストで最大 200 件の連絡先を含めることができます。
readMask

string (FieldMask format)

必須。レスポンスで返される各人物のフィールドを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。読み取りマスクが空の場合、変更後 get はスキップされ、レスポンスでデータは返されません。指定できる値は次のとおりです。

  • addresses
  • ageRanges
  • 伝記
  • 誕生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • イベント
  • externalIds
  • 性別
  • imClients
  • インタレスト
  • locales
  • 開催地
  • メンバーシップ
  • メタデータ
  • miscKeywords
  • 名前
  • ニックネーム
  • 職業
  • 組織
  • phoneNumbers
  • 写真
  • 関係
  • sipAddresses
  • skills
  • URL
  • 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

詳細については、承認ガイドをご覧ください。

ContactToCreate

新しく作成されたソースにデータを入力する個人データを含むラッパー。

JSON 表現 
{
  "contactPerson": {
    object (Person)
  }
}
フィールド
contactPerson

object (Person)

必須。新しく作成されたソースにデータを入力する個人データ。