Method: properties.runFunnelReport

Devuelve un informe de embudo personalizado de tus datos de eventos de Google Analytics. Los datos que devuelve la API se presentan en 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 usuarios que hacen una única compra se convierten en compradores frecuentes? Con esta información, puedes mejorar los recorridos del cliente ineficientes o que suelen abandonarse. Para obtener más información, consulta Exploraciones de 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 tus comentarios sobre esta API, completa 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

Parámetros
property

string

Opcional. Es un identificador de propiedad 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 el ID de tu propiedad. En una solicitud por lotes, esta propiedad no debe especificarse o debe 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 (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
Campos
dateRanges[]

object (DateRange)

Opcional. Son los períodos de los datos que se leerán. Si se solicitan varios períodos, cada fila de la respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los datos del evento para los días superpuestos se incluyen en las filas de respuesta para ambos períodos.
funnel

object (Funnel)

Opcional. Es la configuración del embudo de esta solicitud. Se requiere esta configuración del embudo.
funnelBreakdown

object (FunnelBreakdown)

Opcional. Si se especifica, este desglose agrega una dimensión a la respuesta del subinforme de la tabla del embudo. Esta dimensión de desglose expande cada paso del embudo de conversión a los valores únicos de la dimensión de desglose. Por ejemplo, un desglose por la dimensión deviceCategory creará filas para mobile, tablet, desktop y el total.
funnelNextAction

object (FunnelNextAction)

Opcional. Si se especifica, la siguiente acción agrega una dimensión a la respuesta del subinforme de visualización del embudo. Esta dimensión de la próxima acción expande cada paso del embudo de conversión a los valores únicos de la próxima acción. Por ejemplo, una siguiente acción de la dimensión eventName creará filas para varios eventos (por ejemplo, session_start y click) y el total.

La siguiente acción solo admite eventName y la mayoría de las dimensiones de página o pantalla, como pageTitle y pagePath.
funnelVisualizationType

enum (FunnelVisualizationType)

Opcional. 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 STANDARD_FUNNEL.
segments[]

object (Segment)

Opcional. Son 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 genera una fila independiente en la respuesta, en la que cada segmento se identifica por su nombre.

El parámetro segments es opcional. Las solicitudes se limitan a 4 segmentos.
limit

string (int64 format)

Opcional. Es la cantidad de filas que se devolverán. Si no se especifica, se devuelven 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas solicites. limit debe ser positivo.

La API también puede devolver menos filas que el limit solicitado si no hay tantos valores de dimensión como el limit.
dimensionFilter

object (FilterExpression)

Opcional. Los filtros de dimensiones te permiten solicitar solo valores de dimensiones específicos en el informe. Para obtener más información, consulta Cómo crear un informe: Filtros de dimensiones para ver ejemplos. Las métricas no se pueden usar en este filtro.
returnPropertyQuota

boolean

Opcional. Alterna si se debe devolver el estado actual de la cuota de esta propiedad de Analytics. La cuota se devuelve en PropertyQuota.

Cuerpo de la respuesta

La respuesta del informe de embudo contiene dos informes secundarios. Los dos informes secundarios son combinaciones diferentes de dimensiones y métricas.

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

Representación JSON 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Campos
funnelTable

object (FunnelSubReport)

La tabla del embudo es un informe que incluye el paso del embudo de conversión, el segmento, la dimensión de desglose, los usuarios activos, el porcentaje de respuesta, los abandonos y el porcentaje de abandono.

La dimensión de 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

object (FunnelSubReport)

La visualización del embudo es un informe que incluye el paso del embudo de conversión, el segmento, la fecha, la dimensión de la próxima acción y los usuarios activos.

La dimensión de 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 TRENDED_FUNNEL. La dimensión de la próxima acción solo está presente en la respuesta si se solicitó.
propertyQuota

object (PropertyQuota)

Es el estado de la cuota de esta propiedad de Analytics, incluida esta solicitud.
kind

string

Identifica qué tipo de recurso es este mensaje. Este kind siempre es la cadena fija "analyticsData#runFunnelReport". Es útil para distinguir entre los tipos de respuesta en JSON.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

Embudo

Configura el embudo en una solicitud de informe de embudo. Un embudo genera informes sobre 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 usuarios que hacen una única compra se convierten en compradores frecuentes? Con esta información, puedes mejorar los recorridos del cliente ineficientes o que suelen abandonarse.

Representación JSON 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
Campos
isOpenFunnel

boolean

En un embudo abierto, los usuarios pueden ingresar en cualquier paso, mientras que, en un embudo cerrado, deben ingresar en el primer paso. Opcional. Si no se especifica, se usa un embudo cerrado.
steps[]

object (FunnelStep)

Son los pasos secuenciales de este embudo.

FunnelStep

Los pasos definen el recorrido del usuario que deseas medir. Los pasos contienen una o más condiciones que tus usuarios deben cumplir para que se los incluya en ese paso del recorrido del embudo.

Representación JSON 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
Campos
name

string

Es el nombre distintivo de este paso. Si no se especifica, los pasos se nombrarán con un nombre indexado basado en 1 (por ejemplo, "0. ", "1. ", etcétera). Este nombre define el valor de cadena que devuelve la dimensión funnelStepName. Por ejemplo, si se especifica name = Purchase en el tercer paso del embudo de conversión de la solicitud, se producirá 3. Purchase en la respuesta del informe del embudo.
isDirectlyFollowedBy

boolean

Si es verdadero, este paso debe seguir inmediatamente al paso anterior. Si es falso, puede haber eventos entre el paso anterior y este. Si no se especifica, isDirectlyFollowedBy se trata como falso.
filterExpression

object (FunnelFilterExpression)

Es la condición que deben cumplir tus usuarios para que se los incluya en este paso del recorrido del embudo.
withinDurationFromPriorStep

string (Duration format)

Si se especifica, este paso debe completarse dentro de este período posterior a la finalización del paso anterior. withinDurationFromPriorStep incluye el extremo con una granularidad de microsegundos. Por ejemplo, una duración de 5 segundos se puede completar en 4.9 o 5.0 segundos, pero no en 5 segundos y 1 microsegundo.

withinDurationFromPriorStep es opcional y, si no se especifica, los pasos se pueden separar por cualquier duración.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

FunnelFilterExpression

Expresa combinaciones de filtros de embudo.

Representación JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de unión expr. Especifica un tipo de filtro para FunnelFilterExpression. expr puede ser solo uno de los siguientes:
andGroup

object (FunnelFilterExpressionList)

FunnelFilterExpression en andGroup tiene una relación AND.
orGroup

object (FunnelFilterExpressionList)

Las FunnelFilterExpression en orGroup tienen una relación OR.
notExpression

object (FunnelFilterExpression)

FunnelFilterExpression NO es de notExpression.
funnelFieldFilter

object (FunnelFieldFilter)

Es un filtro de embudo para una dimensión o métrica.
funnelEventFilter

object (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ámetros, solo el subconjunto de eventos que coincidan con el nombre del evento único y las expresiones de filtro de parámetros coincidirán con este filtro de eventos.

FunnelFilterExpressionList

Es una lista de expresiones de filtro del embudo.

Representación JSON 
{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}
Campos
expressions[]

object (FunnelFilterExpression)

Es la lista de expresiones de filtro del embudo.

FunnelFieldFilter

Es una expresión para filtrar valores de dimensiones o métricas.

Representación JSON 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Campos
fieldName

string

Es el nombre de la dimensión o de la métrica.
Campo de unión one_filter. Especifica un tipo de filtro. one_filter puede ser solo uno de los parámetros siguientes:
stringFilter

object (StringFilter)

Es el filtro relacionado con cadenas.
inListFilter

object (InListFilter)

Es un filtro para los valores de la lista.
numericFilter

object (NumericFilter)

Es un filtro para valores numéricos o de fecha.
betweenFilter

object (BetweenFilter)

Es un filtro para valores entre dos valores.

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ámetros, solo el subconjunto de eventos que coincidan con el nombre del evento único y las expresiones de filtro de parámetros coincidirán con este filtro de eventos.

Representación JSON 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
Campos
eventName

string

Este filtro coincide con los eventos de este único nombre de evento. El nombre del evento es obligatorio.
funnelParameterFilterExpression

object (FunnelParameterFilterExpression)

Si se especifica, este filtro coincide con los eventos que coinciden con el nombre del evento único y 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 en parámetros.

Representación JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de unión expr. Especifica un tipo de filtro para FunnelParameterFilterExpression. expr puede ser solo uno de los siguientes:
andGroup

object (FunnelParameterFilterExpressionList)

Los FunnelParameterFilterExpression en andGroup tienen una relación AND.
orGroup

object (FunnelParameterFilterExpressionList)

Los FunnelParameterFilterExpression en orGroup tienen una relación OR.
notExpression

object (FunnelParameterFilterExpression)

FunnelParameterFilterExpression NO es de notExpression.
funnelParameterFilter

object (FunnelParameterFilter)

Es un filtro de parámetros de embudo primitivo.

FunnelParameterFilterExpressionList

Es una lista de expresiones de filtro de parámetros del embudo.

Representación JSON 
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
Campos
expressions[]

object (FunnelParameterFilterExpression)

Es la lista de expresiones de filtro de parámetros del embudo.

FunnelParameterFilter

Es una expresión para filtrar los valores de los parámetros en un embudo.

Representación JSON 
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Campos
Campo de unión one_parameter. Es el campo por el que se filtra. one_parameter puede ser solo uno de los parámetros siguientes:
eventParameterName

string

Este filtro se evaluará en el parámetro de evento especificado. Los parámetros de eventos 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 usar en segmentos y embudos, y solo se pueden usar en un filtro descendiente de un EventFilter. En un filtro descendiente de un EventFilter, se deben usar parámetros de evento o de elemento.
itemParameterName

string

Este filtro se evaluará en el parámetro del elemento especificado. Los parámetros del elemento se registran como parámetros en el array de elementos. Los parámetros del elemento incluyen campos como "item_name" y "item_category".

Los parámetros del elemento solo se pueden usar en segmentos y embudos, y solo se pueden usar en un filtro descendiente de un EventFilter. En un filtro descendiente de un EventFilter, se deben usar parámetros de evento o de elemento.

Los parámetros del artículo solo están disponibles en los eventos de comercio electrónico. Para obtener más información sobre los eventos de comercio electrónico, consulta la guía Cómo medir el comercio electrónico.
Campo de unión one_filter. Especifica un tipo de filtro. one_filter puede ser solo uno de los parámetros siguientes:
stringFilter

object (StringFilter)

Es el filtro relacionado con cadenas.
inListFilter

object (InListFilter)

Es un filtro para los valores de la lista.
numericFilter

object (NumericFilter)

Es un filtro para valores numéricos o de fecha.
betweenFilter

object (BetweenFilter)

Es un filtro para valores entre dos valores.

FunnelBreakdown

Los desgloses agregan una dimensión a la respuesta del informe secundario de la tabla del embudo.

Representación JSON 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
Campos
breakdownDimension

object (Dimension)

Es la columna de dimensión que se agregó a la respuesta del subinforme de la tabla del embudo. La dimensión de desglose desglosa cada paso del embudo de conversión. Se requiere un valor de breakdownDimension válido si se especifica funnelBreakdown.
limit

string (int64 format)

Es la cantidad máxima de valores distintos de la dimensión de desglose que se devolverán en la respuesta. Si no se especifica un límite, se usa un limit de 5. El límite debe ser superior a cero y no puede exceder los 15.

FunnelNextAction

Las siguientes acciones indican el valor de una dimensión después de que el usuario completó un paso, pero antes de que el mismo usuario completara el siguiente paso. Por ejemplo, si nextActionDimension es eventName, entonces nextActionDimension en la fila del paso i del embudo de conversión devolverá el primer evento después del evento que calificó al usuario para el paso i del embudo de conversión, pero antes de que el usuario alcanzara el paso i+1 del embudo de conversión.

Representación JSON 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
Campos
nextActionDimension

object (Dimension)

Es la columna de dimensión que se agregó a la respuesta del subinforme de visualización del embudo. La dimensión de la siguiente acción devuelve el siguiente valor de dimensión de esta dimensión después de que el usuario alcanza el paso i del embudo de conversión.

Actualmente, nextActionDimension solo admite eventName y la mayoría de las dimensiones de página o pantalla, como pageTitle y pagePath. nextActionDimension no puede ser una expresión de dimensión.
limit

string (int64 format)

Es la cantidad máxima de valores distintos de la dimensión de desglose que se devolverán en la respuesta. Si no se especifica un límite, se usa un limit de 5. El límite debe ser superior a cero y no puede superar el 5.

FunnelVisualizationType

Controla las dimensiones presentes en la respuesta del subinforme de visualización del embudo.

Enums
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Tipo no especificado
STANDARD_FUNNEL Es un embudo estándar (escalonado). El subinforme de visualización del embudo en la respuesta no contendrá la fecha.
TRENDED_FUNNEL Un embudo con tendencias (gráfico de líneas). El subinforme de visualización del embudo en la respuesta contendrá la dimensión de fecha.

Segmentar

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, consulta Creador de segmentos.

Representación JSON 
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
Campos
name

string

Es el nombre de este segmento. Si no se especifica, los segmentos se denominan "Segmento". Este nombre define el valor de cadena que devuelve la dimensión segment. La dimensión segment antepone a los nombres de los segmentos el número de índice basado en 1 del segmento en la solicitud (por ejemplo, "1. Segmento", "2. Segmento", etcétera).
Campo de unión one_segment_scope. Un segmento se especifica en un permiso. one_segment_scope puede ser solo uno de los parámetros siguientes:
userSegment

object (UserSegment)

Los segmentos de usuarios son subconjuntos de usuarios que interactuaron con tu sitio o aplicación.
sessionSegment

object (SessionSegment)

Los segmentos de sesiones son subconjuntos de las sesiones que ocurrieron en tu sitio o aplicación.
eventSegment

object (EventSegment)

Los segmentos de eventos son subconjuntos de eventos que se activaron en tu sitio o aplicación.

UserSegment

Los segmentos de usuarios son subconjuntos de usuarios que interactuaron con tu sitio o aplicación; por ejemplo, usuarios que ya realizaron una compra o que agregaron artículos a sus carritos de compras, pero que no completaron una transacción.

Representación JSON 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
Campos
userInclusionCriteria

object (UserSegmentCriteria)

Define qué usuarios se incluyen en este segmento. Opcional.
exclusion

object (UserSegmentExclusion)

Define qué usuarios se excluyen en este segmento. Opcional.

UserSegmentCriteria

Un usuario coincide con un criterio si sus eventos cumplen con las condiciones del criterio.

Representación JSON 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
Campos
andConditionGroups[]

object (UserSegmentConditionGroup)

Un usuario cumple con este criterio si coincide con cada uno de estos andConditionGroups y cada uno de los andSequenceGroups. andConditionGroups puede estar vacío si se especifica andSequenceGroups.
andSequenceGroups[]

object (UserSegmentSequenceGroup)

Un usuario cumple con este criterio si coincide con cada uno de estos andSequenceGroups y cada uno de los andConditionGroups. andSequenceGroups puede estar vacío si se especifica andConditionGroups.

UserSegmentConditionGroup

Las condiciones le indican a Analytics qué datos deben incluirse en el segmento o excluirse de él.

Representación JSON 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
conditionScoping

enum (UserCriteriaScoping)

Los datos se incluyen en el segmento o se excluyen de él según si coinciden con el grupo de condiciones. Este alcance define en cuántos eventos se evalúa el segmentFilterExpression antes de determinar si el grupo de condiciones coincide o no. Por ejemplo, si es conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION, la expresión se evalúa en todos los eventos de una sesión y, luego, se determina si se cumple o no el grupo de condiciones para este usuario. Por ejemplo, si es conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT, la expresión se evalúa en un solo evento y, luego, se determina si se cumple o no el grupo de condiciones para este usuario.

Opcional. Si no se especifica, se usa conditionScoping = ACROSS_ALL_SESSIONS.
segmentFilterExpression

object (SegmentFilterExpression)

Los datos se incluyen en el segmento o se excluyen de él según si coinciden con esta expresión. Las expresiones indican criterios sobre dimensiones, métricas o parámetros.

UserCriteriaScoping

El alcance especifica qué eventos se consideran cuando se evalúa si un usuario cumple con un criterio.

Enums
USER_CRITERIA_SCOPING_UNSPECIFIED Es el alcance de los criterios no especificados. No se debe especificar.
USER_CRITERIA_WITHIN_SAME_EVENT Si se cumplen los criterios en un evento, el usuario coincide con los criterios.
USER_CRITERIA_WITHIN_SAME_SESSION Si se cumplen los criterios en una sesión, el usuario coincide con ellos.
USER_CRITERIA_ACROSS_ALL_SESSIONS Si algún evento del usuario cumple con el criterio, el usuario coincide con él.

SegmentFilterExpression

Expresa combinaciones de filtros de segmentos.

Representación JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de unión expr. Especifica un tipo de filtro para SegmentFilterExpression. expr puede ser solo uno de los siguientes:
andGroup

object (SegmentFilterExpressionList)

Las SegmentFilterExpression en andGroup tienen una relación AND.
orGroup

object (SegmentFilterExpressionList)

Los SegmentFilterExpression en orGroup tienen una relación OR.
notExpression

object (SegmentFilterExpression)

La SegmentFilterExpression NO es de notExpression.
segmentFilter

object (SegmentFilter)

Es un filtro de segmento primitivo.
segmentEventFilter

object (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ámetros, solo el subconjunto de eventos que coincidan con el nombre del evento único y las expresiones de filtro de parámetros coincidirán con este filtro de eventos.

SegmentFilterExpressionList

Es una lista de expresiones de filtro de segmentos.

Representación JSON 
{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}
Campos
expressions[]

object (SegmentFilterExpression)

Es la lista de expresiones de filtro de segmentos.

SegmentFilter

Es una expresión para filtrar valores de dimensiones o métricas.

Representación JSON 
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Campos
fieldName

string

Es el nombre de la dimensión o de la métrica.
filterScoping

object (SegmentFilterScoping)

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

object (StringFilter)

Es el filtro relacionado con cadenas.
inListFilter

object (InListFilter)

Es un filtro para los valores de la lista.
numericFilter

object (NumericFilter)

Es un filtro para valores numéricos o de fecha.
betweenFilter

object (BetweenFilter)

Es un filtro para valores entre dos valores.

SegmentFilterScoping

Los alcances especifican cómo se deben tener en cuenta las dimensiones y las métricas de varios eventos cuando se evalúa un filtro de segmento.

Representación JSON 
{
  "atAnyPointInTime": boolean
}
Campos
atAnyPointInTime

boolean

Si atAnyPointInTime es verdadero, este filtro se evalúa como verdadero para todos los eventos si se evalúa como verdadero para cualquier evento en el período de la solicitud.

Este parámetro atAnyPointInTime no extiende el período de los eventos en el informe. Si atAnyPointInTime es verdadero, solo se consideran los eventos dentro del período del informe cuando se evalúa este filtro.

Este atAnyPointInTime solo se puede especificar si el alcance de los criterios es ACROSS_ALL_SESSIONS y no se puede especificar en secuencias.

Si el alcance de los criterios es ACROSS_ALL_SESSIONS, se usa atAnyPointInTime = false si no se especifica.

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ámetros, solo el subconjunto de eventos que coincidan con el nombre del evento único y las expresiones de filtro de parámetros coincidirán con este filtro de eventos.

Representación JSON 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
Campos
eventName

string

Este filtro coincide con los eventos de este único nombre de evento. El nombre del evento es obligatorio.
segmentParameterFilterExpression

object (SegmentParameterFilterExpression)

Si se especifica, este filtro coincide con los eventos que coinciden con el nombre del evento único y 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 de filtros de segmentos en parámetros.

Representación JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de unión expr. Especifica un tipo de filtro para SegmentParameterFilterExpression. expr puede ser solo uno de los siguientes:
andGroup

object (SegmentParameterFilterExpressionList)

El SegmentParameterFilterExpression en andGroup tiene una relación AND.
orGroup

object (SegmentParameterFilterExpressionList)

El SegmentParameterFilterExpression en orGroup tiene una relación OR.
notExpression

object (SegmentParameterFilterExpression)

El SegmentParameterFilterExpression NO es de notExpression.
segmentParameterFilter

object (SegmentParameterFilter)

Es un filtro de parámetros de segmentos primitivo.

SegmentParameterFilterExpressionList

Es una lista de expresiones de filtro de parámetros de segmentación.

Representación JSON 
{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}
Campos
expressions[]

object (SegmentParameterFilterExpression)

Es la lista de expresiones de filtro de parámetros de segmentación.

SegmentParameterFilter

Es una expresión para filtrar los valores de los parámetros en un segmento.

Representación JSON 
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Campos
filterScoping

object (SegmentParameterFilterScoping)

Especifica el alcance del filtro.
Campo de unión one_parameter. Es el campo por el que se filtra. one_parameter puede ser solo uno de los parámetros siguientes:
eventParameterName

string

Este filtro se evaluará en el parámetro de evento especificado. Los parámetros de eventos 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 usar en segmentos y embudos, y solo se pueden usar en un filtro descendiente de un EventFilter. En un filtro descendiente de un EventFilter, se deben usar parámetros de evento o de elemento.
itemParameterName

string

Este filtro se evaluará en el parámetro del elemento especificado. Los parámetros del elemento se registran como parámetros en el array de elementos. Los parámetros del elemento incluyen campos como "item_name" y "item_category".

Los parámetros del elemento solo se pueden usar en segmentos y embudos, y solo se pueden usar en un filtro descendiente de un EventFilter. En un filtro descendiente de un EventFilter, se deben usar parámetros de evento o de elemento.

Los parámetros del artículo solo están disponibles en los eventos de comercio electrónico. Para obtener más información sobre los eventos de comercio electrónico, consulta la guía Cómo medir el comercio electrónico.
Campo de unión one_filter. Especifica un tipo de filtro. one_filter puede ser solo uno de los parámetros siguientes:
stringFilter

object (StringFilter)

Es el filtro relacionado con cadenas.
inListFilter

object (InListFilter)

Es un filtro para los valores de la lista.
numericFilter

object (NumericFilter)

Es un filtro para valores numéricos o de fecha.
betweenFilter

object (BetweenFilter)

Es un filtro para valores entre dos valores.

SegmentParameterFilterScoping

Los alcances especifican cómo se deben tener en cuenta varios eventos cuando se evalúa un filtro de parámetros de segmento.

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

string (int64 format)

Acumula el parámetro durante el período especificado de días antes de aplicar el filtro. Solo se admite si el alcance de los criterios es ACROSS_ALL_SESSIONS o WITHIN_SAME_SESSION. Solo se admite si el parámetro es event_count.

Por ejemplo, si inAnyNDayPeriod es 3, el nombre del evento es "purchase", el parámetro de evento es "event_count" y el criterio del filtro es mayor que 5, este filtro acumulará el recuento de eventos de compra durante cada período de 3 días consecutivos en el rango de fechas del informe. Un usuario pasará el criterio de este filtro para incluirse en este segmento si su recuento de eventos de compra supera los 5 en cualquier período de 3 días consecutivos. Por ejemplo, se considerarán los períodos del 2021-11-01 al 2021-11-03, del 2021-11-02 al 2021-11-04, del 2021-11-03 al 2021-11-05, etcétera.

El período no se extiende para tener un período completo de N días cerca del inicio del período. Por ejemplo, si un informe abarca del 2021-11-01 al 2021-11-10 y inAnyNDayPeriod = 3, el primer período de dos días se acortará de manera efectiva porque no se leerán datos de eventos fuera del período del informe. Por ejemplo, los primeros cuatro períodos serán del 2021-11-01 al 2021-11-01, del 2021-11-01 al 2021-11-02, del 2021-11-01 al 2021-11-03 y del 2021-11-02 al 2021-11-04.

inAnyNDayPeriod es opcional. Si no se especifica, el segmentParameterFilter se aplica a cada evento de forma individual.

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 (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
Campos
sequenceScoping

enum (UserCriteriaScoping)

Todos los pasos de la secuencia deben cumplirse en el alcance para que el usuario coincida con la secuencia. Por ejemplo, si es sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, todos los pasos de la secuencia deben completarse en una sesión para que el usuario coincida con la secuencia. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT no es compatible.

Opcional. Si no se especifica, se usa conditionScoping = ACROSS_ALL_SESSIONS.
sequenceMaximumDuration

string (Duration format)

Define el período en el que debe ocurrir toda la secuencia; por ejemplo, 30 minutos. sequenceMaximumDuration incluye el extremo con una granularidad de microsegundos. Por ejemplo, una secuencia con una duración máxima de 5 segundos se puede completar en 4.9 o 5.0 segundos, pero no en 5 segundos y 1 microsegundo.

sequenceMaximumDuration es opcional y, si no se especifica, las secuencias se pueden completar en cualquier período.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
userSequenceSteps[]

object (UserSequenceStep)

Es una secuencia ordenada de pasos de condición. Los eventos de un usuario deben completar cada paso para que el usuario coincida con el UserSegmentSequenceGroup.

UserSequenceStep

Es 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 (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
isDirectlyFollowedBy

boolean

Si es verdadero, el evento que satisface este paso debe ser el evento inmediatamente posterior al evento que satisface el último paso. Si es falso, este paso sigue indirectamente al paso anterior; por ejemplo, puede haber eventos entre el paso anterior y este paso. isDirectlyFollowedBy debe ser falso para el primer paso.
stepScoping

enum (UserCriteriaScoping)

Este paso de la secuencia debe cumplirse en el alcance para que el usuario coincida con la secuencia. Por ejemplo, si es sequenceScoping = WITHIN_SAME_SESSION, estos pasos de la secuencia deben completarse en una sesión para que el usuario coincida con la secuencia. stepScoping = ACROSS_ALL_SESSIONS solo se permite si es sequenceScoping = ACROSS_ALL_SESSIONS.

Opcional. Si no se especifica, stepScoping usa el mismo UserCriteriaScoping que el sequenceScoping.
segmentFilterExpression

object (SegmentFilterExpression)

Un usuario coincide con este paso de la secuencia si sus eventos coinciden con esta expresión. Las expresiones indican criterios sobre dimensiones, métricas o parámetros.

UserSegmentExclusion

Especifica qué usuarios se excluyen en este segmento.

Representación JSON 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
Campos
userExclusionDuration

enum (UserExclusionDuration)

Especifica cuánto durará una exclusión si un usuario coincide con el userExclusionCriteria.

Opcional. Si no se especifica, se usa userExclusionDuration de USER_EXCLUSION_TEMPORARY.
userExclusionCriteria

object (UserSegmentCriteria)

Si un usuario cumple con esta condición, se lo excluye de la membresía del segmento durante el período userExclusionDuration.

UserExclusionDuration

Enumera las opciones sobre la duración de una exclusión si un usuario coincide con el userExclusionCriteria.

Enums
USER_EXCLUSION_DURATION_UNSPECIFIED Es la duración de la exclusión sin especificar. No se debe especificar.
USER_EXCLUSION_TEMPORARY Excluye temporalmente a los usuarios del segmento durante los períodos en que cumplan la condición userExclusionCriteria.
USER_EXCLUSION_PERMANENT Excluye permanentemente a los usuarios del segmento si alguna vez cumplen la condición userExclusionCriteria.

SessionSegment

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 (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
Campos
sessionInclusionCriteria

object (SessionSegmentCriteria)

Define qué sesiones se incluyen en este segmento. Opcional.
exclusion

object (SessionSegmentExclusion)

Define qué sesiones se excluyen en este segmento. Opcional.

SessionSegmentCriteria

Una sesión coincide con un criterio si los eventos de la sesión cumplen con las condiciones del criterio.

Representación JSON 
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
Campos
andConditionGroups[]

object (SessionSegmentConditionGroup)

Una sesión coincide con este criterio si coincide con cada uno de estos andConditionGroups.

SessionSegmentConditionGroup

Las condiciones le indican a Analytics qué datos deben incluirse en el segmento o excluirse de él.

Representación JSON 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
conditionScoping

enum (SessionCriteriaScoping)

Los datos se incluyen en el segmento o se excluyen de él según si coinciden con el grupo de condiciones. Este alcance define en cuántos eventos se evalúa el segmentFilterExpression antes de determinar si el grupo de condiciones coincide o no. Por ejemplo, si es conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION, la expresión se evalúa en todos los eventos de una sesión y, luego, se determina si el grupo de condiciones coincide o no con esta sesión. Por ejemplo, si es conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT, la expresión se evalúa en un solo evento y, luego, se determina si el grupo de condiciones coincide o no con esta sesión.

Opcional. Si no se especifica, se usa un conditionScoping de WITHIN_SAME_SESSION.
segmentFilterExpression

object (SegmentFilterExpression)

Los datos se incluyen en el segmento o se excluyen de él según si coinciden con esta expresión. Las expresiones indican criterios sobre dimensiones, métricas o parámetros.

SessionCriteriaScoping

El alcance especifica qué eventos se consideran cuando se evalúa si una sesión cumple con un criterio.

Enums
SESSION_CRITERIA_SCOPING_UNSPECIFIED Es el alcance de los criterios no especificados. No se debe especificar.
SESSION_CRITERIA_WITHIN_SAME_EVENT Si se cumplen los criterios en un evento, la sesión coincide con los criterios.
SESSION_CRITERIA_WITHIN_SAME_SESSION Si se cumplen los criterios dentro de una sesión, la sesión coincide con los criterios.

SessionSegmentExclusion

Especifica qué sesiones se excluyen en este segmento.

Representación JSON 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
Campos
sessionExclusionDuration

enum (SessionExclusionDuration)

Especifica cuánto durará una exclusión si una sesión coincide con sessionExclusionCriteria.

Opcional. Si no se especifica, se usa un sessionExclusionDuration de SESSION_EXCLUSION_TEMPORARY.
sessionExclusionCriteria

object (SessionSegmentCriteria)

Si una sesión cumple con esta condición, se excluye de la membresía en el segmento para el sessionExclusionDuration.

SessionExclusionDuration

Enumera las opciones sobre la duración de una exclusión si una sesión coincide con el sessionExclusionCriteria.

Enums
SESSION_EXCLUSION_DURATION_UNSPECIFIED Es la duración de la exclusión sin especificar. No se debe especificar.
SESSION_EXCLUSION_TEMPORARY Excluye temporalmente las sesiones del segmento durante los períodos en que la sesión cumple con la condición sessionExclusionCriteria.
SESSION_EXCLUSION_PERMANENT Excluye de forma permanente las sesiones del segmento si alguna vez cumplen con la condición sessionExclusionCriteria.

EventSegment

Los segmentos de eventos son subconjuntos de eventos que se activaron en tu 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 (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
Campos
eventInclusionCriteria

object (EventSegmentCriteria)

Define qué eventos se incluyen en este segmento. Opcional.
exclusion

object (EventSegmentExclusion)

Define qué eventos se excluyen en este segmento. Opcional.

EventSegmentCriteria

Un evento coincide con un criterio si cumple las condiciones del criterio.

Representación JSON 
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
Campos
andConditionGroups[]

object (EventSegmentConditionGroup)

Un evento coincide con este criterio si coincide con cada uno de estos andConditionGroups.

EventSegmentConditionGroup

Las condiciones le indican a Analytics qué datos deben incluirse en el segmento o excluirse de él.

Representación JSON 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
conditionScoping

enum (EventCriteriaScoping)

conditionScoping siempre debe ser EVENT_CRITERIA_WITHIN_SAME_EVENT.

Opcional. Si no se especifica, se usa un conditionScoping de EVENT_CRITERIA_WITHIN_SAME_EVENT.
segmentFilterExpression

object (SegmentFilterExpression)

Los datos se incluyen en el segmento o se excluyen de él según si coinciden con esta expresión. Las expresiones indican criterios sobre dimensiones, métricas o parámetros.

EventCriteriaScoping

El alcance especifica qué eventos se consideran cuando se evalúa si un evento cumple con un criterio.

Enums
EVENT_CRITERIA_SCOPING_UNSPECIFIED Es el alcance de los criterios no especificados. No se debe especificar.
EVENT_CRITERIA_WITHIN_SAME_EVENT Si se cumplen los criterios en un evento, el evento coincide con los criterios.

EventSegmentExclusion

Especifica qué eventos se excluyen en este segmento.

Representación JSON 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
Campos
eventExclusionDuration

enum (EventExclusionDuration)

eventExclusionDuration siempre debe ser PERMANENTLY_EXCLUDE.

Opcional. Si no se especifica, se usa un eventExclusionDuration de EVENT_EXCLUSION_PERMANENT.
eventExclusionCriteria

object (EventSegmentCriteria)

Si un evento cumple con esta condición, se excluye de la membresía en el segmento para eventExclusionDuration.

EventExclusionDuration

Enumera las opciones sobre la duración de una exclusión si un evento coincide con eventExclusionCriteria.

Enums
EVENT_EXCLUSION_DURATION_UNSPECIFIED Es la duración de la exclusión sin especificar. No se debe especificar.
EVENT_EXCLUSION_PERMANENT Excluye de forma permanente los eventos del segmento si alguna vez cumplen la condición eventExclusionCriteria.

FunnelSubReport

Los informes secundarios de embudo contienen los valores de datos de las dimensiones y las métricas. Por ejemplo, 12 usuarios llegaron al segundo paso del embudo.

Representación JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
Campos
dimensionHeaders[]

object (DimensionHeader)

Describe las columnas de dimensiones. Los informes de embudo siempre incluyen la dimensión del paso del embudo de conversión en las respuestas de los informes secundarios. Si se solicitan, es posible que en la respuesta se incluyan dimensiones adicionales, como desgloses, fechas y próximas acciones.
metricHeaders[]

object (MetricHeader)

Describe las columnas de métricas. Los informes de embudo siempre incluyen usuarios activos en las respuestas de los informes secundarios. La tabla del embudo incluye métricas adicionales, como el porcentaje de finalización, los abandonos y el porcentaje de abandonos.
rows[]

object (Row)

Son las filas de combinaciones de valores de dimensiones y valores de métricas en el informe.
metadata

object (FunnelResponseMetadata)

Son los metadatos del informe de embudo.

FunnelResponseMetadata

Los metadatos de respuesta del informe de embudo contienen información adicional sobre el informe de embudo.

Representación JSON 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
Campos
samplingMetadatas[]

object (SamplingMetadata)

Si los resultados del informe de embudo son muestreados, se describe qué porcentaje de eventos se usó en este informe de embudo. Se completa un samplingMetadatas para cada período. Cada samplingMetadatas corresponde a un período en el orden en que se especificaron los períodos en la solicitud.

Sin embargo, si los resultados no se muestrean, este campo no se definirá.