サポート問い合わせ先| システムステータス
ページコンテンツ

    概要:次元、フィールド、およびパラメーター

    ディメンションは、次の主要なデータカテゴリです。 Analytics APIデータレポート。このトピックでは、ディメンションの対話型ガイドと、ディメンションに対して返されるフィールドについて説明します。また、レポートで組み合わせることができるディメンションと、さまざまな組み合わせで使用できるフィールドも示しています。

    ディメンションとフィールド

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

     
     

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

    入力

    レポートするディメンションを選択します。

     
     

    返すフィールド:

     
     

    (サンプルのBrightcoveアカウントを使用)

    出力

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

     

    サンプルAPIリクエスト:

    応答データ

      Response will appear here...

    1. デフォルトでは、video_view返される唯一のフィールドです-他のフィールドは、の値で指定されている場合にのみ返されますfieldsパラメータ。
    2. ディメンションまたはディメンションの組み合わせでサポートされていない、返すフィールドを指定した場合、UNSUPPORTED_FIELD_COMBINATION_ERRORエラーが返されます。
    3. ザ・bytes_deliveredフィールドには、ビデオデータ、画像、テキストトラック、その他のアセットなど、Video Cloudによってクライアントに配信されるすべてのデータと、プレーヤーコード自体が含まれます。このデータの一部はCDNから取得されており、最大3日間利用できない場合があります。
    4. に表示されるフィールドに加えて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

    (この場合、2014年1月1日から4月1日までの期間のビデオ視聴をリクエストしています。)

    cURLの使用例

    を使用してAPIを試してみたい場合カール、ここにいくつかの注意事項があります:

    • 最初に取得する必要がありますアクセストークン
    • リクエストの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を使用すると、このリクエストは機能するはずです。使用できることに注意してくださいこのサンプルアプリアクセストークンを生成します。

    サポートされているディメンションの組み合わせ

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

    サポートされているディメンションの組み合わせ
      アカウント browser_type 日付 date_hour destination_domain destination_path device_os device_manufacturer デバイスタイプ live_stream プレイヤー referrer_domain 領域 検索ワード social_platform ソースの種類 動画
    account 該当しません Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes   Yes Yes Yes Yes   Yes Yes
    browser_type Yes 該当しません   Yes Yes Yes                          
    city Yes   該当しません Yes Yes Yes                 Yes        
    country Yes   Yes 該当しません Yes Yes     Yes   Yes   Yes           Yes
    date Yes Yes Yes Yes 該当しません   Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
    date_hour Yes Yes Yes Yes   該当しません Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
    destination_domain Yes       Yes Yes 該当しません           Yes           Yes
    destination_path Yes       Yes Yes   該当しません                      
    device_os Yes     Yes Yes Yes     該当しません       Yes   Yes       Yes
    device_manufacturer Yes       Yes Yes       該当しません                  
    device_type Yes     Yes Yes Yes         該当しません   Yes   Yes       Yes
    live_stream         Yes Yes           該当しません              
    player Yes     Yes Yes Yes Yes   Yes   Yes   該当しません Yes       Yes Yes
    referrer_domain Yes       Yes Yes             Yes 該当しません   Yes   Yes Yes
    region Yes   Yes Yes Yes Yes     Yes   Yes       該当しません        
    search_terms Yes       Yes Yes               Yes   該当しません   Yes  
    social_platform         Yes Yes                     該当しません   Yes
    source_type Yes       Yes Yes             Yes Yes   Yes   該当しません Yes
    video Yes     Yes Yes Yes Yes   Yes   Yes   Yes Yes     Yes Yes 該当しません

    パラメーター

    以下は、で利用可能なパラメータをまとめた表です。 Analytics API。パラメータの使用については、次のセクションで詳しく説明します。

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

    アカウント

    レポートが必要なVideoCloudアカウントは、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の場合」と解釈されますまたは 5678 そしてプレーヤー= 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)。特定のカスタムフィールドを検索する場合は、内部名、表示名ではありません:

    Internal Name vs Display Name
    内部名と表示名

    正しい名前を使用しているかどうかを簡単に確認します。内部名は次のようになります。すべて小文字で、スペースは含まれません

    ここにいくつかの例があります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検索機能には以下が含まれますANDORそしてNOT次のようなロジック:

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

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

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

    このクエリ構文の完全な説明については、を参照してください。 CMS APIの使用:ビデオを検索する

    フィルタと許容値の概要

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

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

    日付範囲

    で指定された日付範囲fromそしてtoすべてのタイプのレポートのパラメーターは、さまざまな形式で示すことができます。

    • テキスト値:
      • to=now(利用可能で、すべてのリクエストのデフォルト値)
    • エポック時間値 (ミリ秒単位)。1377047323000
    • ISO 8601標準の国際日付形式で表された日付:YYYY-MM-DDなどの形式2013-09-12。この形式で表現された日付の場合:
      • 指定された日付範囲はすべて解釈されます アカウントに設定されたタイムゾーンで
      • 日付を与える時間は、指定された日付の午前 0 時 ( 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)は「from」(他の値)として扱われることに注意してください。

    「ビデオ」などのディメンションに関するレポートを1日生成するには、値と値をその日付に設定します。

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

    制限とオフセット

    ザ・limit返されるアイテムの数です(デフォルト:10)。すべてのアイテムを返品するには、limit=alloffsetスキップするアイテムの数です(デフォルト:0)。limitoffsetとを併用して、結果をページスルーするアプリを作成できます。

    調整されたデータ

    ザ・reconciledパラメータはブール値です。に設定されている場合true、結果は調整されたデータに限定されます。場合false、結果はリアルタイム(1時間ごとに調整されていない)データに制限されます。

    地理的レポート

    地理分析のディメンション

    • country -ISO-3611-1国コードとして。例えば:'我ら'
    • region -ISO-3611-2地域コードとして。例えば:「US-WA」
    • city - 市の名前。例えば:シアトル

    注:不明な国または地域の場合、APIはコードとして「ZZ」を返します(ISO-3611-alpha2による)。

    フィールドと並べ替え

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

    使用sort返されたアイテムを並べ替えるために使用されるメトリックフィールドを指定するパラメータ。例えば:sort=video_view。ソートフィールドを否定することにより、ソート順を逆にすることができます。 sort= -video_view

    計算フィールド

    次の構文を使用して、計算フィールドを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

    リクエストの例

    サンプル応答(上記の要求に対する)

    {
      "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
      }
    }

    ページの最終更新日22 Sep 2021