Method: events.ingest

Sube una lista de recursos Event del Destination proporcionado.

Solicitud HTTP

POST https://datamanager.googleapis.com/v1/events: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 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Campos
destinations[]

object (Destination)

Obligatorio. Es la lista de destinos a los que se enviarán los eventos.
events[]

object (Event)

Obligatorio. Es la lista de eventos que se enviarán a los destinos especificados. Se pueden enviar como máximo 2,000 recursos Event en una sola solicitud.
consent

object (Consent)

Opcional. Es el consentimiento a nivel de la solicitud que se aplica a todos los usuarios incluidos en la solicitud. El consentimiento a nivel del usuario anula el consentimiento a nivel de la solicitud y se puede especificar en cada Event.
validateOnly

boolean

Opcional. Solo con fines de prueba. Si es true, la solicitud se valida, pero no se ejecuta. Solo se devuelven errores, no resultados.
encoding

enum (Encoding)

Opcional. Es obligatorio para las cargas de UserData. Es el tipo de codificación de los identificadores de usuario. En el caso de los identificadores de usuario hasheado, este es el tipo de codificación de la cadena hasheada. En el caso de los identificadores de usuario con hash encriptados, este es el tipo de codificación de la cadena encriptada externa, pero no necesariamente de la cadena con hash interna, lo que significa que la cadena con hash interna podría estar codificada de una manera diferente a la cadena encriptada externa. En el caso de las cargas que no son de UserData, este campo se ignora.
encryptionInfo

object (EncryptionInfo)

Opcional. Es la información de encriptación para las cargas de UserData. Si no se configura, se supone que la información de identificación subida tiene codificación hash, pero no está encriptada. En el caso de las cargas que no son de UserData, este campo se ignora.

Cuerpo de la respuesta

Respuesta de IngestEventsRequest.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "requestId": string
}
Campos
requestId

string

Es el ID generado automáticamente de la solicitud.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Evento

Es un evento que representa una interacción del usuario con el sitio web o la aplicación de un anunciante.

Representación JSON 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "conversionValue": number,
  "conversionCount": number
}
Campos
destinationReferences[]

string

Opcional. Es la cadena de referencia que se usa para determinar el destino. Si está vacío, el evento se enviará a todos los destinations de la solicitud.
transactionId

string

Opcional. Es el identificador único de este evento. Se requiere para los eventos que se envían como una fuente de datos adicional para las conversiones de etiquetas.
eventTimestamp

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".
lastUpdatedTimestamp

string (Timestamp format)

Opcional. Fecha y hora en la que se actualizó el evento por última vez.

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".
userData

object (UserData)

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

object (Consent)

Opcional. Es información sobre si el usuario asociado proporcionó diferentes tipos de consentimiento.
adIdentifiers

object (AdIdentifiers)

Opcional. Identificadores y otra información que se utilizan para correlacionar el evento de conversión con otra actividad en línea (como los clics en anuncios)
currency

string

Opcional. Es el código de moneda asociado con todos los valores monetarios dentro de este evento.
eventSource

enum (EventSource)

Opcional. Es un indicador del lugar donde ocurrió el evento (Web, aplicación, en la tienda, etc.).
eventDeviceInfo

object (DeviceInfo)

Opcional. Es la información recopilada sobre el dispositivo que se usaba (si corresponde) cuando ocurrió el evento.
cartData

object (CartData)

Opcional. Es la información sobre la transacción y los artículos asociados con el evento.
customVariables[]

object (CustomVariable)

Opcional. Es información adicional de pares clave-valor que se envía a los contenedores de conversiones (acción de conversión o actividad de FL).
experimentalFields[]

object (ExperimentalField)

Opcional. Es una lista de pares clave-valor para los campos experimentales que, eventualmente, podrían promocionarse para formar parte de la API.
userProperties

object (UserProperties)

Opcional. Es la información sobre el usuario que evaluó el anunciante en el momento en que ocurrió el evento.
eventName

string

Opcional. El nombre del evento Es obligatorio para los eventos de GA4.
clientId

string

Opcional. Es un identificador único para la instancia de usuario de un cliente web de este flujo web de GA4.
userId

string

Opcional. Es un identificador único para un usuario, según lo define el anunciante.
additionalEventParameters[]

object (EventParameter)

Opcional. Es un bucket de cualquier parámetro del evento que se incluirá en el evento y que aún no se especificó con otros campos estructurados.
thirdPartyUserData

object (UserData)

Opcional. Es el mismo tipo de datos que se proporciona en userData, pero se marca explícitamente como datos proporcionados por un tercero y no como datos de origen del anunciante.
eventLocation

object (EventLocation)

Opcional. Es la información recopilada sobre la ubicación del usuario cuando ocurrió este evento.
appInstanceId

string

Opcional. Es un identificador único para la instancia del usuario de un cliente de la app para este flujo de la app de GA4.
conversionValue

number

Opcional. Es el valor de conversión asociado al evento para las conversiones basadas en el valor.
conversionCount

number

Opcional. Es la cantidad de conversiones asociadas al evento, para las conversiones basadas en el recuento.

AdIdentifiers

Identificadores y otra información que se utilizan para correlacionar el evento de conversión con otra actividad en línea (como los clics en anuncios)

Representación JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ]
}
Campos
sessionAttributes

string

Opcional. Son los atributos de sesión para el modelado y la atribución de eventos.
gclid

string

Opcional. Es el ID de clic de Google (gclid) asociado con este evento.
gbraid

string

Opcional. Es el identificador de clics para los clics asociados con los eventos de aplicaciones y que provienen de dispositivos iOS a partir de iOS 14.
wbraid

string

Opcional. Es el identificador de clics para los clics asociados con los eventos web y que provienen de dispositivos iOS a partir de iOS 14.
landingPageDeviceInfo

object (DeviceInfo)

Opcional. Es la información recopilada sobre el dispositivo que se usa (si corresponde) en el momento de acceder al sitio del anunciante después de interactuar con el anuncio.
mobileDeviceId

string

Opcional. Es el identificador de dispositivo móvil para anunciantes. Este sería el IDFA en iOS, el AdID en Android o los identificadores de anunciantes de otras plataformas.
dclid

string

Opcional. Es el ID de clic visible asociado a este evento.
impressionId

string

Opcional. Es el ID de impresión asociado con este evento.
matchId

string

Opcional. Es el campo de ID de coincidencia que se usa para unir este evento con un evento anterior.
encryptedUserIds[]

object (EncryptedUserId)

Opcional. Cualquier cantidad de IDs de usuario encriptados

EncryptedUserId

Es un identificador de usuario que se emite para la atribución. Todos los campos son obligatorios si se usa este parámetro.

Representación JSON 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Campos
encryptedId

string

Obligatorio. Es el ID alfanumérico encriptado.
entityType

enum (EncryptionEntityType)

Obligatorio. Es el tipo de entidad de encriptación. Debe coincidir con la configuración de encriptación para la publicación de anuncios o la Transferencia de datos.
entityId

string (int64 format)

Obligatorio. Es el ID de la entidad de encriptación. Debe coincidir con la configuración de encriptación para la publicación de anuncios o la Transferencia de datos.
source

enum (EncryptionSource)

Obligatorio. Describe si la cookie encriptada se recibió de la publicación de anuncios (la macro %m) o de Transferencia de datos.

EncryptionEntityType

Es el tipo de entidad de encriptación.

Enums
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Tipo de entidad de encriptación no especificado.
CAMPAIGN_MANAGER_ACCOUNT Cuenta de Campaign Manager 360
CAMPAIGN_MANAGER_ADVERTISER Es el anunciante de Campaign Manager 360.
DISPLAY_VIDEO_PARTNER Socio de Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Ser anunciante de Display & Video 360
GOOGLE_ADS_CUSTOMER Cliente de Google Ads
GOOGLE_AD_MANAGER_NETWORK_CODE Es el código de red de Google Ad Manager.

EncryptionSource

Es la fuente de encriptación.

Enums
ENCRYPTION_SOURCE_UNSPECIFIED Fuente de encriptación no especificada.
AD_SERVING Es la fuente de encriptación de la publicación de anuncios.
DATA_TRANSFER Es la fuente de encriptación de la transferencia de datos.

EventSource

Es la fuente del evento.

Enums
EVENT_SOURCE_UNSPECIFIED EventSource no especificado. No debe usarse nunca.
WEB El evento se generó desde un navegador web.
APP El evento se generó a partir de una app.
IN_STORE El evento se generó a partir de una transacción en la tienda.
PHONE El evento se generó a partir de una llamada telefónica.
MESSAGE El evento se generó a partir de un mensaje.
OTHER El evento se generó a partir de otras fuentes.

CartData

Son los datos del carrito asociados con el evento.

Representación JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
Campos
merchantId

string

Opcional. Es el ID de Merchant Center asociado con los artículos.
merchantFeedLabel

string

Opcional. Es la etiqueta de feed de Merchant Center asociada al feed de los artículos.
merchantFeedLanguageCode

string

Opcional. Es el código de idioma en ISO 639-1 asociado al feed de Merchant Center de los artículos donde se suben tus artículos.
transactionDiscount

number

Opcional. Es la suma de todos los descuentos asociados con la transacción.
items[]

object (Item)

Opcional. Es la lista de elementos asociados con el evento.
couponCodes[]

string

Opcional. Es la lista de códigos de cupón que se aplicaron al carrito. Los códigos de cupones a nivel del carrito y del artículo son independientes.

Si el evento es para un destino de Google Analytics, proporciona solo un código de cupón. Google Analytics ignora los códigos de cupón adicionales.

Elemento

Representa un elemento del carrito asociado al evento.

Representación JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
Campos
merchantProductId

string

Opcional. Es el ID del producto en la cuenta de Merchant Center.
quantity

string (int64 format)

Opcional. Es la cantidad de este elemento asociado con el evento.
unitPrice

number

Opcional. Es el precio por unidad sin impuestos, envío ni descuentos a nivel de la transacción.
itemId

string

Opcional. Es un identificador único para hacer referencia al elemento.
additionalItemParameters[]

object (ItemParameter)

Opcional. Es un bucket de cualquier parámetro del evento relacionado con un elemento que se incluirá en el evento y que no se especificó con otros campos estructurados.
merchantId

string

Opcional. Es el ID de Merchant Center asociado al artículo. En el caso de los eventos de Ventas en la tienda, se anulará el valor establecido a nivel del carrito. Este campo se ignora para otros eventos.
merchantFeedLabel

string

Opcional. Es la etiqueta del feed de Merchant Center. Si aún se usan países, se puede usar el código de país de 2 letras según ISO-3166-1 alfa-2. En el caso de los eventos de Ventas en la tienda, se anulará el valor establecido a nivel del carrito. Este campo se ignora para otros eventos.
merchantFeedLanguageCode

string

Opcional. Es el código de idioma en ISO 639-1 asociado al feed de Merchant Center en el que se suben tus artículos.
customVariables[]

object (ItemCustomVariable)

Opcional. Es información adicional sobre el par clave-valor que se envía a los contenedores de conversiones (acción de conversión o actividad de Floodlight) cuando se hace un seguimiento de las conversiones por artículo.
conversionValue

number

Opcional. Es el valor de conversión asociado a este elemento dentro del evento, para los casos en los que el valor de conversión es diferente para cada elemento.

ItemParameter

Es un bucket de cualquier parámetro del evento relacionado con un elemento que se incluirá en el evento y que no se especificó con otros campos estructurados.

Representación JSON 
{
  "parameterName": string,
  "value": string
}
Campos
parameterName

string

Obligatorio. Es el nombre del parámetro que se usará.
value

string

Obligatorio. Es la representación de cadena del valor del parámetro que se establecerá.

ItemCustomVariable

Es una variable personalizada a nivel del artículo para las conversiones de anuncios.

Representación JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Campos
variable

string

Opcional. Es el nombre de la variable personalizada que se establecerá. Si no se encuentra la variable para el destino determinado, se ignorará.
value

string

Opcional. Es el valor que se almacenará para la variable personalizada.
destinationReferences[]

string

Opcional. Es la cadena de referencia que se usa para determinar a cuál de los Event.destination_references se debe enviar la variable personalizada. Si está vacío, se usará Event.destination_references.

CustomVariable

Es la variable personalizada para las conversiones de anuncios.

Representación JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Campos
variable

string

Opcional. Es el nombre de la variable personalizada que se establecerá. Si no se encuentra la variable para el destino determinado, se ignorará.
value

string

Opcional. Es el valor que se almacenará para la variable personalizada.
destinationReferences[]

string

Opcional. Es la cadena de referencia que se usa para determinar a cuál de los Event.destination_references se debe enviar la variable personalizada. Si está vacío, se usará Event.destination_references.

ExperimentalField

Es un campo experimental que representa campos no oficiales.

Representación JSON 
{
  "field": string,
  "value": string
}
Campos
field

string

Opcional. Es el nombre del campo que se usará.
value

string

Opcional. Es el valor que se establecerá en el campo.

UserProperties

Es la información sobre el usuario que evalúa el anunciante en el momento en que ocurrió el evento. Consulta https://support.google.com/google-ads/answer/14007601 para obtener más detalles.

Representación JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Campos
customerType

enum (CustomerType)

Opcional. Es el tipo de cliente asociado al evento.
customerValueBucket

enum (CustomerValueBucket)

Opcional. Es el valor del cliente según la evaluación del anunciante.
additionalUserProperties[]

object (UserProperty)

Opcional. Es un bucket de las propiedades del usuario adicionales del usuario asociado a este evento.

CustomerType

Es el tipo de cliente asociado al evento.

Enums
CUSTOMER_TYPE_UNSPECIFIED CustomerType no especificado. No debe usarse nunca.
NEW El cliente es nuevo para el anunciante.
RETURNING El cliente regresa al anunciante.
REENGAGED El cliente volvió a interactuar con el anunciante.

CustomerValueBucket

Es el valor del cliente según la evaluación del anunciante.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Es el CustomerValueBucket no especificado. No debe usarse nunca.
LOW El cliente tiene un valor bajo.
MEDIUM El cliente es de valor medio.
HIGH El cliente es valioso.

UserProperty

Es un bucket de las propiedades del usuario adicionales del usuario asociado a este evento.

Representación JSON 
{
  "propertyName": string,
  "value": string
}
Campos
propertyName

string

Obligatorio. Nombre de la propiedad del usuario que se usará.
value

string

Obligatorio. Es la representación de cadena del valor de la propiedad del usuario que se usará.

EventParameter

Es el parámetro del evento para los eventos de GA4.

Representación JSON 
{
  "parameterName": string,
  "value": string
}
Campos
parameterName

string

Obligatorio. Es el nombre del parámetro que se usará.
value

string

Obligatorio. Es la representación de cadena del valor del parámetro que se establecerá.

EventLocation

Es la ubicación en la que ocurrió el evento.

Representación JSON 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Campos
storeId

string

Opcional. Obligatorio para las ventas en la tienda. Es el identificador que representa una tienda física en la que ocurrió el evento.
city

string

Opcional. Es el nombre de la ciudad en la que ocurrió el evento.
subdivisionCode

string

Opcional. Es el código de subdivisión ISO 3166-2 en el que ocurrió el evento.
regionCode

string

Opcional. Es el código de región CLDR de 2 letras de la dirección del usuario.
subcontinentCode

string

Opcional. Es el código de subcontinente en formato de la ONU M49 en el que ocurrió el evento.
continentCode

string

Opcional. Es el código de continente en formato UN M49 en el que ocurrió el evento.