Referencia del Protocolo de medición

Descripción general

El envío de datos a Google Analytics mediante el Protocolo de medición consta de dos partes:

  1. El transporte: dónde y cómo envías los datos
  2. La carga útil: Los datos que envías

En este documento, se describe cómo se formatean el transporte y la carga útil.

Transporte

Extremo de URL

Para enviar datos con el Protocolo de medición, debes realizar 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 muestra un código de estado 2xx si se recibió la solicitud HTTP. El Protocolo de medición no muestra un código de error si los datos de la carga útil tienen errores de formato, si los datos en la carga útil eran incorrectos o si Google Analytics no los procesó.

Carga útil

Los datos se envían a Google Analytics mediante el 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 hasta:
Administrador > Flujos de datos > elige tu flujo > Protocolo de medición > Crear

Te recomendamos que los mantengas privados para tu organización. Si implementas el protocolo de medición del cliente, debes rotar los objetos api_secret con regularidad para evitar el spam excesivo.

firebase_app_id

 Obligatorio. ID de la app de Firebase. Es el identificador de una app de Firebase. Se encuentra en Firebase console en:
Configuración del proyecto > General > Tus apps > ID de la app

measurement_id

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

Cuerpo de la entrada en formato JSON

Clave Tipo Descripción

app_instance_id

 string

Obligatorio. Identifica de forma única una instalación específica de una app de Firebase. Este valor se debe recuperar a través del SDK de Firebase.

web

client_id

 string

Obligatorio. Identifica de forma inequívoca una instancia de usuario de un cliente web. Consulta Enviar eventos al Protocolo de medición.

user_id

 string

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

timestamp_micros

 number

Opcional. Una marca de tiempo de Unix (en microsegundos) correspondiente a la hora que se asociará con el evento. Solo se debe configurar para grabar eventos que ocurrieron en el pasado. Este valor se puede anular mediante user_property o las marcas de tiempo de eventos. Se puede crear una retrospectiva de los eventos hasta por 3 días corridos en función de la zona horaria de la propiedad.

user_properties

 object Opcional. Son las propiedades del usuario para la medición. Consulta la sección Propiedades del usuario 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. Se establece en true para indicar que los datos del usuario no se deben usar para los anuncios personalizados.

events[]

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

events[].name

 string Obligatorio. El nombre del evento. Consulta la referencia de eventos para ver todas las opciones.

events[].params

 object Opcional. Los parámetros del evento Consulta la sección eventos a fin de obtener los parámetros sugeridos para cada evento.

El atributo consent configura los tipos y estados de consentimiento. Si no especificas consent, Google Analytics usará la configuración de consentimiento de las interacciones en línea correspondientes a la instancia del cliente o de la app.

Clave Tipo Descripción

ad_user_data

 string

Opcional. Establece el consentimiento para enviar a Google los datos del usuario provenientes de los eventos y las propiedades del usuario de la solicitud 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 parámetros personalizados centrados en el usuario, en el evento y en el artículo 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 el objeto events[].params de la carga útil.
  • Los parámetros personalizados centrados en el artículo se pueden incluir en el array items para cada evento.

Algunos eventos tienen parámetros recomendados. Consulta los eventos a fin de obtener los parámetros recomendados 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_