DocumentaçãoAnalyticsGuia de serviços para mídia de streaming

ID da campanha

Última atualização: 29 de maio de 2026

Criado para:

  • Developer

Esta página aborda a coleta de dados para a variável ID da Campanha. Consulte ID da campanha para a dimensão de relatório correspondente.

style
shade-box

A variável ID da campanha identifica a campanha publicitária à qual o criativo pertence. Qualquer valor da string (normalmente uma ID de campanha da plataforma do servidor de anúncios) é aceitável. Use a variável para acumular engajamento em várias criações que compartilham uma campanha.

Propriedade
Valor
Variável de dados de contexto
a.media.ad.campaign
Campo da coleção XDM
xdm.mediaCollection.advertisingDetails.campaignID
Característica do Audience Manager
c_contextdata.a.media.ad.campaign
Obrigatório
Não
Enviado com
Início do anúncio e fechamento

Tipos de implementação recomendados

Web SDK

Definir campaignID dentro de xdm.mediaCollection.advertisingDetails ao chamar sendEvent:

code language-javascript 
alloy("sendEvent", {
  xdm: {
    eventType: "media.adStart",
    mediaCollection: {
      advertisingDetails: {
        name: "ad-2125",
        campaignID: "fall-2024"
      },
      sessionID: "{sid}",
      playhead: 0
    }
  }
});
iOS

Passe a ID da campanha como uma chave de metadados no argumento HashMap para trackEvent(AdStart). Use MediaConstants.AdMetadataKeys.CAMPAIGN_ID.

code language-swift 
var metadata: [String: String] = [:]
metadata[MediaConstants.AdMetadataKeys.CAMPAIGN_ID] = "fall-2024"

tracker.trackEvent(event: MediaEvent.AdStart, info: adObject, metadata: metadata)
Android

Passe a ID da campanha como uma chave de metadados no argumento HashMap para trackEvent(AdStart). Use MediaConstants.AdMetadataKeys.CAMPAIGN_ID.

code language-kotlin 
val metadata = HashMap<String, String>()
metadata[MediaConstants.AdMetadataKeys.CAMPAIGN_ID] = "fall-2024"

tracker.trackEvent(Media.Event.AdStart, adObject, metadata)
Roku

Definir campaignID dentro de xdm.mediaCollection.advertisingDetails ao chamar sendMediaEvent para media.adStart:

code language-brightscript 
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.adStart",
        "mediaCollection": {
            "advertisingDetails": {
                "name": "ad-2125",
                "campaignID": "fall-2024"
            },
            "playhead": 0
        }
    }
})
API do Media Edge

Chame o ponto de extremidade adStart com campaignID dentro de xdm.mediaCollection.advertisingDetails:

code language-json 
{
  "events": [{
    "xdm": {
      "eventType": "media.adStart",
      "mediaCollection": {
        "advertisingDetails": {
          "name": "ad-2125",
          "length": 15,
          "playerName": "Freewheel",
          "podPosition": 0,
          "campaignID": "fall-2024"
        },
        "sessionID": "{sid}",
        "playhead": 0
      }
    }
  }]
}

Tipos de implementação herdada (somente Analytics)

Media SDK JS 3.x

Passe a ID da campanha no objeto contextData usando ADB.Media.AdMetadataKeys.CampaignId:

code language-javascript 
var contextData = {};
contextData[ADB.Media.AdMetadataKeys.CampaignId] = "fall-2024";

tracker.trackEvent(ADB.Media.Event.AdStart, adInfo, contextData);
Chromecast

Defina a ID da campanha usando ADBMobile.media.AdMetadataKeys.CAMPAIGN_ID no objeto de metadados de anúncio padrão:

code language-javascript 
var adInfo = ADBMobile.media.createAdObject("Ford F-150", "ad-2125", 1, 30);
var standardAdMetadata = {};
standardAdMetadata[ADBMobile.media.AdMetadataKeys.CAMPAIGN_ID] = "fall-2024";
adInfo[ADBMobile.media.MediaObjectKey.StandardAdMetadata] = standardAdMetadata;
ADBMobile.media.trackEvent(ADBMobile.media.Event.AdStart, adInfo, null);
API da coleção de mídia

Incluir media.ad.campaignId no objeto params:

code language-json 
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "adStart",
  "params": {
    "media.ad.campaignId": "fall-2024"
  }
}

Consulte a Referência de eventos da API Media Collection para obter a estrutura de solicitação completa.

recommendation-more-help
media-analytics-help