クエリーの作成

GETコールから返ってくるデータの数を制限するには、whereクエリーを指定することができます。

Note:

フライトタイムは発行ルールによって制限されることもあります。しかし、クエリーAPIはアセット自身の フライト時間制限しか見ません。

日付制限のないアセットは、指定された期間中再生可能であるため、結果に含まれて返ってきます。

現在、nullの値を問い合わせることはできません。

クエリー文字列パラメータ

次の表はクエリー文字列で使用されるすべてのパラメータを示しています。

パラメータ 説明 必須?
and ラベルのインターセクションの問い合わせのため。

タイプ:文字列

デフォルト: なし

例:[GET] /v2/assets?where=labels INCLUDES 'Sports' AND labels INCLUDES 'Case Study'

いいえ
include

アセットに関する追加情報を返します。

タイプ:文字列

デフォルト: 名前

有効値: metadata | labels

例:[GET] /v2/assets?include=metadata,labels

いいえ
limit

返される結果の最大数。指定した値以上の結果が返ってきた場合、ページングの トークンとともに次のページに結果が表示されます。

タイプ:文字列

デフォルト:100

有効値:1-500

例:[GET] /v2/assets?limit=5

いいえ
next_page
前のAPIリクエストから返されたURL。結果がページ単位で閲覧できるようになります。
Note: ページの結果数がlimit値で分割可能な場合、 サービスは404レスポンスを返します。

タイプ:文字列

デフォルト:なし

例:[GET] /v2/assets?limit=2&page_token=1332345124%3B0wZTQ4NDpW27FQgXF6zry0b42OI76GZN

いいえ
orderby

ソートするフィールド。

タイプ:文字列

デフォルト: name、昇順

有効値:name | duration | asset_type | created_at

例:[GET] /v2/assets?orderby=name, [GET] /v2/assets?orderby=name+DESCENDING

いいえ
where

指定した条件に一致する結果を返します。

Note: 値がnullのプロパティを検索することはできません。

タイプ:文字列

デフォルト: name

例:[GET] /v2/assets?where=description='cat video'

いいえ

パターンの一致と結果について

クエリ-はそれぞれのアイテムに対して、用語をすべて含む結果を返します。クエリ-は大文字・小文字を無視し、単数形・複数形両方の用語を返し、"a" や"the"といった一般的な単語を検索から除外します。たとえば、description='Cat videos'は以下を返します。

  • "Videos about cats"
  • "Funny video of a cat"
  • "Cats watching videos"
Note: 削除されたアセットは、クエリー結果には返ってきません。

比較

すべての比較関数は整数およびアセットの単一のフィールドに対応しています。(<, <=, =, >=, >, !=).たとえば、duration>600は10分 (600秒)以上のアセットをすべて返します。

ラベルのインターセクション

2つ以上のラベルを持つアセットを見つけるには、 andオペレーターを使用します。たとえば、ラベルSportsとラベル Baseballの両方を持つアセットを見つけるには、
[GET] /v2/assets?where=labels INCLUDES 'Sports' AND labels INCLUDES 'Baseball'
              

この例は説明内に"cat"と"funny"という単語を持つ、10分以上のアセットのうち最初の2つを返します。

[GET] /v2/assets?where=description='cat funny'+AND+duration>600&orderby=name&limit=2
    

Backlot は次のようなレスポンスを返します。

{
  "items": [     
    {
      "asset_type": "video",
      "duration": 19000,
      "name": "Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-25T15:32:57+00:00",
      "embed_code": "IzNnllMjphu2XF3_UgPROoCi9B2Bwqwt",
      "time_restrictions": null,
      "updated_at": "2011-08-29T23:12:09+00:00",
      "external_id": null,
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-25 at 08.31.mov",
      "description": "A video of funny cats.",
      "status": "live"
    },     
    {
      "asset_type": "video",
      "duration": 25959,
      "name": "More Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/9hcDdkMjq4LUKvPP-vJcgDds_TPIsP0u/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-05T21:49:46+00:00",
      "embed_code": "9hcDdkMjq4LUKvPP-vJcgDds_TPIsrte",
      "time_restrictions": null,
      "updated_at": "2011-06-01T23:13:40+00:00",
      "external_id": null,
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-05 at 14.44.mov",
      "description": "Can there really be more funny cat videos? Yes.",
      "status": "live"
    }
  ],
  "next_page": "/v2/assets?limit=2&page_token=1314306109%3B1saGRyMjoOgjkUSjod_1TQINs_HOQnoU"
} 
    

この例は指定したembedコードに一致するアセットのリストを取得します。

/v2/assets?where=embed_code+IN+('IzNnllMjphu2XF3_UgPROoCi9B2Bwqwt','9hcDdkMjq4LUKvPP-vJcgDds_TPIsrte')
    

Backlot は次のようなレスポンスを返します。

{
  "items": [     
    {
      "asset_type": "video",
      "duration": 19000,
      "name": "Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-25T15:32:57+00:00",
      "embed_code": "IzNnllMjphu2XF3_UgPROoCi9B2Bwqwt",
      "time_restrictions": null,
      "updated_at": "2011-08-29T23:12:09+00:00",
      "external_id": null,
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-25 at 08.31.mov",
      "description": "A video of funny cats.",
      "status": "live"
    },     
    {
      "asset_type": "video",
      "duration": 25959,
      "name": "More Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/9hcDdkMjq4LUKvPP-vJcgDds_TPIsP0u/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-05T21:49:46+00:00",
      "embed_code": "9hcDdkMjq4LUKvPP-vJcgDds_TPIsrte",
      "time_restrictions": null,
      "updated_at": "2011-06-01T23:13:40+00:00",
      "external_id": null,
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-05 at 14.44.mov",
      "description": "Can there really be more funny cat videos? Yes.",
      "status": "live"
    }
  ]
} 
    

この例はカテゴリーのメタデータキーに"Cat Videos"という値が設定されているアセットのリストを取得します。

[GET] /v2/assets?where=metadata.category='Cat Videos'&include=metadata
    

Backlot は次のようなフィードを生成します。

{
  "items": [     
    {
      "asset_type": "video",
      "duration": 19000,
      "name": "Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-25T15:32:57+00:00",
      "embed_code": "IzNnllMjphu2XF3_UgPROoCi9B2Bwqwt",
      "time_restrictions": null,
      "updated_at": "2011-08-29T23:12:09+00:00",
      "external_id": null,
      "metadata": {
        "category": "Cat Videos"
        "rating": "G"        
      },      
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-25 at 08.31.mov",
      "description": "A video of funny cats.",
      "status": "live"
    },     
    {
      "asset_type": "video",
      "duration": 25959,
      "name": "More Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/9hcDdkMjq4LUKvPP-vJcgDds_TPIsP0u/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-05T21:49:46+00:00",
      "embed_code": "9hcDdkMjq4LUKvPP-vJcgDds_TPIsrte",
      "time_restrictions": null,
      "updated_at": "2011-06-01T23:13:40+00:00",
      "external_id": null,
      "metadata": {
        "category": "Cat Videos"
        "rating": "PG"        
      },      
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-05 at 14.44.mov",
      "description": "Can there really be more funny cat videos? Yes.",
      "status": "live"
    }
  ]
}      
    

この例は"funny"というラベルを持つすべてのビデオを返します。

[GET] /v2/assets?where=labels+INCLUDES+'funny'
    

Backlot は次のようなフィードを生成します。

{
  "items": [     
    {
      "asset_type": "video",
      "duration": 19000,
      "name": "Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-25T15:32:57+00:00",
      "embed_code": "IzNnllMjphu2XF3_UgPROoCi9B2Bwqwt",
      "time_restrictions": null,
      "updated_at": "2011-08-29T23:12:09+00:00",
      "external_id": null,
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-25 at 08.31.mov",
      "description": "A video of funny cats.",
      "status": "live"
    },     
    {
      "asset_type": "video",
      "duration": 25959,
      "name": "More Funny Cats",
      "preview_image_url": "http://ak.c.ooyala.com/9hcDdkMjq4LUKvPP-vJcgDds_TPIsP0u/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-04-05T21:49:46+00:00",
      "embed_code": "9hcDdkMjq4LUKvPP-vJcgDds_TPIsrte",
      "time_restrictions": null,
      "updated_at": "2011-06-01T23:13:40+00:00",
      "external_id": null,  
      "hosted_at": null,
      "original_file_name": "Movie on 2011-04-05 at 14.44.mov",
      "description": "Can there really be more funny cat videos? Yes.",
      "status": "live"
    }
  ]
}      
    

フライトタイムはコンテンツの再生可能時間を制限します。この例は2011年6月中再生可能なアセットを返します。

[GET] /v2/assets?where=time_restrictions.start_date<='2011-06-01T00:00:00Z'+AND+time_restrictions.end_date>='2011-07-01T00:00:00Z'
    

Backlot は次のようなレスポンスを返します。

{
  "items": [     
    {
      "asset_type": "video",
      "duration": 3366,
      "name": "My movie",
      "preview_image_url": "http://ak.c.ooyala.com/B5bzAzMzrrnbUrxt_vBj0hLcjgdQSkSH/Ut_HKthATH4eww8X5hMDoxOjBrOw-uIx",
      "created_at": "2011-01-21T23:37:28+00:00",
      "embed_code": "B5bzAzMzrrnbUrxt_vBj0hLcjgdQSkSH",
      "time_restrictions": {
        "type": "range",
        "start_date": "2011-06-01T00:00:00Z",
        "end_date": "2011-06-15T00:00:00Z"
        }
      "updated_at": "2011-11-29T00:40:37+00:00",
      "external_id": null,
      "original_file_name": "My movie.mov",
      "hosted_at": null,
      "description": null,
      "status": "live"
    },
    {
      "asset_type": "video",
      "duration": 0,
      "name": "My other movie",
      "preview_image_url": null,
      "created_at": "2011-01-01T19:40:32+00:00",
      "embed_code": "QycmV4Mjp_iICcP6fhpiHsY81jDgmOUY",
      "time_restrictions": {
        "type": "range",
        "start_date": "2011-06-015T00:00:00Z",
        "end_date": null
       }      
      "updated_at": "2011-10-26T19:40:32+00:00",
      "external_id": null,
      "original_file_name": "My other movie.avi",
      "hosted_at": null,
      "description": null,
      "status": "uploading"
    }
  ]
} 
      

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