Method: customEmojis.list

認証済みユーザーに表示されるカスタム絵文字を一覧表示します。

カスタム絵文字は Google Workspace アカウントでのみ使用できます。また、組織でカスタム絵文字を有効にするには、管理者権限が必要です。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。

次のいずれかの承認スコープによるユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis

HTTP リクエスト

GET https://chat.googleapis.com/v1/customEmojis

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

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるカスタム絵文字の最大数。サービスが返すカスタム 絵文字は、この値より少ない場合があります。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます。
pageToken

string

省略可。（前のクエリから再開する場合）。

前回の list custom emoji 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページネーションを行う場合、フィルタ値はページトークンを受け取った呼び出しと一致している必要があります。別の値を渡すと、予期しない結果になる可能性があります。
filter

string

省略可。クエリフィルタ。

クリエイターによるフィルタリングがサポートされています。

クリエイター別にフィルタするには、有効な値を指定する必要があります。現在、creator("users/me") と NOT creator("users/me") のみが、呼び出し元のユーザーによって作成されたかどうかでカスタム絵文字をフィルタできます。

たとえば、次のクエリは、呼び出し元によって作成されたカスタム絵文字を返します。

creator("users/me")

無効なクエリは INVALID_ARGUMENT エラーで拒否されます。

リクエストの本文

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

レスポンスの本文

カスタム絵文字をリストするレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (CustomEmoji)

順序なしリスト。カスタム絵文字のリスト。
nextPageToken

string

結果の次のページを取得するために pageToken として送信できるトークン。空の場合、後続のページはありません。

認可スコープ

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

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

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