[その他の連絡先](連絡先グループに含まれない連絡先)をすべてリストアップします。[その他の連絡先] は通常、やり取りから自動的に作成された連絡先です。
同期トークンは、完全同期から 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 ~ 1, 000 です。設定しない場合、または 0 に設定した場合、デフォルトは 100 です。 |
requestSyncToken |
省略可。レスポンスが結果の最後のページで 同期動作について詳しくは、 |
syncToken |
省略可。前回のレスポンスから受信した同期トークン 同期時に、 同期動作について詳しくは、 |
readMask |
必須。各人物のどのフィールドが返されるかを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。どの値が有効かは、どの ReadSourceType が使用されているかによって異なります。 READ_SOURCE_TYPE_CONTACT を使用する場合、有効な値は次のとおりです。
READ_SOURCE_TYPE_PROFILE を使用する場合、有効な値は次のとおりです。
|
sources[] |
省略可。返すソースタイプのマスク。設定しない場合のデフォルトは このフィールドに設定可能な値は次のとおりです。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
認証されたユーザーの「その他の連絡先」に対するリクエストに対するレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"otherContacts": [
{
object ( |
フィールド | |
---|---|
otherContacts[] |
人事リソースとして返される「その他の連絡先」のリスト。[その他の連絡先] でサポートされる項目は限られています。詳しくは、ListOtherContactsRequest.request_mask をご覧ください。 |
nextPageToken |
次のページを取得するために |
nextSyncToken |
トークン。最後のリクエスト以降の変更を取得するために |
totalSize |
リスト内の他の連絡先の合計数(ページ分けなし)。 |
承認スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/contacts.other.readonly
詳しくは、承認ガイドをご覧ください。