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)

必須。作成する連絡先。1 回のリクエストで最大 200 件の連絡先にアクセスできます。

readMask

string (FieldMask format)

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

  • addresses
  • ageRanges
  • 伝記
  • 誕生日
  • calendarUrls
  • clientData
  • カバー写真
  • emailAddresses
  • 予定
  • externalId
  • 性別
  • imClients
  • 関心
  • locales
  • 場所
  • メンバーシップ
  • metadata
  • その他のキーワード
  • names
  • ニックネーム
  • 職業
  • organizations
  • phoneNumbers
  • 写真
  • リレーション
  • SipAddress
  • skills
  • URL
  • ユーザー定義
sources[]

enum (ReadSourceType)

(省略可)ミューテーション後の読み取りで返すソースタイプのマスク。設定しない場合、デフォルトは READ_SOURCE_TYPE_CONTACTREAD_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)

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