フィルター

以下はv3 Analytics Reporting API用の定義済み全フィルターのリファレンス詳細です。

基本的に、フィルターの名前はディメンションと同じです。フィルターは、filiters=クエリ文字列パラメーターで指定します。ブール演算子を用いて結果をさらに絞り込むことができます。フィルター値を一重引用符で囲みます(例:filters=asset=='asset_id')。フィルター値は大文字小文字が区別されます。

フィルターの使用例については、どのフィルターを使用できますか?をご覧ください。

日付範囲制限

Note: 2つのフィルターまで、最長1年間(366日)の日付範囲を設定できます。3つのフィルターでは、最長1か月(31日)の日付範囲を設定できます。

230文字のHTTP GET仕様限度を超えるクエリパラメーターのクエリについては、POSTリクエストを使ってください。

GETレポートの通常シンタックス

ルートとクエリ文字列の基本シンタックスは以下のとおりです。読みやすくするため、1行のリクエストが複数行に分かれています。

[GET] /v3/analytics/reports/?
            report_type=type
            &dimensions=dimensions
            &metrics=metrics
            &filters=filter_type=='filter_value'
            &start_date=date
            &end_date=date
            &other_parms
            &api_key=your_api_key
         
  • 必須クエリ文字パラメーター(太文字で表示)はreport_type, start_dateおよびapi_keyです。
  • ディメンションが指定されていない場合、全ディメンションのすべての値が返されます。
  • 一度に3つのディメンションまで指定できます。
  • メトリックが指定されていない場合、すべてのメトリックが返されます。
Note: 現時点で、report_typeの唯一の有効な値はパフォーマンスです。

長いクエリPOSTをレポートする一般的なシンタックス

230文字のHTTP GET仕様限度を超えるクエリパラメーターのクエリについては、POSTリクエストを使ってください。一部のブラウザとHTTPクライアントは230文字以上に対応している場合がありますが、当社はHTTP GET仕様に違反しているクエリにサポートを提供していません。POSTリクエストについては、クエリ文字パラメーターの代わりにリクエスト本文にJSONオブジェクトをパスします。

[POST] /v3/analytics/reports

{
    "report_type":"type",
    "dimensions":"dimensions",
    "metrics":"metrics",
    "filters":"(filter_type==\"filter_value\")",
    "start_date":"date",
    "end_date":"date",
    "other_parms":"other_param_value",
    "api_key":"your_api_key"
}
         
フィルタータイプ 意味 有効な値

asset

アセットでデータをフィルタリングします。
Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。

プロバイダーまたはサブプロバイダーに関連付けられた任意のアセットID。アセットIDはBacklotに入力したembed_codeまたはexternal_idsにすることができます。

country

国名でデータをフィルタリングします。

Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。

カントリーコード。国コードと場所コードをご覧ください。

region

地理的地域でデータをフィルタリングします。地理的レポートはQuovaによって提供されている地域の定義を使用します。
Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。
任意の地域文字列。regionだけを指定することはできません。countryも指定する必要があります。

dma

DMA(設定されたマーケティング地域、アメリカ限定の概念で他国では普及していない)でフィルタリングします。

Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。
プロバイダー定義の任意のDMA。
state 州名でフィルタリングします(国内の州など)。地理的レポートでは、Quovaによって定義されているように、州は国の「一番上の行政区域」です。たとえば、カリフォルニア州での再生回数のデータのみを表示するようフィルタリングできます。
Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。

任意の「州」の文字列。stateだけを指定することはできません。countryも指定する必要があります。

device_type

デバイスタイプでフィルタリングします。

Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。

プラットフォーム、デバイス、オペレーティングシステムの各コードの可能な値をご確認ください。

domain

インターネットドメイン名でフィルタリングします。

任意の「domain」文字列。

url

特定のURLでデータをフィルタリングします。

Note: urlディメンションではurlフィルターだけを使用できます。他のディメンションでこのフィルターを使用することはできません。
任意のURLの文字列。Ooyalaアナリティクスによって追跡されていないURLを使用する場合、APIは0のデータ結果を返します。

os

オペレーティングシステムでフィルタリングします。

Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。

プラットフォーム、デバイス、オペレーティングシステムの各コードの可能な値をご確認ください。

browser

ブラウザでデータをフィルタリングします。 注記: browserディメンションは、device_typedesktopであるときに限り適用されます。

Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。

プラットフォーム、デバイス、オペレーティングシステムの各コードの可能な値をご確認ください。

pcode

プロバイダーのpcode(Ooyalaが提供したプロバイダーID)でデータをフィルタリングします。詳細は、API資格情報をご覧ください。

Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。

現在のアカウント(APIコールを実行中のプロバイダー)またはそのサブアカウントの任意のpcode。

player_id

Ooyalaプレイヤーの)プレイヤーIDでデータをフィルタリングします。

Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。
 

label

ラベルIDを使用しているラベルでデータをフィルタリングします。

Ooyalaアナリティクスでラベルを扱う際は、以下の点に注意してください。
  • ラベルとそれに関連付けられたビデオの関係はあらかじめ集約または集計(ロールアップ)されてはおらず、APIのリクエストの時点で解決されます。
  • 必要な個々のラベルとビデオの関連付けはすべて、明示的に作成されている必要があります。 Ooyalaのシステムにおける集約または集計は、ラベル階層ではなく、明示的関連付けに基づいてのみ行われます。 たとえば、親ラベルとして「Cycle World」、子ラベルとして「Sport Bikes」という2つのラベルがあるとします。 「Sport Bikes」の子ラベルを持つビデオは、「Cycle World」のラベルも明示的に付加されていない限り、親ラベルの「Cycle World」にロールアップはされません。
Note: このフィルターはurlディメンションでは有効ではありません。urlディメンションでは、domainurlフィルターだけを使用できます。
Backlotで定義された任意のラベルを使用できます。結果には、ラベルでタグ付けされたアセットのメトリックのみが含まれます。一度に複数のラベルでフィルタリングできます。

ブール演算子-「&」(AND)および「|」(OR)

フィルターの正式な構文を以下に示します。
filters= filter [boolOp filter]* 
        
記号 拡張子
filter dimension-filterまたはcomposite-filter
dimension-filter dimension op value

以下のケース:

  • dimentionディメンションに表示されているディメンション名またはカスタムディメンション名です。
  • op== (一致)または!=(不一致)です。
  • valueは、os!='android'(Android OSのデータ)のような一重引用符で囲ったディメンション値です。
composite-filter ( filter [boolOp filter ]*)

以下のケース:

  • filterは上記で定義されています。
  • boolOp; (AND) または | (OR)です。ブール演算子と2つ目のフィルターは任意であり、無制限にリピート可能です。
括弧によるグループ化

フィルター値のコンポーネントを論理的にグループ化するには括弧を使用します。例はどのフィルターを使用できますか?をご覧ください。

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