Method: users.settings.cse.identities.list

認証されたユーザーのクライアントサイド暗号化 ID を一覧表示します。

HTTP リクエスト

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities

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

パスパラメータ

パラメータ
userId

string

リクエスト元のメインのメールアドレス。認証済みユーザーを示すには、特別な値 me を使用します。

クエリ パラメータ

パラメータ
pageToken

string

どの ID のページを返すかを示すページ設定トークン。トークンが指定されていない場合、API は結果の最初のページを返します。
pageSize

integer

返される ID の数。指定しない場合、ページサイズはデフォルトで 20 エントリになります。

リクエスト本文

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

レスポンスの本文

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

JSON 表現 
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
フィールド
cseIdentities[]

object (CseIdentity)

ユーザーに設定されている CSE ID のリスト 1 ページ。
nextPageToken

string

ID の次のページを取得するために、後続の identities.list 呼び出しに渡されるページ設定トークン。この値が返されないか、空の文字列である場合、それ以上のページはありません。

認可スコープ

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

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

詳細については、承認ガイドをご覧ください。