すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:DescribeVodPlayerCollectData

    ドキュメントセンター

    ApsaraVideo VOD:DescribeVodPlayerCollectData

    最終更新日:Aug 06, 2025

    プレーヤー再生データの概要をクエリします。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vod:DescribeVodPlayerCollectData

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    タイプ

    必須 / 任意

    説明

    例
    AppId

    string

    必須

    アプリケーションの ID。

    app-1000000
    StartTime

    string

    必須

    クエリ対象の期間の開始時刻。時刻は UTC の yyyy-mm-ddThh:mm:ssZ 形式です。

    説明

    • 過去 1 年間の再生データをクエリできます。

    • 1 回のクエリで指定できる最大期間は 31 日間です。

    • 期間は左閉右開区間です。開始時刻を含み、終了時刻は含みません。 [StartTime, EndTime)。

    2025-06-24T00:55:06Z
    EndTime

    string

    必須

    クエリ対象の期間の終了時刻。時刻は UTC の yyyy-mm-ddThh:mm:ssZ 形式です。

    2025-06-05T15:59:59Z
    Interval

    string

    必須

    クエリの時間粒度。有効な値： 5m、 1h、 1d。StartTime と EndTime で指定された期間によって、サポートされる時間粒度は異なります。

    • 期間が 3 日以内の場合、このパラメータを 5m、 1h、または 1d に設定できます。

    • 期間が 4～7 日の場合、このパラメータを 1h または 1d に設定できます。

    • 期間が 7 日を超える場合、このパラメータを 1d に設定できます。

    1d
    TerminalType

    string

    必須

    端末タイプ。有効な値：

    • web：Web クライアント。

    • mobile：ネイティブクライアント。

    web
    Os

    string

    任意

    プレーヤーのオペレーティングシステム。このパラメータを指定すると、特定のオペレーティングシステムの再生データをクエリできます。有効な値には、Android、 iOS、 Harmony、 Windows、 MacOS、 Linux などがあります。有効な値は、端末タイプによって異なります。以下のリストは、マッピングを示しています。

    • native：Android、iOS、Harmony。

    • web：Android、iOS、Harmony、Windows、MacOS、Linux。

    複数のオペレーティングシステムは #_# で区切ってください。

    Android、iOS、Windows
    Metrics

    string

    必須

    メトリックタイプ。複数のメトリックを指定できます。最大 3 つのメトリックを指定できます。

    説明

    • パーセンテージ関連データの値は、10 進数形式で返されます。

    サービス品質 ( QoS ) メトリック：

    • Vv：再生回数。

    • RealVv：実際の再生回数。

    • FirstFrame：最初のフレームの待ち時間。

    • SecondPlayRate：1 秒以内に再生が開始される割合。

    • SlowPlayRate：再生開始が遅い割合。

    • StuckCountRate：途切れ回数に基づく途切れ率。

    • SeekDuration：シーク待ち時間。

    • StuckDuration100s：100 秒あたりの途切れ時間。

    • StuckCount100s：100 秒あたりの途切れ回数。

    • PlayFailRate：再生失敗率。

    • SeedFailRate：再生開始失敗率。

    • AvgPlayBitrate：平均再生ビットレート。

    • AvgStartBitrate：平均開始ビットレート。

    • ErrorCount100s：100 秒あたりのエラー数。

    体感品質 ( QoE ) メトリック：

    • Uv：ユニークビジター数 ( UV )。

    • AvgPerVv：1 人あたりの平均再生回数。

    • AvgVideoDuration：平均ビデオ再生時間。

    • AvgPerPlayDuration：1 人あたりの平均再生時間。

    • AvgPerCompletionVv：1 人あたりの平均完了再生回数。

    • CompletionVv：完了再生回数。

    • CompletionRate：完了率。

    • AvgPlayDuration：平均再生時間。

    • JumpRate5s：5 秒直帰率。

    Vv,Uv,AvgPerVv
    Period

    string

    任意

    前期間比分析の時間範囲。単位：日 ( d )。

    たとえば、このパラメータを 1d に設定すると、前期間比データの時間範囲は StartTime-1d から EndTime-1d になります。

    1d

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    レスポンスのスキーマ

    RequestId

    string

    リクエスト ID

    25818875-5F78-4AF6-D7393642CA58****
    DataList

    array<object>

    返されたデータのリスト。

    object

    Metric

    string

    返されたデータメトリック。

    Vv
    Value

    number

    返されたデータメトリックの値。

    100.0
    ValueRefer

    number

    返されたデータメトリックの前期間比の値。

    200.0
    ValueRatio

    number

    前期間比のパーセンテージ。

    0.5

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "DataList": [
    {
      "Metric": "Vv",
      "Value": 100,
      "ValueRefer": 200,
      "ValueRatio": 0.5
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Meter.ParamError Param Error:%s,Please Check Again.
    500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error.
    500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again.
    403 Meter.AuthError Authentication Failed,Please Try Again.
    502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。