Method: people.connections.list

認証されたユーザーの連絡先のリストを提供します。

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

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

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

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

書き込みの同期リクエストでは、数分間の遅延が発生する可能性があります。増分同期は、書き込み後の読み取りのユースケースを対象としたものではありません。

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

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
  • 名前
  • ニックネーム
  • 職業
  • 組織
  • phoneNumbers
  • 写真
  • 関係
  • sipAddresses
  • skills
  • URL
  • 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 姓で並べ替える。