curl --request POST \
--url https://api.hubapi.com/media-bridge/v1/events/attention-span \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mediaType": "AUDIO",
"occurredTimestamp": 123,
"rawDataMap": {},
"sessionId": "<string>",
"_hsenc": "<string>",
"contactId": 123,
"contactUtk": "<string>",
"derivedValues": {
"totalPercentPlayed": 123,
"totalSecondsPlayed": 123
},
"externalId": "<string>",
"externalPlayContext": "EMAIL",
"mediaBridgeId": 123,
"mediaName": "<string>",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageUrl": "<string>",
"rawDataString": "<string>"
}
'{
"contactId": 123,
"mediaBridgeId": 123,
"mediaBridgeObjectCoordinates": "<string>",
"mediaBridgeObjectTypeId": "<string>",
"mediaName": "<string>",
"mediaType": "AUDIO",
"occurredTimestamp": 123,
"percentRange": "<string>",
"portalId": 123,
"providerId": 123,
"sessionId": "<string>",
"totalPercentPlayed": 123,
"externalPlayContext": "EMAIL",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageObjectCoordinates": "<string>",
"pageUrl": "<string>",
"rawData": "<string>",
"totalSecondsPlayed": 123
}メディアの表示者の注意持続時間の詳細を含むイベントを作成します。
curl --request POST \
--url https://api.hubapi.com/media-bridge/v1/events/attention-span \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mediaType": "AUDIO",
"occurredTimestamp": 123,
"rawDataMap": {},
"sessionId": "<string>",
"_hsenc": "<string>",
"contactId": 123,
"contactUtk": "<string>",
"derivedValues": {
"totalPercentPlayed": 123,
"totalSecondsPlayed": 123
},
"externalId": "<string>",
"externalPlayContext": "EMAIL",
"mediaBridgeId": 123,
"mediaName": "<string>",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageUrl": "<string>",
"rawDataString": "<string>"
}
'{
"contactId": 123,
"mediaBridgeId": 123,
"mediaBridgeObjectCoordinates": "<string>",
"mediaBridgeObjectTypeId": "<string>",
"mediaName": "<string>",
"mediaType": "AUDIO",
"occurredTimestamp": 123,
"percentRange": "<string>",
"portalId": 123,
"providerId": 123,
"sessionId": "<string>",
"totalPercentPlayed": 123,
"externalPlayContext": "EMAIL",
"mediaUrl": "<string>",
"pageId": 123,
"pageName": "<string>",
"pageObjectCoordinates": "<string>",
"pageUrl": "<string>",
"rawData": "<string>",
"totalSecondsPlayed": 123
}サポートされる製品
必須スコープ
The access token received from the authorization server in the OAuth 2.0 flow.
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO Show child attributes
Show child attributes
EMAIL, EXTERNAL_PAGE successful operation
メディアを消費した、HubSpotのシステム内のコンタクトのID。これは、HubSpotのユーザートークン(utk)でコンタクトを取得するAPIを使用して取得できます。APIはユーザートークンの提供もサポートしており、コンタクトIDへの自動変換を処理します。
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO イベントが発生した時間のタイムスタンプ(エポックからの経過ミリ秒数)。
HubSpotアカウントのID。
ユーザーがメディアを消費したパーセンテージ。プロバイダーは、メディアの同じ部分が繰り返し消費された場合をどのように扱うかに応じて、異なる方法でこの値を計算できます。したがって、APIはイベントの注意持続時間の情報に対して、totalPercentWatchedの検証を試みません。このプロパティーがない場合、HubSpotは、注意持続時間マップから(値が1以上のスパンの数)/(スパンの合計数)を計算してこの値を求めます。
EMAIL, EXTERNAL_PAGE HubSpotでホスティングされている場合のページのID。HubSpotページに必須です。
ページの名前。ページがHubSpotでホスティングされていない場合必須です。
イベントが発生したページのURL。ページがHubSpotでホスティングされていない場合必須です。
メディアのスパンと、ユーザーが各スパンを消費した回数に関する最もきめ細かい情報を提供する未加工データです。例えば、10秒の動画で、各秒がスパンである場合、訪問者が動画の最初の5秒を視聴した後、動画を再生しなおして再び最初の2秒を視聴した場合、結果として生成されるrawDataStringは、"0=2;1=2;2=1;3=1;4=1;5=0;6=0;7=0;8=0;9=0;"になります。
ユーザーがメディアを消費した秒数。メディアブリッジはこれをtotalPercentPlayed*mediaDurationとして計算します。プロバイダーが別の計算方法を希望する場合は、イベントの作成時に事前計算済みの値を提供できます。