POST
/
media-bridge
/
v1
/
events
/
attention-span
Crear un evento de atención
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>"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubGratuito

​
Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • 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

ID del contacto del sistema de HubSpot que consumió el medio. Puede obtenerse mediante la API Get contact by usertoken (utk) de HubSpot . La API también admite el suministro de un usertoken y se encargará de convertirlo automáticamente en un ID de contacto.

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

La marca de tiempo en que este evento ocurrió, expresada en milisegundos desde Epoch.

​
providerId
integer
required
​
portalId
integer
required

El ID de la cuenta HubSpot.

Example:

1234567

​
totalPercentPlayed
number
required

El porcentaje de los medios que el usuario consumió. Los proveedores pueden calcularlo de manera diferente dependiendo de la forma en que consideren las visualizaciones repetidas de la misma sección del medio. Es por ello que la API no va a tratar de validar el totalPercentWatched (porcentaje total visualizado) con respecto a la información sobre el período de atención para el evento. En caso de que no esté, HubSpot lo calculará del mapa de períodos de atención así: (número de períodos con un valor igual a 1 o más)/(Número total de períodos).

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

Estos son los datos sin procesar que suministran la información más detallada sobre los períodos de los medios y sobre las veces que el usuario consumió cada período. Por ejemplo, para un video de 10 segundos en el que cada segundo es un período, si un visitante ve los primeros 5 segundos del mismo, luego reinicia el video y ve los primeros 2 segundos nuevamente, la cadena "rawDataString" resultante sería “0=2;1=2;2=1;3=1;4=1;5=0;6=0;7=0;8=0;9=0;”.

​
pageId
integer

El ID de la página, si está alojada en HubSpot. Se requiere para las páginas de HubSpot.

​
pageName
string

El nombre de la página. Se requiere si la página no está alojada en HubSpot.

​
pageObjectCoordinates
string
​
totalSecondsPlayed
integer

Los segundos que un usuario pasó consumiendo el medio. El centro multimedia lo calcula como totalPercentPlayed*mediaDuration. En caso de que un proveedor quiera que se calcule de otra forma, puede suministrar el valor pre-calculado cuando cree el evento.

​
pageUrl
string

La URL de la página en la que un evento ocurrió. Se requiere si la página no está alojada en HubSpot.