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

ブロードキャストメッセージAPI

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

UIに表示されるバナーおよび通知を操作するには、このAPIを使用します。詳細については、ブロードキャストメッセージを参照してください。

GETリクエストは認証を必要としません。その他のすべてのブロードキャストメッセージAPIエンドポイントは、管理者のみがアクセスできます。GET以外のリクエストが次の場合:

  • ゲストの場合、401 Unauthorizedとなります。
  • 一般ユーザーの場合、403 Forbiddenとなります。

すべてのブロードキャストメッセージを一覧表示

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

すべてのブロードキャストメッセージを一覧表示します。

GET /broadcast_messages

リクエスト例:

curl "https://gitlab.example.com/api/v4/broadcast_messages"

レスポンス例:

[
    {
        "message":"Example broadcast message",
        "starts_at":"2016-08-24T23:21:16.078Z",
        "ends_at":"2016-08-26T23:21:16.080Z",
        "font":"#FFFFFF",
        "id":1,
        "active": false,
        "target_access_levels": [10,30],
        "target_path": "*/welcome",
        "broadcast_type": "banner",
        "dismissable": false,
        "theme": "indigo"
    }
]

ブロードキャストメッセージを取得する

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

指定されたブロードキャストメッセージを取得する。

GET /broadcast_messages/:id

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

属性型必須説明
id整数はい取得するブロードキャストメッセージのID。

リクエスト例:

curl "https://gitlab.example.com/api/v4/broadcast_messages/1"

レスポンス例:

{
    "message":"Deploy in progress",
    "starts_at":"2016-08-24T23:21:16.078Z",
    "ends_at":"2016-08-26T23:21:16.080Z",
    "font":"#FFFFFF",
    "id":1,
    "active":false,
    "target_access_levels": [10,30],
    "target_path": "*/welcome",
    "broadcast_type": "banner",
    "dismissable": false,
    "theme": "indigo"
}

ブロードキャストメッセージを作成

ブロードキャストメッセージは、ターゲティング設定に関係なく、APIを通じて公開されます。機密情報や個人情報を含めたり、特定のグループやプロジェクトに個人情報を伝えるためにブロードキャストメッセージを使用したりしないでください。

ブロードキャストメッセージを作成します。

POST /broadcast_messages

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

属性型必須説明
message文字列はい表示するメッセージ。
starts_at日時いいえ開始時刻（UTCの現在時刻がデフォルトです）。ISO 8601形式（2019-03-15T08:00:00Z）で指定します。
ends_at日時いいえ終了時刻（UTCの現在時刻から1時間後がデフォルトです）。ISO 8601形式（2019-03-15T08:00:00Z）で指定します。
font文字列いいえ前景色（16進数コード）。
target_access_levels整数の配列いいえブロードキャストメッセージのターゲットアクセスレベル（ロール）。
target_path文字列いいえブロードキャストメッセージのターゲットパス。
broadcast_type文字列いいえ表示タイプ（バナーがデフォルト）。
dismissableブール値いいえユーザーはメッセージを却下できますか？
theme文字列いいえブロードキャストメッセージのカラーテーマ（バナーのみ）。

target_access_levelsはGitlab::Accessモジュールで定義されています。以下のレベルが有効です:

  • ゲスト（10）
  • プランナー（15）
  • レポーター（20）
  • セキュリティマネージャー（25）
  • デベロッパー（30）
  • メンテナー（40）
  • オーナー（50）

themeオプションはSystem::BroadcastMessageクラスで定義されています。以下のテーマが有効です:

  • indigo（デフォルト）
  • light-indigo
  • blue
  • light-blue
  • green
  • light-green
  • red
  • light-red
  • dark
  • light

リクエスト例:

curl --data "message=Deploy in progress&target_access_levels[]=10&target_access_levels[]=30&theme=red" \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/broadcast_messages"

レスポンス例:

{
    "message":"Deploy in progress",
    "starts_at":"2016-08-26T00:41:35.060Z",
    "ends_at":"2016-08-26T01:41:35.060Z",
    "font":"#FFFFFF",
    "id":1,
    "active": true,
    "target_access_levels": [10,30],
    "target_path": "*/welcome",
    "broadcast_type": "notification",
    "dismissable": false,
    "theme": "red"
}

ブロードキャストメッセージを更新

ブロードキャストメッセージは、ターゲティング設定に関係なく、APIを通じて公開されます。機密情報や個人情報を含めたり、特定のグループやプロジェクトに個人情報を伝えるためにブロードキャストメッセージを使用したりしないでください。

指定されたブロードキャストメッセージを更新します。

PUT /broadcast_messages/:id

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

属性型必須説明
id整数はい更新するブロードキャストメッセージのID。
message文字列いいえ表示するメッセージ。
starts_at日時いいえ開始時刻（UTC）。ISO 8601形式（2019-03-15T08:00:00Z）で指定します。
ends_at日時いいえ終了時刻（UTC）。ISO 8601形式（2019-03-15T08:00:00Z）で指定します。
font文字列いいえ前景色（16進数コード）。
target_access_levels整数の配列いいえブロードキャストメッセージのターゲットアクセスレベル（ロール）。
target_path文字列いいえブロードキャストメッセージのターゲットパス。
broadcast_type文字列いいえ表示タイプ（バナーがデフォルト）。
dismissableブール値いいえユーザーはメッセージを却下できますか？
theme文字列いいえブロードキャストメッセージのカラーテーマ（バナーのみ）。

target_access_levelsはGitlab::Accessモジュールで定義されています。以下のレベルが有効です:

  • ゲスト（10）
  • プランナー（15）
  • レポーター（20）
  • デベロッパー（30）
  • メンテナー（40）
  • オーナー（50）

themeオプションはSystem::BroadcastMessageクラスで定義されています。以下のテーマが有効です:

  • indigo（デフォルト）
  • light-indigo
  • blue
  • light-blue
  • green
  • light-green
  • red
  • light-red
  • dark
  • light

リクエスト例:

curl --request PUT \
  --data "message=Update message" \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/broadcast_messages/1"

レスポンス例:

{
    "message":"Update message",
    "starts_at":"2016-08-26T00:41:35.060Z",
    "ends_at":"2016-08-26T01:41:35.060Z",
    "font":"#FFFFFF",
    "id":1,
    "active": true,
    "target_access_levels": [10,30],
    "target_path": "*/welcome",
    "broadcast_type": "notification",
    "dismissable": false,
    "theme": "indigo"
}

ブロードキャストメッセージを削除

指定されたブロードキャストメッセージを削除します。

DELETE /broadcast_messages/:id

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

属性型必須説明
id整数はい削除するブロードキャストメッセージのID。

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/broadcast_messages/1"