メディア企業向け

コンテンツチャンネルAPI

メディア企業が、ニュース・天気などの画像や動画を自社のシステムからコンテンツチャンネルに追加・削除します。追加した画像・動画は、チャンネルを選んだ店舗のサイネージで流れます(レシートローラーの承認済みのチャンネルのみ)。画像・動画は広告と同じサイネージの仕様(16:9 または 9:16、1920×1080 推奨、動画は H.264 の MP4 で6・15・30秒)に合わせてください。RSS・Atom のフィードを設定すると、15分ごとに読み込んで自動で追加することもできます。organizationId にメディア企業のビジネスアカウントのIDを指定します。必要なスコープは media.channels.read(取得)と media.channels.write(追加・削除・フィードの設定)です。

api/v1/content-channels APIリファレンスで確認

エンドポイント一覧

メソッド パス 説明 レスポンス
GET /api/v1/content-channels/ チャンネルを一覧取得
アカウントのチャンネルと、審査の状態(承認まで Pending)、フィードの読み込み結果を返します。
200 403
GET /api/v1/content-channels/{channelId}/items チャンネルの画像・動画を取得
新しい順に返します。流れるのは期間内の新しい10件までです。
200 403 404
POST /api/v1/content-channels/{channelId}/items 画像・動画を追加
multipart で file(必須)、title・validUntil(配信を終える日時)・externalId(貴社側のID)を送ります。同じ externalId を再送すると、追加せずに既存の項目を200で返すので、再試行しても重複しません。仕様に合わないファイルは400です。
201 200 400 403 404
DELETE /api/v1/content-channels/{channelId}/items/{itemId} 画像・動画を削除
各店舗のプレイリストが次に更新されたときに流れなくなります。APIやフィードで追加したものはファイルも削除します。
204 403 404
PUT /api/v1/content-channels/{channelId}/feed フィードを設定
feedUrl に https で公開している RSS 2.0 または Atom のフィードを指定します。各項目の enclosure または media:content の画像・動画を15分ごとに取り込み、フィードからなくなった項目は配信を終えます。空にすると読み込みを止めます。
204 400 403 404

エンドポイント詳細

アカウントのチャンネルと、審査の状態(承認まで Pending)、フィードの読み込み結果を返します。

完全パス: GET /api/v1/content-channels/
レスポンスコード: 200 403

新しい順に返します。流れるのは期間内の新しい10件までです。

完全パス: GET /api/v1/content-channels/{channelId}/items
レスポンスコード: 200 403 404

multipart で file(必須)、title・validUntil(配信を終える日時)・externalId(貴社側のID)を送ります。同じ externalId を再送すると、追加せずに既存の項目を200で返すので、再試行しても重複しません。仕様に合わないファイルは400です。

完全パス: POST /api/v1/content-channels/{channelId}/items
レスポンスコード: 201 200 400 403 404

各店舗のプレイリストが次に更新されたときに流れなくなります。APIやフィードで追加したものはファイルも削除します。

完全パス: DELETE /api/v1/content-channels/{channelId}/items/{itemId}
レスポンスコード: 204 403 404

feedUrl に https で公開している RSS 2.0 または Atom のフィードを指定します。各項目の enclosure または media:content の画像・動画を15分ごとに取り込み、フィードからなくなった項目は配信を終えます。空にすると読み込みを止めます。

完全パス: PUT /api/v1/content-channels/{channelId}/feed
レスポンスコード: 204 400 403 404

リクエスト例

リクエスト
POST /api/v1/content-channels/{channelId}/items?organizationId={organizationId}
Authorization: Bearer {access_token}
Content-Type: multipart/form-data

file=@weather-tokyo.jpg
title=東京の天気
validUntil=2026-10-02T00:00:00+09:00
externalId=weather-tokyo-20261001
レスポンス
{
  "id": "0797…",
  "title": "東京の天気",
  "type": "Image",
  "width": 1920,
  "height": 1080,
  "validUntil": "2026-10-01T15:00:00Z",
  "source": "api",
  "externalId": "weather-tokyo-20261001",
  "createdAt": "2026-10-01T06:00:00Z"
}
認証について

このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。トークンの取得方法は認証ガイドをご確認ください。

認証・アクセスAPIを見る