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 ～ 1, 000 です。設定しない場合または 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
  • メタデータ
  • 名前
  • phoneNumbers
  • 写真

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

  • 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_CONTACT を指定せずに READ_SOURCE_TYPE_PROFILE を指定することはできません。

リクエスト本文

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

レスポンスの本文

認証されたユーザーの [その他の連絡先] のリクエストに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (Person)

[その他の連絡先] のリストPerson リソースとして返されます。[その他の連絡先]一部のフィールドのみをサポートしています。詳しくは、ListOtherContactsRequest.request_mask をご覧ください。
nextPageToken

string

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

string

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

integer

ページ分けされていない、リスト内の他の連絡先の合計数。

認可スコープ

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

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

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