Referencia del Protocolo de medición

Descripción general

Hay dos partes en enviar datos a Google Analytics con el servicio de medición Protocolo:

  1. El transporte: dónde y cómo se envían los datos
  2. Carga útil: los datos que envías

En este documento, se describe el formato del transporte y la carga útil.

Transporte

Extremo de URL

Para enviar datos con el Protocolo de medición, realiza solicitudes HTTP POST al siguiente extremo:

https://www.google-analytics.com/mp/collect

Para enviar un evento, emite la siguiente solicitud POST:

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
<payload_data>

Códigos de respuesta

El Protocolo de medición siempre devuelve un código de estado 2xx si el HTTP si recibiste esa solicitud. El Protocolo de medición no devuelve un código de error si Si los datos de la carga útil eran incorrectos, Google Analytics no la procesó.

Carga útil

.

Los datos se envían a Google Analytics usando los datos del Protocolo de medición en dos partes:

  1. Parámetros de consulta
  2. Un cuerpo POST de JSON

parámetros de consulta

Nombre del parámetro Descripción

api_secret

Obligatorio. Un API Secret que se genera a través de la IU de Google Analytics.

Para crear un secreto nuevo, navega en la IU de Google Analytics para hacer lo siguiente:
Administrador > Flujos de datos > elige tu transmisión &gt; Protocolo de medición > Crear

Te recomendamos que las mantengas privadas para tu organización. Si implementas el Protocolo de medición del cliente, Rota los api_secret con regularidad para evitar el spam excesivo.

measurement_id

 ID de medición. Es el identificador de un flujo de datos. Se encuentra en la IU de Analytics en:
Administrador > Flujos de datos > elige tu transmisión &gt; ID de medición

Cuerpo de la entrada JSON

Clave Tipo Descripción

client_id

 string

Obligatorio. Identifica de forma única una instancia de usuario de un cliente web. Consulta Enviar evento a Protocolo de medición.

user_id

 string

Opcional. Es un identificador único para un usuario. Consulta User-ID para multiplataforma para obtener más información sobre este identificador.

timestamp_micros

 number

Opcional. Una marca de tiempo de Unix (en microsegundos) para el tiempo de asociación con el evento. Esta opción solo se debe configurar para grabar eventos que ocurrieron en el pasado. Este valor se puede anular con user_property o marcas de tiempo de eventos. Los eventos pueden tener una fecha anterior hasta 3 días corridos según la zona horaria de la propiedad.

user_properties

 object Opcional. Son las propiedades del usuario para la medición. Consulta Información propiedades para obtener más información.
object Opcional. Establece la configuración de consentimiento para la solicitud. Consulta la sección de consentimiento para obtener más información.

non_personalized_ads

 boolean Opcional. Configúralo en true para indicar que los datos del usuario no deben usarse para los anuncios personalizados.

events[]

 array Obligatorio. Un array de elementos de eventos. Se pueden enviar hasta 25 eventos por para cada solicitud. Consulta los eventos. referencia para todos los eventos válidos.

events[].name

 string Obligatorio. El nombre del evento. Consulta los eventos. referencia para todas las opciones.

events[].params

 object Opcional. Son los parámetros del evento. Ver los eventos para los parámetros sugeridos para cada evento.

El atributo consent configura los tipos y estados de consentimiento. Si no especificas consent, Google Analytics utilizará el consentimiento de las interacciones en línea correspondientes para el cliente o la instancia de la app.

Clave Tipo Descripción

ad_user_data

 string

Opcional. Establece el consentimiento para enviar datos del usuario desde y propiedades del usuario a Google con fines publicitarios.

Debe ser GRANTED o DENIED.

ad_personalization

 string

Opcional. Establece el consentimiento del usuario para la publicidad personalizada.

Debe ser GRANTED o DENIED.

Custom parameters

Además de los parámetros prescritos, puedes incluir personalizados centrados en el usuario, centrados en el evento y centrados en el artículo parámetros dentro de una carga útil del Protocolo de medición.

  • Los parámetros personalizados centrados en el usuario se pueden incluir en el objeto user_properties de la carga útil.
  • Los parámetros personalizados centrados en el evento se pueden incluir en events[].params. objeto de la carga útil.
  • Los parámetros personalizados centrados en el artículo se pueden incluir en la Array items para cada evento.

Algunos eventos tienen parámetros recomendados. Consulta los eventos para ver las recomendaciones parámetros para todos los eventos compatibles.

Nombres reservados

Nombres de eventos reservados

Los siguientes nombres de eventos están reservados y no se pueden utilizar:

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • session_start
  • user_engagement

Nombres de parámetros reservados

Los siguientes nombres de parámetros están reservados y no se pueden utilizar:

  • firebase_conversion

Además, los nombres de parámetros no pueden comenzar con lo siguiente:

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

Nombres de propiedades del usuario reservados

Los siguientes nombres de propiedades del usuario están reservados y no se pueden utilizar:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

Además, los nombres de propiedades del usuario no pueden comenzar con lo siguiente:

  • _ (underscore)
  • firebase_
  • ga_
  • google_