Zum Hauptinhalt springen
POST
/
media-bridge
/
v1
/
events
/
attention-span
Event vom Typ „Aufmerksamkeitsspanne“ erstellen
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>"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
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

Die ID des Kontakts im System von HubSpot, der die Medien aufgerufen hat. Kann mit der HubSpot-API „Kontakt nach usertoken (utk) abrufen“ abgerufen werden. Die API unterstützt auch die Angabe eines Benutzertokens und wandelt dieses automatisch in eine Kontakt-ID um.

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

Der Zeitstempel, zu dem dieses Event aufgetreten ist, in Millisekunden seit Beginn der Epoche.

​
providerId
integer
required
​
portalId
integer
required

Die ID des HubSpot-Accounts.

Example:

1234567

​
totalPercentPlayed
number
required

Der Prozentsatz der Medien, die der Benutzer aufgerufen hat. Die Berechnungsgrundlage ist je nach Anbieter verschieden, abhängig davon, wie wiederholte Aufrufe desselben Medienteils berücksichtigt werden. Aus diesem Grund versucht die API nicht, totalPercentWatched anhand der Informationen zur Aufmerksamkeitsspanne für das Event zu validieren. Wenn diese fehlt, berechnet HubSpot sie wie folgt aus der Aufmerksamkeitsspannen-Karte: (Anzahl der Spannen mit einem Wert von 1 oder mehr)/(Gesamtzahl der Spannen).

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

Rohdaten, die präzise Daten über die Medienspanne liefern und darüber, wie oft der Benutzer jede Spanne aufgerufen hat. Wenn beispielsweise ein Besucher bei einem 10-Sekunden-Video, bei dem jede Sekunde eine Spanne darstellt, die ersten 5 Sekunden des Videos ansieht, dann das Video neu startet und die ersten 2 Sekunden erneut ansieht, würde der resultierende „rawDataString“ wie folgt aussehen: „0=2;1=2;2=1;3=1;4=1;5=0;6=0;7=0;8=0;9=0;“.

​
pageId
integer

Die ID der Seite, wenn sie auf HubSpot gehostet wird. Erforderlich für HubSpot-Seiten.

​
pageName
string

Der Name der Seite. Erforderlich, wenn die Seite nicht auf HubSpot gehostet wird.

​
pageObjectCoordinates
string
​
totalSecondsPlayed
integer

Die Sekunden, die ein Benutzer mit dem Aufruf der Medien verbracht hat. Die Media Bridge berechnet diesen Wert als „totalPercentPlayed“*„mediaDuration“. Wenn ein Anbieter diesen Wert anders berechnen möchte, kann beim Erstellen des Events der vorab berechneten Wert angegeben werden.

​
pageUrl
string

Die URL der Seite, auf der ein Event aufgetreten ist. Erforderlich, wenn die Seite nicht auf HubSpot gehostet wird.

⌘I