Método reports.batchGet

Devuelve los datos de Analytics.

Solicitud HTTP

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

(Este URI usa la sintaxis de Plantilla URI.)

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
}
Nombre del campo Tipo Descripción
reportRequests[] object(ReportRequest) Solicitudes. Cada solicitud tiene una respuesta distinta. Puede realizarse un máximo de cinco solicitudes y todas deben tener los mismos campos dateRanges, viewId, segments, samplingLevel y cohortGroup.

Cuerpo de la respuesta

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Clase de respuesta principal que incluye los informes de la llamada batchGet de la API de informes.

Representación JSON
{
  "reports": [
    {
      object(Report)
    }
  ],
}
Nombre del campo Tipo Descripción
reports[] object(Report) Respuestas correspondientes a cada solicitud.

Autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

ReportRequest

Clase de solicitud principal que especifica la solicitud de 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,
}
Nombre del campo Tipo Descripción
viewId cadena ID de vista de Analytics a partir del cual se obtienen los datos. Todas las clases ReportRequest de un método batchGet deben tener el mismo valor de viewId.
dateRanges[] object(DateRange) Periodos de la solicitud. La solicitud puede tener un máximo de dos periodos. La respuesta incluirá un conjunto de valores de métricas para cada combinación de dimensiones de cada periodo indicado en la solicitud. De este modo, si hay dos periodos, se incluirán dos conjuntos de valores de métricas, uno para el periodo original y otro para el segundo periodo. El campo reportRequest.dateRanges no debe especificarse para las solicitudes de cohortes o valor del ciclo de vida del cliente. Si no se indica ningún periodo, se utilizará el periodo predeterminado (startDate: fecha actual - 7 días, endDate: fecha actual - 1 día). Todas las clases ReportRequest de un método batchGet deben tener la misma definición de dateRanges.
samplingLevel enum(Sampling) Tamaño de muestra deseado del informe. Si no se especifica ningún valor en el campo samplingLevel, se utilizará el nivel de muestra predeterminado (DEFAULT). Todas las clases ReportRequest de un método batchGet deben tener la misma definición de samplingLevel. Consulta los detalles en la guía para desarrolladores.
dimensions[] object(Dimension) Dimensiones solicitadas. Las solicitudes pueden incluir hasta 7 dimensiones.
dimensionFilterClauses[] object(DimensionFilterClause) Cláusulas del filtro de dimensiones para filtrar los valores de dimensión. Se combinan de forma lógica con el operador AND. Ten en cuenta que el filtrado se realiza antes de agregar dimensiones, de forma que las métricas devueltas representan el total para las dimensiones relevantes únicamente.
metrics[] object(Metric) Métricas solicitadas. En las solicitudes hay que especificar entre 1 y 10 métricas.
metricFilterClauses[] object(MetricFilterClause) Cláusulas del filtro de métricas. Se combinan de forma lógica con el operador AND. Los filtros de métricas no se aplican al periodo comparativo, sino solo al primer periodo. Ten en cuenta que el filtrado de las métricas se realiza después de agregar las métricas.
filtersExpression cadena Filtros de dimensiones o métricas que acotan los datos que devuelve la solicitud. Para usar el campo filtersExpression, debes indicar la dimensión o la métrica por la que quiera filtrar los datos, seguida de la expresión de filtrado. Por ejemplo, la expresión siguiente selecciona la dimensión ga:browser que empieza por Firefox; ga:browser=~^Firefox. Consulta la referencia de filtros para obtener más información sobre los filtros de dimensiones y métricas.
orderBys[] object(OrderBy) Clasificación de las filas de los resultados. Para comparar dos filas, se aplican los elementos del objeto siguiente por orden hasta que se encuentra una diferencia. Se aplica el mismo orden de filas a todos los periodos de los resultados.
segments[] object(Segment) Segmentación de los datos que devuelve la solicitud. La definición de un segmento permite analizar un subconjunto de la solicitud del segmento. Una solicitud puede incluir un máximo de cuatro segmentos. Todas las clases ReportRequest de un método batchGet deben tener la misma definición de segments. Las solicitudes que contengan segmentos deben incluir la dimensión ga:segment.
pivots[] object(Pivot) Definiciones de la tabla dinámica. Las solicitudes pueden tener un máximo de dos tablas dinámicas.
cohortGroup object(CohortGroup) Grupo de cohortes asociado a la solicitud. Si la solicitud contiene un grupo de cohortes, también debe incluir la dimensión ga:cohort. Todas las clases ReportRequest de un método batchGet deben tener la misma definición de cohortGroup.
pageToken cadena Token de continuación para ir a la página siguiente de los resultados. Si se incluye en la solicitud, se obtendrán las filas después de pageToken. El valor de pageToken debe ser el que se ha devuelto en el parámetro nextPageToken de la respuesta a la solicitud reports.batchGet.
pageSize número El tamaño de página sirve para la paginación y especifica el número máximo de filas que devuelve la solicitud. El tamaño de página debe ser >= 0. De forma predeterminada, una consulta devuelve 1000 filas. La API de informes centrales de Analytics devuelve un máximo de 10.000 filas por solicitud, independientemente de las que se hayan solicitado. También puede devolver menos filas de las solicitadas, si hay menos segmentos de dimensión de los previstos. Por ejemplo, hay menos de 300 valores posibles para ga:country, por lo que, al segmentar solo por el país, no se pueden obtener más de 300 filas, aunque se haya configurado pageSize como un valor más alto.
includeEmptyRows booleano Si se configura como "false", la respuesta no incluye ninguna fila si el valor de todas las métricas obtenidas es igual a cero. El valor predeterminado es "false", lo que significa que se excluyen estas filas.
hideTotals booleano Si se configura como "true", se oculta el total de todas las métricas de las filas coincidentes, en ambos periodos. El valor predeterminado es "false" y muestra los totales.
hideValueRanges booleano Si se configura como "true", se ocultan los valores máximo y mínimo de todas las filas coincidentes. El valor predeterminado es "false" y muestra los intervalos de valores.

DateRange

Conjunto de días contiguos: startDate, startDate + 1 día, …, endDate. Las fechas de inicio y de finalización se indican en el formato de fecha AAAA-MM-DD que establece la norma ISO8601.

Representación JSON
{
  "startDate": string,
  "endDate": string,
}
Nombre del campo Tipo Descripción
startDate cadena Fecha de inicio de la consulta en formato AAAA-MM-DD.
endDate cadena Fecha de finalización de la consulta en formato AAAA-MM-DD.

Muestreo

Valores del nivel de muestreo.

Valor de enumeración Descripción
SAMPLING_UNSPECIFIED Si no se especifica ningún valor en el campo samplingLevel, se utiliza el nivel predeterminado (DEFAULT).
DEFAULT Devuelve una respuesta con un tamaño de muestra que equilibra velocidad y precisión.
SMALL Devuelve una respuesta rápida con un tamaño de muestra menor.
LARGE Devuelve una respuesta más exacta con un tamaño de muestra grande, pero puede provocar que la respuesta sea más lenta.

Dimensión

Las dimensiones son atributos de los datos. Por ejemplo, la dimensión ga:city indica la ciudad (como "Madrid" o "Nueva York") desde la que se origina una sesión.

Representación JSON
{
  "name": string,
  "histogramBuckets": [
    string
  ],
}
Nombre del campo Tipo Descripción
name cadena Nombre de la dimensión que se debe obtener. Por ejemplo: ga:browser.
histogramBuckets[] string
(int64 format)

Si el campo no está vacío, colocamos los valores de la dimensión situados en grupos después de la cadena en int64. Los valores de la dimensión que no constituyen una representación en cadena de un valor entero se convierten a cero. El orden de los valores del grupo debe ser ascendente. Cada grupo se cierra por el extremo inferior y se abre por el extremo superior. El "primer" grupo incluye todos los valores inferiores al primer límite y el "último" grupo incluye todos los valores hasta el infinito. Los valores de dimensiones que se encuentran dentro de un grupo se transforman en un nuevo valor de dimensión. Por ejemplo, si uno proporciona una lista de "0, 1, 3, 4, 7", devolvemos los grupos siguientes:

  • grupo n.º 1: valores < 0, valor de dimensión "<0"
  • grupo n.º 2: valores en [0,1), valor de dimensión "0"
  • grupo n.º 3: valores en [1,3), valor de dimensión "1-2"
  • grupo n.º 4: valores en [3,4), valor de dimensión "3"
  • grupo n.º 5: valores en [4,7), valor de dimensión "4-6"
  • grupo n.º 6: valores >= 7, valor de dimensión "7+"

NOTA: Si aplicas la mutación de histograma en alguna dimensión, y utilizas dicha dimensión para ordenar los elementos, te recomendamos que uses el tipo de orden HISTOGRAM_BUCKET. De lo contrario, los valores de la dimensión se clasificarán por orden lexicográfico. Por ejemplo, el orden lexicográfico ascendente es:

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

Y el orden ascendente de HISTOGRAM_BUCKET es:

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

El cliente debe solicitar explícitamente "orderType": "HISTOGRAM_BUCKET" para una dimensión con mutación de histograma.

DimensionFilterClause

Grupo de filtros de dimensión. Configura el valor del operador de modo que especifique la forma lógica en que se combinan los filtros.

Representación JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ],
}
Nombre del campo Tipo Descripción
operator enum(FilterLogicalOperator) Operador para combinar varios filtros de dimensión. Si no se especifica ningún valor, se utiliza OR.
filters[] object(DimensionFilter) Conjunto repetido de filtros. Se combinan de forma lógica según el operador especificado.

FilterLogicalOperator

Lógica que se utiliza para combinar los filtros.

Valor de enumeración Descripción
OPERATOR_UNSPECIFIED Operador no especificado. Se utiliza OR.
OR Operador lógico OR.
AND Operador lógico AND.

DimensionFilter

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

Representación JSON
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean,
}
Nombre del campo Tipo Descripción
dimensionName cadena Dimensión por la que se filtran los resultados. Un campo DimensionFilter debe incluir una dimensión.
not booleano Operador lógico NOT. Si este operador booleano se configura como "true", los valores de dimensión coincidentes se excluyen del informe. El valor predeterminado es "false".
operator enum(Operator) Forma en que se relaciona la dimensión con la expresión. El valor predeterminado es REGEXP.
expressions[] cadena Cadenas o expresión regular con las que deben coincidir los resultados. Solo se usa el primer valor de la lista para la comparación, salvo si el operador es IN_LIST, en cuyo caso se usa toda la lista para filtrar las dimensiones como se explica en la descripción del operador IN_LIST.
caseSensitive booleano Valor que indica si debe tenerse en cuenta el uso de mayúsculas y minúsculas a la hora de obtener los resultados. El valor predeterminado es "false".

Operador

Distintos tipos de concordancia admitidos.

Valor de enumeración Descripción
OPERATOR_UNSPECIFIED Si no se especifica el tipo de concordancia, se utiliza REGEXP.
REGEXP La expresión de concordancia se trata como una expresión regular. No todos los tipos de concordancia se tratan como expresiones regulares.
BEGINS_WITH Se obtiene el valor que empieza con la expresión de concordancia especificada.
ENDS_WITH Se obtiene el valor que finaliza con la expresión de concordancia especificada.
PARTIAL Concordancia de cadena secundaria.
EXACT El valor debe coincidir exactamente con la expresión de concordancia.
NUMERIC_EQUAL

Filtros de comparación de enteros. No distinguen entre mayúsculas y minúsculas y la expresión debe ser una cadena que representa un número entero. Condiciones de error:

  • Si la expresión no es un valor int64 válido, el cliente obtendrá un error.
  • Las dimensiones introducidas que no sean valores int64 válidos no coincidirán nunca con el filtro.
NUMERIC_GREATER_THAN Comprueba si la dimensión es numéricamente mayor que la expresión de concordancia. 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 concordancia. 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 incluir cualquier valor de una lista de valores determinada. Esto evita tener que evaluar varios filtros de dimensión de concordancia exacta unidos con el operador OR en cada fila de la respuesta. Por ejemplo:

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

Las filas de la respuesta cuyas dimensiones tienen el valor A, B o C coinciden con este DimensionFilter.

Métrica

Las métricas son mediciones cuantitativas. Por ejemplo, la métrica ga:users indica el total de usuarios para el periodo solicitado.

Representación JSON
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType),
}
Nombre del campo Tipo Descripción
expression cadena Expresión de métrica de la solicitud. Una expresión se forma con una o varias métricas y cifras. Operadores admitidos: más (+), menos (-), negación (operación unaria -), dividido entre (/), multiplicado por (*), paréntesis, números cardinales positivos (0-9); puede incluir decimales y un máximo de 1024 caracteres. Ejemplo: ga:totalRefunds/ga:users. En la mayoría de los casos, la expresión de métrica es solo el nombre de una métrica, como ga:users. Si se agregan métricas MetricType mixtas, como CURRENCY + PERCENTAGE,) se obtendrán resultados inesperados.
alias cadena Un alias en la expresión de métrica es un nombre alternativo para la expresión. El alias puede usarse para filtrar y ordenar los resultados. Este campo es opcional y resulta útil si la expresión no está formada por una única métrica, sino que es una expresión compleja que no puede usarse para filtrar y ordenar los resultados. El alias también se utiliza en el encabezado de columna de la respuesta.
formattingType enum(MetricType) Especifica cómo debe formatearse la expresión de la métrica. Por ejemplo: INTEGER.

MetricType

Tipos de métricas.

Valor de enumeración Descripción
METRIC_TYPE_UNSPECIFIED No se ha especificado el tipo de métrica.
INTEGER El tipo de métrica es un entero.
FLOAT El tipo de métrica es un número de punto flotante.
CURRENCY El tipo de métrica es una moneda.
PERCENT El tipo de métrica es un porcentaje.
TIME El tipo de métrica es una hora expresada en el formato HH:MM:SS.

MetricFilterClause

Representa un grupo de filtros de métrica. Configura el valor del operador de modo que especifique la forma lógica en que se combinan los filtros.

Representación JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ],
}
Nombre del campo Tipo Descripción
operator enum(FilterLogicalOperator) Operador para combinar varios filtros de métricas. Si no se especifica ningún valor, se utiliza OR.
filters[] object(MetricFilter) Conjunto repetido de filtros. Se combinan de forma lógica según el operador especificado.

MetricFilter

MetricFilter especifica el filtro de una métrica.

Representación JSON
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string,
}
Nombre del campo Tipo Descripción
metricName cadena Métrica por la que se filtrarán los resultados. Un campo metricFilter debe incluir un nombre de métrica. Este nombre puede ser un alias que se haya definido anteriormente como métrica o bien una expresión de métrica.
not booleano Operador lógico NOT. Si este operador booleano se configura como "true", los valores de métrica coincidentes se excluyen del informe. El valor predeterminado es "false".
operator enum(Operator) Indica si la métrica es igual (EQUAL), inferior (LESS_THAN) o superior (GREATER_THAN) al valor de comparación (comparisonValue). El valor predeterminado es EQUAL. Si el operador es IS_MISSING, se comprueba si no hay ninguna métrica e ignora el valor de comparación (comparisonValue).
comparisonValue cadena Valor de comparación.

Operador

Distintas opciones de tipos de comparación.

Valor de enumeración Descripción
OPERATOR_UNSPECIFIED Si no se especifica el operador, se usa 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 inferior al valor de comparación.
GREATER_THAN El valor de la métrica debe ser superior al valor de comparación.
IS_MISSING Comprueba si no hay ninguna métrica. No tiene en cuenta el valor de comparación (comparisonValue).

OrderBy

Especifica las opciones para ordenar los resultados.

Representación JSON
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder),
}
Nombre del campo Tipo Descripción
fieldName cadena Campo por el que se ordenarán los resultados. El orden predeterminado es ascendente. Ejemplo: ga:browser. Recuerda que solo puedes especificar un campo. Por ejemplo, ga:browser, ga:city no es válido.
orderType enum(OrderType) Tipo de orden. El tipo de orden predeterminado es VALUE.
sortOrder enum(SortOrder) Orden según el cual se clasificarán los resultados.

OrderType

El objeto OrderType controla cómo se determina el orden de clasificación.

Valor de enumeración Descripción
ORDER_TYPE_UNSPECIFIED Si no se especifica el tipo de orden, la clasificación se basará en el valor.
VALUE El orden de clasificación se basa en el valor de la columna seleccionada; solo se tiene en cuenta el primer periodo.
DELTA El orden de clasificación se basa en la diferencia de valores de la columna seleccionada entre los dos primeros periodos. Solo se puede usar si hay exactamente dos periodos.
SMART El orden de clasificación se basa en el valor ponderado de la columna seleccionada. Si la columna tiene el formato n/d, el valor ponderado de esta relación será (n + totals.n)/(d + totals.d). Solo se puede usar con las métricas que representan relaciones.
HISTOGRAM_BUCKET El tipo de orden de histograma solo se puede aplicar a las columnas de dimensiones que no tienen grupos de histograma vacíos.
DIMENSION_AS_INTEGER Si las dimensiones son números de longitud fija, puede usarse el orden normal. DIMENSION_AS_INTEGER puede usarse si las dimensions son números de longitud variable.

SortOrder

Orden de clasificación.

Valor de enumeración Descripción
SORT_ORDER_UNSPECIFIED Si no se especifica el orden de clasificación, se utiliza el orden predeterminado ascendente.
ASCENDING Orden ascendente. El campo se ordena en sentido ascendente.
DESCENDING Orden descendente. El campo se ordena en sentido descendente.

Segmento

Definición del segmento en los informes que deban segmentarse. Un segmento es un subconjunto de datos de Analytics. Por ejemplo, de entre todos los usuarios que tienes, un segmento podría estar formado por usuarios de un país o una ciudad concretos.

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.
}
Nombre del campo Tipo Descripción
Campo de unión dynamicOrById. El segmento puede definirse dinámicamente con DynamicSegment o con un ID de un segmento integrado o personalizado. El campo dynamicOrById solo puede ser uno de los siguientes:
dynamicSegment object(DynamicSegment) Definición de segmento dinámico en la solicitud.
segmentId cadena ID de un segmento integrado o personalizado. Por ejemplo: gaid::-3.

DynamicSegment

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

Representación JSON
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  },
}
Nombre del campo Tipo Descripción
name cadena Nombre del segmento dinámico.
userSegment object(SegmentDefinition) Segmento de usuario para seleccionar a los usuarios que se incluirán en el segmento.
sessionSegment object(SegmentDefinition) Segmento de sesión para seleccionar las sesiones que se incluirán en el segmento.

SegmentDefinition

SegmentDefinition define el segmento como un conjunto de SegmentFilters combinados mediante el operador lógico AND.

Representación JSON
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ],
}
Nombre del campo Tipo Descripción
segmentFilters[] object(SegmentFilter) Un segmento se define mediante un conjunto de filtros de segmento que se combinan con el operador lógico AND.

SegmentFilter

SegmentFilter define el segmento como un segmento simple o de secuencia. Una condición de segmento simple incluye condiciones de dimensiones y métricas para seleccionar las sesiones o los usuarios. Una condición de segmento de secuencia puede usarse para seleccionar usuarios o sesiones en función de una serie 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.
}
Nombre del campo Tipo Descripción
not booleano

Si el valor es "true", los resultados coinciden con el complemento del segmento simple o de secuencia. Por ejemplo, para obtener todas las visitas que no proceden de "Nueva York", podemos definir el segmento de este modo:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },
Campo de unión simpleOrSequence. Es la definición de un segmento simple o de secuencia. El campo simpleOrSequence solo puede ser uno de los siguientes:
simpleSegment object(SimpleSegment) Las condiciones de segmento simple constan de una o varias condiciones de dimensión o métrica que se pueden combinar.
sequenceSegment object(SequenceSegment) Las condiciones de secuencia constan de uno o varios pasos, donde cada paso se define mediante una o varias condiciones de dimensión o métrica. Se pueden combinar varios pasos con operadores de secuencia especiales.

SimpleSegment

Las condiciones de segmento simple constan de una o varias condiciones de dimensión o métrica que se pueden combinar.

Representación JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
}
Nombre del campo Tipo Descripción
orFiltersForSegment[] object(OrFiltersForSegment) Lista de grupos de filtros de segmento combinados con el operador lógico AND.

OrFiltersForSegment

Lista de filtros de segmento del grupo OR combinados con el operador lógico OR.

Representación JSON
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ],
}
Nombre del campo Tipo Descripción
segmentFilterClauses[] object(SegmentFilterClause) Lista de filtros de segmento combinados con el operador OR.

SegmentFilterClause

Cláusula de filtro que se usa en una definición de segmento. Puede ser un filtro de métrica o 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.
}
Nombre del campo Tipo Descripción
not booleano Coincide con el complemento (!) del filtro.
Campo de unión dimensionOrMetricFilter. Filtro de dimensión o de métrica. El campo dimensionOrMetricFilter solo puede ser uno de estos:
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 filtrado de una dimensión.

Representación JSON
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string,
}
Nombre del campo Tipo Descripción
dimensionName cadena Nombre de la dimensión para la que se aplica el filtro.
operator enum(Operator) Operador que se usará para relacionar la dimensión con las expresiones.
caseSensitive booleano Indica si la concordancia debe distinguir entre mayúsculas y minúsculas. No se tiene en cuenta con el operador IN_LIST.
expressions[] cadena Lista de expresiones. Solo el primer elemento se usa para todos los operadores.
minComparisonValue cadena Valores de comparación mínimos para el tipo de concordancia BETWEEN.
maxComparisonValue cadena Valores de comparación máximos para el tipo de concordancia BETWEEN.

Operador

Distintos tipos de concordancia admitidos.

Valor de enumeración Descripción
OPERATOR_UNSPECIFIED Si no se especifica el tipo de concordancia, se usa REGEXP.
REGEXP La expresión de concordancia se trata como una expresión regular. Los demás tipos de concordancia no se tratan como expresiones regulares.
BEGINS_WITH Se obtiene el valor que empieza con la expresión de concordancia especificada.
ENDS_WITH Se obtiene el valor que finaliza con la expresión de concordancia especificada.
PARTIAL Concordancia de cadena secundaria.
EXACT El valor debe coincidir exactamente con la expresión de concordancia.
IN_LIST

Esta opción se usa para especificar un filtro de dimensión cuya expresión puede incluir cualquier valor de una lista de valores determinada. Esto evita tener que evaluar varios filtros de dimensión de concordancia exacta unidos con el operador OR en cada fila de la respuesta. Por ejemplo:

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

Las filas de la respuesta cuyas dimensiones tienen el valor A, B o C coinciden con este DimensionFilter.

NUMERIC_LESS_THAN

Filtros de comparación de enteros. No distinguen entre mayúsculas y minúsculas y la expresión debe ser una cadena que representa un número entero. Condiciones de error:

  • Si la expresión no es un valor int64 válido, el cliente obtendrá un error.
  • Las dimensiones introducidas que no sean valores int64 válidos no coincidirán nunca con el filtro.

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

NUMERIC_GREATER_THAN Comprueba si la dimensión es numéricamente mayor que la expresión de concordancia.
NUMERIC_BETWEEN Comprueba si la dimensión se encuentra numéricamente entre el valor mínimo y máximo de la expresión de concordancia (no se incluyen los límites).

SegmentMetricFilter

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

Representación JSON
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string,
}
Nombre del campo Tipo Descripción
scope enum(Scope) El ámbito de una métrica indica el nivel en que se define dicha métrica. El ámbito de métrica especificado debe ser igual o mayor que su ámbito principal definido en el modelo de datos. El ámbito principal se define si el segmento selecciona usuarios o sesiones.
metricName cadena Métrica por la que se filtrarán los resultados. Un campo metricFilter debe incluir un nombre de métrica.
operator enum(Operator) Especifica la operación que debe realizarse para comparar la métrica. El valor predeterminado es EQUAL.
comparisonValue cadena Valor de comparación. Si el operador es BETWEEN, este valor se trata como el valor de comparación mínimo.
maxComparisonValue cadena El valor de comparación máximo solo se usa para el operador BETWEEN.

Ámbito

El ámbito de una métrica indica el nivel en el que se define dicha métrica: PRODUCT, HIT, SESSION o USER. Los valores de métrica también se pueden registrar en ámbitos superiores a su ámbito principal. Por ejemplo, ga:pageviews y ga:transactions se pueden registrar en los niveles SESSION y USER con solo agregarlos para cada hit que se produce en esas sesiones o para dichos usuarios.

Valor de enumeración Descripción
UNSPECIFIED_SCOPE Si no se especifica el ámbito, se usa el ámbito predeterminado USER o SESSION en función de si el segmento intenta seleccionar usuarios o sesiones.
PRODUCT Ámbito de producto.
HIT Ámbito de hit.
SESSION Ámbito de sesión.
USER Ámbito de usuario.

Operador

Distintas opciones de tipos de comparación.

Valor de enumeración Descripción
UNSPECIFIED_OPERATOR Si no se especifica ningún operador, se usa 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 superior al valor de comparación.
EQUAL Operador igual.
BETWEEN En el operador BETWEEN, los valores mínimo y máximo son exclusivos. Se usará LT y GT para la comparación.

SequenceSegment

Las condiciones de secuencia constan de uno o varios pasos, donde cada paso se define mediante una o varias condiciones de dimensión o métrica. Se pueden combinar varios pasos con operadores de secuencia especiales.

Representación JSON
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean,
}
Nombre del campo Tipo Descripción
segmentSequenceSteps[] object(SegmentSequenceStep) Lista de pasos de la secuencia.
firstStepShouldMatchFirstHit booleano Si se define, la condición del primer paso debe coincidir con el primer hit del visitante (dentro del periodo).

SegmentSequenceStep

Definición de una secuencia de segmento.

Representación JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType),
}
Nombre del campo Tipo Descripción
orFiltersForSegment[] object(OrFiltersForSegment) Una secuencia se especifica con una lista de filtros agrupados con OR que se combinan con el operador AND.
matchType enum(MatchType) Especifica si el paso es inmediatamente anterior al próximo paso o si puede producirse en cualquier momento antes de este.

MatchType

Tipo de concordancia de la secuencia.

Valor de enumeración Descripción
UNSPECIFIED_MATCH_TYPE Si no se especifica el tipo de concordancia se usa el valor PRECEDES.
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

La Tabla dinámica describe la sección dinámica de la solicitud. Permite reorganizar la información de la tabla en algunos informes moviendo los datos a otra dimensión.

Representación JSON
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number,
}
Nombre del campo Tipo Descripción
dimensions[] object(Dimension) Lista de dimensiones que se muestran como columnas dinámicas. Las dimensiones dinámicas pueden tener hasta 4 dimensiones y forman parte de la restricción que establece el número máximo de dimensiones permitidas en la solicitud.
dimensionFilterClauses[] object(DimensionFilterClause) Los campos DimensionFilterClauses se combinan de forma lógica con el operador AND: solo los datos que se indican en estos campos DimensionFilterClauses afectan a los valores de esta sección dinámica. Pueden usarse filtros de dimensiones para limitar las columnas que se muestran en la sección dinámica. Por ejemplo, si la dimensión solicitada en la sección dinámica es ga:browser y especificas filtros de clave para limitar ga:browser solo a "IE" o a "Firefox", solo se mostrarán estos dos navegadores como columnas.
metrics[] object(Metric) Métricas dinámicas. Forman parte de la restricción que establece el número máximo de métricas permitidas en la solicitud.
startGroup número

Si se solicitan k métricas, la respuesta incluirá varias columnas de datos múltiples de k del informe. Por ejemplo, si creas una columna dinámica de la dimensión ga:browser, obtendrás k columnas para "Firefox", k columnas para "IE", k columnas para "Chrome", etc. La clasificación de los grupos de columnas la determina el orden descendente del "total" de los primeros k valores. Las uniones se rompen con la clasificación lexicográfica de la primera dimensión dinámica, después con la clasificación lexicográfica de la segunda dimensión dinámica y así sucesivamente. Por ejemplo, si los totales del primer valor de Firefox, IE y Chrome eran 8, 2 y 8, respectivamente, el orden de las columnas será Chrome, Firefox, IE.

Los siguientes valores permiten elegir los grupos de k columnas que se incluirán en la respuesta.

maxGroupCount número Especifica el número máximo de grupos que deben devolverse. El valor predeterminado es 10 y el valor máximo es 1000.

CohortGroup

Define un grupo de cohortes. 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,
}
Nombre del campo Tipo Descripción
cohorts[] object(Cohort) Definición de la cohorte.
lifetimeValue booleano

Habilita el valor del ciclo de vida del cliente (VCV). El VCV mide el valor del ciclo de vida del cliente de los usuarios que se han obtenido a través de distintos canales. Consulta Análisis de grupo y Valor del ciclo de vida del cliente. Si el valor del ciclo de vida del cliente es "false":

  • Los valores de métrica son similares a los valores del informe de cohortes de la interfaz web.
  • Los periodos de la definición de las cohortes deben coincidir con la semana y el mes naturales. Por ejemplo, si se solicita ga:cohortNthWeek, el valor de startDate en la definición de la cohorte debe ser domingo y el valor de endDate debe ser el sábado siguiente; para ga:cohortNthMonth, el valor de startDate debe ser el primer día del mes y el valor de endDate debe ser el último día del mes.

Si el valor del ciclo de vida del cliente es "true":

  • Los valores de la métrica corresponden a los valores del informe Valor del ciclo de vida del cliente de la interfaz web.
  • El informe Valor del ciclo de vida del cliente indica la evolución del valor del usuario (Ingresos) y de sus interacciones (vistas de aplicación, consecuciones de objetivo, sesiones y duración de las sesiones) durante los 90 días posteriores a su adquisición.
  • Las métricas se calculan como valor medio acumulado por usuario y por incremento de tiempo.
  • No es necesario que los periodos de la definición de la cohorte coincidan con la semana y el mes naturales.
  • El valor de viewId debe ser un ID de visita de aplicación.

Cohorte

Define una cohorte. Una cohorte es un grupo de usuarios que comparten una característica 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)
  },
}
Nombre del campo Tipo Descripción
name cadena Nombre exclusivo para la cohorte. Si no se define ningún nombre, se generará uno automáticamente con los valores de cohorte_[1234…].
type enum(Type) Tipo de cohorte. Por ahora, el único tipo admitido es FIRST_VISIT_DATE. Si no se especifica ningún valor en este campo, se usa el tipo de cohorte FIRST_VISIT_DATE.
dateRange object(DateRange) Este campo se usa para la cohorte FIRST_VISIT_DATE. La cohorte selecciona los usuarios cuya fecha de la primera visita se encuentra entre la fecha de inicio y la fecha de finalización definidas en el campo DateRange. Los periodos deben coincidir con las solicitudes de cohorte. Si la solicitud contiene ga:cohortNthDay, el periodo será exactamente de un día. Si contiene ga:cohortNthWeek, el periodo deberá coincidir con el límite de la semana (que empieza un domingo y acaba el sábado siguiente). Si contiene ga:cohortNthMonth, el periodo debe coincidir con el mes (que empieza el primer día y acaba el último día del mes). Las solicitudes de VCV no presentan estas restricciones. No es necesario indicar ningún periodo en el campo reportsRequest.dateRanges.

Tipo

Tipo de cohorte.

Valor de enumeración Descripción
UNSPECIFIED_COHORT_TYPE Si no se especifica ningún valor, se utiliza FIRST_VISIT_DATE.
FIRST_VISIT_DATE Cohortes seleccionadas en función de la fecha de la primera visita.

Informe

Respuesta de datos a la solicitud.

Representación JSON
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string,
}
Nombre del campo Tipo Descripción
columnHeader object(ColumnHeader) Encabezados de columna.
data object(ReportData) Datos de la respuesta.
nextPageToken cadena Token de página para recuperar la siguiente página de resultados de la lista.

ColumnHeader

Encabezados de columna.

Representación JSON
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  },
}
Nombre del campo Tipo Descripción
dimensions[] cadena Nombres de las dimensiones de la respuesta.
metricHeader object(MetricHeader) Encabezados de las métricas de la respuesta.

MetricHeader

Encabezados de las métricas.

Representación JSON
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ],
}
Nombre del campo Tipo Descripción
metricHeaderEntries[] object(MetricHeaderEntry) Encabezados de las métricas de la respuesta.
pivotHeaders[] object(PivotHeader) Encabezados de las tablas dinámicas de la respuesta.

MetricHeaderEntry

Encabezado de las métricas.

Representación JSON
{
  "name": string,
  "type": enum(MetricType),
}
Nombre del campo Tipo Descripción
name cadena Nombre del encabezado.
type enum(MetricType) Tipo de métrica, por ejemplo, INTEGER.

PivotHeader

Encabezados de cada una de las secciones dinámicas definidas en la solicitud.

Representación JSON
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number,
}
Nombre del campo Tipo Descripción
pivotHeaderEntries[] object(PivotHeaderEntry) Encabezado de una sola sección dinámica.
totalPivotGroupsCount número Número total de grupos de la sección dinámica.

PivotHeaderEntry

Encabezados de cada una de las columnas de métricas correspondientes a las métricas solicitadas en la sección dinámica de la respuesta.

Representación JSON
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  },
}
Nombre del campo Tipo Descripción
dimensionNames[] cadena Nombre de las dimensiones en la respuesta dinámica.
dimensionValues[] cadena Valores de las dimensiones en la respuesta dinámica.
metric object(MetricHeaderEntry) Encabezado de la métrica en la respuesta dinámica.

ReportData

Parte del informe que incluye los datos.

Representación JSON
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
}
Nombre del campo Tipo Descripción
rows[] object(ReportRow) Hay un campo ReportRow para cada combinación exclusiva de dimensiones.
totals[] object(DateRangeValues) Todos los formatos de valor solicitados en el conjunto de todas las columnas de cada periodo solicitado obtienen un total. El total de un formato de valor se obtiene calculando primero el total de métricas indicado en el formato de valor y después evaluando el formato de valor como expresión escalar. Por ejemplo, para obtener los "totales" de 3 / (ga:sessions + 2) calculamos 3 / ((sum of all relevant ga:sessions) + 2). Los totales se calculan antes de la paginación.
rowCount número Total de filas que coinciden con la consulta.
minimums[] object(DateRangeValues) Valores mínimo y máximo de todas las filas que coinciden con la consulta. Ambos campos están vacíos si el valor hideValueRanges de la solicitud es "false" o si el valor de rowCount es cero.
maximums[] object(DateRangeValues) Valores mínimo y máximo de todas las filas que coinciden con la consulta. Ambos campos están vacíos si el valor hideValueRanges de la solicitud es "false" o si el valor de rowCount es cero.
samplesReadCounts[] string
(int64 format)
Si los resultados se muestrean, se devuelve el número total de muestras leídas, con una entrada por periodo. Si los resultados no se muestrean, este campo no se define. Consulta los detalles en la guía para desarrolladores.
samplingSpaceSizes[] string
(int64 format)
Si los resultados se muestrean, se devuelve el número total de muestras presentes, con una entrada por periodo. Si los resultados no se muestrean, este campo no se define. Consulta los detalles en la guía para desarrolladores.
isDataGolden booleano Indica si los datos de la respuesta a la solicitud son valiosos o no. Los datos son valiosos cuando la misma solicitud se realiza con posterioridad y no obtiene nuevos resultados.

ReportRow

Fila del informe.

Representación JSON
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ],
}
Nombre del campo Tipo Descripción
dimensions[] cadena Lista de dimensiones solicitadas.
metrics[] object(DateRangeValues) Lista de métricas de cada periodo solicitado.

DateRangeValues

Se usa para devolver una lista de métricas para una única combinación de periodo y dimensión.

Representación JSON
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ],
}
Nombre del campo Tipo Descripción
values[] cadena Cada valor corresponde a una métrica de la solicitud.
pivotValueRegions[] object(PivotValueRegion) Valores de cada sección dinámica.

PivotValueRegion

Valores de métrica de la sección dinámica.

Representación JSON
{
  "values": [
    string
  ],
}
Nombre del campo Tipo Descripción
values[] cadena Valores de las métricas en cada una de las secciones dinámicas.

Pruébalo