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 ～ 1, 000 です。設定しない場合、または 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
  • coverPhotos
  • emailAddresses
  • イベント
  • externalIds
  • 性別
  • imClients
  • 関心
  • locales
  • 開催地
  • メンバーシップ
  • メタデータ
  • miscKeywords
  • names
  • ニックネーム
  • 職業
  • organizations
  • phoneNumbers
  • 写真
  • 関係
  • sipAddresses
  • skills
  • urls
  • userDefined
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 人物を姓で並べ替える。