Eventos de Mídia

Os eventos de mídia possibilitam avisar o RD Station sempre que um contato começa ou termina de consumir uma mídia (áudio ou vídeo).


Evento de Início do Playback de uma Mídia

O RD Station Marketing considera sempre o valor do atributo event_type MEDIA_PLAYBACK_STARTED como identificador do evento customizado. Esse evento é registrado sempre que ocorre o início do playback de uma mídia.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the media playback started event it should be sent as "MEDIA_PLAYBACK_STARTED".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
emailStringtrueLead email
nameStringfalseLead name
company_nameStringfalseLead's company name
company_siteStringfalseLead's company website
job_titleStringfalseLead's job title
personal_phoneStringfalseLead's phone
mobile_phoneStringfalseLead's mobile pgone
twitterStringfalseLead's Twitter
facebookStringfalseLead's Facebook
linkedinStringfalseLead's Linkedin
websiteStringfalseLead's website
media_typeStringtrueVideo or Audio
media_metadataStringfalseMedia (audio or video) URL
media_recorded_contentBooleanfalseTrue if this is a recording. False if it is live.
media_identifierStringtrueidentifier
media_categoryStringfalseMedia category
media_durationIntegerfalseMedia duration, in seconds.
media_published_date_timestampTimestampfalseDatetime of media publishing. Must be in RFC 3339 datetime format (example: '2019-03-15T15:00:00.05Z').
legal_basesArray of ObjectsfalseLegal Bases of the contact.

Request body example
{
  "event_type": "MEDIA_PLAYBACK_STARTED",
  "event_family":"CDP",
  "payload": {
    "email": "[email protected]",
    "name": "John Doe",
    "company_name": "Acme Inc",
    "company_site": "http://www.acme.inc",
    "job_title": "CTO",
    "personal_phone": "+551112341234",
    "mobile_phone": "+5511912341234",
    "twitter": "@johndoe",
    "facebook": "https://facebook.com/john.doe/",
    "linkedin": "https://www.linkedin.com/in/johndoe/",
    "website": "https://johndoe.com",
    "media_type": "Video",
    "media_metadata": "https://www.mycompany.com/videos/c9266675-f484-44a7-9ad1-e43a080a8545",
    "media_recorded_content": true,
    "media_identifier": "c9266675-f484-44a7-9ad1-e43a080a8545",
    "media_category": "Marketing",
    "media_duration": 58,
    "media_published_date_timestamp": "2019-03-15T14:53:42.928Z",
    "legal_bases": [
      {
        "category": "communications",
        "type": "consent",
        "status": "granted"
      }
    ]
  }
}

Legal Bases
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted or declined

Evento de Término do Playback de uma Mídia

O RD Station Marketing considera sempre o valor do atributo event_type MEDIA_PLAYBACK_STOPPED como identificador do evento customizado. Esse evento é registrado sempre que ocorre o término do playback de uma mídia.

Request body parameters
FieldTypeRequiredDescription
event_typeStringtrueThe event type that diferentiates the event. For the media playback stopped event it should be sent as "MEDIA_PLAYBACK_STOPPED".
event_familyStringtrueThe family of the event for processing purposes. It currently accepts only "CDP" as valid option.
emailStringtrueLead email
nameStringfalseLead name
company_nameStringfalseLead's company name
company_siteStringfalseLead's company website
job_titleStringfalseLead's job title
personal_phoneStringfalseLead's phone
mobile_phoneStringfalseLead's mobile pgone
twitterStringfalseLead's Twitter
facebookStringfalseLead's Facebook
linkedinStringfalseLead's Linkedin
websiteStringfalseLead's website
media_typeStringtrueVideo or Audio
media_metadataStringfalseMedia (audio or video) URL
media_recorded_contentBooleanfalseTrue if this is a recording. False if it is live.
media_identifierStringtrueidentifier
media_categoryStringfalseMedia category
media_durationIntegerfalseMedia duration, in seconds.
media_published_date_timestampTimestampfalseDatetime of media publishing. Must be in RFC 3339 datetime format (example: '2019-03-15T15:00:00.05Z').
media_finishedBooleanfalseIndicates if the media was watched or listened to the end.
media_user_interaction_durationIntegerfalseTime the user listend or watched the media. In seconds.
media_user_interaction_percentageIntegerfalsePercentage of the media that the user listend or watched.
media_user_interaction_date_timestampStringfalseDatetime of when the media was consumed. Must be in RFC 3339 datetime format (example: '2019-03-15T15:00:00.05Z').
legal_basesArray of ObjectsfalseLegal Bases of the contact.

Request body example
{
  "event_type": "MEDIA_PLAYBACK_STOPPED",
  "event_family":"CDP",
  "payload": {
    "email": "[email protected]",
    "name": "John Doe",
    "company_name": "Acme Inc",
    "company_site": "http://www.acme.inc",
    "job_title": "CTO",
    "personal_phone": "+551112341234",
    "mobile_phone": "+5511912341234",
    "twitter": "@johndoe",
    "facebook": "https://facebook.com/john.doe/",
    "linkedin": "https://www.linkedin.com/in/johndoe/",
    "website": "https://johndoe.com",
    "media_type": "Video",
    "media_metadata": "https://www.mycompany.com/videos/c9266675-f484-44a7-9ad1-e43a080a8545",
    "media_identifier": "c9266675-f484-44a7-9ad1-e43a080a8545",
    "media_category": "Marketing",
    "media_finished": true,
    "media_recorded_content": true,
    "media_duration": 58,
    "media_published_date_timestamp": "2019-03-11T14:53:42.928Z",
    "media_user_interaction_duration": 30,
    "media_user_interaction_percentage": 30,
    "media_user_interaction_date_timestamp":  "2019-03-15T14:53:42.928Z",
    "legal_bases": [
      {
        "category": "communications",
        "type": "consent",
        "status": "granted"
      }
    ]
  }
}

Legal Bases
FieldTypeValid Params
categoryStringcommunications
typeStringpre_existent_contract, consent, legitimate_interest, judicial_process, vital_interest or public_interest
statusStringgranted or declined