Zum Hauptinhalt springen
POST
/
media-bridge
/
v1
/
events
/
attention-span
Créer un événement sur la capacité d'attention
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>"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubGratuit

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • 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

L’identifiant du contact dans le système HubSpot qui a consulté le média. Il peut être récupéré via l’API Obtenir le contact par l'usertoken (utk) de HubSpot. Cette API permet également de fournir un usertoken, qu’elle convertira automatiquement en ID de contact.

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

L'horodatage auquel cet événement s'est produit, en millisecondes depuis l'epoch.

​
providerId
integer
required
​
portalId
integer
required

L'ID du compte HubSpot.

Example:

1234567

​
totalPercentPlayed
number
required

Le pourcentage du contenu média consommé par l’utilisateur. Les fournisseurs peuvent le calculer différemment selon la manière dont ils prennent en compte les visionnages répétés d’une même portion du média. Pour cette raison, l’API ne tentera pas de valider la valeur du pourcentage total visionné par rapport aux informations de la carte d’attention de l’événement. Si cette valeur est absente, HubSpot la calculera à partir de la carte d’attention comme suit : (nombre de segments ayant une valeur supérieure ou égale à 1) ÷ (nombre total de segments).

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

Il s'agit des données brutes, qui fournissent les informations les plus détaillées sur les segments du média et le nombre de fois où chaque segment a été consulté par l'utilisateur. Par exemple, pour une vidéo de 10 secondes où chaque seconde constitue un segment, si un visiteur regarde les 5 premières secondes, puis redémarre la vidéo et regarde à nouveau les 2 premières secondes, la chaîne de données brutes résultante serait : “0=2;1=2;2=1;3=1;4=1;5=0;6=0;7=0;8=0;9=0;”.

​
pageId
integer

L'ID de la page, si elle est hébergée sur HubSpot. Requis pour les pages HubSpot.

​
pageName
string

Le nom de la page. Requis si la page n'est pas hébergée sur HubSpot.

​
pageObjectCoordinates
string
​
totalSecondsPlayed
integer

Le nombre de secondes pendant lesquelles un utilisateur a consommé le contenu média. Le module de liaison média calcule cette valeur en multipliant le pourcentage total visionné par la durée du média. Si un fournisseur souhaite utiliser un mode de calcul différent, il peut fournir la valeur pré-calculée lors de la création de l’événement.

​
pageUrl
string

L'URL de la page sur laquelle un événement s'est produit. Requis si la page n'est pas hébergée sur HubSpot.

⌘I