Method: adEvents.ingest

Sube una lista de recursos AdEvent a Google Analytics.

Esta función solo está disponible para las cuentas incluidas en una lista de entidades permitidas.

Encabezados de autorización:

Este método también requiere el siguiente encabezado para definir cómo la API autoriza el acceso a la solicitud:

  • login-account: (Obligatorio) Es el nombre del recurso de la cuenta del socio de datos en la que la Cuenta de Google de las credenciales es un usuario. Formato: accountTypes/DATA_PARTNER/accounts/{loginAccountId}

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación de gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Campos
adEvents[]

object (AdEvent)

Obligatorio. Obligatorio (al menos 1). Es una lista de eventos de anuncios.
encryptionInfo

object (EncryptionInfo)

Opcional. Es información sobre las claves de encriptación que se usan para encriptar los datos. Este campo se debe proporcionar cuando los eventos de anuncios contengan UserData.
validateOnly
(deprecated)

boolean

Opcional. Si es verdadero, se valida la solicitud, pero no se ejecuta.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

AdEvent

Es un evento de anuncio.

Representación JSON 
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "ipAddress": string,
  "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)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adType": enum (AdType),
  "adTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platform": enum (Platform),
  "platformString": string
  // End of mutually exclusive fields.
  "measurementAllowed": boolean
}
Campos
advertiserId

string

Obligatorio. Es el ID del anunciante para el evento del anuncio.

Debe coincidir con el ID enviado en el flujo de vinculación.
eventType

enum (EventType)

Obligatorio. El tipo de evento.
timestamp

string (Timestamp format)

Obligatorio. La hora en que ocurrió el evento.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
eventId

string

Opcional. Es un ID creado y administrado por la entidad que llama que identifica de forma única este evento.

Se requiere si deseas anular la duplicación de los eventos de anuncios que se incluyen en varias solicitudes. De lo contrario, este campo es opcional.
userData

object (UserData)

Opcional. Son varios fragmentos de datos proporcionados por el usuario que representan al usuario con el que se asocia el evento.

Es posible proporcionar varias instancias del mismo tipo de datos (p.ej., dirección de correo electrónico). Cuantos más datos proporciones, más probabilidades habrá de que se encuentre una coincidencia.
deviceInfo

object (DeviceInfo)

Obligatorio. Es la información recopilada sobre el dispositivo que se usaba cuando ocurrió el evento del anuncio.
ipAddress

string

Opcional. Es la dirección IP que se usa para la medición. Debe ser el mismo valor que DeviceInfo.ip_address. Déjalo en blanco si no quieres compartir la IP para la medición.
mobileDeviceId

string

Opcional. Es el ID del dispositivo en el que se publicó el anuncio.
campaignId

string

Obligatorio. Es el ID de la campaña asociada.
campaignName

string

Obligatorio. Es el nombre de la campaña asociada.
adGroupId

string

Opcional. Es el ID del grupo de anuncios asociado.
adId

string

Opcional. Es el ID del anuncio asociado dentro del grupo.
adHeight

integer

Opcional. Es la altura del anuncio en píxeles.
adWidth

integer

Opcional. Es el ancho del anuncio en píxeles.
regionCode

string

Opcional. Es el país y la subdivisión según la norma ISO 3166-2.
source

string

Obligatorio. Es la fuente de la plataforma del anuncio, similar a la fuente de Google Analytics.
medium

string

Obligatorio. Es el medio del anuncio, similar al medio de Google Analytics.
attributionHint

enum (AttributionHint)

Opcional. Es el estado de atribución que se supone para este evento del anuncio.

Solo actúa como un indicador de cómo se desarrolló la atribución supuesta del socio y no fuerza un resultado final en los informes finales.
viewabilityInfo

object (ViewabilityInfo)

Obligatorio. Son los detalles de la visibilidad del anuncio publicado.

Opcional. Es una clasificación adicional sobre el tipo de evento de anuncio.

Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
eventSubtype

enum (EventSubtype)

Es el valor de enumeración para el subtipo de evento.
eventSubtypeString

string

Es el valor de cadena del subtipo de evento.
Fin de los campos mutuamente excluyentes.

Opcional. Es el tipo de anuncio publicado.

Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
adType

enum (AdType)

Es el valor de enumeración para el tipo de anuncio.
adTypeString

string

Es el valor de cadena del tipo de anuncio.
Fin de los campos mutuamente excluyentes.

Opcional. Es el tipo de anuncio publicado.

Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
adFormat

enum (AdFormat)

Es el valor de enumeración del formato del anuncio.
adFormatString

string

Es el valor de cadena del formato del anuncio.
Fin de los campos mutuamente excluyentes.

Opcional. Es la posición del anuncio publicado.

Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
adPlacement

enum (AdPlacement)

Es el valor de enumeración para la posición del anuncio.
adPlacementString

string

Es el valor de cadena para la posición del anuncio.
Fin de los campos mutuamente excluyentes.

Opcional. Es el tipo de segmentación que se usa para publicar el anuncio.

Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
targetingType

enum (TargetingType)

Es el valor de enumeración del tipo de segmentación.
targetingTypeString

string

Es el valor de cadena del tipo de segmentación.
Fin de los campos mutuamente excluyentes.

Opcional. Es el tipo de plataforma en la que se publicó el anuncio.

Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
platformType

enum (PlatformType)

Es el valor de enumeración para el tipo de plataforma.
platformTypeString

string

Es el valor de cadena del tipo de plataforma.
Fin de los campos mutuamente excluyentes.

Opcional. Es un detalle adicional de la plataforma en la que se publicó el anuncio.

Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
platform

enum (Platform)

Es el valor de enumeración para la plataforma.
platformString

string

Es el valor de cadena para la plataforma.
Fin de los campos mutuamente excluyentes.
measurementAllowed

boolean

Opcional. Indica si se permite usar la fila para fines de medición, según lo regido por las leyes de privacidad aplicables dentro de la jurisdicción regional.

EventType

El tipo de evento.

Enums
EVENT_TYPE_UNSPECIFIED Es un tipo de evento sin especificar.
EVENT_TYPE_VIEW Ver el evento
EVENT_TYPE_CLICK Evento de clic.

EventSubtype

Es una clasificación adicional sobre el tipo de evento de anuncio.

Enums
EVENT_SUBTYPE_UNSPECIFIED Es el subtipo de evento no especificado.
EVENT_SUBTYPE_IMPRESSION Es un evento de impresión.
EVENT_SUBTYPE_ENGAGED_VIEW Es el evento de vista interesada.
EVENT_SUBTYPE_ONSITE_CLICK Es un evento de clic en el sitio.
EVENT_SUBTYPE_OUTBOUND_CLICK Es un evento de clic de salida.

AdType

Es el tipo de anuncio publicado.

Enums
AD_TYPE_UNSPECIFIED Es un tipo de anuncio sin especificar.
AD_TYPE_DISPLAY Es un anuncio gráfico.
AD_TYPE_TEXT Anuncio de texto.
AD_TYPE_IMAGE Anuncios gráficos.
AD_TYPE_RICH_MEDIA Es un anuncio rich media.
AD_TYPE_HTML Es un anuncio HTML.
AD_TYPE_AUDIO Anuncio de audio.
AD_TYPE_VIDEO Anuncios de video.

AdFormat

Es el formato del anuncio publicado.

Enums
AD_FORMAT_UNSPECIFIED Es un formato de anuncio sin especificar.
AD_FORMAT_AR Anuncio de RA.
AD_FORMAT_AUDIO Anuncio de audio.
AD_FORMAT_BANNER Anuncio de banner.
AD_FORMAT_BUMPER Anuncio bumper
AD_FORMAT_COLLECTION Es un anuncio de colección.
AD_FORMAT_IMAGE Anuncios gráficos.
AD_FORMAT_INTERACTIVE Anuncio interactivo.
AD_FORMAT_INTERSTITIAL Anuncio intersticial.
AD_FORMAT_IN_FEED Anuncio in-feed.
AD_FORMAT_IN_STREAM Anuncio in-stream.
AD_FORMAT_IN_STREAM_SKIPPABLE Anuncio in-stream que se puede omitir.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Anuncio in-stream que no se puede omitir.
AD_FORMAT_NATIVE Anuncio nativo.
AD_FORMAT_SHORTS Anuncio de Shorts.
AD_FORMAT_STORY Anuncio con historias.
AD_FORMAT_SPONSORED Anuncio patrocinado.
AD_FORMAT_VIDEO Anuncios de video.

AdPlacement

Es la posición del anuncio publicado.

Enums
AD_PLACEMENT_UNSPECIFIED No se especificó la posición del anuncio.
AD_PLACEMENT_DISCOVER Posición de Descubrir
AD_PLACEMENT_FEED Es la posición del feed.
AD_PLACEMENT_HEADER Es la posición del encabezado.
AD_PLACEMENT_HOME Ubicación en la página principal
AD_PLACEMENT_IN_CONTENT Es la posición dentro del contenido.
AD_PLACEMENT_PROMOTED Es una posición promocionada.
AD_PLACEMENT_STORY Ubicación de la historia

TargetingType

Es el tipo de segmentación que se usa para publicar el anuncio.

Enums
TARGETING_TYPE_UNSPECIFIED Es un tipo de segmentación sin especificar.
TARGETING_TYPE_AUDIENCE Orientación por público.
TARGETING_TYPE_CONTEXTUAL Segmentación contextual
TARGETING_TYPE_DEMOGRAPHIC Segmentación demográfica.
TARGETING_TYPE_DEVICE Segmentación por dispositivo
TARGETING_TYPE_GEO Segmentación geográfica
TARGETING_TYPE_INTEREST Segmentación por intereses
TARGETING_TYPE_PURCHASE_INTENT Segmentación por intención de compra
TARGETING_TYPE_REMARKETING Es la segmentación por remarketing.

PlatformType

Es el tipo de plataforma en la que se publicó el anuncio.

Enums
PLATFORM_TYPE_UNSPECIFIED Tipo de plataforma sin especificar.
PLATFORM_TYPE_MOBILE Es la plataforma para dispositivos móviles.
PLATFORM_TYPE_DESKTOP Plataforma de escritorio.
PLATFORM_TYPE_CTV Plataforma de CTV.
PLATFORM_TYPE_PHONE Plataforma del teléfono.
PLATFORM_TYPE_TABLET Plataforma de tablets.

Plataforma

Es un detalle adicional de la plataforma en la que se publicó el anuncio.

Enums
PLATFORM_UNSPECIFIED Es una plataforma sin especificar.
PLATFORM_IOS Plataforma de iOS.
PLATFORM_ANDROID Plataforma de Android.
PLATFORM_WEB Plataforma web.

AttributionHint

Es el estado de atribución que se supone para este evento del anuncio.

Enums
ATTRIBUTION_HINT_UNSPECIFIED Estado de atribución desconocido.
ATTRIBUTION_HINT_CONVERTED Es el estado de conversión.
ATTRIBUTION_HINT_NOT_CONVERTED Estado de no conversión.

ViewabilityInfo

Son los detalles de la visibilidad del anuncio publicado.

Representación JSON 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Campos
viewType

enum (ViewType)

Obligatorio. El tipo de evento.
viewablePercent

integer

Opcional. Es el porcentaje numérico (de 0 a 100) de los píxeles que eran visibles.
viewableDuration

string (Duration format)

Opcional. Es la cantidad de tiempo que el anuncio estuvo visible.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
mediaSkippable

boolean

Opcional. Indica si el contenido multimedia del anuncio se podía omitir o no.
mediaQuartile

enum (MediaQuartile)

Opcional. Es la cantidad de contenido multimedia que se reprodujo en cuartiles discretos.
mediaDuration

string (Duration format)

Opcional. Es la duración del contenido multimedia del anuncio.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
mediaVolumePercent

integer

Opcional. Es el porcentaje numérico (de 0 a 100) del volumen de la reproducción de contenido multimedia.
playbackDuration

string (Duration format)

Opcional. Es la duración de la reproducción del contenido multimedia del anuncio, independientemente de si fue visible o no.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

ViewType

El tipo de evento.

Enums
VIEW_TYPE_UNSPECIFIED Tipo de vista sin especificar.
VIEW_TYPE_MRC_VIEWED Se visualizó el MRC.
VIEW_TYPE_MRC_RENDERED Se renderizó el MRC.

MediaQuartile

Es la cantidad de contenido multimedia que se reprodujo en cuartiles discretos.

Enums
MEDIA_QUARTILE_UNSPECIFIED Cuartil de medios no especificado.
MEDIA_QUARTILE_START Comenzar.
MEDIA_QUARTILE_FIRST_QUARTILE Primer cuartil.
MEDIA_QUARTILE_MIDPOINT Es el punto medio.
MEDIA_QUARTILE_THIRD_QUARTILE Es el tercer cuartil.
MEDIA_QUARTILE_COMPLETE Completa.