Sessions リクエスト sessions-request

POST
https://{uri}/api/v1/sessions

URI パラメーター

なし

リクエスト本文

リクエスト本文は、JSON である必要があり、このリクエスト本文の例と同じ構造である必要があります。

{
    "playerTime": {
        "playhead": 0,
        "ts": 1509045324153
    },
    "eventType": "sessionStart",
    "params": {
        "media.playerName": "sample-html5-api-player",
        "analytics.trackingServer": "<your-aa-tracking-server>",
        "analytics.reportSuite": "<your-aa-rsid>",
        "analytics.visitorId": "<your-userId>",
        "media.contentType": "VOD",
        "media.length": 60.39333333333333,
        "media.id": "MA API Sample Player",
        "visitor.marketingCloudOrgId": "<your-org-id>",
        "media.name": "ClickMe",
        "media.channel": "sample-channel",
        "media.sdkVersion": "va-api-0.0.0",
        "analytics.enableSSL": false
    },
    "customMetadata": {
        "myCustomData": "<your metadata>",
        "myCustomData2": "<your metadata>",
        ...
    },
    "qoeData": {
        "param1": "<your param-value>",
        "param2": "<your param-value>",
        ...
    }
}
  • playerTime (必須)

    • playhead - コンテンツがライブの場合、再生ヘッドはその日の現在の時間(秒)となる必要があります。0 < = 再生ヘッド < 86400。コンテンツが記録される場合、再生ヘッドはコンテンツの現在の秒数(0 < = 再生ヘッド < コンテンツの長さ)である必要があります。値には、浮動小数点数を使用できます。
    • ts - タイムスタンプはミリ秒単位、協定世界時(UTC)である必要があります。
  • eventType (必須)

    有効な値: sessionStart

  • params (必須)

  • customMetadata (オプション)

  • qoeData (オプション)

応答

HTTP/1.1 201 Created
Server: nginx/1.13.5
Date: Wed, 06 Dec 2017 19:14:51 GMT
Content-Type: application/octet-stream
Content-Length: 0
Location: /api/v1/sessions/bfcca2ca597a3c71bc03b4ce357833ad02b3570d262ecd0c595fcf8f2ae4df58
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: OPTIONS,POST,PUT
Access-Control-Allow-Headers: Content-Type
Access-Control-Expose-Headers: Location
Age: 0
Via: 1.1 wsg.sanjose08

Location: ヘッダー - /api/v1/ 部分は API バージョンを示します。[…]sessions/ の後の部分は、セッション ID です。

応答コード

HTTP 応答コード
説明
201
セッションが作成されました
400
正しくないリクエストです
500
サーバーエラー
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb