Method: users.settings.cse.identities.list

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

組織内のユーザーの ID と鍵ペアを管理する管理者の場合、リクエストには、https://www.googleapis.com/auth/gmail.settings.basic スコープでユーザーに成り代わるためのドメイン全体の委任権限を持つサービス アカウントによる承認が必要です。

ユーザーが独自の 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

詳細については、OAuth 2.0 Overview をご覧ください。