Method: properties.runFunnelReport

Muestra un informe de embudo personalizado de tus datos de eventos de Google Analytics. Los datos que muestra la API aparecen 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 el artículo 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 de acceso

Parámetros
property

string

Opcional. Un identificador de la propiedad GA4 de Google Analytics de cuyos eventos se hace un seguimiento. Se especifica en la ruta de la URL y no en el cuerpo. Si deseas obtener más información, consulta dónde encontrar tu ID de propiedad. Dentro de una solicitud por lotes, esta propiedad no debe estar especificada 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 (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. Períodos de los datos que se leerán. 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 de esos días se incluirán en las filas de respuesta de ambos períodos.

funnel

object (Funnel)

Opcional. La configuración del embudo de esta solicitud. Esta configuración de embudo es obligatoria.

funnelBreakdown

object (FunnelBreakdown)

Opcional. Si se especifica, este desglose agrega una dimensión a la respuesta del informe secundario 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 de 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 informe secundario de visualización del embudo. Esta dimensión de acción siguiente expande cada paso del embudo de conversión a los valores únicos de la siguiente acción. Por ejemplo, una próxima acción de la dimensión eventName creará filas para varios eventos (por ejemplo, session_start y click) y el total.

La próxima 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 informe secundario 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 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 tienen un límite de 4 segmentos.

limit

string (int64 format)

Opcional. Es 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, sin importar cuántas pidas. El valor de limit debe ser positivo.

La API también puede mostrar menos filas que la limit solicitada si no hay tantos valores de dimensión como la limit.

dimensionFilter

object (FilterExpression)

Opcional. Los filtros de dimensión te permiten solicitar solo valores de dimensión específicos en el informe. Si deseas obtener más información, consulta el artículo Cómo crear un informe: Filtros de dimensión para ver ejemplos. No se pueden usar métricas en este filtro.

returnPropertyQuota

boolean

Opcional. Activa o desactiva si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra 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 con el paso del embudo, 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 con el paso del embudo, 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 siguiente dimensión de acción solo está presente en la respuesta si se solicitó.

propertyQuota

object (PropertyQuota)

Es el estado de cuota de esta propiedad de Analytics que incluye 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 tipos de respuesta en JSON.

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

DateRange

Un conjunto contiguo de días es startDate, startDate + 1, ..., endDate. Las solicitudes se permiten en un máximo de 4 períodos.

Representación JSON
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Campos
startDate

string

La fecha de inicio inclusiva de la consulta en el formato YYYY-MM-DD. No puede ser posterior a endDate. También se acepta el formato NdaysAgo, yesterday o today y, en ese caso, la fecha se infiere en función de la zona horaria del informe de la propiedad.

endDate

string

La fecha de finalización inclusiva para la consulta en el formato YYYY-MM-DD. No puede ser anterior a startDate. También se acepta el formato NdaysAgo, yesterday o today y, en ese caso, la fecha se infiere en función de la zona horaria del informe de la propiedad.

name

string

Asigna un nombre a este período. En una respuesta del informe, se asigna este nombre a la dimensión dateRange. Si está configurado, no puede comenzar con date_range_ ni RESERVED_. Si no se establece, los períodos se nombran según su índice basado en cero en la solicitud: date_range_0, date_range_1, etcétera.

Embudo

Configura el embudo en una solicitud de informe de embudo. Un embudo informa sobre los usuarios a medida que avanzan en 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

Si se trata de un embudo abierto, los usuarios pueden ingresar en cualquier paso y, en el caso de un embudo cerrado, los usuarios deben ingresar en el primer paso. Opcional. Si no se especifica, se usa un embudo cerrado.

steps[]

object (FunnelStep)

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

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 muestra la dimensión funnelStepName. Por ejemplo, si especificas name = Purchase en el tercer paso del embudo de la solicitud, se generará un 3. Purchase en la respuesta del informe de embudo.

isDirectlyFollowedBy

boolean

Si es verdadero, este paso debe seguir directamente 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)

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 del período que se establece en el paso anterior. withinDurationFromPriorStep incluye el extremo con el nivel de detalle de microsegundos. Por ejemplo, una duración de 5 segundos se puede completar en 4.9 o 5.0 segundos, pero no 5 segundos ni 1 microsegundo.

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

Es una duración en segundos con hasta nueve dígitos decimales que termina 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)

La FunnelFilterExpression en andGroup tiene una relación AND.

orGroup

object (FunnelFilterExpressionList)

La FunnelFilterExpression en orGroup tiene una relación OR.

notExpression

object (FunnelFilterExpression)

La FunnelFilterExpression NO es de notExpression.

funnelFieldFilter

object (FunnelFieldFilter)

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 coincide con el nombre de un solo evento y las expresiones de filtro de parámetros coinciden con este filtro de evento.

FunnelFilterExpressionList

Una lista de expresiones de filtro de embudo

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

object (FunnelFilterExpression)

La lista de expresiones de filtro de embudo.

FunnelFieldFilter

Una expresión para filtrar valores de dimensión o métrica.

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

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

object (StringFilter)

Filtro relacionado con cadenas.

inListFilter

object (InListFilter)

Un filtro para los valores en la lista.

numericFilter

object (NumericFilter)

Un filtro para valores numéricos o de fecha.

betweenFilter

object (BetweenFilter)

Un filtro para entre dos valores.

StringFilter

El filtro para una cadena

Representación JSON
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Campos
matchType

enum (MatchType)

El tipo de concordancia de este filtro.

value

string

El valor de string que se usa para la coincidencia.

caseSensitive

boolean

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 string.
BEGINS_WITH Comienza con el valor de cadena.
ENDS_WITH Termina con el valor de cadena.
CONTAINS Contiene el valor de la cadena.
FULL_REGEXP Coincidencia completa para la expresión regular con el valor de string.
PARTIAL_REGEXP Coincidencia parcial para la expresión regular con el valor de string.

InListFilter

El resultado debe estar en una lista de valores de cadena.

Representación JSON
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Campos
values[]

string

Es la lista de valores de cadena. No puede estar vacío.

caseSensitive

boolean

Si es verdadero, el valor de la string distingue mayúsculas de minúsculas.

NumericFilter

Filtra por valores numéricos o de fecha.

Representación JSON
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Campos
operation

enum (Operation)

El tipo de operación de este filtro.

value

object (NumericValue)

Es 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 que
GREATER_THAN Mayor que
GREATER_THAN_OR_EQUAL Mayor o igual que

NumericValue

Representar un número

Representación JSON
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
Campos
Campo de unión one_value. Uno de los valores numéricos one_value solo puede ser una de las siguientes opciones:
int64Value

string (int64 format)

Valor del número entero

doubleValue

number

Valor doble

BetweenFilter

expresar que el resultado debe estar entre dos números (inclusive).

Representación JSON
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Campos
fromValue

object (NumericValue)

Comienza con este número.

toValue

object (NumericValue)

Termina con este número.

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 coincide con el nombre de un solo evento y las expresiones de filtro de parámetros coinciden con este filtro de evento.

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

string

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

funnelParameterFilterExpression

object (FunnelParameterFilterExpression)

Si se especifica, este filtro coincide con los eventos que coinciden tanto con el nombre del evento único como 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 en los 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)

La FunnelParameterFilterExpression en andGroup tiene una relación AND.

orGroup

object (FunnelParameterFilterExpressionList)

La FunnelParameterFilterExpression en orGroup tiene una relación OR.

notExpression

object (FunnelParameterFilterExpression)

La FunnelParameterFilterExpression NO es de notExpression.

funnelParameterFilter

object (FunnelParameterFilter)

Un filtro de parámetros de embudo primitivo.

FunnelParameterFilterExpressionList

Una lista de expresiones de filtro de parámetros del embudo.

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

object (FunnelParameterFilterExpression)

La lista de expresiones de filtro de parámetros del embudo.

FunnelParameterFilter

Una expresión para filtrar valores de 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. El campo que se filtra. Las direcciones (one_parameter) solo pueden ser una de las siguientes opciones:
eventParameterName

string

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

itemParameterName

string

Este filtro se evaluará en función del parámetro del elemento especificado. Los parámetros del elemento se registran como parámetros en el array del elemento. Los parámetros del artículo incluyen campos como "item_name" y "item_category".

Los parámetros de artículos solo se pueden usar en segmentos y embudos, y en un filtro descendente de un EventFilter. En un filtro descendiente de un EventFilter, se deben usar los parámetros de eventos o elementos.

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. Las direcciones (one_filter) solo pueden ser una de las siguientes opciones:
stringFilter

object (StringFilter)

Filtro relacionado con cadenas.

inListFilter

object (InListFilter)

Un filtro para los valores en la lista.

numericFilter

object (NumericFilter)

Un filtro para valores numéricos o de fecha.

betweenFilter

object (BetweenFilter)

Un filtro para 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 dimensiones que se agregó a la respuesta del informe secundario de la tabla del embudo. La dimensión de desglose desglosa cada paso del embudo de conversión. Se requiere un 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 mostrarán en la respuesta. Si no se especifica el límite, se usa un limit de 5. El límite debe ser superior a cero y no puede ser superior a 15.

Dimensión

Las dimensiones son atributos de tus datos. Por ejemplo, la dimensión de ciudad indica la ciudad donde se origina un evento. Los valores de las dimensiones en las respuestas del informe son cadenas. Por ejemplo, la ciudad podría ser "París" o "Nueva York".

Representación JSON
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Campos
name

string

Es el nombre de la dimensión. Consulta las Dimensiones de la API para obtener la lista de nombres de dimensiones compatibles con los métodos principales de informes, como runReport y batchRunReports. Consulta Dimensiones en tiempo real para ver la lista de nombres de dimensiones compatibles con el método runRealtimeReport. Consulta Dimensiones del embudo para obtener la lista de nombres de dimensiones compatibles con el método runFunnelReport.

Si se especifica dimensionExpression, name puede ser cualquier cadena que desees dentro del grupo de caracteres permitido. Por ejemplo, si una dimensionExpression concatena country y city, puedes llamar a esa dimensión countryAndCity. Los nombres de las dimensiones que elijas deben coincidir con la expresión regular ^[a-zA-Z0-9_]$.

name hace referencia a las dimensiones en dimensionFilter, orderBys, dimensionExpression y pivots.

dimensionExpression

object (DimensionExpression)

Una dimensión puede ser el resultado de una expresión de varias dimensiones. Por ejemplo, la dimensión "país, ciudad": concatenate(país, ", ", ciudad).

DimensionExpression

Se usa para expresar una dimensión que es el resultado de una fórmula de varias dimensiones. Ejemplo de uso: 1) minúscula(dimensión) 2) concatenate(dimensión1, símbolo, dimensión2).

Representación JSON
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
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

object (CaseExpression)

Se utiliza para convertir el valor de una dimensión en minúsculas.

upperCase

object (CaseExpression)

Se usa para convertir el valor de una dimensión en mayúsculas.

concatenate

object (ConcatenateExpression)

Se utiliza para combinar valores de dimensión con una sola dimensión. Por ejemplo, la dimensión "país, ciudad": concatenate(país, ", ", ciudad).

CaseExpression

Se usa para convertir el valor de una dimensión en un solo caso.

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

string

Es el nombre de una dimensión. El nombre debe hacer referencia a un nombre en el campo de dimensiones de la solicitud.

ConcatenateExpression

Se utiliza para combinar valores de dimensión con una sola dimensión.

Representación JSON
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Campos
dimensionNames[]

string

Son los nombres de las dimensiones. Los nombres deben referirse a nombres en el campo de dimensiones de la solicitud.

delimiter

string

El delimitador ubicado entre los nombres de las dimensiones.

Los delimitadores suelen ser caracteres únicos, como "|" o ",", pero pueden ser cadenas más largas. Si un valor de dimensión contiene el delimitador, ambos estarán presentes en respuesta sin distinción. Por ejemplo,si el valor de dimensión 1 es "US,FR", el valor de dimensión 2 es "JP" y el delimitador es ",", la respuesta contendrá "US,FR,JP".

FunnelNextAction

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

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

object (Dimension)

Es la columna de dimensiones que se agregó a la respuesta del informe secundario de visualización del embudo. La siguiente dimensión de acción muestra el siguiente valor de esta dimensión una vez que el usuario haya completado el io paso 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 mostrarán en la respuesta. Si no se especifica el límite, se usa un limit de 5. El límite debe ser superior a cero y no puede ser superior a 5.

FunnelVisualizationType

Controla las dimensiones presentes en la respuesta del informe secundario 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 en la respuesta no contendrá 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.

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

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 "Segment". Este nombre define el valor de cadena que muestra la dimensión segment. La dimensión segment prefija los nombres de los segmentos según 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. Los segmentos se especifican en un alcance. Las direcciones (one_segment_scope) solo pueden ser una de las siguientes opciones:
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 su 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 usuarios que agregaron artículos a sus carritos de compras, pero no completaron una compra.

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 las condiciones de los criterios.

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

object (UserSegmentConditionGroup)

Un usuario coincide con estos criterios si coincide con cada una de estas andConditionGroups y cada una de las andSequenceGroups. andConditionGroups puede estar vacío si se especifican andSequenceGroups.

andSequenceGroups[]

object (UserSegmentSequenceGroup)

Un usuario coincide con estos criterios si coincide con cada una de estas andSequenceGroups y cada una de las andConditionGroups. andSequenceGroups puede estar vacío si se especifican 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)

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

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

segmentFilterExpression

object (SegmentFilterExpression)

Se incluyen datos en el segmento o se excluyen de él según su coincidencia con esta expresión. Las expresiones expresan criterios sobre dimensiones, métricas o parámetros.

UserCriteriaScoping

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

Enumeradores
USER_CRITERIA_SCOPING_UNSPECIFIED Alcance de criterios sin especificar. No especificar.
USER_CRITERIA_WITHIN_SAME_EVENT Si se cumplen los criterios en un evento, el usuario coincide con ellos.
USER_CRITERIA_WITHIN_SAME_SESSION Si los criterios se cumplen en una sesión, el usuario coincidirá con los criterios.
USER_CRITERIA_ACROSS_ALL_SESSIONS Si algún evento del usuario cumple los criterios, este último coincidirá con los criterios.

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)

La SegmentFilterExpression en andGroup tiene una relación AND.

orGroup

object (SegmentFilterExpressionList)

La SegmentFilterExpression en orGroup tiene una relación OR.

notExpression

object (SegmentFilterExpression)

La SegmentFilterExpression NO es de notExpression.

segmentFilter

object (SegmentFilter)

Un filtro de segmentos 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 coincide con el nombre de un solo evento y las expresiones de filtro de parámetros coinciden con este filtro de evento.

SegmentFilterExpressionList

Una lista de expresiones de filtro de segmentos.

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

object (SegmentFilterExpression)

La lista de expresiones de filtro de segmentos

SegmentFilter

Una expresión para filtrar valores de dimensión o métrica.

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

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)

Filtro relacionado con cadenas.

inListFilter

object (InListFilter)

Un filtro para los valores en la lista.

numericFilter

object (NumericFilter)

Un filtro para valores numéricos o de fecha.

betweenFilter

object (BetweenFilter)

Un filtro para entre dos valores.

SegmentFilterScoping

Los permisos especifican cómo se deben considerar las dimensiones y métricas de varios eventos cuando se evalúa un filtro de segmentos.

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 eventos del informe. Si el valor de atAnyPointInTime es verdadero, solo se considerarán los eventos dentro del período del informe cuando se evalúe 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 coincide con el nombre de un solo evento y las expresiones de filtro de parámetros coinciden con este filtro de evento.

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

string

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

segmentParameterFilterExpression

object (SegmentParameterFilterExpression)

Si se especifica, este filtro coincide con los eventos que coinciden tanto con el nombre del evento único como 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 las combinaciones de filtros de segmentos en los 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)

La SegmentParameterFilterExpression en andGroup tiene una relación AND.

orGroup

object (SegmentParameterFilterExpressionList)

La SegmentParameterFilterExpression en orGroup tiene una relación O.

notExpression

object (SegmentParameterFilterExpression)

La SegmentParameterFilterExpression NO es de notExpression.

segmentParameterFilter

object (SegmentParameterFilter)

Un filtro de parámetros de segmento primitivo.

SegmentParameterFilterExpressionList

Una lista de expresiones de filtro de parámetros de segmentos.

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

object (SegmentParameterFilterExpression)

La lista de expresiones de filtro de parámetros de segmento.

SegmentParameterFilter

Una expresión para filtrar valores de 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. El campo que se filtra. Las direcciones (one_parameter) solo pueden ser una de las siguientes opciones:
eventParameterName

string

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

itemParameterName

string

Este filtro se evaluará en función del parámetro del elemento especificado. Los parámetros del elemento se registran como parámetros en el array del elemento. Los parámetros del artículo incluyen campos como "item_name" y "item_category".

Los parámetros de artículos solo se pueden usar en segmentos y embudos, y en un filtro descendente de un EventFilter. En un filtro descendiente de un EventFilter, se deben usar los parámetros de eventos o elementos.

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. Las direcciones (one_filter) solo pueden ser una de las siguientes opciones:
stringFilter

object (StringFilter)

Filtro relacionado con cadenas.

inListFilter

object (InListFilter)

Un filtro para los valores en la lista.

numericFilter

object (NumericFilter)

Un filtro para valores numéricos o de fecha.

betweenFilter

object (BetweenFilter)

Un filtro para entre dos valores.

SegmentParameterFilterScoping

Los permisos especifican cómo se deben considerar 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 de días especificado 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 eventName es "purchase", el parámetro del evento es "event_count" y los criterios del filtro son mayores que 5, este filtro acumulará el recuento de eventos de eventos de compra durante cada período de 3 días consecutivos en el período del informe. Un usuario pasará los criterios de este filtro para que se incluya 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 01-11-2021 al 3-11-2021, del 2-11-2021 al 4-11-2021, del 3-11-11-2021 al 05-11-2021, etcétera.

El período no se extiende como 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 inAnyNDayPeriod = 3, el período de los primeros dos días se acortará de forma efectiva porque no se leerán datos de eventos fuera del período del informe. Por ejemplo, los primeros cuatro períodos serán efectivamente: del 1-11-2021 al 1-11-2021, del 1-11-2021 al 2-11-2021, del 1-11-2021 al 3-11-2021 y del 2-1-11-2021 al 2-11-2021.

inAnyNDayPeriod es opcional. Si no se especifica, se aplica segmentParameterFilter 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, se deben completar todos los pasos de la secuencia 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 el nivel de detalle de microsegundos. Por ejemplo, una secuencia con una duración máxima de 5 segundos se puede completar a 4.9 o 5.0 segundos, pero no 5 segundos ni 1 microsegundo.

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

Es una duración en segundos con hasta nueve dígitos decimales que termina en "s". Ejemplo: "3.5s".

userSequenceSteps[]

object (UserSequenceStep)

Una secuencia ordenada de pasos de condición. Los eventos de un usuario deben completar cada paso para que este coincida con la UserSegmentSequenceGroup.

UserSequenceStep

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 siguiente después del evento que cumple con 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, los pasos de esta secuencia deben completarse en una sesión para que el usuario coincida con la secuencia. stepScoping = ACROSS_ALL_SESSIONS solo se permite si sequenceScoping = ACROSS_ALL_SESSIONS.

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

segmentFilterExpression

object (SegmentFilterExpression)

Un usuario coincide con este paso de la secuencia si sus eventos coinciden con esta expresión. Las expresiones expresan 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 tiempo durará una exclusión si un usuario coincide con 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 en el segmento de userExclusionDuration.

UserExclusionDuration

Enumera las opciones sobre cuánto durará una exclusión si un usuario coincide con userExclusionCriteria.

Enumeradores
USER_EXCLUSION_DURATION_UNSPECIFIED No se especificó la duración de la exclusión. No especificar.
USER_EXCLUSION_TEMPORARY Excluye temporalmente a los usuarios del segmento durante los períodos en los que estos cumplan con la condición userExclusionCriteria.
USER_EXCLUSION_PERMANENT Excluye de forma permanente 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 sus eventos cumplen las condiciones de los criterios.

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

object (SessionSegmentConditionGroup)

Una sesión coincide con estos criterios si coincide con cada uno de los 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)

Se incluyen datos en el segmento o se excluyen de él según su coincidencia con el grupo de condiciones. Este alcance define cuántos eventos se evalúa segmentFilterExpression antes de que se determine que 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 que el grupo de condiciones coincide o no para esta sesión. Por ejemplo, si conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT, la expresión se evalúa en un solo evento y, luego, se determina que el grupo de condiciones coincide o no para esta sesión.

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

segmentFilterExpression

object (SegmentFilterExpression)

Se incluyen datos en el segmento o se excluyen de él según su coincidencia con esta expresión. Las expresiones expresan criterios sobre dimensiones, métricas o parámetros.

SessionCriteriaScoping

El alcance especifica qué eventos se tienen en cuenta cuando se evalúa si una sesión cumple con ciertos criterios.

Enumeradores
SESSION_CRITERIA_SCOPING_UNSPECIFIED Alcance de criterios sin especificar. No especificar.
SESSION_CRITERIA_WITHIN_SAME_EVENT Si se cumplen los criterios en un evento, la sesión coincide con ellos.
SESSION_CRITERIA_WITHIN_SAME_SESSION Si los criterios se cumplen en una sesión, la sesión coincide con ellos.

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 tiempo 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 excluirá de la membresía en el segmento para sessionExclusionDuration.

SessionExclusionDuration

Enumera las opciones sobre cuánto durará una exclusión si una sesión coincide con sessionExclusionCriteria.

Enumeradores
SESSION_EXCLUSION_DURATION_UNSPECIFIED No se especificó la duración de la exclusión. No especificar.
SESSION_EXCLUSION_TEMPORARY Excluye temporalmente sesiones del segmento durante los períodos en los que la sesión cumple con la condición sessionExclusionCriteria.
SESSION_EXCLUSION_PERMANENT Excluye de forma permanente las sesiones del segmento si estas cumplen alguna vez 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 de los criterios.

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

object (EventSegmentConditionGroup)

Un evento coincide con estos criterios 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)

Se incluyen datos en el segmento o se excluyen de él según su coincidencia con esta expresión. Las expresiones expresan criterios sobre dimensiones, métricas o parámetros.

EventCriteriaScoping

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

Enumeradores
EVENT_CRITERIA_SCOPING_UNSPECIFIED Alcance de criterios sin especificar. No especificar.
EVENT_CRITERIA_WITHIN_SAME_EVENT Si se cumplen los criterios dentro de un evento, el evento coincide con ellos.

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 esta condición, se excluye de la membresía en el segmento de eventExclusionDuration.

EventExclusionDuration

Enumera las opciones sobre cuánto durará una exclusión si un evento coincide con eventExclusionCriteria.

Enumeradores
EVENT_EXCLUSION_DURATION_UNSPECIFIED No se especificó la duración de la exclusión. No especificar.
EVENT_EXCLUSION_PERMANENT Excluye eventos del segmento de forma permanente si estos cumplen 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 expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
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

object (FilterExpressionList)

Las FilterExpressions en andGroup tienen una relación de AND.

orGroup

object (FilterExpressionList)

Las FilterExpressions en orGroup tienen una relación OR.

notExpression

object (FilterExpression)

FilterExpression NO es notExpression.

filter

object (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 (FilterExpression)
    }
  ]
}
Campos
expressions[]

object (FilterExpression)

Una lista de expresiones de filtro.

Filtro

Una expresión para filtrar valores de dimensión o métrica.

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

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

object (StringFilter)

Filtro relacionado con cadenas.

inListFilter

object (InListFilter)

Un filtro para los valores en la lista.

numericFilter

object (NumericFilter)

Un filtro para valores numéricos o de fecha.

betweenFilter

object (BetweenFilter)

Un filtro para entre dos valores.

FunnelSubReport

Los informes secundarios de embudo contienen los valores de los 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 de pasos del embudo de conversión en las respuestas del subinforme. Si se solicita, la respuesta puede incluir dimensiones adicionales, como desgloses, fechas y próximas acciones.

metricHeaders[]

object (MetricHeader)

Describe las columnas de métricas. Los informes de embudo siempre incluyen a los usuarios activos en las respuestas del informe secundario. La tabla del embudo incluye métricas adicionales, como el porcentaje de respuesta, los abandonos y el porcentaje de abandonos.

rows[]

object (Row)

Filas de combinaciones de valores de dimensiones y valores de métricas del informe.

metadata

object (FunnelResponseMetadata)

Metadatos del informe de embudo.

DimensionHeader

Describe una columna de dimensiones del informe. Las dimensiones solicitadas en un informe producen entradas de columna dentro de las filas y DimensionHeaders. Sin embargo, las dimensiones que se usan exclusivamente en filtros o expresiones no generan columnas en un informe. En consecuencia, esas dimensiones no generan encabezados.

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

string

Es el nombre de la dimensión.

MetricHeader

Describe una columna de métricas del informe. Las métricas visibles solicitadas en un informe producen entradas de columna dentro de las filas y MetricHeaders. Sin embargo, las métricas que se usan exclusivamente en filtros o expresiones no generan columnas en un informe. En consecuencia, esas métricas no generan encabezados.

Representación JSON
{
  "name": string,
  "type": enum (MetricType)
}
Campos
name

string

El nombre de la métrica.

type

enum (MetricType)

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 Es el tipo de punto flotante.
TYPE_SECONDS Una duración de segundos; un tipo especial de punto flotante.
TYPE_MILLISECONDS Es una duración en milisegundos; un tipo especial de punto flotante.
TYPE_MINUTES Una duración en minutos; un tipo especial de punto flotante.
TYPE_HOURS Una duración en horas; un tipo especial de punto flotante.
TYPE_STANDARD Una métrica personalizada de tipo estándar; un tipo especial de punto flotante.
TYPE_CURRENCY Una cantidad de dinero; un tipo especial de punto flotante.
TYPE_FEET Una longitud en pies; un tipo especial de punto flotante.
TYPE_MILES Es una longitud en millas; un tipo especial de punto flotante.
TYPE_METERS Una longitud en metros; un tipo especial de punto flotante.
TYPE_KILOMETERS Una longitud en kilómetros; un tipo especial de punto flotante.

Fila

Informa los datos de cada fila. Por ejemplo, si RunReportRequest contiene lo siguiente:

"dimensions": [
  {
    "name": "eventName"
  },
  {
    "name": "countryId"
  }
],
"metrics": [
  {
    "name": "eventCount"
  }
]

Esta sería una fila con "in_app_purchase" como eventName, "JP" como countryId y 15 como eventCount:

"dimensionValues": [
  {
    "value": "in_app_purchase"
  },
  {
    "value": "JP"
  }
],
"metricValues": [
  {
    "value": "15"
  }
]
Representación JSON
{
  "dimensionValues": [
    {
      object (DimensionValue)
    }
  ],
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
Campos
dimensionValues[]

object (DimensionValue)

Lista de valores de dimensión solicitados. En un PivotReport, dimensionValues solo se enumeran para las dimensiones incluidas en una tabla dinámica.

metricValues[]

object (MetricValue)

Lista de valores de métricas visibles solicitados.

DimensionValue

Es el valor de una dimensión.

Representación JSON
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Campos
Campo de unión one_value. Un tipo de valor de dimensión one_value puede ser solo una de las siguientes opciones:
value

string

Es el valor como cadena si el tipo de dimensión es una cadena.

MetricValue

Es el valor de una métrica.

Representación JSON
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Campos
Campo de unión one_value. Uno de los valores de la métrica one_value solo puede ser uno de los siguientes:
value

string

Valor de medición. Consulta MetricHeader para conocer el tipo.

FunnelResponseMetadata

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

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

object (SamplingMetadata)

Si los resultados del informe de embudo tienen muestreo, esto describe qué porcentaje de eventos se usó en este informe de embudo. Se propaga un valor de 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á.

SamplingMetadata

Si se realiza un muestreo de los resultados del informe de embudo, estos metadatos describen qué porcentaje de eventos se usó en este informe de embudo para un período determinado. El muestreo es la práctica de analizar un subconjunto de todos los datos para descubrir la información significativa en el conjunto de datos más grande.

Representación JSON
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
Campos
samplesReadCount

string (int64 format)

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 analizaron en este informe de embudo.

samplingSpaceSize

string (int64 format)

Es 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 determinado. El muestreo descubre la información significativa sobre el conjunto de datos más grande, que es el más grande.

Para calcular el porcentaje de datos disponibles que se usaron en este informe de embudo, calcula samplesReadCount/samplingSpaceSize.

PropertyQuota

Es el estado actual de todas las cuotas de esta propiedad de Analytics. Si se agota la cuota de una propiedad, todas las solicitudes a esa propiedad mostrarán errores de recursos agotados.

Representación JSON
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  },
  "concurrentRequests": {
    object (QuotaStatus)
  },
  "serverErrorsPerProjectPerHour": {
    object (QuotaStatus)
  },
  "potentiallyThresholdedRequestsPerHour": {
    object (QuotaStatus)
  },
  "tokensPerProjectPerHour": {
    object (QuotaStatus)
  }
}
Campos
tokensPerDay

object (QuotaStatus)

Las propiedades estándar de Analytics pueden usar hasta 200,000 tokens por día, mientras que las propiedades de Analytics 360 pueden usar 2,000,000 de tokens por día. La mayoría de las solicitudes consumen menos de 10 tokens.

tokensPerHour

object (QuotaStatus)

Las propiedades de Analytics estándar pueden usar hasta 40,000 tokens por hora, mientras que las propiedades de Analytics 360 pueden usar 400,000 tokens por hora. Una solicitud a la API consume una sola cantidad de tokens, que se deduce de todas las cuotas por hora, por día y por proyecto.

concurrentRequests

object (QuotaStatus)

Las propiedades estándares de Analytics pueden enviar hasta 10 solicitudes simultáneas, mientras que las propiedades de Analytics 360 pueden usar hasta 50.

serverErrorsPerProjectPerHour

object (QuotaStatus)

Las propiedades de Analytics estándar y los pares de proyectos de la nube pueden tener hasta 10 errores de servidor por hora. Las propiedades de Analytics 360 y los pares de proyectos en la nube pueden tener hasta 50 errores de servidor por hora.

potentiallyThresholdedRequestsPerHour

object (QuotaStatus)

Las propiedades de Analytics pueden enviar hasta 120 solicitudes con dimensiones posiblemente 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 posiblemente limitadas.

tokensPerProjectPerHour

object (QuotaStatus)

Las propiedades de Analytics pueden usar hasta el 35% de sus tokens por proyecto por hora. Esto equivale a las propiedades de Analytics estándares que pueden usar hasta 14,000 tokens por proyecto por hora y las propiedades de Analytics 360 pueden usar 140,000 tokens por proyecto por hora. Una solicitud a la API consume una sola cantidad de tokens, que 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

integer

Cuota consumida por esta solicitud.

remaining

integer

Cuota restante después de esta solicitud.