ディメンション

以下はv3 AnalyticsReporting API用に定義されている全ディメンションのリファレンスの詳細です。

ディメンションは、dimensions=クエリ文字列パラメーターで指定します。注意すべき点:
  • 一度に最高3つのディメンションでフィルターできます。
    Note: urlクエリで1つのディメンションだけ使用できます。
  • 複数の値はスペースなしのカンマ区切りにする必要があります。
  • 値の順序は影響しません:
    • dimensions=device_type,dmaでもdimensions=dma,device_typeでも同じです。

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"
}
         
名前 意味 追加情報

アセット

OoyalaAsset ID(embedコードまたはコンテンツID)および外部識別子を含む、ビデオや他のアセット。

アセットディメンションをラベルでフィルタリングするには、フィルターを含めます:filters=label=='yourLabelId'

レスポンスには以下のものが含まれます:
{ embed_code,name,status,type }
  • nameはビデオのタイトルです。
  • embed_codeはビデオの識別子(コンテンツIDまたはAsset ID)です。
  • statusOoyala Backlotlive or paused)のビデオのステータスです。

country

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

レスポンスには国の正式名称が含まれます。

アナリティクスUIで、の一部地域

region

地理的地域。地理的レポートはQuovaによって提供されている地域の定義を使用します。

regionだけを指定することはできません。countryも指定する必要があります。

アナリティクスUIで、の一部地域

dma

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

実行結果にはDMA IDと具体名が含まれます。アナリティクスUIで、の一部地域
state 州名。たとえば、アメリカ合衆国を地域で掘り下げた場合、カリフォルニア、アリゾナ等が表示されます。地理的レポートはQuovaによって提供されている州の定義を使用します(州は国の「一番上の行政区域」です)。

stateだけを指定することはできません。countryも指定する必要があります。

アナリティクスUIで、の一部地域

device_type

デバイスタイプ。

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

domain

インターネットドメイン(完全修飾ドメイン名)

アナリティクスUIで、の一部トラフィックの発信元

url

ユニフォームリソースロケーター(URL)。

Note: urlクエリで1つのディメンション(url)だけ使用できます。urlクエリでurlまたはdomainフィルターだけを適用できます。
アナリティクスUIで、の一部トラフィックの発信元

os

ユーザーのデバイスのオペレーティングシステム。完全一致文字列でなければなりません。部分一致には対応していません。

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

browser

ユーザーのウェブブラウザ。

注記: browserディメンションは、device_typedesktopであるときに限り適用されます。

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

pcode

Ooyalaから提供されたプロバイダーID

player_id

ビデオ再生中に使用されたOoyalaまたは他の指定されたビデオプレイヤーの識別子。

Note: 現在、Ooyala mobile SDKs(AndroidおよびiOS)はplayer_idを送信しません。モバイルSDKのplayer_idの属性は「不明」になります。

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