Method: reports.batchGet

Muestra los datos de Analytics.

Solicitud HTTP

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
Campos
reportRequests[]

object(ReportRequest)

Solicitudes, cada solicitud tendrá una respuesta independiente. Puede haber un máximo de 5 solicitudes. Todas las solicitudes deben tener los mismos dateRanges, viewId, segments, samplingLevel y cohortGroup.

useResourceQuotas

boolean

Habilita las cuotas basadas en recursos (de forma predeterminada, False). Si este campo se establece en True, las cuotas por vista (perfil) se rigen por el costo de procesamiento de la solicitud. Ten en cuenta que si usas cuotas basadas en el costo, se habilitarán tasas de muestreo más altas. (10 millones para SMALL, 100 millones para LARGE. Consulta la documentación sobre límites y cuotas para obtener más detalles.

Cuerpo de la respuesta

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

Es la clase de respuesta principal que contiene los informes de la llamada batchGet a la API de informes.

Representación JSON
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
Campos
reports[]

object(Report)

Respuestas correspondientes a cada solicitud

queryCost

number

La cantidad de tokens de cuota de recursos deducidos para ejecutar la consulta. Incluye todas las respuestas.

resourceQuotasRemaining

object(ResourceQuotasRemaining)

La cantidad de cuota de recursos restantes para la propiedad.

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

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

ReportRequest

La clase de solicitud principal que especifica la solicitud a la API de informes.

Representación JSON
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
Campos
viewId

string

El ID de vista de Analytics del que se recuperarán los datos. Cada ReportRequest dentro de un método batchGet debe contener el mismo viewId.

dateRanges[]

object(DateRange)

Períodos de la solicitud La solicitud puede tener un máximo de 2 períodos. La respuesta contendrá un conjunto de valores de métrica para cada combinación de las dimensiones de cada período de la solicitud. Por lo tanto, si hay dos períodos, habrá dos conjuntos de valores de métricas, uno para el período original y otro para el segundo. El campo reportRequest.dateRanges no se debe especificar para cohortes ni solicitudes de valor del ciclo de vida del cliente. Si no se proporciona un período, se utiliza el predeterminado (fechaFecha: fecha actual - 7 días, Fecha final: fecha actual - 1 día). Cada ReportRequest dentro de un método batchGet debe contener la misma definición de dateRanges.

samplingLevel

enum(Sampling)

El tamaño de muestra del informe deseado. Si no se especifica el campo samplingLevel, se usa el nivel de muestreo DEFAULT. Cada ReportRequest dentro de un método batchGet debe contener la misma definición de samplingLevel. Para obtener más información, consulte la guía para desarrolladores.

dimensions[]

object(Dimension)

Las dimensiones solicitadas. Las solicitudes pueden tener un total de 9 dimensiones.

dimensionFilterClauses[]

object(DimensionFilterClause)

Las cláusulas de filtro de dimensiones para filtrar los valores de dimensiones. Se combinan de forma lógica con el operador AND. Tenga en cuenta que el filtrado se produce antes de que se agreguen todas las dimensiones, de modo que las métricas que se muestran representan el total solo de las dimensiones relevantes.

metrics[]

object(Metric)

Las métricas solicitadas. Las solicitudes deben especificar al menos una métrica. Las solicitudes pueden tener un total de 10 métricas.

metricFilterClauses[]

object(MetricFilterClause)

Las cláusulas de filtro de métricas. Se combinan de forma lógica con el operador AND. Los filtros de métricas solo consideran el primer período y no el período de comparación. Tenga en cuenta que el filtrado de métricas se produce después de agregar las métricas.

filtersExpression

string

Filtros de dimensiones o métricas que restringen los datos que se muestran para tu solicitud Para usar filtersExpression, proporciona una dimensión o métrica en la que filtrar, seguida de la expresión de filtro. Por ejemplo, la siguiente expresión selecciona la dimensión ga:browser que comienza con Firefox; ga:browser=~^Firefox. Para obtener más información sobre las dimensiones y los filtros de métricas, consulta la Referencia de filtros.

orderBys[]

object(OrderBy)

Ordena por filas de salida. Para comparar dos filas, se aplican los siguientes elementos en orden hasta que se encuentra una diferencia. Todos los períodos del resultado obtienen el mismo orden de filas.

segments[]

object(Segment)

Segmenta los datos que se muestran para la solicitud. Una definición de segmento ayuda a observar un subconjunto de la solicitud de segmento. Una solicitud puede contener hasta cuatro segmentos. Cada ReportRequest dentro de un método batchGet debe contener la misma definición de segments. Las solicitudes con segmentos deben tener la dimensión ga:segment.

pivots[]

object(Pivot)

Las definiciones dinámicas. Las solicitudes pueden tener un máximo de 2 pivotes.

cohortGroup

object(CohortGroup)

Grupo de cohorte asociado con esta solicitud. Si hay un grupo de cohorte en la solicitud, la dimensión ga:cohort debe estar presente. Cada ReportRequest dentro de un método batchGet debe contener la misma definición de cohortGroup.

pageToken

string

Un token de continuación para obtener la siguiente página de los resultados. Si se agrega a la solicitud, se mostrarán las filas después del pageToken. El pageToken debe ser el valor que se muestra en el parámetro nextPageToken en la respuesta a la solicitud reports.batchGet.

pageSize

number

El tamaño de la página es para la paginación y especifica la cantidad máxima de filas mostradas. El tamaño de la página debe ser >= 0. Una consulta muestra el valor predeterminado de 1,000 filas. La API de Analytics Core Reporting muestra un máximo de 100,000 filas por solicitud, independientemente de la cantidad que solicites. También puede mostrar menos filas de las solicitadas si no hay tantos segmentos de dimensiones como esperaba. Por ejemplo, hay menos de 300 valores posibles para ga:country; por lo tanto, cuando segmentas solo por país, no puedes obtener más de 300 filas, incluso si configuras pageSize en un valor más alto.

includeEmptyRows

boolean

Si se establece como falsa, la respuesta no incluye filas si todas las métricas recuperadas son iguales a cero. El valor predeterminado es falso, lo que excluirá estas filas.

hideTotals

boolean

Si se establece como verdadera, se oculta el total de todas las métricas para todas las filas coincidentes para cada período. El valor predeterminado es falso y muestra los totales.

hideValueRanges

boolean

Si se configura como verdadero, se ocultan los valores mínimos y máximos en todas las filas coincidentes. El valor predeterminado es falso y se muestran los rangos de valores.

Muestreo

Valores para el nivel de muestreo.

Enumeradores
SAMPLING_UNSPECIFIED Si no se especifica el campo samplingLevel, se usa el nivel de muestreo DEFAULT.
DEFAULT Muestra una respuesta con un tamaño de muestra que equilibra la velocidad y la exactitud.
SMALL Muestra una respuesta rápida con un tamaño de muestreo más pequeño.
LARGE Muestra una respuesta más precisa con un tamaño de muestra grande. Sin embargo, esto puede provocar que la respuesta sea más lenta.

Dimensión

Las dimensiones son atributos de sus datos. Por ejemplo, la dimensión ga:city indica la ciudad, por ejemplo, "París" o "Nueva York" en la que se origina una sesión.

Representación JSON
{
  "name": string,
  "histogramBuckets": [
    string
  ]
}
Campos
name

string

Nombre de la dimensión que se recuperará, por ejemplo, ga:browser.

histogramBuckets[]

string (int64 format)

Si no está vacío, colocamos los valores de las dimensiones en buckets después de la string en int64. Los valores de dimensión que no sean la representación de string de un valor integral se convertirán en cero. Los valores del bucket deben estar en orden ascendente. Cada bucket está cerrado en el extremo inferior y abierto en el extremo superior. El primer segmento incluye todos los valores menores que el primer límite; el último segmento incluye todos los valores hasta el infinito. Los valores de dimensión que se incluyen en un bucket se transforman en un valor de dimensión nuevo. Por ejemplo, si se proporciona una lista de &0; 1, 3, 4, 7" entonces se muestran los siguientes depósitos:

  • segmento n.o 1: valores < 0, valor de dimensión &ltt;0"
  • bucket n.o 2: valores en [0,1], valor de dimensión "0"
  • segmento n.o 3: valores en [1,3], valor de dimensión "1-2"
  • segmento n.o 4: valores en [3,4], valor de dimensión "3"
  • segmento n.o 5: valores en [4,7], valor de dimensión "4-6"
  • bucket n.o 6: valores >= 7, valor de dimensión "7+"

NOTA: Si aplicas una mutación de histograma en cualquier dimensión y usas esa dimensión en orden, te recomendamos usar el tipo de orden HISTOGRAM_BUCKET para ese propósito. Sin ella, los valores de las dimensiones se ordenarán según el orden del diccionario (lexicográfico). Por ejemplo, el orden ascendente del diccionario es el siguiente:

"<50" "1001+ & &tt;121-1000", "50-120"

Y el orden HISTOGRAM_BUCKET ascendente es el siguiente:

"<50" "50-120", "121-1000" 1001+

El cliente debe solicitar de forma explícita "orderType": "HISTOGRAM_BUCKET" para una dimensión con histogramas modificados.

Cláusula FilterFilter

Un grupo de filtros de dimensiones. Establece el valor del operador para especificar cómo se combinan los filtros de forma lógica.

Representación JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
Campos
operator

enum(FilterLogicalOperator)

El operador para combinar varios filtros de dimensiones. Si no se especifica, se trata como OR.

filters[]

object(DimensionFilter)

El conjunto repetido de filtros. Se combinan de forma lógica según el operador especificado.

FilterLogicalOperator

Cómo se combinan lógicamente los filtros.

Enumeradores
OPERATOR_UNSPECIFIED Operador no especificado. Se trata como una OR.
OR El operador lógico OR
AND El operador lógico AND

Filtro de dimensión

El filtro de dimensión especifica las opciones de filtro de una dimensión.

Representación JSON
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
Campos
dimensionName

string

La dimensión que se usará para filtrar. Un DimensionFilter debe contener una dimensión.

not

boolean

Operador lógico NOT Si este valor booleano se establece como verdadero, se excluirán los valores de dimensión coincidentes en el informe. El valor predeterminado es falso.

operator

enum(Operator)

Cómo hacer coincidir la dimensión con la expresión El valor predeterminado es REGEXP.

expressions[]

string

Strings o expresiones regulares con las que debe coincidir. Solo se usa el primer valor de la lista para la comparación, a menos que el operador sea IN_LIST. Si es un operador IN_LIST, se usa toda la lista para filtrar las dimensiones como se explica en la descripción del operador IN_LIST.

caseSensitive

boolean

¿La coincidencia debe distinguir entre mayúsculas y minúsculas? El valor predeterminado es falso.

Operador

Se admiten diferentes tipos de concordancia.

Enumeradores
OPERATOR_UNSPECIFIED Si no se especifica el tipo de concordancia, se lo trata como un REGEXP.
REGEXP La expresión de coincidencia se trata como una expresión regular. No todos los tipos de concordancia se consideran expresiones regulares.
BEGINS_WITH Coincide con el valor que comienza con la expresión de coincidencia proporcionada.
ENDS_WITH Coincide con los valores que terminan con la expresión de coincidencia proporcionada.
PARTIAL Coincidencia de substring.
EXACT El valor debe coincidir con la expresión de coincidencia por completo.
NUMERIC_EQUAL

Filtros de comparación de números enteros. Se ignora la distinción entre mayúsculas y minúsculas para estos y se supone que la expresión es una string que representa un número entero. Condiciones de falla:

  • Si la expresión no es un int64 válido, el cliente debe esperar un error.
  • Las dimensiones de entrada que no son valores int64 válidos nunca coincidirán con el filtro.
NUMERIC_GREATER_THAN Comprueba si la dimensión es numéricamente mayor que la expresión de coincidencia. Lee la descripción de NUMERIC_EQUALS para conocer las restricciones.
NUMERIC_LESS_THAN Comprueba si la dimensión es numéricamente menor que la expresión de coincidencia. Lee la descripción de NUMERIC_EQUALS para conocer las restricciones.
IN_LIST

Esta opción se usa para especificar un filtro de dimensión cuya expresión puede tomar cualquier valor de una lista de valores seleccionada. Esto ayuda a evitar la evaluación de varios filtros de dimensión de concordancia exacta organizados en cada fila de respuesta. Por ejemplo:

expressions: ["A", "B", "C"]

Cualquier fila de respuesta cuya dimensión tenga su valor como A, B o C, coincide con este DimensionFilter.

Métrica

Las métricas son mediciones cuantitativas. Por ejemplo, la métrica ga:users indica la cantidad total de usuarios durante el período solicitado.

Representación JSON
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
Campos
expression

string

Una expresión de métrica en la solicitud. Una expresión se construye a partir de una o más métricas y números. Los operadores aceptados incluyen: Más (+), Menos (-), Negación (Unary -), Dividido por (/), Multiplicado por (*), Paréntesis, Números de cardinales positivos (0-9), pueden incluir decimales y están limitados a 1,024 caracteres. Ejemplo de ga:totalRefunds/ga:users, en la mayoría de los casos, la expresión de métrica es solo un nombre de métrica único como ga:users. Agregar MetricType combinados (p.ej., CURRENCY + PERCENTAGE) generarán resultados inesperados.

alias

string

Un alias para la expresión de métrica es un nombre alternativo para la expresión. El alias se puede usar para filtrar y ordenar. Este campo es opcional y es útil si la expresión no es una métrica única, sino una expresión compleja que no se puede usar para filtrar y ordenar. El alias también se usa en el encabezado de la columna de respuesta.

formattingType

enum(MetricType)

Especifica cómo se debe dar formato a la expresión de métrica, por ejemplo, INTEGER.

MetricType

Los tipos de métricas.

Enumeradores
METRIC_TYPE_UNSPECIFIED El tipo de métrica no está especificado.
INTEGER Métrica de número entero.
FLOAT Métrica flotante.
CURRENCY Métrica de la moneda.
PERCENT Es la métrica de porcentaje.
TIME Métrica de tiempo en formato HH:MM:SS.

Cláusula FilterFilter

Representa un grupo de filtros de métricas. Establece el valor del operador para especificar cómo se combinan los filtros de forma lógica.

Representación JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
Campos
operator

enum(FilterLogicalOperator)

El operador para combinar varios filtros de métricas. Si no se especifica, se trata como OR.

filters[]

object(MetricFilter)

El conjunto repetido de filtros. Se combinan de forma lógica según el operador especificado.

Métrica

MetricFilter especifica el filtro en una métrica.

Representación JSON
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
Campos
metricName

string

La métrica que se filtrará. El valor de metricFilter debe contener un nombre de métrica. Un nombre de métrica puede ser un alias definido anteriormente como una métrica o también una expresión de métrica.

not

boolean

Operador lógico NOT Si este valor booleano se establece como verdadero, los valores de métricas coincidentes se excluirán en el informe. El valor predeterminado es falso.

operator

enum(Operator)

La métrica EQUAL, LESS_THAN o GREATER_THAN es el valor de comparación, y el valor predeterminado es EQUAL. Si el operador es IS_MISSING, comprueba si falta la métrica y, además, ignorará el valor de comparación.

comparisonValue

string

Valor con el que se va a comparar.

Operador

Diferentes opciones de tipos de comparación.

Enumeradores
OPERATOR_UNSPECIFIED Si no se especifica el operador, se lo trata como EQUAL.
EQUAL ¿El valor de la métrica debe ser exactamente igual al valor de comparación?
LESS_THAN ¿El valor de la métrica debe ser menor que el valor de comparación?
GREATER_THAN ¿El valor de la métrica debe ser superior al valor de comparación?
IS_MISSING Valida si falta la métrica. No se tiene en cuenta la comparaciónValue.

OrderBy

Especifica las opciones de orden.

Representación JSON
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder)
}
Campos
fieldName

string

El campo por el que se desea ordenar. El orden de clasificación predeterminado es ascendente. Ejemplo: ga:browser. Ten en cuenta que aquí solo puedes especificar un campo para ordenar. Por ejemplo, ga:browser, ga:city no es válido.

orderType

enum(OrderType)

El tipo de pedido. El valor predeterminado orderType es VALUE.

sortOrder

enum(SortOrder)

El orden de clasificación para el campo.

OrderType

OrderType controla cómo se determina el orden.

Enumeradores
ORDER_TYPE_UNSPECIFIED El tipo de pedido no especificado se considerará como orden en función del valor.
VALUE El orden de clasificación se basa en el valor de la columna elegida; se ve solo en el primer período.
DELTA El orden de clasificación se basa en la diferencia de los valores de la columna elegida entre los dos primeros períodos. Se puede utilizar solo si hay exactamente dos períodos.
SMART El orden de clasificación se basa en el valor ponderado de la columna elegida. Si la columna tiene el formato n/d, el valor ponderado de esta proporción será (n + totals.n)/(d + totals.d). Solo se puede usar para métricas que representan proporciones.
HISTOGRAM_BUCKET El tipo de orden del histograma solo se aplica a las columnas de dimensiones con depósitos de histogramas que no están vacíos.
DIMENSION_AS_INTEGER Si las dimensiones son números de longitud fija, el orden común funcionaría bien. DIMENSION_AS_INTEGER se puede usar si las dimensiones son números de longitud variable.

SortOrder

El orden de clasificación.

Enumeradores
SORT_ORDER_UNSPECIFIED Si no se especifica el orden, el valor predeterminado es ascendente.
ASCENDING Orden ascendente El campo se ordenará de forma ascendente.
DESCENDING Orden descendente El campo se ordenará de forma descendente.

Segmento

La definición de segmento, si el informe debe segmentarse. Un segmento es un subconjunto de los datos de Analytics. Por ejemplo, un segmento completo de usuarios puede estar formado por usuarios de un país o una ciudad en particular.

Representación JSON
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
Campos
Campo de unión dynamicOrById. El segmento se puede definir de forma dinámica mediante DynamicSegment o con un ID de un segmento integrado o personalizado. Las direcciones (dynamicOrById) solo pueden ser una de las siguientes opciones:
dynamicSegment

object(DynamicSegment)

Una definición de segmento dinámico en la solicitud.

segmentId

string

El ID de segmento de un segmento integrado o personalizado, por ejemplo, gaid::-3.

Segmento dinámico

Definición de segmento dinámico para definir el segmento dentro de la solicitud. Un segmento puede seleccionar usuarios, sesiones o ambos.

Representación JSON
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  }
}
Campos
name

string

Es el nombre del segmento dinámico.

userSegment

object(SegmentDefinition)

Segmento de usuarios para seleccionar usuarios para incluir en el segmento.

sessionSegment

object(SegmentDefinition)

Segmento de sesiones para seleccionar las sesiones que se incluirán en el segmento.

Definición de segmento

SegmentDefinition define el segmento como un conjunto de SegmentFilters que se combinan con una operación lógica AND.

Representación JSON
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ]
}
Campos
segmentFilters[]

object(SegmentFilter)

Un segmento se define mediante un conjunto de filtros de segmento que se combinan con una operación lógica AND.

Filtro de segmentos

SegmentFilter define el segmento como un segmento simple o de secuencia. Una condición de segmento simple contiene condiciones de dimensiones y métricas para seleccionar las sesiones o los usuarios. Se puede usar una condición de segmento de secuencia para seleccionar usuarios o sesiones en función de condiciones secuenciales.

Representación JSON
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
Campos
not

boolean

Si es verdadero, busca coincidencias con el complemento de segmento simple o de secuencia. Por ejemplo, para hacer coincidir todas las visitas que no provienen de "Nueva York&quot, podemos definir el segmento de la siguiente manera:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

Campo de unión simpleOrSequence. ¿Es un segmento simple o una definición de segmento de secuencia? Las direcciones (simpleOrSequence) solo pueden ser una de las siguientes opciones:
simpleSegment

object(SimpleSegment)

Las condiciones de segmento simple constan de una o más condiciones de dimensión o métrica que pueden combinarse

sequenceSegment

object(SequenceSegment)

Las condiciones de secuencia constan de uno o más pasos, y cada uno de ellos está definido por una o más condiciones de dimensiones y métricas. Se pueden combinar varios pasos con operadores de secuencias especiales.

Segmento simple

Las condiciones de segmento simple constan de una o más condiciones de dimensiones y métricas que se pueden combinar.

Representación JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ]
}
Campos
orFiltersForSegment[]

object(OrFiltersForSegment)

Una lista de grupos de filtros de segmentos que se combinan con el operador lógico AND.

OrFiltersForSegment

Una lista de filtros de segmentos en el grupo OR se combina con el operador lógico OR.

Representación JSON
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ]
}
Campos
segmentFilterClauses[]

object(SegmentFilterClause)

Lista de filtros de segmentos que se combinarán con un operador OR.

Cláusula de filtro de segmentos

La Cláusula de filtro que se utiliza en la definición de un segmento puede ser una medida o un filtro de dimensión.

Representación JSON
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
Campos
not

boolean

Coincide con el complemento (!) del filtro.

Campo de unión dimensionOrMetricFilter. Dimensión o un filtro de métrica. Las direcciones (dimensionOrMetricFilter) solo pueden ser una de las siguientes opciones:
dimensionFilter

object(SegmentDimensionFilter)

Filtro de dimensión para la definición del segmento.

metricFilter

object(SegmentMetricFilter)

Filtro de métrica para la definición del segmento.

SegmentDimensionFilter

El filtro de dimensión especifica las opciones de filtro de una dimensión.

Representación JSON
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
Campos
dimensionName

string

Nombre de la dimensión para la que se aplica el filtro.

operator

enum(Operator)

El operador que se usará para hacer coincidir la dimensión con las expresiones.

caseSensitive

boolean

Si la coincidencia distingue entre mayúsculas y minúsculas, se ignora para el operador IN_LIST.

expressions[]

string

La lista de expresiones; solo se usa el primer elemento para todos los operadores

minComparisonValue

string

Valores mínimos de comparación para el tipo de concordancia BETWEEN.

maxComparisonValue

string

Valores máximos de comparación para el tipo de concordancia BETWEEN.

Operador

Se admiten diferentes tipos de concordancia.

Enumeradores
OPERATOR_UNSPECIFIED Si no se especifica el tipo de concordancia, se lo trata como un REGEXP.
REGEXP La expresión de coincidencia se trata como una expresión regular. Los demás tipos de concordancia no se tratan como expresiones regulares.
BEGINS_WITH Coincide con los valores que comienzan con la expresión de coincidencia proporcionada.
ENDS_WITH Coincide con los valores que terminan con la expresión de coincidencia proporcionada.
PARTIAL Coincidencia de substring.
EXACT El valor debe coincidir con la expresión de coincidencia por completo.
IN_LIST

Esta opción se usa para especificar un filtro de dimensión cuya expresión puede tomar cualquier valor de una lista de valores seleccionada. Esto ayuda a evitar la evaluación de varios filtros de dimensión de concordancia exacta organizados en cada fila de respuesta. Por ejemplo:

expressions: ["A", "B", "C"]

Cualquier fila de respuesta cuya dimensión tenga su valor como A, B o C, coincide con este DimensionFilter.

NUMERIC_LESS_THAN

Filtros de comparación de números enteros. Se ignora la distinción entre mayúsculas y minúsculas para estos y se supone que la expresión es una string que representa un número entero. Condiciones de falla:

  • Si la expresión no es un int64 válido, el cliente debe esperar un error.
  • Las dimensiones de entrada que no son valores int64 válidos nunca coincidirán con el filtro.

Comprueba si la dimensión es numéricamente menor que la expresión de coincidencia.

NUMERIC_GREATER_THAN Comprueba si la dimensión es numéricamente mayor que la expresión de coincidencia.
NUMERIC_BETWEEN Comprueba si la dimensión está numéricamente entre el mínimo y el máximo de la expresión de coincidencia, y se excluyen los límites.

SegmentMetricFilter

Filtro de métrica que se usará en una cláusula de filtro de segmento.

Representación JSON
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
Campos
scope

enum(Scope)

El alcance de una métrica define el nivel en el que se define esa métrica. El alcance de la métrica especificada debe ser igual o mayor que el alcance principal que se define en el modelo de datos. El alcance principal se define si el segmento selecciona usuarios o sesiones.

metricName

string

La métrica que se filtrará. Un metricFilter debe contener un nombre de métrica.

operator

enum(Operator)

Especifica la operación que se realizará para comparar la métrica. El valor predeterminado es EQUAL.

comparisonValue

string

Valor con el que se va a comparar. Si el operador es BETWEEN, este valor se trata como el valor de comparación mínimo.

maxComparisonValue

string

El valor de comparación máximo solo se usa para el operador BETWEEN.

Alcance

El alcance de una métrica define el nivel en el que se define: PRODUCT, HIT, SESSION o USER. Los valores de las métricas también se pueden informar en alcances superiores a su alcance principal. P. ej.: ga:pageviews y ga:transactions se pueden registrar en los niveles SESSION y USER con solo sumarlos para cada hit que se genere en esas sesiones o para esos usuarios.

Enumeradores
UNSPECIFIED_SCOPE Si no se especifica el alcance, se establece de forma predeterminada como el alcance de la condición, USER o SESSION, según si el segmento intenta elegir usuarios o sesiones.
PRODUCT Alcance del producto.
HIT Alcance del hit.
SESSION Alcance de la sesión.
USER Alcance del usuario.

Operador

Diferentes opciones de tipos de comparación.

Enumeradores
UNSPECIFIED_OPERATOR El operador no especificado se trata como el operador LESS_THAN.
LESS_THAN Comprueba si el valor de la métrica es inferior al valor de comparación.
GREATER_THAN Comprueba si el valor de la métrica es mayor que el valor de comparación.
EQUAL Es un operador igual.
BETWEEN Para el operador intermedio, el mínimo y el máximo son exclusivos. Usaremos LT y GT como comparación.

Segmento de secuencia

Las condiciones de secuencia constan de uno o más pasos, y cada uno de ellos está definido por una o más condiciones de dimensiones y métricas. Se pueden combinar varios pasos con operadores de secuencias especiales.

Representación JSON
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
Campos
segmentSequenceSteps[]

object(SegmentSequenceStep)

La lista de pasos en la secuencia.

firstStepShouldMatchFirstHit

boolean

Si se establece, la condición del primer paso debe coincidir con el primer hit del visitante (en el período).

SegmentSequenceStep

Una definición de secuencia de segmentos.

Representación JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
Campos
orFiltersForSegment[]

object(OrFiltersForSegment)

Una secuencia se especifica con una lista de filtros OR agrupados que se combinan con el operador AND.

matchType

enum(MatchType)

Especifica si el paso precede inmediatamente o puede ser en cualquier momento antes del siguiente paso.

MatchType

El tipo de concordancia de la secuencia.

Enumeradores
UNSPECIFIED_MATCH_TYPE El tipo de concordancia no especificado se considera precedente.
PRECEDES El operador indica que el paso anterior precede al paso siguiente.
IMMEDIATELY_PRECEDES El operador indica que el paso anterior precede inmediatamente al paso siguiente.

Tabla dinámica

El Pivot describe la sección de tabla dinámica de la solicitud. El Pivot ayuda a reorganizar la información de la tabla para ciertos informes, ya que gira los datos en una segunda dimensión.

Representación JSON
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
Campos
dimensions[]

object(Dimension)

Una lista de dimensiones para mostrar como columnas dinámicas. Un Pivot puede tener un máximo de 4 dimensiones. Las dimensiones dinámicas son parte de la restricción de la cantidad total de dimensiones permitidas en la solicitud.

dimensionFilterClauses[]

object(DimensionFilterClause)

DimensionFilterClauses se combina de forma lógica con un operador AND: solo los datos que incluyen todas estas DimensionFilterClauses contribuyen a los valores de esta región dinámica. Los filtros de dimensión se pueden usar para restringir las columnas que se muestran en la región dinámica. Por ejemplo, si tienes ga:browser como la dimensión solicitada en la región dinámica y especificas filtros clave para restringir ga:browser a solo"IE"o"Firefox", solo esos dos navegadores se mostrarán como columnas.

metrics[]

object(Metric)

Las métricas dinámicas. Las métricas dinámicas son parte de la restricción de la cantidad total de métricas permitidas en la solicitud.

startGroup

number

Si se solicitaron k métricas, la respuesta contendrá varios múltiplos dependientes de los datos en el informe. Por ejemplo, si giraste sobre la dimensión ga:browser, obtendrás k columnas para &Firefox; k columnas para &IE; k columnas for &Chrome; etc. El orden de los grupos de columnas se determina por orden descendente de &totales. Los vínculos se dividen por orden lexicográfico de la primera dimensión dinámica, luego por orden lexicográfico de la segunda dimensión dinámica, y así sucesivamente. Por ejemplo, si los totales del primer valor para Firefox, IE y Chrome fueran 8, 2 y 8, respectivamente, el orden de las columnas sería Chrome, Firefox, IE.

Lo siguiente te permite elegir qué grupos de k columnas se incluyen en la respuesta.

maxGroupCount

number

Especifica la cantidad máxima de grupos que se mostrarán. El valor predeterminado es 10 y el valor máximo es 1,000.

Grupo de cohorte

Define un grupo de cohorte. Por ejemplo:

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
Representación JSON
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
Campos
cohorts[]

object(Cohort)

Es la definición de cohorte.

lifetimeValue

boolean

Habilitar valor del ciclo de vida (LTV) El LTV mide el valor del ciclo de vida del cliente para los usuarios adquiridos a través de diferentes canales. Consulte Análisis de grupo y Valor del ciclo de vida del cliente. Si el valor del ciclo de vida del cliente es falso:

  • Los valores de la métrica son similares a los valores del informe de cohorte de la interfaz web.
  • Los períodos de definición de cohorte deben alinearse con la semana y el mes calendario. Es decir, mientras se solicita ga:cohortNthWeek, el startDate de la definición de cohorte debe ser un domingo, y el endDate debe ser el sábado siguiente. Para ga:cohortNthMonth, el startDate debe ser el primer día del mes, y endDate debe ser el último día del mes.

Cuando el valor de trueValue sea verdadero:

  • Los valores de las métricas corresponderán a los valores del informe de valor de la duración de la interfaz web.
  • El informe del valor del ciclo de vida del cliente muestra cómo crecen el valor del usuario (ingresos) y la participación (vistas de aplicaciones, consecuciones de objetivos, sesiones y duración de la sesión) durante los 90 días posteriores a la adquisición de un usuario.
  • Las métricas se calculan como un promedio acumulativo por usuario según el incremento de tiempo.
  • Los períodos de definición de cohorte no deben alinearse con los límites de semanas y meses del calendario.
  • El viewId debe ser un ID de vista de la app

Cohorte

Define una cohorte. Una cohorte es un grupo de usuarios que comparten una característica en común. Por ejemplo, todos los usuarios con la misma fecha de adquisición pertenecen a la misma cohorte.

Representación JSON
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  }
}
Campos
name

string

Un nombre único para la cohorte. Si no se define un nombre, se generará automáticamente con los valores de la cohorte_[1234...].

type

enum(Type)

Tipo de cohorte. Por el momento, el único tipo admitido es FIRST_VISIT_DATE. Si no se especifica este campo, la cohorte se trata como una cohorte de tipo FIRST_VISIT_DATE.

dateRange

object(DateRange)

Se usa para la cohorte FIRST_VISIT_DATE, la cual selecciona usuarios cuya fecha de primera visita es entre la fecha de inicio y la fecha de finalización definidas en el período. Los períodos deben alinearse para las solicitudes de cohorte. Si la solicitud contiene ga:cohortNthDay, debe tener una duración exacta de un día, si ga:cohortNthWeek debe alinearse con el límite de semana (desde el domingo hasta el sábado) y para ga:cohortNthMonth, el período debe alinearse con el mes (a partir del primer día y finalizar el último día del mes). En el caso de las solicitudes de LTV, no existen restricciones como esta. No es necesario que proporciones un período para el campo reportsRequest.dateRanges.

Tipo

El tipo de cohorte.

Enumeradores
UNSPECIFIED_COHORT_TYPE Si no se especifica, se trata como FIRST_VISIT_DATE.
FIRST_VISIT_DATE Cohortes que se seleccionan según la fecha de la primera visita.

Denunciar

La respuesta de datos correspondiente a la solicitud.

Representación JSON
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
Campos
columnHeader

object(ColumnHeader)

Los encabezados de columna.

data

object(ReportData)

Datos de respuesta.

nextPageToken

string

Token de página para recuperar la página siguiente de resultados de la lista.

Encabezado de columna

Encabezados de columna.

Representación JSON
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
Campos
dimensions[]

string

Los nombres de las dimensiones en la respuesta.

metricHeader

object(MetricHeader)

Encabezados de métricas para las métricas en la respuesta.

MetricHeader

Los encabezados de las métricas.

Representación JSON
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
Campos
metricHeaderEntries[]

object(MetricHeaderEntry)

Encabezados para las métricas en la respuesta.

pivotHeaders[]

object(PivotHeader)

Encabezados para los pivotes en la respuesta.

Entrada de encabezado de métrica

Encabezado de las métricas

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

string

El nombre del encabezado.

type

enum(MetricType)

El tipo de métrica, por ejemplo, INTEGER.

PivotHeader

Los encabezados para cada una de las secciones dinámicas definidas en la solicitud.

Representación JSON
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
Campos
pivotHeaderEntries[]

object(PivotHeaderEntry)

Un solo encabezado de sección de tabla dinámica.

totalPivotGroupsCount

number

La cantidad total de grupos para este pivote.

Entrada HeaderHeader

Los encabezados de cada columna de métricas que corresponden a las métricas solicitadas en la sección de pivotes de la respuesta.

Representación JSON
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
Campos
dimensionNames[]

string

El nombre de las dimensiones en la respuesta dinámica.

dimensionValues[]

string

Los valores de las dimensiones de la tabla dinámica.

metric

object(MetricHeaderEntry)

El encabezado de métrica para la métrica en la tabla dinámica.

Datos del informe

La parte de datos del informe.

Representación JSON
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
Campos
rows[]

object(ReportRow)

Hay una ReportRow para cada combinación única de dimensiones.

totals[]

object(DateRangeValues)

Para cada período solicitado, en el conjunto de todas las filas que coinciden con la consulta, cada formato de valor solicitado obtiene un total. Para calcular el total de un formato de valor, primero se suman las métricas mencionadas en el formato de valor y, luego, se evalúa el formato de valor como una expresión escalar. P. ej.: Los &totales&; para 3 / (ga:sessions + 2) calculamos 3 / ((sum of all relevant ga:sessions) + 2). Los totales se calculan antes de la paginación.

rowCount

number

Cantidad total de filas coincidentes para esta consulta.

minimums[]

object(DateRangeValues)

Valores mínimos y máximos que se observan en todas las filas coincidentes. Ambos están vacíos cuando hideValueRanges en la solicitud es falso o cuando rowCount es cero.

maximums[]

object(DateRangeValues)

Valores mínimos y máximos que se observan en todas las filas coincidentes. Ambos están vacíos cuando hideValueRanges en la solicitud es falso o cuando rowCount es cero.

samplesReadCounts[]

string (int64 format)

Si los resultados se muestran, esto muestra la cantidad total de muestras leídas, una entrada por período. Si los resultados no se muestrean, este campo no se definirá. Para obtener más información, consulte la guía para desarrolladores.

samplingSpaceSizes[]

string (int64 format)

Si los resultados se muestran, muestra la cantidad total de muestras presentes, una entrada por período. Si los resultados no se muestrean, este campo no se definirá. Para obtener más información, consulte la guía para desarrolladores.

isDataGolden

boolean

Indica si la respuesta a esta solicitud es dorada o no. Los datos son dorados cuando la misma solicitud no producirá resultados nuevos si se solicita más adelante.

dataLastRefreshed

string (Timestamp format)

La última vez que se actualizaron los datos del informe. Todos los hits que se recibieron antes de esta marca de tiempo se incluyen en el cálculo del informe.

Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

Fila del informe

Una fila del informe

Representación JSON
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
Campos
dimensions[]

string

Lista de dimensiones solicitadas.

metrics[]

object(DateRangeValues)

Lista de métricas para cada período solicitado.

FechaRangoValores

Se usa para mostrar una lista de métricas para una sola combinación de período / dimensión

Representación JSON
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
Campos
values[]

string

Cada valor corresponde a cada métrica de la solicitud.

pivotValueRegions[]

object(PivotValueRegion)

Los valores de cada región de tabla dinámica.

Región de PivotValue

Los valores de la métrica en la región dinámica.

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

string

Los valores de las métricas en cada una de las regiones dinámicas.

Cuotas de recursos restantes

Los tokens de cuota de recursos restantes para la propiedad después de que se completa la solicitud.

Representación JSON
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
Campos
dailyQuotaTokensRemaining

number

Queda una cuota diaria de recursos.

hourlyQuotaTokensRemaining

number

Quedan tokens de cuota de recursos por hora.

Pruébela.