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

詳しくは、認可ガイドをご覧ください。