- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- AdEvent
- EventType
- EventSubtype
- AdType
- AdFormat
- AdPlacement
- TargetingType
- PlatformType
- Plataforma
- AttributionHint
- ViewabilityInfo
- ViewType
- MediaQuartile
- Pruébalo
Sube una lista de recursos AdEvent a Google Analytics.
Esta función solo está disponible para las cuentas incluidas en la lista de entidades permitidas.
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 ( |
| Campos | |
|---|---|
adEvents[] |
Obligatorio. Obligatorio (al menos 1). Es una lista de eventos de anuncios. |
encryptionInfo |
Opcional. Es información sobre las claves de encriptación que se usan para encriptar los datos. |
validateOnly |
Opcional. Si es verdadero, la solicitud se valida, 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 ( |
| Campos | |
|---|---|
advertiserId |
Obligatorio. Es el ID del anunciante para el evento del anuncio. Debe coincidir con el ID que se envió en el flujo de vinculación. |
eventType |
Obligatorio. El tipo de evento. |
timestamp |
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: |
eventId |
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 |
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 encontrar una coincidencia. |
deviceInfo |
Opcional. Es la información recopilada sobre el dispositivo que se usaba cuando ocurrió el evento del anuncio. |
mobileDeviceId |
Opcional. Es el ID del dispositivo en el que se publicó el anuncio. |
campaignId |
Obligatorio. Es el ID de la campaña asociada. |
campaignName |
Obligatorio. Es el nombre de la campaña asociada. |
adGroupId |
Opcional. Es el ID del grupo de anuncios asociado. |
adId |
Opcional. Es el ID del anuncio asociado dentro del grupo. |
adHeight |
Opcional. Altura del anuncio en píxeles. |
adWidth |
Opcional. Es el ancho del anuncio en píxeles. |
regionCode |
Obligatorio. Es el país y la subdivisión según la norma ISO 3166-2. |
source |
Obligatorio. Es la fuente de la plataforma del anuncio, similar a la fuente de Google Analytics. |
medium |
Obligatorio. Es el medio del anuncio, similar al medio de Google Analytics. |
attributionHint |
Opcional. Es el estado de atribución que se supone para este evento del anuncio. Esto 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 |
Obligatorio. Son los detalles de la visibilidad del anuncio publicado. |
Campo de unión Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. |
|
eventSubtype |
Es el valor de enumeración para el subtipo de evento. |
eventSubtypeString |
Es el valor de cadena del subtipo de evento. |
Campo de unión Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. |
|
adType |
Es el valor de enumeración para el tipo de anuncio. |
adTypeString |
Es el valor de cadena del tipo de anuncio. |
Campo de unión Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. |
|
adFormat |
Es el valor de enumeración para el formato del anuncio. |
adFormatString |
Es el valor de cadena para el formato del anuncio. |
Campo de unión Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. |
|
adPlacement |
Es el valor de enumeración para la posición del anuncio. |
adPlacementString |
Es el valor de cadena para la posición del anuncio. |
Campo de unión Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. |
|
targetingType |
Es el valor de enumeración para el tipo de segmentación. |
targetingTypeString |
Es el valor de cadena del tipo de segmentación. |
Campo de unión Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. |
|
platformType |
Es el valor de enumeración para el tipo de plataforma. |
platformTypeString |
Es el valor de cadena para el tipo de plataforma. |
Campo de unión Se acepta una cadena sin procesar para controlar valores que no sean enumeraciones puras. Se prefiere el enum si es posible. |
|
platform |
Es el valor de enumeración para la plataforma. |
platformString |
Es el valor de cadena para la plataforma. |
measurementAllowed |
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 |
Tipo de evento sin especificar. |
EVENT_TYPE_VIEW |
Ver 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 el 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 |
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 |
Formato de anuncio no especificado. |
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_CAROUSEL |
Anuncio de carrusel. |
AD_FORMAT_COLLECTION |
Es un anuncio de colección. |
AD_FORMAT_IMAGE |
Anuncios gráficos. |
AD_FORMAT_INTERACTIVE |
Es un 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 colocación del anuncio. |
AD_PLACEMENT_DISCOVER |
Posición de Descubrimiento |
AD_PLACEMENT_FEED |
Es la posición del feed. |
AD_PLACEMENT_FOOTER |
Ubicación del pie de página |
AD_PLACEMENT_HEADER |
Es la posición del encabezado. |
AD_PLACEMENT_HOME |
Posición en la página principal |
AD_PLACEMENT_IN_CONTENT |
Posición dentro del contenido. |
AD_PLACEMENT_PROMOTED |
Es una posición promocionada. |
AD_PLACEMENT_SEARCH |
Es la posición de búsqueda. |
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 |
Es la 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 |
Es un tipo de plataforma sin especificar. |
PLATFORM_TYPE_MOBILE |
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 |
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 |
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 ( |
| Campos | |
|---|---|
viewType |
Obligatorio. El tipo de evento. |
viewablePercent |
Opcional. Es el porcentaje numérico (de 0 a 100) de los píxeles que se pudieron ver. |
viewableDuration |
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 “ |
mediaSkippable |
Opcional. Indica si el contenido multimedia del anuncio se podía omitir o no. |
mediaQuartile |
Opcional. Es la cantidad de contenido multimedia que se reprodujo en cuartiles discretos. |
mediaDuration |
Opcional. Es la duración del contenido multimedia del anuncio. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
mediaVolumePercent |
Opcional. Es el porcentaje numérico (de 0 a 100) del volumen de la reproducción de contenido multimedia. |
playbackDuration |
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 “ |
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. |