Method: otherContacts.list

「その他の連絡先」（連絡先グループにない連絡先）をすべてリストアップします。「その他の連絡先」は通常、やり取りから自動作成される連絡先です。

同期トークンは、完全な同期から 7 日後に期限切れになります。期限切れの同期トークンを含むリクエストの場合は、google.rpc.ErrorInfo とともにエラーが返されます。その理由は「EXPIRED_SYNC_TOKEN」です。このようなエラーが発生した場合、クライアントは syncToken を使用せずに完全な同期リクエストを行う必要があります。

完全な同期リクエストの最初のページには、追加の割り当てがあります。割り当てを超過すると、429 エラーが返されます。この割り当ては固定されており、増やすことはできません。

syncToken を指定すると、最後の同期以降に削除されたリソースは、PersonMetadata.deleted が true に設定されたユーザーとして返されます。

pageToken または syncToken を指定すると、他のすべてのリクエスト パラメータが最初の呼び出しと一致する必要があります。

同期リクエストの場合、書き込みの伝播に数分かかる場合があります。増分同期は、read-after-write のユースケース用ではありません。

使用例については、ユーザーの他の連絡先を一覧表示するをご覧ください。

HTTP リクエスト

GET https://people.googleapis.com/v1/otherContacts

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

クエリ パラメータ

パラメータ
pageToken

string

（省略可）前のレスポンス nextPageToken から受け取ったページトークン。これを指定して、後続のページを取得します。

ページ分けを行う場合、otherContacts.list に指定する他のパラメータはすべて、ページトークンを提供した最初の呼び出しと一致する必要があります。
pageSize

integer

（省略可）返信に含める「その他の連絡先」の数。有効な値は 1 ～ 1000 です。未設定または 0 に設定した場合のデフォルトは 100 です。
requestSyncToken

boolean

（省略可）結果の最後のページでレスポンスが nextSyncToken を返すかどうか。これを、リクエスト syncToken で設定することで、最後のリクエスト以降の増分変更を取得できます。

同期動作について詳しくは、otherContacts.list をご覧ください。
syncToken

string

（省略可）前のレスポンス nextSyncToken から受信した同期トークン。最後のリクエスト以降に変更されたリソースのみを取得する場合に指定します。

同期時に、otherContacts.list に渡される他のパラメータはすべて、同期トークンを渡した最初の呼び出しと一致している必要があります。

同期動作について詳しくは、otherContacts.list をご覧ください。
readMask

string (FieldMask format)

必須。フィールド マスク。各ユーザーに返されるフィールドを制限します。複数のフィールドを指定する場合は、カンマで区切ります。有効な値は、使用する ReadSourceType によって異なります。

READ_SOURCE_TYPE_CONTACT を使用する場合、有効な値は次のとおりです。

  • emailAddresses
  • metadata
  • names
  • phoneNumbers
  • 写真

READ_SOURCE_TYPE_PROFILE が使用されている場合、有効な値は次のとおりです。

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

enum (ReadSourceType)

（省略可）返されるソースタイプのマスク。設定しない場合、デフォルトは READ_SOURCE_TYPE_CONTACT です。

このフィールドに使用できる値は次のとおりです。

READ_SOURCE_TYPE_CONTACT を指定せずに READ_SOURCE_TYPE_PROFILE を指定することは許可されていません。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

認証済みユーザーの「その他の連絡先」に対するリクエストに対するレスポンス。

JSON 表現 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
フィールド
otherContacts[]

object (Person)

Person リソースとして返される「Other contacts」のリスト。「その他の連絡先」でサポートされる項目は限定的です。詳細については、ListOtherContactsRequest.request_mask をご覧ください。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
nextSyncToken

string

最後のリクエスト以降の変更を取得するために syncToken として送信できるトークン。同期トークンを返すには、リクエストを requestSyncToken に設定する必要があります。
totalSize

integer

ページ分けなしでリスト内の他の連絡先の総数。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、承認ガイドをご覧ください。