Method: people.connections.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/{resourceName=people/*}/connections

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

パスパラメータ

パラメータ
resourceName
(deprecated)

string

必須。接続を返すためのリソース名。people/me のみが有効です。

クエリ パラメータ

パラメータ
pageToken

string

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

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

integer

（省略可）レスポンスに含める接続の数。有効な値は 1 ～ 1000 です。未設定または 0 に設定した場合のデフォルトは 100 です。
sortOrder

enum (SortOrder)

（省略可）接続の並べ替え順序。デフォルトは LAST_MODIFIED_ASCENDING です。
requestSyncToken

boolean

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

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

string

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

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

同期動作について詳しくは、people.connections.list をご覧ください。
requestMask
(deprecated)

object (RequestMask)

（省略可）非推奨（代わりに personFields を使用してください）

結果をユーザー フィールドのサブセットに制限するマスク。
personFields

string (FieldMask format)

必須。フィールド マスク。各ユーザーに返されるフィールドを制限します。複数のフィールドを指定する場合は、カンマで区切ります。指定できる値は次のとおりです。

  • 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_PROFILE になります。

リクエスト本文

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

レスポンスの本文

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

認証されたユーザーの接続要求に対するレスポンス。

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

object (Person)

リクエスト送信者が接続しているユーザーのリスト。
nextPageToken

string

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

string

最後のリクエスト以降の変更を取得するために syncToken として送信できるトークン。同期トークンを返すには、リクエストを requestSyncToken に設定する必要があります。レスポンスがページ分けされる場合、最後のページのみに nextSyncToken が含まれます。
totalPeople
(deprecated)

integer

非推奨（totalItems を使用してください）ページ分けなしでリストのユーザーの合計数です。
totalItems

integer

ページ分けなしのリスト内のアイテムの総数。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

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

SortOrder

接続リストの並べ替え順序。これは、同期がリクエストされていない場合にのみ使用されます。

列挙型
LAST_MODIFIED_ASCENDING 変更者を古い順に並べ替えます。古いエントリから先に行います。
LAST_MODIFIED_DESCENDING 変更者を新しい順に並べ替えます。
FIRST_NAME_ASCENDING 名前でユーザーを並べ替えます。
LAST_NAME_ASCENDING ユーザーを姓で並べ替えます。