クエリーAPI

Backlotaアカウントのコンテンツに関する情報をリクエストするためのフレキシブルなクエリーAPIをご提供しています。

リクエストはhttp://api.ooyala.com/partner/queryへRESTスタイルの署名付きGETによって発行されます。結果は、限定パラメーターのページサイズ設定にしたがってページ分割され、ページIDパラメータによって要求されたページ数が設定されます。nextPageIDの値が-1の場合、これ以上フェッチすべき結果は存在しません。

必須の検索条件パラメータ:

  • pcode – アカウント識別子
  • expires – エポック(00:00:00 1/1/1970 GMT)からの秒単位のクエリー有効期限
  • signature – リクエストのデジタル署名。署名はSHA-256署名発行ルールを使用して算出されます。

任意の検索条件基準パラメータ:

  • contentType – コンテンツタイプによる検索。Video、VideoAd、Channel、MultiChannel、LiveStream、YouTube、RemoteAssetのいずれか1つ。
  • description – descriptionの単語を使用して検索。
  • title – titleの単語で検索。'LIKE' のマッチングにはSQL準拠を使います。
  • text – titleまたはdescriptionの単語で検索。検索結果には、titleまたはdescriptionに指定単語を含むコンテンツが含まれます。
  • embedCode – embedCodeに一致。完全に一致するembedCode が複数ある場合には、カンマ区切りの一覧を使って指定できます。
  • fields – 結果に含める追加フィールドのコンマ区切りの一覧。この一覧の有効値:
    • labels
    • metadata
    • ratings – 評価情報は、次の形式の"movieRatings" XML要素で返されます。<movieRatings>4;3;2;0;0;0;0;0;0;0;0</movieRatings>.コンテンツのアイテムにまだ評価がない場合には、この要素はありません。
    Note: ラベルが検索パラメータに含まれる場合、レスポンスにラベルが含まれます。同様に、メタデータも同様です。
  • includeDeleted – trueまたはfalse。クエリーレスポンスに30日以内に削除されたコンテンツを含むかどうかを指定します。デフォルトはfalseです。
  • label[<id>] – 任意のすべての文字列と一致する完全修飾名を持つラベルを含むコンテンツに一致。パラメーターの"id"部分に英数字を使用します。
  • limit – 1ページごとに含まれる結果数。デフォルトは500です。
  • pageID – リクエストされたページのID。デフォルトは0です。
  • queryMode – 複数の検索条件を評価する時に使う演算子。"AND"または"OR"のどちらかになります。デフォルトはANDです。
  • statistics – 返される統計期間を指定するカンマ区切りの一覧。ライフタイム1d、2d、3d、4d、5d、7d、14d、28d、29d、30d、 31dから、1つまたは複数を指定します。
  • status – コンテンツ状態に一致。複数の状態を指定する場合、カンマ区切りの一覧を使用することができます。
    • RemoteAsset – リモートアセット
    • deleted – システムから削除されたチャンネルまたはビデオ
    • live—ビデオまたはチャンネルにエラーがなく、処理済みで、現在再生可能。
    • scheduled—ビデオまたはチャンネルにエラーがなく、処理済みで、今後ある時点から用可能になる予定。
    • finished airing—ビデオまたはチャンネルはエラーがなく、処理済みで、もう利用できません。
    • error – 処理前、処理後エラー
    • filemissing – アップロード段階のエラー
    • uploading – ファイルを現在アップロード中
    • paused – ビデオは再生出来ません(ユーザー設定の状態)
    • uploaded – アップロードと処理の間の状態
    • na – 不明のコンテンツを表わす
    • removed –ソースアカウントで削除されたため、公開先アカウントで利用出来なくなった削除された自動公開コンテンツ
    • uploading – この場合'a' はAPIを表わしますので、APIアップロードという意味になります。Backlotインターフェース経由に行われなかったすべてのアップロードがAPIアップロードです。
    • auploaded – 上記、auploadingを参照
    • duplicate — 特定のアカウント内の名前およびサイズをベースに検出された重複ファイル
    • pending — 実質 'paused'(休止)と同じ状態ですが、適度なソート処理が行われていることを示すために違う名前が付けられています。
    • processing —ビデオは処理中です
  • updatedAfter — ある日付以降にアップロードされたコンテンツを見つける。 エポック(00:00:00 1/1/1970 GMT)からの秒単位の日付を指定します。
  • orderBy — 次の二通りのソートオプションを指定することが出来ます。uploadedatまたはupdatedatの2つで、それぞれアセットのアップロードされた日、および最終更新日に対応します。ソート順序はascまたはdescで指定します。以下は結果をアップロード時間の降順に並べたい場合の例です。orderBy=uploadedAt,desc.
Note: 複数の検索パラメータが指定された場合、有効なマッチはすべてのパラメータを満たしていなければいけません。

クエリー結果

クエリー結果はレスポンスボディの機能を果たすXML文書です。ルートタグは<list>で、マッチするすべてのコンテンツ要素はその一覧に<item>タグとして組込まれています。結果サンプルは次のセクションに続きます。

クエリー結果データフィールド:

  • embedCode: 任意のコンテンツのembedコード
  • title:該当する場合にはコンテンツのタイトル
  • description:該当する場合にはコンテンツの説明
  • status:コンテンツの状態
  • hostedAt:該当する場合にはビデオまたはチャンネルが埋め込まれたメインページのURL
  • remoteAssetURL:該当する場合にはリモートアセットの基本URL
  • error: 処理中のエラー
  • content_type:Video、VideoAd、Channel、Alias、AliasAd、MultiChannel、Autosyndのいずれかひとつ
  • uploadedAt:エポック(00:00:00 1/1/1970 GMT)からの秒単位のアップロード時間
  • length:ミリ秒単位のビデオの再生時間
  • size:元のビデオのサイズ(バイト)
  • updatedAt:エポック(00:00:00 1/1/1970 GMT)からの秒単位の最終更新時間
  • flightStartTime:Backlot UIで設定してオーバーライドしなければ、シンジケーショングループに割り当てられる開始時間からアセットの開始時間を使用します。オーバーライドした場合、開始時間はアセットに設定したものを基本とします(デフォルトは動画のアップロード時間です)。
  • flightEndTime:この時間以降ビデオは再生できなくなります。エポック(00:00:00 1/1/1970 GMT)から秒単位で指定された時間。
  • width:元のビデオの横幅(ピクセル)
  • height:元のビデオの高さ(ピクセル)
  • labels:コンテンツと関連付けられたラベル。 ラベルが検索条件の一部である、あるいはパラメータ"fields=labels" が指定されている場合のみ、このセクションは組み込まれます。
  • metadata:コンテンツと関連付けられたすべての名前/値ペア。メタデータフィールドが検索条件の一部である、あるいはパラメータ "fields=metadata" が指定されている場合にのみ、このセクションが組み込まれます。
  • ratings: コンテンツのこの部分に関連付けられた評価。各整数がこのアイテムに対して特定の評価が与えられた回数を表わす11の整数からなる配列を返します。 たとえば、[0, 16, 0, 0, 0, 0, 0, 0, 25, 0, 0] はアイテムが"1"を16票、"8"を25票獲得していることを表わします。
  • thumbnail: デフォルトのサムネイル情報には高さ、横幅、URLが含まれます
  • stat:リクエストされた場合、表示、再生、巻戻し、再生時間、視聴を含む統計情報から成る再生時間指定ブロックを返します。
Note: クエリーAPI経由で公開された内部ステータスはBacklotユーザーインターフェース内のステータスと若干異なる可能性があります。

クエリー結果サンプル

<?xml version="1.0" encoding="UTF-8"?>
<list totalResults="277" nextPageID="10" size="2" statistics-as-of="1247507998"
 statistics-as-of_text="Mon Jul 13 17:59:58 UTC 2009" limit="2" pageID="9">
<item>
  <embedCode>RyY2IxOtfOye1qEPARlzC5S9oPt0tFeH</embedCode>
  <title>MOV00821.MPG</title>
  <description/>
  <status>pending</status>
  <content_type>Video</content_type>
  <uploadedAt>1211529928</uploadedAt>
  <length>12960</length>
  <size>4708348</size>
  <updatedAt>1211568871</updatedAt>
  <flightStartTime>1211529928</flightStartTime>
  <width>640</width>
  <height>480</height>
  <labels>
    <label>/any/another</label>
    <label>/any/some</label>
    <label>/bysmthng/qqq</label>
    <label>/byuser/u1</label>
  </labels>
  <metadata>
    <metadataItem name="director" value="Francis Ford Coppola"/>
    <metadataItem name="actor" value="Marlon Brando"/>
  </metadata>
  <thumbnail height="79" width="106">
    http://ak.c.ooyala.com/RyY2IxOtfOye1qEPARlzC5S9oPt0tFeH/Ut_HKthATH4eww8X5iMDoxOmEzOxWwy3
  </thumbnail>
  <stat>
    <lifetime>
      <displays total="0"/>
      <plays total="0"/>
      <rewinds total="0"/>
      <playtime ms="0"/>
      <watched _25="0" _50="0" _75="0" _100="0"/>
    </lifetime>
  </stat>
</item>
</list>
   

この記事はお役にたちましたか?