Curator Broadcaster API は、Curatorが作成したオンエアーで表示するための(もしくはその他デジタル表示用の)ストリームを放送局に提供する非公開APIです。
このCurator Broadcaster API へアクセスするには特別なアクセス権が必要で、TV放送をする場合にのみ使用できます。アクセスの申請をする場合はcurator.twitter.comからお願いします。
この概要のページでは、必要な資格情報の作成、アクセステスト、原則とリソースについて説明し、よく使われるリクエストをいくつか例示しています。
詳細情報については、Curator プロダクト内の FAQs ページ を参照してください。
Curator Broadcaster APIを使うには、以下のことをしておく必要があります:
はじめに twitter.comへ行き、アカウントを作成します。アプリケーション専用の新しいアカウントを作成することを推奨します。 Eメールアドレスには、通常は個人アカウントを設定せずにチーム名を設定するのがベストです (パスワードリセットやアカウント管理目的のために)。 パスワードは複雑に生成されたものを設定してください。 アカウントを取得した後は、Eメール通知を無効にする、アカウントを非公開にする、タグ機能を無効化する、パスワードのリセットには個人情報が必要なようにする、といったいくつかの初期設定を行うと良いでしょう。
あなたのTwitter アカウントがCurator アカウントを使用するためのホワイトリストに登録されていなければ、次の項目には進めません。 お使いのプラットウォーム関連の担当者に問い合わせてください。
Curatorにログインしてストリームを作成します。ストリームが作成されたら、左側にあるOutputs
をクリックしてください。
左の枠にあるURLのいずれかをコピーし、全体が見えるようにどこかに貼り付けてください。
streams/
以降に記載されている、ストリームIDとauth
トークンを保存します。
全てのAPIの呼び出しでは、認証のための auth
パラメータが必要です。さらに、あなたを識別するために使われるストリームIDも必要です。
Curator Broadcaster API は二つのメインリソースを持っています: /streams
と/collections
です。
現在、以下のリソースが使用可能です:
trendline
エンドポイントは、リクエストした粒度に基づいて期間を制限されます:
metrics
エンドポイントとcompare
エンドポイントとcompare_to_targe
エンドポイントでは、start_time
パラメータを切り捨てに使い、end_time
パラメータを切り上げに使って上記規約で認められている最少粒度にします。
以下がリクエスト例になります。
curl
を使ってテストする場合は、次のコードを使用できます: curl https://curator.twitter.com/broadcast/1/streams/<stream_id>/?auth=<auth_token>&limit=
指定したストリームの最新のツイート。
https://curator.twitter.com/broadcast/1/streams/<stream_id>/content?auth=<auth_token>&limit=25
指定したコレクションの最新のツイート。
https://curator.twitter.com/broadcast/1/collections/<collection_id>/content?auth=<auth_token>&limit=25