概要：ディメンション、フィールド、パラメータ

寸法とフィールド

ディメンションは、分析の主要データバケットです。個々のディメンションの完全なガイドを表示するには、下のリストのディメンション名をクリックします。

以下のディメンションを選択して、返されるフィールドを確認します。また、 リクエストを作成する ボタンをクリックしてサンプルリクエストを行い、結果を確認します。互換性のない複数のディメンションを選択すると、その旨のメッセージが表示されます。

注：フィールドを返すことはできません video.custom_fieldsしかし、場合によっては できる リターン video.custom_fields.{field_name}。これは以下に表されますが、 {field_name} 実際のフィールド名ではないため、サンプルリクエストでは使用されません。

入力

報告するディメンションを選択：

戻るフィールド：

（サンプルのBrightcoveアカウントを使用）

のデータ ad_mode_begin, ad_mode_complete＆ play_request 06-13-2016を起動すると利用可能です。

出力

最古の `from` このディメンションの組み合わせの日付：

サンプルAPIリクエスト：

応答データ

  Response will appear here...

ノート

デフォルトでは、 video_view 返される唯一のフィールドです。他のフィールドは、そのフィールドの値に指定されている場合のみ返されます。 fields パラメータに一致する最初のデバイスのリモートコントロール URL を返します。
ディメンションまたはディメンションの組み合わせでサポートされていない返されるフィールドを指定すると、 UNSUPPORTED_FIELD_COMBINATION_ERROR エラーが返されます。
　 bytes_delivered フィールドにはすべてのデータが含まれますlive赤で Video Cloud ビデオデータ、画像、テキストトラック、その他のアセット、および player コード自体。このデータの一部はCDNから取得され、最大3日間利用できない場合があります。
表示されているフィールドに加えて video ディメンション、返すこともできます video.custom_fields.{field_name}

リクエストの例

複数のディメンションに関するレポートを取得する典型的な使用例：デスクトップデバイスとモバイルデバイスの間のビデオビューの内訳と、iOSとAndroidデバイスのモバイルデバイスビューの数、デスクトップの数ビューはMacとWindowsマシンの間にありました。現在のところ、Studio Analytics Moduleにはこの情報を提供する標準レポートはありませんが、これを使用して取得できます Analytics API コール：

  https://analytics.api.brightcove.com/v1/data?accounts=57838016001&dimensions=video,device_type,device_os&from=2014-01-01&to=2014-04-01&fields=video_view

（この場合、1月の1から1の4月の2014までの期間の動画再生をリクエストしています）。

cURLを使用した例

APIを試してみたい curlここにいくつかのノートがあります：

あなたはまずアクセストークン
リクエストのURLには常に URLパラメータ、引用符で囲む必要があります（単一または二重）

サンプル

サンプルのcURLコマンドを次に示します。

  curl -s --header "Authorization: Bearer $ACCESS_TOKEN" \
  "https://analytics.api.brightcove.com/v1/data?accounts=$ACCOUNT_ID&dimensions=video&from=2017-04-04&limit=100"

交換した場合 $ACCESS_TOKEN 有効なアクセストークンを使用して $ACCOUNT_ID あなたのアカウントIDで、このリクエストは機能するはずです。あなたが使用できることに注意してくださいこのサンプルアプリアクセストークンを生成します。

サポートされている寸法の組み合わせ

クイックリファレンスとして、以下の表は、サポートされているかどうかの次元の組み合わせを示しています。 2つ以上のディメンションを使用できるケースがいくつかあることに注意してください。あなたはこれらを寸法とフィールド上のツール。

サポートされている次元の組み合わせ
	`account`	`browser_type`	`city`	`country`	`date`	`date_hour`	`destination_domain`	`destination_path`	`device_os`	`device_manufacturer`	`device_type`	`live_stream`	`player`	`referrer_domain`	`region`	`search_terms`	`social_platform`	`source_type`	`video`
`account`	N / A
`browser_type`		N / A
`city`			N / A
`country`				N / A
`date`					N / A
`date_hour`						N / A
`destination_domain`							N / A
`destination_path`								N / A
`device_os`									N / A
`device_manufacturer`										N / A
`device_type`											N / A
`live_stream`												N / A
`player`													N / A
`referrer_domain`														N / A
`region`															N / A
`search_terms`																N / A
`social_platform`																	N / A
`source_type`																		N / A
`video`																			N / A

パラメーター

以下の表は、 Analytics API。パラメータの使用については、以降のセクションで詳しく説明します。

パラメーター	必須	説明	価値観	デフォルト

アカウント

　 Video Cloud レポートを作成するアカウントは、 accounts パラメータ。たとえば、次のように

  https://analytics.api.brightcove.com/v1/data?accounts={account1_id,account2_id}

フィルタの場所

フィルタの一般的な構文は次のとおりです。

where=dimension1==value1;dimension2==value2

例：

https://analytics.api.brightcove.com/v1?accounts=account_id(s)&dimensions=device_type&where=video==video_id;device_type==tablet

カンマは論理ORとして扱われ、セミコロンは論理ANDとして扱われます。例えば、 where=video==1234,5678;player==9876 「ビデオ= 1234」と解釈されます OR 5678 そして player = 9876 "

スペースと特殊文字

文字列値はURIエンコードされている必要があります。また、 ""を使って特殊文字をエスケープすることもできます：

where=search_terms==boston,%20ma

フィルタとして任意のディメンションを使用できます焙煎が極度に未発達や過発達のコーヒーにて、クロロゲン酸の味わいへの影響は強くなり、金属を思わせる味わいと乾いたマウスフィールを感じさせます。のみそのディメンションが dimensions あなたは要求しています。

動画のプロパティによるフィルタリング

特別な使用 where=video.q=={property}:{value} フィルタを使用すると、次のようなさまざまなプロパティに基づいて、特定のビデオセットにレポートを制限できます。

タグ
reference_id
custom_fields ^【1]
{a_specific_custom_field}
created_at

ノート

^【1] 基本的な構文は次のとおりです。 where=video.q==custom_fields:value （任意のカスタムフィールドの値に一致）または where=video.q==myfield:value （特定のカスタムフィールドの値と一致します myfield）。特定のカスタムフィールドを検索している場合は、 内部名、表示名ではありません：

あなたが正しい名前を使用しているかどうかを1つの簡単なチェック：内部の名前は すべて小文字で、空白は含まれません。.

例

いくつかの例があります where タグとカスタムフィールドで検索するためのフィルタ：

シングルタグ

where=video.q==tags:foo

複数のタグ：

where=video.q==tags:foo,bar

カスタムフィールド

where=video.q==custom_fields:foo

タグとカスタムフィールド

where=video.q==tags:foo,bar+custom_fields:fish

なお、 video.q 検索機能には以下が含まれます AND, OR および NOT 次のようなロジック：

A + （プラス）検索語の前の記号は結果を意味します しなければなりません この用語を含めます。
A - 検索語の前の（マイナス）記号は結果を意味します してはいけません この用語を含めます。
プラス記号もマイナス記号もない場合、結果にはこの用語が含まれる場合と含まれない場合があります。

次の例は、このロジックの使用法を示しています。

検索の例
`where` フィルタ	成果
`where=video.q==tags:red%20tags:blue%tags:green`	タグ付きの動画 `red` OR `blue` OR `green` 返されます
`where=video.q==+tags:red%20tags:blue%tags:green`	返される動画にはタグが必要です `red` ANDにはタグが付いている場合があります `blue` OR `green`
`where=video.q==+tags:red%20tags:blue%-tags:green`	返される動画にはタグが必要です `red` ANDにはタグが付いている場合があります `blue`、ただしタグを付けないでください `green`

注意： %20 上記の例では、URIエンコードされたスペースです。リクエストを行うために使用するクライアントによっては、エンコードする必要がある場合もあります + として署名 %2B.

このクエリ構文の詳細については、「使い方 CMS API：ビデオを検索する.

フィルターと許容値の要約

次の表に、フィルタとして使用される各ディメンションの許容値を示します。

ディメンションフィルタ	許容値

期間

指定された日付範囲 from および to すべてのタイプのレポートのパラメータは、さまざまな形式で指定できます。

テキスト値：
- to=now （利用可能で、すべての要求のデフォルト値）
エポック時間の値（ミリ秒単位） 1377047323000
ISO 8601標準国際日付形式で表される日付： YYYY-MM-DDフォーマット 2013-09-12。この形式で表される日付の場合：
- 指定された日付範囲はすべて解釈されます アカウントのタイムゾーンに設定
- 与えられた日付の時刻は真夜中（ 00:00:00）指定日に アカウントのタイムゾーンに設定
相対日付：あなたは to および from 値をd（日）またはh（時間）で表します。例えば：
- from=2015-01-01&to=31d
- from=-48h&to=now
- from=-2d&to=now （前の例と同じ結果が得られます）
- from=-365d&to=2014-12-31
負の数（-2d）は「前」（他の値）と解釈され、正の数（48h）は「元」（他の値）として扱われることに注意してください。

1日の「動画」などのディメンションに関するレポートを生成するには、開始日と終了日をその日に設定します。

...&dimensions=video&from=2013-11-01&to=2013-11-01

限界とオフセット

　 limit 返される項目の数です（デフォルト：10）。すべての商品を返品するには、 limit=all. offset スキップする項目の数です（デフォルト：0）。あなたは使うことができます limit および offset 一緒に結果をページングするアプリケーションを作成します。

リコンサイルデータ

　 reconciled パラメータはブール値です。設定されている場合 true結果は、調整されたデータに限定されます。もし false結果はリアルタイム（時間単位の未調整）データに限定されます。

リアルタイムデータは、以前の32日のみ利用可能です。設定した場合 reconciled=false と from 32日前より前の日付では、その時点で未照合データがないため、APIはデータを返しません。

地理的なレポート

地理的分析のための寸法

country - ISO-3611-1国コード。例： 'US'
region - ISO-3611-2地域コードとして。例： 'US-WA'
city - 市の名前。例：シアトル

注：未知の国または地域の場合、APIはコードとして「ZZ」を返します（ISO-3611-alpha2に準拠）。

フィールドとソート

使用 fields パラメータを使用して、返すフィールドを指定します。デフォルトでは、 video_view レポートされているディメンションに対応するフィールドが返されます（例： destination_domain）が返されます。見る寸法とフィールド詳細はこちら

使用 sort 戻り値の項目をソートするために使用されるメトリックフィールドを指定するパラメータ。例えば： sort=video_view。並べ替え順序を反転するには、並べ替えフィールドを無効にします。 sort= -video_view

戻り値またはソート可能なフィールドは、メトリクスレポートしているディメンションに返されます。これらのパラメータは厳密に検証されます。 fields or sort パラメータが要求に有効でないフィールドを指しています。

動画ディメンションレポートの場合、有効なソート値には動画メタデータフィールドが含まれます。 video.name, video.reference_id＆ video.tags.

video_nameとvideo.nameの比較

video_name アナリティクスデータに記録されている動画名です
video.name ビデオメタデータ内の動画名です

ほとんどの場合、2つの値は同じになりますが、そうでない場合があります。

場合によっては、 video.nameしかし、そうではない video_name - この場合、何らかの理由で動画名がアナリティクスデータコレクターに送信されませんでした
場合によっては、値が異なる場合があります。この場合、動画の名前が変更されていることがあります。 video.name あなたの中のビデオの現在の名前です Video Cloud メディアライブラリ。 video_name データがアナリティクスデータコレクタに送信された時点での動画の動画名です（名前が変更された期間をクエリすると、APIによって返される値は大半のビューに関連付けられた名前になります）その期間中）。

計算フィールド

次の構文を使用して、計算されたフィールドをAPIリクエストに追加できます。

fields=calulated_field_name:expression

計算フィールドを使用して、既存のメトリックから独自のカスタムフィールドを作成したり、既存のフィールドの名前を変更したりすることができます。

計算されたフィールドの名前は、URIと互換性のある任意の文字列にすることができます。式には、通常のフィールド名と次の算術演算子を含めることができます。

+ （添加）
- （減算）
* （乗算）
/ （分割）
^ （指数）
() （括弧）

例

fields=avg_seconds_viewed:video_seconds_viewed/video_view,video.name

fields=avg_incomplete_ads:(ad_mode_begin-ad_mode_complete)/video_view,video.name

fields=Video%20Views:video_view,video.name

サンプルリクエスト

https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=video&fields=avg_seconds_viewed:video_seconds_viewed/video_view,video_seconds_viewed,video.name&sort=-video_view&limit=4

サンプルレスポンス（上記のリクエストに対する）

{
  "item_count": 110,
  "items": [
    {
      "avg_seconds_viewed": 2152.2519913106444,
      "video.name": "Flamingos",
      "video_seconds_viewed": 2972260,
      "video": "4825279519001",
      "video_view": 1381
    },
    {
      "avg_seconds_viewed": 14.016225448334756,
      "video.name": "Tiger",
      "video_seconds_viewed": 16413,
      "video": "4093643993001",
      "video_view": 1171
    },
    {
      "avg_seconds_viewed": 12.06,
      "video.name": "Zebra",
      "video_seconds_viewed": 9045,
      "video": "3851389913001",
      "video_view": 750
    },
    {
      "avg_seconds_viewed": 23.343065693430656,
      "video.name": "Sea-SeaTurtle",
      "video_seconds_viewed": 15990,
      "video": "1754276205001",
      "video_view": 685
    }
  ],
  "summary": {
    "avg_seconds_viewed": 274.27374399301004,
    "video_seconds_viewed": 3139063,
    "video_view": 11445
  }
}

ページ内容

概要：ディメンション、フィールド、パラメータ

寸法とフィールド

報告するディメンションを選択：

戻るフィールド：すべてを選択します。すべての選択を解除

最古の from このディメンションの組み合わせの日付：

サンプルAPIリクエスト：

応答データ

ノート

リクエストの例

cURLを使用した例

サンプル

サポートされている寸法の組み合わせ

パラメーター

アカウント

フィルタの場所

スペースと特殊文字

動画のプロパティによるフィルタリング

ノート

例

シングルタグ

複数のタグ：

カスタムフィールド

タグとカスタムフィールド

フィルターと許容値の要約

期間

限界とオフセット

リコンサイルデータ

地理的なレポート

地理的分析のための寸法

フィールドとソート

計算フィールド

例

サンプルリクエスト

サンプルレスポンス（上記のリクエストに対する）

戻るフィールド：

最古の `from` このディメンションの組み合わせの日付：