正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

絵文字リアクションAPI

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

絵文字リアクションは千の言葉を語ります。

GitLabでは、絵文字リアクションを受け入れるオブジェクトをawardableと呼びます。以下のものに絵文字でリアクションできます:

イシュー、マージリクエスト、スニペット

コメントでこれらのエンドポイントを使用する方法については、コメントへのリアクションの追加を参照してください。

awardableの絵文字リアクションを一覧表示する

指定されたawardableのすべての絵文字リアクションのリストを取得します。指定されたマージリクエストが公開されている場合、このエンドポイントへのアクセスは認証なしで可能です。

GET /projects/:id/issues/:issue_iid/award_emoji
GET /projects/:id/merge_requests/:merge_request_iid/award_emoji
GET /projects/:id/snippets/:snippet_id/award_emoji

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid``merge_request_iid``snippet_id整数はいawardableのID（マージリクエスト/イシューの場合はiid、スニペットの場合はid）。

リクエスト例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji"

レスポンス例:

[
  {
    "id": 4,
    "name": "1234",
    "user": {
      "name": "Administrator",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/root"
    },
    "created_at": "2016-06-15T10:09:34.206Z",
    "updated_at": "2016-06-15T10:09:34.206Z",
    "awardable_id": 80,
    "awardable_type": "Issue"
  },
  {
    "id": 1,
    "name": "microphone",
    "user": {
      "name": "User 4",
      "username": "user4",
      "id": 26,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/user4"
    },
    "created_at": "2016-06-15T10:09:34.177Z",
    "updated_at": "2016-06-15T10:09:34.177Z",
    "awardable_id": 80,
    "awardable_type": "Issue"
  }
]

単一の絵文字リアクションを取得する

イシュー、スニペット、またはマージリクエストから単一の絵文字リアクションを取得します。指定されたマージリクエストが公開されている場合、このエンドポイントへのアクセスは認証なしで可能です。

GET /projects/:id/issues/:issue_iid/award_emoji/:award_id
GET /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid``merge_request_iid``snippet_id整数はいawardableのID（マージリクエスト/イシューの場合はiid、スニペットの場合はid）。
award_id整数はい絵文字リアクションのID。

リクエスト例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/1"

レスポンス例:

{
  "id": 1,
  "name": "microphone",
  "user": {
    "name": "User 4",
    "username": "user4",
    "id": 26,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/user4"
  },
  "created_at": "2016-06-15T10:09:34.177Z",
  "updated_at": "2016-06-15T10:09:34.177Z",
  "awardable_id": 80,
  "awardable_type": "Issue"
}

新しい絵文字リアクションを追加する

指定されたawardableに絵文字リアクションを追加します。

POST /projects/:id/issues/:issue_iid/award_emoji
POST /projects/:id/merge_requests/:merge_request_iid/award_emoji
POST /projects/:id/snippets/:snippet_id/award_emoji

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid``merge_request_iid``snippet_id整数はいawardableのID（マージリクエスト/イシューの場合はiid、スニペットの場合はid）。
name文字列はいコロンなしの絵文字の名前。
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish"

レスポンス例:

{
  "id": 344,
  "name": "blowfish",
  "user": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/root"
  },
  "created_at": "2016-06-17T17:47:29.266Z",
  "updated_at": "2016-06-17T17:47:29.266Z",
  "awardable_id": 80,
  "awardable_type": "Issue"
}

絵文字リアクションを削除します

時にはうまくいかないことがあり、リアクションを削除する必要があります。

管理者またはリアクションの作成者のみが絵文字リアクションを削除できます。

DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id
DELETE /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id
DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid``merge_request_iid``snippet_id整数はいawardableのID（マージリクエスト/イシューの場合はiid、スニペットの場合はid）。
award_id整数はい絵文字リアクションのID。
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344"

コメントにリアクションを追加する

コメント（注釈とも呼ばれます）は、イシュー、マージリクエスト、およびスニペットのサブリソースです。

以下の例では、イシューのコメントに対する絵文字リアクションの操作について説明していますが、マージリクエストとスニペットのコメントにも適用できます。したがって、issue_iidをmerge_request_iidまたはsnippet_idに置き換える必要があります。

コメントの絵文字リアクションをリストする

コメント（注釈）のすべての絵文字リアクションを取得します。コメントが公開されている場合、このエンドポイントには認証なしでアクセスできます。

GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数はいイシューの内部ID。
note_id整数はいコメント（注釈）のID。

リクエスト例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji"

レスポンス例:

[
  {
    "id": 2,
    "name": "mood_bubble_lightning",
    "user": {
      "name": "User 4",
      "username": "user4",
      "id": 26,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/user4"
    },
    "created_at": "2016-06-15T10:09:34.197Z",
    "updated_at": "2016-06-15T10:09:34.197Z",
    "awardable_id": 1,
    "awardable_type": "Note"
  }
]

コメントの絵文字リアクションを取得する

コメント（注釈）の単一の絵文字リアクションを取得します。コメントが公開されている場合、このエンドポイントには認証なしでアクセスできます。

GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数はいイシューの内部ID。
note_id整数はいコメント（注釈）のID。
award_id整数はい絵文字リアクションのID。

リクエスト例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji/2"

レスポンス例:

{
  "id": 2,
  "name": "mood_bubble_lightning",
  "user": {
    "name": "User 4",
    "username": "user4",
    "id": 26,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/user4"
  },
  "created_at": "2016-06-15T10:09:34.197Z",
  "updated_at": "2016-06-15T10:09:34.197Z",
  "awardable_id": 1,
  "awardable_type": "Note"
}

コメントに新しい絵文字リアクションを追加する

指定されたコメント（注釈）に絵文字リアクションを作成します。

POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数はいイシューの内部ID。
note_id整数はいコメント（注釈）のID。
name文字列はいコロンなしの絵文字の名前。

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji?name=rocket"

レスポンス例:

{
  "id": 345,
  "name": "rocket",
  "user": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://gitlab.example.com/root"
  },
  "created_at": "2016-06-17T19:59:55.888Z",
  "updated_at": "2016-06-17T19:59:55.888Z",
  "awardable_id": 1,
  "awardable_type": "Note"
}

コメントから絵文字リアクションを削除する

時にはうまくいかないことがあり、リアクションを削除する必要があります。

管理者またはリアクションの作成者のみが絵文字リアクションを削除できます。

DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数はいイシューの内部ID。
note_id整数はいコメント（注釈）のID。
award_id整数はい絵文字リアクションのID。

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345"