「その他の連絡先」(連絡先グループにない連絡先)をすべてリストアップします。「その他の連絡先」は通常、やり取りから自動作成される連絡先です。
同期トークンは、完全な同期から 7 日後に期限切れになります。期限切れの同期トークンを含むリクエストの場合は、google.rpc.ErrorInfo とともにエラーが返されます。その理由は「EXPIRED_SYNC_TOKEN」です。このようなエラーが発生した場合、クライアントは
を使用せずに完全な同期リクエストを行う必要があります。syncToken
完全な同期リクエストの最初のページには、追加の割り当てがあります。割り当てを超過すると、429 エラーが返されます。この割り当ては固定されており、増やすことはできません。
を指定すると、最後の同期以降に削除されたリソースは、syncToken
が true に設定されたユーザーとして返されます。PersonMetadata.deleted
または pageToken
を指定すると、他のすべてのリクエスト パラメータが最初の呼び出しと一致する必要があります。syncToken
同期リクエストの場合、書き込みの伝播に数分かかる場合があります。増分同期は、read-after-write のユースケース用ではありません。
使用例については、ユーザーの他の連絡先を一覧表示するをご覧ください。
HTTP リクエスト
GET https://people.googleapis.com/v1/otherContacts
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
pageToken |
(省略可)前のレスポンス ページ分けを行う場合、 |
pageSize |
(省略可)返信に含める「その他の連絡先」の数。有効な値は 1 ~ 1000 です。未設定または 0 に設定した場合のデフォルトは 100 です。 |
requestSyncToken |
(省略可)結果の最後のページでレスポンスが 同期動作について詳しくは、 |
syncToken |
(省略可)前のレスポンス 同期時に、 同期動作について詳しくは、 |
readMask |
必須。フィールド マスク。各ユーザーに返されるフィールドを制限します。複数のフィールドを指定する場合は、カンマで区切ります。有効な値は、使用する ReadSourceType によって異なります。 READ_SOURCE_TYPE_CONTACT を使用する場合、有効な値は次のとおりです。
READ_SOURCE_TYPE_PROFILE が使用されている場合、有効な値は次のとおりです。
|
sources[] |
(省略可)返されるソースタイプのマスク。設定しない場合、デフォルトは このフィールドに使用できる値は次のとおりです。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
認証済みユーザーの「その他の連絡先」に対するリクエストに対するレスポンス。
JSON 表現 |
---|
{
"otherContacts": [
{
object ( |
フィールド | |
---|---|
otherContacts[] |
Person リソースとして返される「Other contacts」のリスト。「その他の連絡先」でサポートされる項目は限定的です。詳細については、ListOtherContactsRequest.request_mask をご覧ください。 |
nextPageToken |
次のページを取得するために |
nextSyncToken |
最後のリクエスト以降の変更を取得するために |
totalSize |
ページ分けなしでリスト内の他の連絡先の総数。 |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/contacts.other.readonly
詳しくは、承認ガイドをご覧ください。