Method: adEvents.ingest

Faz upload de uma lista de recursos AdEvent para o Google Analytics.

Esse recurso está disponível apenas para contas em uma lista de permissões.

Solicitação HTTP

POST https://datamanager.googleapis.com/v1/adEvents:ingest

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Campos
adEvents[]

object (AdEvent)

Obrigatório. Obrigatório (pelo menos 1). Uma lista de eventos de anúncio.

encryptionInfo

object (EncryptionInfo)

Opcional. Informações sobre as chaves de criptografia usadas para criptografar os dados.

validateOnly

boolean

Opcional. Se for verdadeiro, a solicitação será validada, mas não executada.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/datamanager

AdEvent

Um evento de anúncio.

Representação JSON
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "campaignId": string,
  "campaignName": string,
  "adGroupId": string,
  "adId": string,
  "adHeight": integer,
  "adWidth": integer,
  "regionCode": string,
  "source": string,
  "medium": string,
  "attributionHint": enum (AttributionHint),
  "viewabilityInfo": {
    object (ViewabilityInfo)
  },

  // Union field event_subtype_oneof can be only one of the following:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of list of possible types for union field event_subtype_oneof.

  // Union field ad_type_oneof can be only one of the following:
  "adType": enum (AdType),
  "adTypeString": string
  // End of list of possible types for union field ad_type_oneof.

  // Union field ad_format_oneof can be only one of the following:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of list of possible types for union field ad_format_oneof.

  // Union field ad_placement_oneof can be only one of the following:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of list of possible types for union field ad_placement_oneof.

  // Union field targeting_type_oneof can be only one of the following:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of list of possible types for union field targeting_type_oneof.

  // Union field platform_type_oneof can be only one of the following:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of list of possible types for union field platform_type_oneof.

  // Union field platform_oneof can be only one of the following:
  "platform": enum (Platform),
  "platformString": string
  // End of list of possible types for union field platform_oneof.
  "measurementAllowed": boolean
}
Campos
advertiserId

string

Obrigatório. O ID do anunciante do evento de anúncio.

Ele precisa corresponder ao ID enviado no fluxo de vinculação.

eventType

enum (EventType)

Obrigatório. O tipo do evento.

timestamp

string (Timestamp format)

Obrigatório. Hora em que o evento ocorreu

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

eventId

string

Opcional. Um ID criado e gerenciado pelo autor da chamada que identifica exclusivamente esse evento.

Obrigatório se você quiser remover eventos de anúncio duplicados incluídos em várias solicitações. Caso contrário, esse campo é opcional.

userData

object (UserData)

Opcional. Vários dados fornecidos pelo usuário, representando o usuário a que o evento está associado.

É possível fornecer várias instâncias do mesmo tipo de dado (por exemplo, endereço de e-mail). Quanto mais dados forem fornecidos, maior será a probabilidade de uma correspondência ser encontrada.

deviceInfo

object (DeviceInfo)

Opcional. Informações coletadas sobre o dispositivo usado quando o evento de anúncio ocorreu.

mobileDeviceId

string

Opcional. O ID do dispositivo em que o anúncio foi veiculado.

campaignId

string

Obrigatório. O ID da campanha associada.

campaignName

string

Obrigatório. O nome da campanha associada.

adGroupId

string

Opcional. O ID do grupo de anúncios associado.

adId

string

Opcional. O ID do anúncio associado no grupo.

adHeight

integer

Opcional. A altura do anúncio em pixels.

adWidth

integer

Opcional. A largura do anúncio em pixels.

regionCode

string

Obrigatório. O país e a subdivisão de acordo com a norma ISO 3166-2.

source

string

Obrigatório. A plataforma de origem do anúncio, semelhante à origem do Google Analytics.

medium

string

Obrigatório. A mídia do anúncio, semelhante à mídia do Google Analytics.

attributionHint

enum (AttributionHint)

Opcional. O status de atribuição presumida pelo parceiro para esse evento de anúncio.

Isso funciona apenas como um indicador de como a atribuição presumida do parceiro foi realizada e não força um resultado final nos relatórios finais.

viewabilityInfo

object (ViewabilityInfo)

Obrigatório. Detalhes da visibilidade do anúncio veiculado.

Campo de união event_subtype_oneof. Opcional. Classificação adicional sobre o tipo de evento de anúncio.

Uma string bruta é aceita para processar valores diferentes dos enums puros. O enumerador é preferível, se possível. event_subtype_oneof pode ser apenas de um dos tipos a seguir:

eventSubtype

enum (EventSubtype)

Valor de enumeração para o subtipo de evento.

eventSubtypeString

string

Valor da string para o subtipo de evento.

Campo de união ad_type_oneof. Opcional. O tipo de anúncio veiculado.

Uma string bruta é aceita para processar valores diferentes dos enums puros. O enumerador é preferível, se possível. ad_type_oneof pode ser apenas de um dos tipos a seguir:

adType

enum (AdType)

Valor de enumeração para o tipo de anúncio.

adTypeString

string

Valor da string para o tipo de anúncio.

Campo de união ad_format_oneof. Opcional. O tipo de anúncio veiculado.

Uma string bruta é aceita para processar valores diferentes dos enums puros. O enumerador é preferível, se possível. ad_format_oneof pode ser apenas de um dos tipos a seguir:

adFormat

enum (AdFormat)

Valor de enumeração para o formato do anúncio.

adFormatString

string

Valor de string para o formato de anúncio.

Campo de união ad_placement_oneof. Opcional. A posição do anúncio veiculado.

Uma string bruta é aceita para processar valores diferentes dos enums puros. O enumerador é preferível, se possível. ad_placement_oneof pode ser apenas de um dos tipos a seguir:

adPlacement

enum (AdPlacement)

Valor de enumeração para a posição do anúncio.

adPlacementString

string

Valor da string para a posição do anúncio.

Campo de união targeting_type_oneof. Opcional. O tipo de segmentação usado para veicular o anúncio.

Uma string bruta é aceita para processar valores diferentes dos enums puros. O enumerador é preferível, se possível. targeting_type_oneof pode ser apenas de um dos tipos a seguir:

targetingType

enum (TargetingType)

Valor de enumeração para o tipo de segmentação.

targetingTypeString

string

Valor da string para o tipo de segmentação.

Campo de união platform_type_oneof. Opcional. O tipo de plataforma em que o anúncio foi veiculado.

Uma string bruta é aceita para processar valores diferentes dos enums puros. O enumerador é preferível, se possível. platform_type_oneof pode ser apenas de um dos tipos a seguir:

platformType

enum (PlatformType)

Valor de enumeração para o tipo de plataforma.

platformTypeString

string

Valor da string para o tipo de plataforma.

Campo de união platform_oneof. Opcional. Mais detalhes sobre a plataforma em que o anúncio foi veiculado.

Uma string bruta é aceita para processar valores diferentes dos enums puros. O enumerador é preferível, se possível. platform_oneof pode ser apenas de um dos tipos a seguir:

platform

enum (Platform)

Valor de enumeração para a plataforma.

platformString

string

Valor da string para a plataforma.

measurementAllowed

boolean

Opcional. Representa se a linha pode ser usada para fins de medição, conforme regido pelas leis de privacidade aplicáveis na jurisdição regional.

EventType

O tipo do evento.

Tipos enumerados
EVENT_TYPE_UNSPECIFIED Tipo de evento não especificado.
EVENT_TYPE_VIEW Ver evento.
EVENT_TYPE_CLICK Evento de clique.

EventSubtype

Classificação adicional sobre o tipo de evento de anúncio.

Tipos enumerados
EVENT_SUBTYPE_UNSPECIFIED Subtipo de evento não especificado.
EVENT_SUBTYPE_IMPRESSION Evento de impressão.
EVENT_SUBTYPE_ENGAGED_VIEW Evento de visualização engajada.
EVENT_SUBTYPE_ONSITE_CLICK Evento de clique no site.
EVENT_SUBTYPE_OUTBOUND_CLICK Evento de clique de saída.

AdType

O tipo de anúncio veiculado.

Tipos enumerados
AD_TYPE_UNSPECIFIED Tipo de anúncio não especificado.
AD_TYPE_DISPLAY Anúncio de display.
AD_TYPE_TEXT Anúncio de texto.
AD_TYPE_IMAGE Anúncio gráfico
AD_TYPE_RICH_MEDIA Anúncio rich media.
AD_TYPE_HTML Anúncio HTML.
AD_TYPE_AUDIO Anúncio em áudio.
AD_TYPE_VIDEO Anúncio em vídeo

AdFormat

O formato do anúncio veiculado.

Tipos enumerados
AD_FORMAT_UNSPECIFIED Formato de anúncio não especificado.
AD_FORMAT_AR Anúncio de RA.
AD_FORMAT_AUDIO Anúncio em áudio.
AD_FORMAT_BANNER Anúncio de banner.
AD_FORMAT_BUMPER Anúncio bumper.
AD_FORMAT_COLLECTION Anúncio de coleção.
AD_FORMAT_IMAGE Anúncio gráfico
AD_FORMAT_INTERACTIVE Anúncio interativo.
AD_FORMAT_INTERSTITIAL Anúncio intersticial.
AD_FORMAT_IN_FEED Anúncio in-feed.
AD_FORMAT_IN_STREAM Anúncio in-stream.
AD_FORMAT_IN_STREAM_SKIPPABLE Anúncio in-stream pulável.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Anúncio in-stream não pulável.
AD_FORMAT_NATIVE Anúncio nativo.
AD_FORMAT_SHORTS Anúncio do YouTube Shorts.
AD_FORMAT_STORY Anúncio de imagens sequenciais.
AD_FORMAT_SPONSORED Anúncio patrocinado.
AD_FORMAT_VIDEO Anúncio em vídeo

AdPlacement

A posição do anúncio veiculado.

Tipos enumerados
AD_PLACEMENT_UNSPECIFIED Posicionamento de anúncio não especificado.
AD_PLACEMENT_DISCOVER Descobrir a posição.
AD_PLACEMENT_FEED Posicionamento do feed.
AD_PLACEMENT_HEADER Posicionamento do cabeçalho.
AD_PLACEMENT_HOME Posicionamento na página inicial.
AD_PLACEMENT_IN_CONTENT Posicionamento no conteúdo.
AD_PLACEMENT_PROMOTED Posição promovida.
AD_PLACEMENT_STORY Posicionamento da história.

TargetingType

O tipo de segmentação usado para veicular o anúncio.

Tipos enumerados
TARGETING_TYPE_UNSPECIFIED Tipo de segmentação não especificado.
TARGETING_TYPE_AUDIENCE Segmentação por público-alvo.
TARGETING_TYPE_CONTEXTUAL Segmentação contextual.
TARGETING_TYPE_DEMOGRAPHIC Segmentação demográfica.
TARGETING_TYPE_DEVICE Segmentação por dispositivo.
TARGETING_TYPE_GEO Segmentação por área geográfica.
TARGETING_TYPE_INTEREST Segmentação por interesse.
TARGETING_TYPE_PURCHASE_INTENT Segmentação por intenção de compra.
TARGETING_TYPE_REMARKETING Segmentação de remarketing.

PlatformType

O tipo de plataforma em que o anúncio foi veiculado.

Tipos enumerados
PLATFORM_TYPE_UNSPECIFIED Tipo de plataforma não especificado.
PLATFORM_TYPE_MOBILE Plataforma para dispositivos móveis.
PLATFORM_TYPE_DESKTOP Plataforma de computador.
PLATFORM_TYPE_CTV Plataforma de smart TV.
PLATFORM_TYPE_PHONE Plataforma de smartphone.
PLATFORM_TYPE_TABLET Plataforma de tablet.

Plataforma

Mais detalhes sobre a plataforma em que o anúncio foi veiculado.

Tipos enumerados
PLATFORM_UNSPECIFIED Plataforma não especificada.
PLATFORM_IOS Plataforma iOS.
PLATFORM_ANDROID Plataforma Android.
PLATFORM_WEB Plataforma da Web.

AttributionHint

O status de atribuição presumida pelo parceiro para esse evento de anúncio.

Tipos enumerados
ATTRIBUTION_HINT_UNSPECIFIED Status de atribuição desconhecido.
ATTRIBUTION_HINT_CONVERTED Status de conversão.
ATTRIBUTION_HINT_NOT_CONVERTED Status "Não convertido".

ViewabilityInfo

Detalhes da visibilidade do anúncio veiculado.

Representação JSON
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Campos
viewType

enum (ViewType)

Obrigatório. O tipo do evento.

viewablePercent

integer

Opcional. A porcentagem numérica (0 a 100) dos pixels que estavam visíveis.

viewableDuration

string (Duration format)

Opcional. O tempo que o anúncio ficou visível.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

mediaSkippable

boolean

Opcional. Indica se a mídia do anúncio era pulável ou não.

mediaQuartile

enum (MediaQuartile)

Opcional. É a quantidade de mídia reproduzida como quartis discretos.

mediaDuration

string (Duration format)

Opcional. A duração da mídia do anúncio.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

mediaVolumePercent

integer

Opcional. A porcentagem numérica (0 a 100) do volume da reprodução de mídia.

playbackDuration

string (Duration format)

Opcional. A duração da reprodução da mídia do anúncio, independente de ter sido visível ou não.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

ViewType

O tipo do evento.

Tipos enumerados
VIEW_TYPE_UNSPECIFIED Tipo de visualização não especificado.
VIEW_TYPE_MRC_VIEWED MRC visualizado.
VIEW_TYPE_MRC_RENDERED MRC feita.

MediaQuartile

É a quantidade de mídia reproduzida como quartis discretos.

Tipos enumerados
MEDIA_QUARTILE_UNSPECIFIED Quartil de mídia não especificado.
MEDIA_QUARTILE_START Iniciar
MEDIA_QUARTILE_FIRST_QUARTILE Primeiro quartil.
MEDIA_QUARTILE_MIDPOINT Ponto médio.
MEDIA_QUARTILE_THIRD_QUARTILE Terceiro quartil.
MEDIA_QUARTILE_COMPLETE COMPLETE,