- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Período
- Embudo
- FunnelStep
- FunnelFilterExpression
- FunnelFilterExpressionList
- FunnelFieldFilter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operación
- NumericValue
- BetweenFilter
- FunnelEventFilter
- FunnelParameterFilterExpression
- FunnelParameterFilterExpressionList
- FunnelParameterFilter
- FunnelBreakdown
- Dimensión
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- FunnelNextAction
- Tipo de visualización del embudo
- Segmento
- UserSegment
- UserSegmentCriterios
- UserSegmentConditionGroup
- UserCriterioScoping
- SegmentFilterExpression
- SegmentFilterExpressionList
- SegmentFilter
- SegmentFilterScoping
- SegmentEventFilter
- SegmentParameterFilterExpression
- SegmentParameterFilterExpressionList
- SegmentParameterFilter
- SegmentParameterFilterScoping
- UserSegmentSequenceGroup
- UserSequenceStep
- UserSegmentExclusion
- UserExclusionDuration
- SessionSegment
- SessionSegmentCriterios
- SessionSegmentConditionGroup
- Alcance de la sesión
- SessionSegmentExclusion
- SessionExclusionDuration
- EventSegment
- EventSegmentCriterios
- EventSegmentConditionGroup
- EventCriteriaScoping
- EventSegmentExclusion
- EventExclusionDuration
- FilterExpression
- FilterExpressionList
- Filtro
- FunnelSubReport
- DimensionHeader
- MetricHeader
- Tipo de métrica
- Fila
- DimensionValue
- MetricValue
- FunnelResponseMetadata
- SamplingMetadata
- PropertyQuota
- QuotaStatus
- Pruébala
Muestra un informe de embudo personalizado de tus datos de eventos de Google Analytics. Los datos que muestra la API se muestran como una tabla con columnas para las dimensiones y métricas solicitadas.
La exploración de embudo permite visualizar los pasos que siguen los usuarios para completar una tarea y ver rápidamente si tienen éxito o no en cada paso. Por ejemplo, ¿de qué manera los clientes potenciales se convierten en visitantes y, finalmente, en compradores? ¿de qué manera los compradores por única vez se convierten en compradores frecuentes? Con esta información, puede mejorar los recorridos del cliente ineficientes o que suelen abandonarse. Para obtener más información, consulte Exploraciones del embudo de GA4.
Este método se introduce durante el período de estabilidad de la versión alfa con la intención de reunir comentarios sobre la sintaxis y las funciones antes de proceder a la versión beta. Para enviar comentarios sobre esta API, complete los comentarios del informe sobre el embudo de la API de datos de Google Analytics.
Solicitud HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
property |
Es un identificador de propiedad GA4 de Google Analytics cuyos eventos se rastrean. Se especifica en la ruta de URL y no en el cuerpo. Para obtener más información, consulta dónde encontrar tu ID de propiedad. Dentro de una solicitud por lotes, esta propiedad no debe especificarse o ser coherente con la propiedad a nivel del lote. Ejemplo: properties/1234 |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "dateRanges": [ { object ( |
Campos | |
---|---|
dateRanges[] |
Períodos de datos para leer Si se solicitan varios períodos, cada fila de respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los datos de los eventos correspondientes se incluyen en las filas de respuesta de ambos períodos. |
funnel |
La configuración del embudo de esta solicitud. Esta configuración de embudo es obligatoria. |
funnelBreakdown |
Si se especifica, este desglose agrega una dimensión a la respuesta del informe secundario del embudo de conversión. Esta dimensión de desglose expande cada paso del embudo a los valores únicos de la dimensión de desglose. Por ejemplo, un desglose por dimensión |
funnelNextAction |
Si se especifica, la siguiente acción agrega una dimensión a la respuesta del subinforme de visualización del embudo. Esta siguiente dimensión de acción expande cada paso del embudo a los valores únicos de la siguiente acción. Por ejemplo, la siguiente acción de la dimensión La siguiente acción solo admite |
funnelVisualizationType |
El tipo de visualización del embudo controla las dimensiones presentes en la respuesta del subinforme de visualización del embudo. Si no se especifica, se usa |
segments[] |
Las configuraciones de los segmentos. Los segmentos son subconjuntos de los datos de una propiedad. En un informe de embudo con segmentos, el embudo se evalúa en cada segmento. Cada segmento especificado en esta solicitud produce una fila separada en la respuesta; en la respuesta, cada segmento se identifica por su nombre. El parámetro de segmentos es opcional. Las solicitudes se limitan a 4 segmentos. |
limit |
La cantidad de filas que se mostrarán. Si no se especifica, se muestran 10,000 filas. La API muestra un máximo de 250,000 filas por solicitud, independientemente de cuántas solicites. La API también puede mostrar menos filas que el |
dimensionFilter |
Los filtros de dimensiones le permiten solicitar solo valores de dimensión específicos en el informe. Si desea obtener más información, consulte Cómo crear un informe: Filtros de dimensión para ver ejemplos. No se pueden usar las métricas en este filtro. |
returnPropertyQuota |
Alterna si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota. |
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
La respuesta del informe de embudo contiene dos subinformes. Los dos informes secundarios son diferentes combinaciones de dimensiones y métricas.
Representación JSON |
---|
{ "funnelTable": { object ( |
Campos | |
---|---|
funnelTable |
La tabla de embudo es un informe de los pasos, el segmento, la dimensión del desglose, los usuarios activos, el porcentaje de finalización, los abandonos y el porcentaje de abandonos del embudo. La dimensión del segmento solo está presente en esta respuesta si se solicitó un segmento. La dimensión de desglose solo está presente en esta respuesta si se solicitó. |
funnelVisualization |
La visualización del embudo es un informe del paso del embudo, el segmento, la fecha, la siguiente dimensión de acción y los usuarios activos. La dimensión del segmento solo está presente en esta respuesta si se solicitó un segmento. La dimensión de fecha solo está presente en esta respuesta si se solicitó a través del tipo de embudo |
propertyQuota |
El estado de cuota de esta propiedad de Analytics, incluida esta solicitud. |
kind |
Identifica el tipo de recurso que es este mensaje. |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
Período
Un conjunto contiguo de días: startDate, startDate + 1, ..., endDate. Se permiten hasta 4 períodos.
Representación JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Campos | |
---|---|
startDate |
Es la fecha de inicio inclusiva de la consulta en el formato |
endDate |
Es la fecha de finalización inclusiva de la consulta en el formato |
name |
Asigna un nombre a este período. La dimensión |
Embudo
Configura el embudo en una solicitud de informe de embudo. Un embudo informa a los usuarios a medida que pasan por una secuencia de pasos.
La exploración de embudo permite visualizar los pasos que siguen los usuarios para completar una tarea y ver rápidamente si tienen éxito o no en cada paso. Por ejemplo, ¿de qué manera los clientes potenciales se convierten en visitantes y, finalmente, en compradores? ¿de qué manera los compradores por única vez se convierten en compradores frecuentes? Con esta información, puede mejorar los recorridos del cliente ineficientes o que suelen abandonarse.
Representación JSON |
---|
{
"isOpenFunnel": boolean,
"steps": [
{
object ( |
Campos | |
---|---|
isOpenFunnel |
En un embudo abierto, los usuarios pueden ingresar en cualquier paso y, en un embudo cerrado, los usuarios deben ingresar en el primer paso. Opcional. Si no se especifica, se usa un embudo cerrado. |
steps[] |
Los pasos secuenciales de este embudo. |
Paso de embudo
Los pasos definen el recorrido del usuario que desea medir. Los pasos contienen una o más condiciones que sus usuarios deben cumplir para que se los incluya en ese paso del recorrido del embudo.
Representación JSON |
---|
{
"name": string,
"isDirectlyFollowedBy": boolean,
"filterExpression": {
object ( |
Campos | |
---|---|
name |
Es el nombre distintivo de este paso. Si no se especifica, los pasos tendrán un nombre indexado basado en 1 (por ejemplo, “0. ", "1. ", etcétera). Este nombre define el valor de string que muestra la dimensión |
isDirectlyFollowedBy |
Si es verdadero, este paso debe seguir directamente al anterior. Si es falso, puede haber eventos entre el paso anterior y este paso. Si no se especifica, |
filterExpression |
Es la condición que deben cumplir los usuarios para incluirse en este paso del recorrido del embudo. |
withinDurationFromPriorStep |
Si se especifica, este paso debe completarse en el transcurso del paso anterior.
Una duración en segundos con un máximo de 9 dígitos decimales, que termina en ' |
Expresión de filtro de embudo
Expresa combinaciones de filtros de embudo.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión expr . Especifica un tipo de filtro para FunnelFilterExpression . expr puede ser solo uno de los siguientes: |
|
andGroup |
El FunnelFilterExpression en |
orGroup |
El FunnelFilterExpression en |
notExpression |
FunnelFilterExpression NO es de |
funnelFieldFilter |
Un filtro de embudo para una dimensión o métrica. |
funnelEventFilter |
Crea un filtro que coincide con los eventos de un solo nombre de evento. Si se especifica una expresión de filtro de parámetro, solo el subconjunto de eventos que coincide con el nombre del evento único y con las expresiones de filtro de parámetros coinciden con este filtro de evento. |
Lista de expresiones de filtro de embudo
Una lista de expresiones de filtro de embudo.
Representación JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
La lista de expresiones de filtro del embudo. |
Filtro de campo de embudo
Una expresión para filtrar los valores de dimensión o métrica.
Representación JSON |
---|
{ "fieldName": string, // Union field |
Campos | |
---|---|
fieldName |
El nombre de la dimensión o de la métrica. |
Campo de unión one_filter . Especifica un tipo de filtro. Las direcciones (one_filter ) solo pueden ser una de las siguientes opciones: |
|
stringFilter |
Filtro relacionado con strings. |
inListFilter |
Un filtro para los valores de lista. |
numericFilter |
Un filtro para valores numéricos o de fecha. |
betweenFilter |
Un filtro para entre dos valores. |
StringFilter
El filtro para la string
Representación JSON |
---|
{
"matchType": enum ( |
Campos | |
---|---|
matchType |
El tipo de concordancia para este filtro. |
value |
El valor de string que se usa para la coincidencia. |
caseSensitive |
Si es verdadero, el valor de la string distingue mayúsculas de minúsculas. |
MatchType
El tipo de concordancia de un filtro de string
Enumeradores | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Sin especificar |
EXACT |
Coincidencia exacta del valor de la string. |
BEGINS_WITH |
Comienza con el valor de la string. |
ENDS_WITH |
Termina con el valor de string. |
CONTAINS |
Contiene el valor de la string. |
FULL_REGEXP |
Coincidencia completa de la expresión regular con el valor de string. |
PARTIAL_REGEXP |
Coincidencia parcial de la expresión regular con el valor de string. |
FiltroDeLista
El resultado debe estar en una lista de valores de string.
Representación JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Campos | |
---|---|
values[] |
Es la lista de valores de string. No debe estar vacío. |
caseSensitive |
Si es verdadero, el valor de la string distingue mayúsculas de minúsculas. |
FiltroNumérico
Filtra los valores numéricos o de fecha.
Representación JSON |
---|
{ "operation": enum ( |
Campos | |
---|---|
operation |
El tipo de operación de este filtro. |
value |
Un valor numérico o de fecha. |
Operación
La operación aplicada a un filtro numérico
Enumeradores | |
---|---|
OPERATION_UNSPECIFIED |
No se especifica. |
EQUAL |
Igual |
LESS_THAN |
Menor que |
LESS_THAN_OR_EQUAL |
Menor o igual |
GREATER_THAN |
Mayor que |
GREATER_THAN_OR_EQUAL |
Mayor o igual que |
NumericValue
Para representar un número.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión one_value . Un valor numérico one_value puede ser solo una de las siguientes opciones: |
|
int64Value |
Valor del número entero |
doubleValue |
Valor doble |
De filtro entre
Para expresar que el resultado debe estar entre dos números (inclusive).
Representación JSON |
---|
{ "fromValue": { object ( |
Campos | |
---|---|
fromValue |
Comienza con este número. |
toValue |
Finaliza con este número. |
Filtro de eventos de embudo
Crea un filtro que coincide con los eventos de un solo nombre de evento. Si se especifica una expresión de filtro de parámetro, solo el subconjunto de eventos que coincide con el nombre del evento único y con las expresiones de filtro de parámetros coinciden con este filtro de evento.
Representación JSON |
---|
{
"eventName": string,
"funnelParameterFilterExpression": {
object ( |
Campos | |
---|---|
eventName |
Este filtro coincide con los eventos de este único nombre de evento. El nombre del evento es obligatorio. |
funnelParameterFilterExpression |
Si se especifica, este filtro coincide con eventos que coinciden con el nombre del evento único y con las expresiones de filtro de parámetros. Dentro de la expresión de filtro de parámetros, solo están disponibles los filtros de parámetros. |
FunnelParameterFilterExpression
Expresa combinaciones de filtros de embudo de los parámetros.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión expr . Especifica un tipo de filtro para FunnelParameterFilterExpression . expr puede ser solo uno de los siguientes: |
|
andGroup |
El FunnelParameterFilterExpression de |
orGroup |
El FunnelParameterFilterExpression de |
notExpression |
FunnelParameterFilterExpression NO es |
funnelParameterFilter |
Un filtro de parámetro del embudo primitivo. |
FunnelParameterFilterExpressionList
Una lista de expresiones de filtro de parámetros de embudo.
Representación JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
La lista de expresiones de filtro de parámetros de embudo. |
Filtro de parámetro de embudo
Una expresión para filtrar los valores de los parámetros en un embudo.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión one_parameter . El campo que se filtra. Las direcciones (one_parameter ) solo pueden ser una de las siguientes opciones: |
|
eventParameterName |
Este filtro se evaluará según el parámetro de evento especificado. Los parámetros del evento se registran como parámetros del evento. Los parámetros de eventos incluyen campos como “firebase_screen” y “currency”. Los parámetros de eventos solo se pueden utilizar en los segmentos y embudos, y solo en un filtro de descenso de un EventFilter. En un filtro de descenso de un elemento EventFilter, se deben usar los parámetros de evento o elemento. |
itemParameterName |
Este filtro se evaluará según el parámetro del elemento especificado. Los parámetros del elemento se registran como parámetros en el array de elementos. Los parámetros de artículos incluyen campos como "item_name" y "item_category". Los parámetros de elementos solo se pueden usar en los segmentos y embudos, y solo en un filtro de descenso de un EventFilter. En un filtro de descenso de un elemento EventFilter, se deben usar los parámetros de evento o elemento. Los parámetros de artículos solo están disponibles en los eventos de comercio electrónico. Para obtener más información sobre los eventos de comercio electrónico, consulte la guía Cómo medir el comercio electrónico. |
Campo de unión one_filter . Especifica un tipo de filtro. Las direcciones (one_filter ) solo pueden ser una de las siguientes opciones: |
|
stringFilter |
Filtro relacionado con strings. |
inListFilter |
Un filtro para los valores de lista. |
numericFilter |
Un filtro para valores numéricos o de fecha. |
betweenFilter |
Un filtro para entre dos valores. |
Desglose del embudo
Los desgloses agregan una dimensión a la respuesta del subinforme de la tabla del embudo.
Representación JSON |
---|
{
"breakdownDimension": {
object ( |
Campos | |
---|---|
breakdownDimension |
Es la columna de dimensiones que se agrega a la respuesta del subinforme de la tabla del embudo. La dimensión de desglose desglosa cada paso del embudo. Se requiere un |
limit |
Es la cantidad máxima de valores distintos de la dimensión de desglose que se muestra en la respuesta. Se usa un |
Dimensión
Las dimensiones son atributos de sus datos. Por ejemplo, la dimensión "ciudad" indica la ciudad donde se origina un evento. Los valores de dimensión en las respuestas del informe son strings. Por ejemplo, la ciudad podría ser "París" o "Nueva York".
Representación JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Campos | |
---|---|
name |
Es el nombre de la dimensión. Consulte las dimensiones de API para ver la lista de nombres de dimensiones. Si se especifica
|
dimensionExpression |
Una dimensión puede ser el resultado de una expresión de varias dimensiones. Por ejemplo, la dimensión "country, city": concatenate(country, ", ", city). |
DimensionExpression
Se usa para expresar una dimensión que es el resultado de una fórmula de varias dimensiones. Ejemplos de uso: 1) minúscula(dimensión) 2) concatenar(dimensión1, símbolo, dimensión2).
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión one_expression . Especifica un tipo de expresión de dimensión para DimensionExpression . one_expression puede ser solo uno de los siguientes: |
|
lowerCase |
Se usa para convertir un valor de dimensión en minúsculas. |
upperCase |
Se utiliza para convertir un valor de dimensión en mayúsculas. |
concatenate |
Se usa para combinar valores de dimensión en una sola dimensión. Por ejemplo, la dimensión "country, city": concatenate(country, ", ", city). |
CaseExpression
Se usa para convertir un valor de dimensión en un solo caso.
Representación JSON |
---|
{ "dimensionName": string } |
Campos | |
---|---|
dimensionName |
Es el nombre de una dimensión. El nombre debe referirse a un nombre en el campo de dimensiones de la solicitud. |
Expresión de concatenación
Se usa para combinar valores de dimensión en una sola dimensión.
Representación JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Campos | |
---|---|
dimensionNames[] |
Son los nombres de las dimensiones. Los nombres deben hacer referencia a los nombres en el campo de dimensiones de la solicitud. |
delimiter |
El delimitador ubicado entre nombres de dimensiones. Los delimitadores suelen ser caracteres individuales, como "|" o ",", pero pueden ser strings más largas. Si un valor de dimensión contiene el delimitador, ambos estarán presentes como respuesta sin distinguirlos. Por ejemplo, si el valor de la dimensión 1 es "US,FR", el valor de la dimensión 2 es igual a "JP" y el delimitador es igual a "", la respuesta contendrá "US,FR,JP". |
Acción del siguiente paso
Las siguientes acciones indican el valor de una dimensión después de que el usuario realiza un paso, pero antes de que este lo haga. Por ejemplo, si nextActionDimension
es eventName
, nextActionDimension
en la fila del paso i
del embudo mostrará el primer evento después del evento que calificó al usuario en el paso i
del embudo, pero antes de que lograra el paso i+1
del embudo.
Representación JSON |
---|
{
"nextActionDimension": {
object ( |
Campos | |
---|---|
nextActionDimension |
Es la columna de dimensiones que se agregó a la respuesta del subinforme de visualización del embudo. La siguiente dimensión de acción muestra el siguiente valor de dimensión de esta dimensión después de que el usuario haya alcanzado el paso Actualmente, |
limit |
Es la cantidad máxima de valores distintos de la dimensión de desglose que se muestra en la respuesta. Se usa un |
Tipo de visualización del embudo
Controla las dimensiones presentes en la respuesta del subinforme de visualización del embudo.
Enumeradores | |
---|---|
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED |
Tipo no especificado |
STANDARD_FUNNEL |
Un embudo estándar (escalonado) El subinforme de visualización del embudo de la respuesta no contendrá fecha. |
TRENDED_FUNNEL |
Un embudo de tendencia (gráfico de líneas) El subinforme de visualización del embudo en la respuesta contendrá la dimensión de fechas. |
Segmento
Un segmento es un subconjunto de sus datos de Analytics. Por ejemplo, un segmento dentro de todo su conjunto de usuarios podría estar formado por las personas de un país o una ciudad en particular. Otro, por los usuarios que compran una línea particular de productos o que visitan una parte específica de su sitio o activan ciertos eventos en su aplicación.
Para obtener más información, consulte el Creador de segmentos de GA4.
Representación JSON |
---|
{ "name": string, // Union field |
Campos | |
---|---|
name |
Es el nombre de este segmento. Si no se especifica, los segmentos se denominan "Segmento". Este nombre define el valor de string que muestra la dimensión |
Campo de unión one_segment_scope . Se especifica un segmento en un alcance. Las direcciones (one_segment_scope ) solo pueden ser una de las siguientes opciones: |
|
userSegment |
Los segmentos de usuarios son subconjuntos de usuarios que interactuaron con su sitio o aplicación. |
sessionSegment |
Los segmentos de sesiones son subconjuntos de las sesiones que ocurrieron en su sitio o aplicación. |
eventSegment |
Los segmentos de eventos son subconjuntos de eventos que se activaron en su sitio o aplicación. |
Segmento de usuario
Los segmentos de usuarios son subconjuntos de usuarios que interactuaron con su sitio o aplicación. Por ejemplo, usuarios que ya realizaron una compra o que agregaron artículos a sus carritos, pero no completaron la compra.
Representación JSON |
---|
{ "userInclusionCriteria": { object ( |
Campos | |
---|---|
userInclusionCriteria |
Define qué usuarios se incluyen en este segmento. Opcional. |
exclusion |
Define qué usuarios se excluyen en este segmento. Opcional. |
Criterios de segmento de usuario
Un usuario coincide con un criterio si los eventos del usuario cumplen con las condiciones indicadas en el criterio.
Representación JSON |
---|
{ "andConditionGroups": [ { object ( |
Campos | |
---|---|
andConditionGroups[] |
Un usuario coincide con estos criterios si el usuario coincide con cada uno de estos |
andSequenceGroups[] |
Un usuario coincide con estos criterios si el usuario coincide con cada uno de estos |
UserSegmentConditionGroup
Las condiciones le indican a Analytics qué datos deben incluirse en el segmento o excluirse de él.
Representación JSON |
---|
{ "conditionScoping": enum ( |
Campos | |
---|---|
conditionScoping |
Los datos se incluyen en el segmento o se excluyen en función de si coincide con el grupo de condición. Este alcance define en cuántos eventos se evalúa Opcional. Si no se especifica, se usa |
segmentFilterExpression |
Los datos se incluyen en el segmento o se excluyen en función de si coincide con esta expresión. Las expresiones expresan criterios de dimensión, métricas o parámetros. |
Criterios del usuario
El alcance especifica qué eventos se consideran cuando se evalúa si un usuario cumple con un criterio.
Enumeradores | |
---|---|
USER_CRITERIA_SCOPING_UNSPECIFIED |
Alcance de los criterios sin especificar. No especificar. |
USER_CRITERIA_WITHIN_SAME_EVENT |
Si los criterios se cumplen en un evento, el usuario coincide con ellos. |
USER_CRITERIA_WITHIN_SAME_SESSION |
Si los criterios se cumplen en una sesión, el usuario coincide con ellos. |
USER_CRITERIA_ACROSS_ALL_SESSIONS |
Si algún evento cumple con los criterios del usuario, este debe cumplir con los criterios. |
Filtración de segmentos
Expresa combinaciones de filtros de segmentos.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión expr . Especifica un tipo de filtro para SegmentFilterExpression . expr puede ser solo uno de los siguientes: |
|
andGroup |
La SegmentFilterExpression de |
orGroup |
SegmentFilterExpression en |
notExpression |
SegmentFilterExpression NO es |
segmentFilter |
Un filtro de segmento primitivo. |
segmentEventFilter |
Crea un filtro que coincide con los eventos de un solo nombre de evento. Si se especifica una expresión de filtro de parámetro, solo el subconjunto de eventos que coincide con el nombre del evento único y con las expresiones de filtro de parámetros coinciden con este filtro de evento. |
Lista de expresiones de filtro de segmentos
Una lista de expresiones de filtro de segmentos.
Representación JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
La lista de expresiones de filtro de segmentos |
Filtro de segmentos
Una expresión para filtrar los valores de dimensión o métrica.
Representación JSON |
---|
{ "fieldName": string, "filterScoping": { object ( |
Campos | |
---|---|
fieldName |
El nombre de la dimensión o de la métrica. |
filterScoping |
Especifica el alcance del filtro. |
Campo de unión one_filter . Especifica un tipo de filtro para Filter . one_filter puede ser solo uno de los siguientes: |
|
stringFilter |
Filtro relacionado con strings. |
inListFilter |
Un filtro para los valores de lista. |
numericFilter |
Un filtro para valores numéricos o de fecha. |
betweenFilter |
Un filtro para entre dos valores. |
Alcance de los filtros de segmentos
Los alcances especifican cómo se deben considerar las dimensiones y las métricas de varios eventos al evaluar un filtro de segmento.
Representación JSON |
---|
{ "atAnyPointInTime": boolean } |
Campos | |
---|---|
atAnyPointInTime |
Si Este parámetro Este Si el alcance del criterio es |
Filtro de eventos de segmento
Crea un filtro que coincide con los eventos de un solo nombre de evento. Si se especifica una expresión de filtro de parámetro, solo el subconjunto de eventos que coincide con el nombre del evento único y con las expresiones de filtro de parámetros coinciden con este filtro de evento.
Representación JSON |
---|
{
"eventName": string,
"segmentParameterFilterExpression": {
object ( |
Campos | |
---|---|
eventName |
Este filtro coincide con los eventos de este único nombre de evento. El nombre del evento es obligatorio. |
segmentParameterFilterExpression |
Si se especifica, este filtro coincide con eventos que coinciden con el nombre del evento único y con las expresiones de filtro de parámetros. Dentro de la expresión de filtro de parámetros, solo están disponibles los filtros de parámetros. |
SegmentParameterFilterExpression
Expresa combinaciones del filtro de segmentos en los parámetros.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión expr . Especifica un tipo de filtro para SegmentParameterFilterExpression . expr puede ser solo uno de los siguientes: |
|
andGroup |
SegmentParameterFilterExpression en |
orGroup |
SegmentParameterFilterExpression en |
notExpression |
SegmentParameterFilterExpression NO es de |
segmentParameterFilter |
Un filtro de parámetro de segmento primitivo. |
SegmentParameterFilterExpressionList
Una lista de expresiones de filtro de parámetros de segmentos.
Representación JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
La lista de expresiones de filtro de parámetros de segmentos. |
Filtro de parámetro de segmento
Una expresión para filtrar los valores de los parámetros en un segmento.
Representación JSON |
---|
{ "filterScoping": { object ( |
Campos | |
---|---|
filterScoping |
Especifica el alcance del filtro. |
Campo de unión one_parameter . El campo que se filtra. Las direcciones (one_parameter ) solo pueden ser una de las siguientes opciones: |
|
eventParameterName |
Este filtro se evaluará según el parámetro de evento especificado. Los parámetros del evento se registran como parámetros del evento. Los parámetros de eventos incluyen campos como “firebase_screen” y “currency”. Los parámetros de eventos solo se pueden utilizar en los segmentos y embudos, y solo en un filtro de descenso de un EventFilter. En un filtro de descenso de un elemento EventFilter, se deben usar los parámetros de evento o elemento. |
itemParameterName |
Este filtro se evaluará según el parámetro del elemento especificado. Los parámetros del elemento se registran como parámetros en el array de elementos. Los parámetros de artículos incluyen campos como "item_name" y "item_category". Los parámetros de elementos solo se pueden usar en los segmentos y embudos, y solo en un filtro de descenso de un EventFilter. En un filtro de descenso de un elemento EventFilter, se deben usar los parámetros de evento o elemento. Los parámetros de artículos solo están disponibles en los eventos de comercio electrónico. Para obtener más información sobre los eventos de comercio electrónico, consulte la guía Cómo medir el comercio electrónico. |
Campo de unión one_filter . Especifica un tipo de filtro. Las direcciones (one_filter ) solo pueden ser una de las siguientes opciones: |
|
stringFilter |
Filtro relacionado con strings. |
inListFilter |
Un filtro para los valores de lista. |
numericFilter |
Un filtro para valores numéricos o de fecha. |
betweenFilter |
Un filtro para entre dos valores. |
ParámetroParameterFilterScoping
Los alcances especifican cómo se deben considerar varios eventos cuando se evalúa un filtro de parámetro de segmento.
Representación JSON |
---|
{ "inAnyNDayPeriod": string } |
Campos | |
---|---|
inAnyNDayPeriod |
Acumula el parámetro durante el período especificado de días antes de aplicar el filtro. Solo se admite si el alcance del criterio es Por ejemplo, si El período no se extiende para tener una ventana completa de N días cerca del inicio del período. Por ejemplo, si un informe corresponde al período del 1 de noviembre de 2021 al 10 de noviembre de 2021 y
|
UserSegmentSequenceGroup
Define las condiciones que deben ocurrir en un orden específico para que el usuario sea miembro del segmento.
Representación JSON |
---|
{ "sequenceScoping": enum ( |
Campos | |
---|---|
sequenceScoping |
Se deben cumplir todos los pasos de la secuencia en el alcance para que el usuario coincida con la secuencia. Por ejemplo, si es Opcional. Si no se especifica, se usa |
sequenceMaximumDuration |
Define el período en el que debe ocurrir toda la secuencia; por ejemplo, 30 minutos.
Una duración en segundos con un máximo de 9 dígitos decimales, que termina en ' |
userSequenceSteps[] |
Una secuencia ordenada de pasos de condición. Los eventos de un usuario deben completar cada paso para que coincida con el |
Paso de secuencia de usuarios
Una condición que debe ocurrir en el orden de pasos especificado para que este usuario coincida con la secuencia.
Representación JSON |
---|
{ "isDirectlyFollowedBy": boolean, "stepScoping": enum ( |
Campos | |
---|---|
isDirectlyFollowedBy |
Si es verdadero, el evento que cumpla con este paso debe ser el siguiente después de que satisfaga el último paso. Si es falso, este paso sigue de forma indirecta el paso anterior. Por ejemplo, puede haber eventos entre el paso anterior y este paso. |
stepScoping |
Este paso de la secuencia debe cumplirse en el alcance para que el usuario coincida con la secuencia. Por ejemplo, si Opcional. Si no se especifica, |
segmentFilterExpression |
Un usuario coincide con este paso de la secuencia si sus eventos coinciden con esta expresión. Las expresiones expresan criterios de dimensión, métricas o parámetros. |
Exclusión de segmento de usuario
Especifica qué usuarios se excluyen en este segmento.
Representación JSON |
---|
{ "userExclusionDuration": enum ( |
Campos | |
---|---|
userExclusionDuration |
Especifica cuánto durará una exclusión si un usuario coincide con Opcional. Si no se especifica, se usa |
userExclusionCriteria |
Si un usuario cumple con esta condición, se lo excluirá de la membresía en el segmento de |
Duración de la exclusión de usuarios
Enumera las opciones de duración de una exclusión si un usuario coincide con userExclusionCriteria
.
Enumeradores | |
---|---|
USER_EXCLUSION_DURATION_UNSPECIFIED |
Duración de la exclusión sin especificar. No especificar. |
USER_EXCLUSION_TEMPORARY |
Excluye temporalmente al usuario del segmento durante los períodos en que el usuario cumpla la condición userExclusionCriteria . |
USER_EXCLUSION_PERMANENT |
Excluye de forma permanente a los usuarios del segmento si cumplen con la condición userExclusionCriteria . |
Segmento de sesión
Los segmentos de sesiones son subconjuntos de las sesiones que ocurrieron en su sitio o aplicación: por ejemplo, todas las sesiones que se generaron a partir de una campaña publicitaria particular.
Representación JSON |
---|
{ "sessionInclusionCriteria": { object ( |
Campos | |
---|---|
sessionInclusionCriteria |
Define las sesiones que se incluyen en este segmento. Opcional. |
exclusion |
Define las sesiones que se excluyen en este segmento. Opcional. |
Criterios de segmento de sesión
Una sesión coincide con un criterio si los eventos de la sesión cumplen con las condiciones correspondientes.
Representación JSON |
---|
{
"andConditionGroups": [
{
object ( |
Campos | |
---|---|
andConditionGroups[] |
Una sesión coincide con estos criterios si la sesión coincide con cada uno de estos |
SessionSegmentConditionGroup
Las condiciones le indican a Analytics qué datos deben incluirse en el segmento o excluirse de él.
Representación JSON |
---|
{ "conditionScoping": enum ( |
Campos | |
---|---|
conditionScoping |
Los datos se incluyen en el segmento o se excluyen en función de si coincide con el grupo de condición. Este alcance define en cuántos eventos se evalúa Opcional. Si no se especifica, se usa un |
segmentFilterExpression |
Los datos se incluyen en el segmento o se excluyen en función de si coincide con esta expresión. Las expresiones expresan criterios de dimensión, métricas o parámetros. |
Alcance de los criterios de sesión
El alcance especifica qué eventos se consideran cuando se evalúa si una sesión cumple con ciertos criterios.
Enumeradores | |
---|---|
SESSION_CRITERIA_SCOPING_UNSPECIFIED |
Alcance de los criterios sin especificar. No especificar. |
SESSION_CRITERIA_WITHIN_SAME_EVENT |
Si los criterios se cumplen en un evento, la sesión coincide con los criterios. |
SESSION_CRITERIA_WITHIN_SAME_SESSION |
Si los criterios se cumplen en una sesión, esta coincide con los criterios. |
Exclusión de segmento de sesión
Especifica qué sesiones se excluyen en este segmento.
Representación JSON |
---|
{ "sessionExclusionDuration": enum ( |
Campos | |
---|---|
sessionExclusionDuration |
Especifica cuánto durará una exclusión si una sesión coincide con Opcional. Si no se especifica, se usa un |
sessionExclusionCriteria |
Si una sesión cumple con esta condición, se excluirá de la membresía en el segmento de |
Duración de la sesión
Enumera las opciones de duración de una exclusión si una sesión coincide con sessionExclusionCriteria
.
Enumeradores | |
---|---|
SESSION_EXCLUSION_DURATION_UNSPECIFIED |
Duración de la exclusión sin especificar. No especificar. |
SESSION_EXCLUSION_TEMPORARY |
Excluye temporalmente las sesiones del segmento durante los períodos en que cumplan con la condición sessionExclusionCriteria . |
SESSION_EXCLUSION_PERMANENT |
Excluye sesiones del segmento de forma permanente si la sesión cumple con la condición sessionExclusionCriteria . |
Segmento de evento
Los segmentos de eventos son subconjuntos de eventos que se activaron en su sitio o aplicación. Por ejemplo, todos los eventos de compra realizados en una ubicación determinada o los eventos app_exception que ocurrieron en un sistema operativo específico.
Representación JSON |
---|
{ "eventInclusionCriteria": { object ( |
Campos | |
---|---|
eventInclusionCriteria |
Define qué eventos se incluyen en este segmento. Opcional. |
exclusion |
Define qué eventos se excluyen en este segmento. Opcional. |
Criterios de EventSegment
Un evento coincide con un criterio si cumple con las condiciones indicadas en el criterio.
Representación JSON |
---|
{
"andConditionGroups": [
{
object ( |
Campos | |
---|---|
andConditionGroups[] |
Un evento coincide con estos criterios si el evento coincide con cada uno de estos |
EventSegmentConditionGroup
Las condiciones le indican a Analytics qué datos deben incluirse en el segmento o excluirse de él.
Representación JSON |
---|
{ "conditionScoping": enum ( |
Campos | |
---|---|
conditionScoping |
Opcional. Si no se especifica, se usa un |
segmentFilterExpression |
Los datos se incluyen en el segmento o se excluyen en función de si coincide con esta expresión. Las expresiones expresan criterios de dimensión, métricas o parámetros. |
Criterios del alcance del evento
El alcance especifica qué eventos se consideran cuando se evalúa si un evento cumple con ciertos criterios.
Enumeradores | |
---|---|
EVENT_CRITERIA_SCOPING_UNSPECIFIED |
Alcance de los criterios sin especificar. No especificar. |
EVENT_CRITERIA_WITHIN_SAME_EVENT |
Si los criterios se cumplen en un evento, el evento coincide con los criterios. |
EventSegmentExclusion
Especifica qué eventos se excluyen en este segmento.
Representación JSON |
---|
{ "eventExclusionDuration": enum ( |
Campos | |
---|---|
eventExclusionDuration |
Opcional. Si no se especifica, se usa un |
eventExclusionCriteria |
Si un evento cumple con esta condición, se excluirá del evento en el segmento de |
EventExclusionDuration
Enumera las opciones de duración de una exclusión si un evento coincide con eventExclusionCriteria
.
Enumeradores | |
---|---|
EVENT_EXCLUSION_DURATION_UNSPECIFIED |
Duración de la exclusión sin especificar. No especificar. |
EVENT_EXCLUSION_PERMANENT |
Excluye de forma permanente los eventos del segmento si el evento cumple alguna vez con la condición eventExclusionCriteria . |
FilterExpression
Para expresar filtros de dimensiones o métricas. Los campos de la misma FilterExpression deben ser todas las dimensiones o todas las métricas.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión expr . Especifica un tipo de expresión de filtro para FilterExpression . expr puede ser solo uno de los siguientes: |
|
andGroup |
Los FilterExpressions de andGroup tienen una relación Y. |
orGroup |
Los FilterExpressions de orGroup tienen una relación OR. |
notExpression |
FilterExpression NO es notExpression. |
filter |
Un filtro primitivo. En la misma FilterExpression, todos los nombres de campo del filtro deben ser todas las dimensiones o todas las métricas. |
FilterExpressionList
Una lista de expresiones de filtro.
Representación JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
Una lista de expresiones de filtro. |
Filtro
Una expresión para filtrar los valores de dimensión o métrica.
Representación JSON |
---|
{ "fieldName": string, // Union field |
Campos | |
---|---|
fieldName |
El nombre de la dimensión o de la métrica. Debe ser un nombre definido en dimensiones o métricas. |
Campo de unión one_filter . Especifica un tipo de filtro para Filter . one_filter puede ser solo uno de los siguientes: |
|
stringFilter |
Filtro relacionado con strings. |
inListFilter |
Un filtro para los valores de lista. |
numericFilter |
Un filtro para valores numéricos o de fecha. |
betweenFilter |
Un filtro para entre dos valores. |
Subinforme del embudo
Los informes secundarios del embudo contienen los valores de los datos de dimensiones y métricas. Por ejemplo, 12 usuarios llegaron al segundo paso del embudo.
Representación JSON |
---|
{ "dimensionHeaders": [ { object ( |
Campos | |
---|---|
dimensionHeaders[] |
Describe las columnas de dimensiones. Los informes de embudo siempre incluyen la dimensión del paso del embudo en las respuestas de los subinformes. Si se solicita, es posible que haya dimensiones adicionales, como desgloses, fechas y próximas acciones. |
metricHeaders[] |
Describe las columnas de métricas. Los informes de embudo siempre incluyen a los usuarios activos en las respuestas de los subinformes. La tabla del embudo incluye métricas adicionales, como el porcentaje de respuesta, el porcentaje de abandonos y el porcentaje de abandonos. |
rows[] |
Filas de combinaciones de valores de dimensiones y valores de métricas en el informe |
metadata |
Metadatos para el informe de embudo. |
DimensionHeader
Describe una columna de dimensiones en el informe. Las dimensiones solicitadas en un informe producen entradas de columna dentro de filas y DimensionHeaders. Sin embargo, las dimensiones que se utilizan exclusivamente en los filtros o expresiones no producen columnas en un informe. En consecuencia, esas dimensiones no producen encabezados.
Representación JSON |
---|
{ "name": string } |
Campos | |
---|---|
name |
Es el nombre de la dimensión. |
MetricHeader
Describe una columna de métricas en el informe. Las métricas visibles solicitadas en un informe producen entradas de columnas dentro de filas y MetricHeaders. Sin embargo, las métricas que se usan de forma exclusiva dentro de los filtros o las expresiones no generan columnas en un informe, por lo que no generan encabezados.
Representación JSON |
---|
{
"name": string,
"type": enum ( |
Campos | |
---|---|
name |
El nombre de la métrica. |
type |
El tipo de datos de la métrica. |
MetricType
El tipo de valor de una métrica.
Enumeradores | |
---|---|
METRIC_TYPE_UNSPECIFIED |
Tipo no especificado |
TYPE_INTEGER |
Tipo de número entero. |
TYPE_FLOAT |
Tipo de punto flotante |
TYPE_SECONDS |
Una duración de segundos; un tipo de punto flotante especial. |
TYPE_MILLISECONDS |
Una duración en milisegundos; un tipo especial de punto flotante. |
TYPE_MINUTES |
Una duración en minutos; un tipo de punto flotante especial |
TYPE_HOURS |
Una duración en horas; un tipo de punto flotante especial. |
TYPE_STANDARD |
Una métrica personalizada de tipo estándar; un tipo de punto flotante especial. |
TYPE_CURRENCY |
Una cantidad de dinero, un tipo de punto flotante especial |
TYPE_FEET |
Una longitud en pies; un tipo de punto flotante especial. |
TYPE_MILES |
Una longitud en millas; un tipo de punto flotante especial. |
TYPE_METERS |
Una longitud en metros; un tipo de punto flotante especial. |
TYPE_KILOMETERS |
Una longitud en kilómetros; un tipo de punto flotante especial. |
Fila
Datos de informes para cada fila. Por ejemplo, si RunReportRequest contiene lo siguiente:
"dimensions": [
{
"name": "eventName"
},
{
"name": "countryId"
}
],
"metrics": [
{
"name": "eventCount"
}
]
Una fila con “in_app_purchase” como el eventName, “JP” como el countryId y 15 como el eventCount, sería:
"dimensionValues": [
{
"value": "in_app_purchase"
},
{
"value": "JP"
}
],
"metricValues": [
{
"value": "15"
}
]
Representación JSON |
---|
{ "dimensionValues": [ { object ( |
Campos | |
---|---|
dimensionValues[] |
Lista de valores de dimensión solicitados. En un PivotReport, dimensionValues solo se enumera para las dimensiones incluidas en un pivot. |
metricValues[] |
Lista de valores de métricas visibles solicitados. |
DimensionValue
Es el valor de una dimensión.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión one_value . Un tipo de valor de dimensión one_value puede ser solo uno de los siguientes: |
|
value |
Valor como una string si el tipo de dimensión es una string. |
MetricValue
El valor de una métrica.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión one_value . El valor de la métrica one_value puede ser solo una de las siguientes opciones: |
|
value |
Valor de medición. Consulta MetricHeader para conocer el tipo |
Metadatos del embudo de respuesta
Los metadatos de respuesta del informe de embudo contienen información adicional sobre el informe de embudo.
Representación JSON |
---|
{
"samplingMetadatas": [
{
object ( |
Campos | |
---|---|
samplingMetadatas[] |
Si los resultados del informe de embudo están de muestra, esto describe qué porcentaje de eventos se utilizaron en este informe de embudo. Se propaga un Sin embargo, si no se muestrean los resultados, no se definirá este campo. |
Metadatos de muestra
Si los resultados del informe de embudo están de muestra, estos metadatos describen qué porcentaje se usó en el informe de embudo para un período determinado. El muestreo es la práctica de analizar un subconjunto de todos los datos a fin de descubrir información significativa en el conjunto de datos más grande.
Representación JSON |
---|
{ "samplesReadCount": string, "samplingSpaceSize": string } |
Campos | |
---|---|
samplesReadCount |
Es la cantidad total de eventos leídos en este informe de muestra para un período. Este es el tamaño del subconjunto de datos de esta propiedad que se analizó en este informe de embudo. |
samplingSpaceSize |
Indica la cantidad total de eventos presentes en los datos de esta propiedad que se podrían haber analizado en este informe de embudo para un período. El muestreo revela la información significativa sobre el conjunto de datos más grande, y este es el tamaño del conjunto de datos más grande. Para calcular el porcentaje de datos disponibles que se usaron en este informe de embudo, calcule |
PropertyQuota
Estado actual de todas las cuotas de esta propiedad de Analytics. Si se agota cualquier cuota de una propiedad, todas las solicitudes a esa propiedad mostrarán errores de recurso agotado.
Representación JSON |
---|
{ "tokensPerDay": { object ( |
Campos | |
---|---|
tokensPerDay |
Las propiedades estándar de Analytics pueden utilizar hasta 200,000 tokens por día. Las propiedades Analytics 360 pueden usar 2,000,000 tokens por día. La mayoría de las solicitudes consumen menos de 10 tokens. |
tokensPerHour |
Las propiedades estándar de Analytics pueden utilizar hasta 40,000 tokens por hora. Las propiedades Analytics 360 pueden usar 400,000 tokens por hora. Una solicitud a la API consume una sola cantidad de tokens, y ese número se deduce de todas las cuotas por hora, por día y por proyecto. |
concurrentRequests |
Las propiedades estándar de Analytics pueden enviar hasta 10 solicitudes simultáneas; las propiedades de Analytics 360 pueden utilizar hasta 50 solicitudes simultáneas. |
serverErrorsPerProjectPerHour |
Los pares de propiedades estándar de Analytics y de proyecto de nube pueden tener hasta 10 errores de servidor por hora. Las propiedades de Analytics 360 y los pares de proyectos de nube pueden tener hasta 50 errores de servidor por hora. |
potentiallyThresholdedRequestsPerHour |
Las propiedades de Analytics pueden enviar hasta 120 solicitudes con dimensiones potencialmente limitadas por hora. En una solicitud por lotes, cada solicitud de informe se cuenta, de forma individual, para esta cuota si la solicitud contiene dimensiones potencialmente limitadas. |
tokensPerProjectPerHour |
Las propiedades de Analytics pueden usar hasta el 35% de sus tokens por proyecto por hora. Esto equivale a Propiedades de Analytics estándar que pueden utilizar hasta 14,000 tokens por proyecto por hora, mientras que las Propiedades de Analytics 360 pueden utilizar 140,000 tokens por proyecto por hora. Una solicitud a la API consume una sola cantidad de tokens, y ese número se deduce de todas las cuotas por hora, por día y por proyecto. |
QuotaStatus
Estado actual de un grupo de cuotas en particular.
Representación JSON |
---|
{ "consumed": integer, "remaining": integer } |
Campos | |
---|---|
consumed |
Cuota consumida por esta solicitud. |
remaining |
Cuota restante después de esta solicitud. |