DescribePlayUserTotal - - Alibaba Cloud ドキュメントセンター

指定された時間範囲内の日次再生統計を照会します。再生統計には、総視聴回数、総視聴者数、総再生時間、および再生時間分布が含まれます。

操作説明

この操作は、中国 (上海) リージョンでのみ利用可能です。
この操作では、ApsaraVideo Player SDK を使用して再生された動画から収集された再生統計のみを照会できます。
当日の再生統計は、翌日の 09:00 (UTC+08:00) に生成されます。
2018 年 1 月 1 日以降に生成されたデータを照会できます。照会できる最大時間範囲は 180 日です。

今すぐお試しください

この 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:DescribePlayUserTotal

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	string	必須	照会する時間範囲の開始時刻。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は UTC である必要があります。	2016-06-29T13:00:00Z
EndTime	string	必須	照会する時間範囲の終了時刻。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は UTC である必要があります。説明終了時刻は開始時刻より後である必要があります。開始時刻と終了時刻の間隔は 180 日を超えることはできません。	2016-06-30T13:00:00Z

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	1FAFB884-D5A7-47D1-****-8928AA9C8720
UserPlayStatisTotals	object
UserPlayStatisTotal	array<object>	日次再生統計。
	array<object>
Date	string	日付。日付は yyyy-MM-dd 形式で表示されます。	20170120
PlayDuration	string	総再生時間。単位：ミリ秒。	9340070
PlayRange	string	再生時間の分布。	"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%"
VV	object	動画の総視聴回数。
Flash	string	Flash プレーヤーを使用して再生された動画の総視聴回数。	2
iOS	string	ApsaraVideo Player SDK for iOS を使用して再生された動画の総視聴回数。	0
HTML5	string	HTML5 プレーヤーを使用して再生された動画の総視聴回数。	2
Android	string	ApsaraVideo Player SDK for Android を使用して再生された動画の総視聴回数。	161
UV	object	ユニークビジターの総数。
Flash	string	Flash プレーヤーを使用するユニークビジターの総数。	1
iOS	string	ApsaraVideo Player SDK for iOS を使用するユニークビジターの総数。	0
HTML5	string	HTML5 プレーヤーを使用するユニークビジターの総数。	1
Android	string	ApsaraVideo Player SDK for Android を使用するユニークビジターの総数。	2

例

成功レスポンス

JSONJSON

{
  "RequestId": "1FAFB884-D5A7-47D1-****-8928AA9C8720",
  "UserPlayStatisTotals": {
    "UserPlayStatisTotal": [
      {
        "Date": "20170120",
        "PlayDuration": "9340070",
        "PlayRange": "\"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%\"",
        "VV": {
          "Flash": "2",
          "iOS": "0",
          "HTML5": "2",
          "Android": "161"
        },
        "UV": {
          "Flash": "1",
          "iOS": "0",
          "HTML5": "1",
          "Android": "2"
        }
      }
    ]
  }
}

エラーレスポンス

JSONJSON

{
    "RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
    "HostId":"vod.cn-shanghai.aliyuncs.com",
    "Code":"InvalidStartTime.Malformed",
    "Message":"Specified StartTime is malformed."
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.BeyondCurrent	EndTime beyond current time.
400	InvalidParamter	%s
400	InvalidEndTime.Mismatch	StartTime or EndTime is mismatch.

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

変更履歴

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