Zum Hauptinhalt springen
POST
/
media-bridge
/
v1
/
events
/
attention-span
Crie um evento de atenção
curl --request POST \
  --url https://api.hubapi.com/media-bridge/v1/events/attention-span \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "mediaUrl": "<string>",
  "contactId": 123,
  "rawDataString": "<string>",
  "rawDataMap": {},
  "derivedValues": {
    "totalSecondsPlayed": 123,
    "totalPercentPlayed": 123
  },
  "externalId": "<string>",
  "mediaType": "VIDEO",
  "sessionId": "<string>",
  "pageId": 123,
  "pageName": "<string>",
  "occurredTimestamp": 123,
  "contactUtk": "<string>",
  "pageUrl": "<string>",
  "_hsenc": "<string>",
  "mediaBridgeId": 123,
  "mediaName": "<string>"
}'
{
  "mediaUrl": "<string>",
  "contactId": 123,
  "mediaType": "VIDEO",
  "sessionId": "<string>",
  "rawData": "<string>",
  "pageId": 123,
  "mediaBridgeObjectTypeId": "<string>",
  "pageName": "<string>",
  "pageObjectCoordinates": "<string>",
  "occurredTimestamp": 123,
  "providerId": 123,
  "portalId": 1234567,
  "totalPercentPlayed": 123,
  "totalSecondsPlayed": 123,
  "pageUrl": "<string>",
  "mediaBridgeId": 123,
  "percentRange": "<string>",
  "mediaBridgeObjectCoordinates": "<string>",
  "mediaName": "<string>"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • media_bridge.write

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
rawDataMap
object
required
​
mediaType
enum<string>
required
Available options:
VIDEO,
AUDIO,
DOCUMENT,
OTHER,
IMAGE
​
sessionId
string
required
​
occurredTimestamp
integer
required
​
mediaUrl
string
​
contactId
integer
​
rawDataString
string
​
derivedValues
object
​
externalId
string
​
pageId
integer
​
pageName
string
​
contactUtk
string
​
pageUrl
string
​
_hsenc
string
​
mediaBridgeId
integer
​
mediaName
string

Response

successful operation

​
contactId
integer
required

O ID do contato no sistema HubSpot que consumiu a mídia. Esse ID pode ser obtido utilizando a API "Obter contato por usertoken (utk) da HubSpot. A API também permite o fornecimento de um usertoken e fará automaticamente a conversão desse token em um ID de contato.

​
mediaType
enum<string>
required
Available options:
VIDEO,
AUDIO,
DOCUMENT,
OTHER,
IMAGE
​
sessionId
string
required
​
mediaBridgeObjectTypeId
string
required
​
occurredTimestamp
integer
required

O registro de data e hora em que esse evento ocorreu, em milissegundos desde a época.

​
providerId
integer
required
​
portalId
integer
required

O ID da conta da HubSpot.

Example:

1234567

​
totalPercentPlayed
number
required

A porcentagem da mídia que o usuário consumiu. Os provedores podem calcular esse valor de forma diferente, dependendo de como consideram as visualizações repetidas de uma mesma parte da mídia. Por esse motivo, a API não tentará validar o campo totalPercentWatched com base nas informações de intervalos de atenção do evento. Se esse valor estiver ausente, o HubSpot o calculará a partir do mapa de intervalos de atenção da seguinte forma: (número de intervalos com valor igual ou superior a 1)/(número total de intervalos).

​
mediaBridgeId
integer
required
​
percentRange
string
required
​
mediaBridgeObjectCoordinates
string
required
​
mediaName
string
required
​
mediaUrl
string
​
rawData
string

Estes são os dados brutos que fornecem as informações mais detalhadas sobre os intervalos da mídia e quantas vezes cada intervalo foi consumido pelo usuário. Por exemplo, para um vídeo de 10 segundos onde cada segundo representa um intervalo, se um visitante assistir aos primeiros 5 segundos do vídeo, depois reiniciar e assistir novamente aos 2 primeiros segundos, rawDataString será “0=2;1=2;2=1;3=1;4=1;5=0;6=0;7=0;8=0;9=0;”.

​
pageId
integer

O ID da página, se hospedada no HubSpot. Obrigatório para páginas do HubSpot.

​
pageName
string

Nome da página. Obrigatório se a página não estiver hospedada no HubSpot.

​
pageObjectCoordinates
string
​
totalSecondsPlayed
integer

Os segundos que um usuário passou consumindo a mídia. A media bridge calcula esse valor como totalPercentPlayed * mediaDuration. Se um provedor desejar que esse cálculo seja feito de forma diferente, ele pode fornecer o valor já calculado ao criar o evento.

​
pageUrl
string

O URL da página onde o evento ocorreu. Obrigatório se a página não estiver hospedada no HubSpot.

⌘I