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, (la configuración predeterminada es 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 usar cuotas basadas en los costos aumentará la habilitación de las tasas de muestreo. (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:

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

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

object(Report)

Respuestas correspondientes a cada una de las solicitudes

queryCost

number

La cantidad de tokens de cuota de recursos que se deducen para ejecutar la consulta. Incluye todas las respuestas.

resourceQuotasRemaining

object(ResourceQuotasRemaining)

La cantidad de cuota de recursos restante 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 Reporting.

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

Es el ID de vista de Analytics desde el que se recuperan 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étricas 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 métricos: uno para el período original y otro para el segundo. El campo reportRequest.dateRanges no se debe especificar para las cohortes o las solicitudes de valor del ciclo de vida del cliente. Si no se proporciona un período, el predeterminado es (startDate: current date - 7 days, endDate: current date - 1 day). Cada ReportRequest dentro de un método batchGet debe contener la misma definición de dateRanges.

samplingLevel

enum(Sampling)

Indica 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. Si deseas obtener más información, consulta la guía para desarrolladores.

dimensions[]

object(Dimension)

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

dimensionFilterClauses[]

object(DimensionFilterClause)

Las cláusulas de filtro de dimensiones para filtrar valores de dimensión. Se combinan de forma lógica con el operador AND. Ten en cuenta que el filtrado se realiza antes de que se agregue cualquier dimensión, de modo que las métricas que se muestran representan solo el total de las dimensiones relevantes.

metrics[]

object(Metric)

Son 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 del filtro de métricas. Se combinan de forma lógica con el operador AND. Los filtros de métricas solo contemplan el primer período y no el de comparación. Ten en cuenta que el filtrado de las métricas se produce después de que se agregan.

filtersExpression

string

Filtros de dimensión o métrica que restringen los datos que se muestran para tu solicitud. Para usar filtersExpression, proporciona una dimensión o métrica para 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)

Orden de clasificación en las filas de salida. Para comparar dos filas, se aplican los elementos de las siguientes opciones en orden hasta que se encuentra una diferencia. Todos los períodos del resultado tienen el mismo orden de filas.

segments[]

object(Segment)

Segmentar los datos que se muestran para la solicitud La definición de un 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 de tabla dinámica. Las solicitudes pueden tener un máximo de 2 tablas dinámicas.

cohortGroup

object(CohortGroup)

Grupo de cohorte asociado con esta solicitud. Si la solicitud contiene un grupo de cohorte, debe estar presente la dimensión ga:cohort. 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 agregas esto 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 que se muestran. El tamaño de la página debe ser mayor o igual que 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 dimensión como esperas. Por ejemplo, hay menos de 300 valores posibles para ga:country, por lo que, si segmentas solo por país, no podrás obtener más de 300 filas, incluso si estableces pageSize en un valor más alto.

includeEmptyRows

boolean

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

hideTotals

boolean

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

hideValueRanges

boolean

Si se configura como verdadera, se ocultan el mínimo y el máximo en todas las filas coincidentes. El valor predeterminado es falso y se devuelven 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 Devuelve una respuesta con un tamaño de muestra que equilibra la velocidad y la precisión.
SMALL Muestra una respuesta rápida con un tamaño de muestra más pequeño.
LARGE Muestra una respuesta más precisa cuando se usa un tamaño de muestra grande. Sin embargo, esto puede hacer que la respuesta sea más lenta.

Dimensión

Las dimensiones son atributos de tus datos. Por ejemplo, la dimensión ga:city indica la ciudad, como "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 dimensión en buckets después de la cadena hasta int64. Los valores de dimensión que no sean la representación de cadena de un valor integral se convertirán en cero. Los valores de los buckets deben estar en orden creciente. Cada segmento está cerrado en el extremo inferior y abierto en el extremo superior. El bucket “primer” incluye todos los valores inferiores al primer límite, mientras que el “último” bucket incluye todos los valores hasta infinito. Los valores de dimensión que se incluyen en un bucket se transforman en un nuevo valor de dimensión. Por ejemplo, si se muestra una lista de “0, 1, 3, 4, 7”, se mostrarán los siguientes buckets:

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

NOTA: Si aplicas la mutación del histograma en cualquier dimensión y usas esa dimensión en el orden, te recomendamos que uses el tipo de orden HISTOGRAM_BUCKET para ese propósito. De lo contrario, 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”, “1,001+”, “121-1000”, “50-120”

Y el orden ascendente de HISTOGRAM_BUCKET es el siguiente:

“<50”, “50-120”, “121-1000”, “1,001 o más”

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

DimensionFilterClause

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

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 un OR.

filters[]

object(DimensionFilter)

Es el conjunto repetido de filtros. Se combinan lógicamente según el operador especificado.

FilterLogicalOperator

Cómo se combinan lógicamente los filtros.

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

DimensionFilter

El filtro de dimensión especifica las opciones de filtrado en 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 va a filtrar. Un DimensionFilter debe contener una dimensión.

not

boolean

Operador lógico NOT. Si este valor booleano se establece como verdadero, los valores de dimensión coincidentes se excluirán del 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 se debe comparar. Solo se usa el primer valor de la lista para la comparación, a menos que el operador sea IN_LIST. Si el operador es 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 mayúsculas de 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 trata como un REGEXP.
REGEXP La expresión de coincidencia se trata como una expresión regular. No todos los tipos de concordancia se tratan como 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 subcadena.
EXACT El valor debe coincidir en su totalidad con la expresión de coincidencia.
NUMERIC_EQUAL

Filtros de comparación de números enteros. Se ignora la distinción entre mayúsculas y minúsculas para estos filtros, 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 sean 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 evaluar múltiples filtros de dimensiones de concordancia exacta que tienen el operador OR para cada fila de respuesta. Por ejemplo:

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

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

Métrica

Las métricas son las 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. Entre los operadores aceptados, se incluyen los siguientes: Más (+), Menos (-), Negación (Unary -), Dividido por (/), Multiplicado por (*), Paréntesis, Números cardinales positivos (0-9), que pueden incluir decimales y tiene un límite de 1,024 caracteres. ga:totalRefunds/ga:users de ejemplo. En la mayoría de los casos, la expresión de la métrica es solo un nombre de métrica único, como ga:users. Agregar MetricType mixtos (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 sola métrica, sino una expresión compleja que no se puede usar para filtrar ni 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 No se especificó el tipo de métrica.
INTEGER Métrica de número entero
FLOAT Número de punto flotante.
CURRENCY Métrica de moneda.
PERCENT Métrica de porcentaje.
TIME Métrica de tiempo en formato HH:MM:SS.

MetricFilterClause

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

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

enum(FilterLogicalOperator)

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

filters[]

object(MetricFilter)

Es el conjunto repetido de filtros. Se combinan lógicamente 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
}
Campos
metricName

string

La métrica que se filtrará. Un metricFilter debe contener un nombre de métrica. El nombre de una 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 la métrica coincidente se excluirán del informe. El valor predeterminado es falso.

operator

enum(Operator)

Si la métrica EQUAL, LESS_THAN o GREATER_THAN es la comparativaValue, el valor predeterminado es EQUAL. Si el operador es IS_MISSING, verifica si falta la métrica y, además, ignora el comparadorValue.

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 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 mayor que el valor de comparación.
IS_MISSING Valida si falta la métrica. No tiene en cuenta compararValue.

OrderBy

Especifica las opciones de orden.

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

string

El campo según el cual se ordena. El orden 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)

Es el tipo de pedido. El valor predeterminado de 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 Si no se especifica el tipo de orden, se tratará como un orden en función del valor.
VALUE El orden de clasificación se basa en el valor de la columna elegida; solo se considera 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. Solo es utilizable 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) utilizable solo para métricas que representan razones.
HISTOGRAM_BUCKET El tipo de orden de histograma solo se aplica a las columnas de dimensiones con buckets de histogramas que no estén vacíos.
DIMENSION_AS_INTEGER Si las dimensiones son números de longitud fija, la ordenación común simplemente funcionaría bien. Se puede usar DIMENSION_AS_INTEGER si las dimensiones son números de longitud variable.

SortOrder

Es 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 estar segmentado) Un segmento es un subconjunto de los datos de Analytics. Por ejemplo, de todo el conjunto de usuarios, un segmento podría 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 con DynamicSegment o con el 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

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

DynamicSegment

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

Indica el nombre del segmento dinámico.

userSegment

object(SegmentDefinition)

Segmento de usuarios para seleccionar los usuarios que se incluirán en el segmento.

sessionSegment

object(SegmentDefinition)

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

SegmentDefinition

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

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

object(SegmentFilter)

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

SegmentFilter

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, coincide con el complemento del segmento simple o de secuencia. Por ejemplo, para que coincidan todas las visitas que no provengan de "Nueva York", 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 un segmento simple consisten en una o más condiciones de dimensión o métrica que se pueden combinar

sequenceSegment

object(SequenceSegment)

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

SimpleSegment

Las condiciones de un segmento simple constan de una o más condiciones de dimensión o métrica 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 combinan 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.

SegmentFilterClause

La cláusula de filtro que se utilizará en la definición de un segmento puede ser una métrica 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. Filtro de dimensión o 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 de segmento.

SegmentDimensionFilter

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

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

string

Es el nombre de la dimensión a la que se aplica el filtro.

operator

enum(Operator)

Operador que se usa para hacer coincidir la dimensión con las expresiones.

caseSensitive

boolean

Si la coincidencia distingue mayúsculas de minúsculas, se debe ignorar 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 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 subcadena.
EXACT El valor debe coincidir en su totalidad con la expresión de coincidencia.
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 evaluar múltiples filtros de dimensiones de concordancia exacta que tienen el operador OR para cada fila de respuesta. Por ejemplo:

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

Cualquier fila de respuesta cuya dimensión tenga el valor 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 filtros, 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 valor 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 se encuentra numéricamente entre el mínimo y el máximo de la expresión de coincidencia (se excluyen los límites).

SegmentMetricFilter

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

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 permiso de métrica especificado debe ser igual o mayor que su alcance principal, según se define en el modelo de datos. El alcance principal se define en función de 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 debe 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 un valor de comparación mínimo.

maxComparisonValue

string

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

Alcance

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

Enumeradores
UNSPECIFIED_SCOPE Si no se especifica el permiso, la configuración predeterminada será 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 un operador LESS_THAN.
LESS_THAN Comprueba si el valor de la métrica es menor que el valor de comparación.
GREATER_THAN Comprueba si el valor de la métrica es mayor que el valor de comparación.
EQUAL Operador de igualdad.
BETWEEN Para un operador entre, el mínimo y el máximo son exclusivos. Usaremos LT y GT para comparar.

SequenceSegment

Las condiciones de la secuencia constan de uno o más pasos, y cada paso se define mediante una o más 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
}
Campos
segmentSequenceSteps[]

object(SegmentSequenceStep)

Es 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 segmento.

Representación JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
Campos
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 precede inmediatamente al paso siguiente o puede serlo en cualquier momento antes.

MatchType

Es el tipo de concordancia de la secuencia.

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

Dinamizar

El elemento dinámico describe su sección en la solicitud. La tabla dinámica ayuda a reorganizar la información de la tabla para ciertos informes al reorientar los datos a una segunda dimensión.

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

object(Dimension)

Es una lista de las dimensiones que se mostrarán como columnas dinámicas. Una tabla dinámica puede tener un máximo de 4 dimensiones. Las dimensiones dinámicas forman parte de la restricción sobre 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 incluidos por todas estas DimensionFilterClauses contribuyen a los valores de esta región dinámica. Los filtros de dimensión se pueden utilizar para restringir las columnas que se muestran en la región de tabla dinámica. Por ejemplo, si tienes ga:browser como la dimensión solicitada en la región dinámica y especificas filtros de clave para restringir ga:browser a "IE" o "Firefox", solo esos dos navegadores se mostrarán como columnas.

metrics[]

object(Metric)

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

startGroup

number

Si se solicitaron métricas k, la respuesta contendrá varias columnas de k en el informe dependientes de los datos. Por ejemplo, si dinamizas la dimensión ga:browser, obtendrás k columnas para "Firefox", k columnas para "IE", k columnas para "Chrome", etc. El orden de los grupos de columnas se determina por orden descendente de "total" para los primeros de los valores de k. Los vínculos se separan con el orden lexicográfico de la primera dimensión dinámica, luego con el 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, 8, respectivamente, el orden de las columnas sería Chrome, Firefox o IE.

Lo siguiente te permite elegir cuáles de los 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.

CohortGroup

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 la cohorte.

lifetimeValue

boolean

Habilita el valor del ciclo de vida del cliente (LTV). El LTV mide el valor del ciclo de vida del cliente de los usuarios adquiridos a través de diferentes canales. Consulta los siguientes vínculos: Análisis de cohorte y Valor del ciclo de vida del cliente si el valor de lifecycleValue es falso:

  • Los valores de las métricas son similares a los 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, la startDate en la definición de cohorte debe ser un domingo, y el endDate debe ser el sábado siguiente, y para ga:cohortNthMonth, el startDate debe ser el 1er día del mes y el endDate debe ser el último día del mes.

Cuando el lifecycleValue es verdadero, sucede lo siguiente:

  • Los valores de la métrica corresponderán a los valores del informe de Valores del ciclo de vida de la interfaz web.
  • En el informe Valor del ciclo de vida del cliente, se muestra cómo aumentan 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 en el incremento de tiempo.
  • Los períodos de definición de cohorte no deben alinearse con los límites de semana y mes calendario.
  • 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

Es un nombre único para la cohorte. Si no está definido, el nombre se generará automáticamente con valores cohorte_[1234...].

type

enum(Type)

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

dateRange

object(DateRange)

Se utiliza para la cohorte FIRST_VISIT_DATE; la cohorte selecciona usuarios cuya fecha de primera visita se encuentra entre la fecha de inicio y la fecha de finalización definidas en el período. Los períodos deben estar alineados para las solicitudes de cohorte. Si la solicitud contiene ga:cohortNthDay, debe durar exactamente un día. Si ga:cohortNthWeek debe alinearse con el límite de la semana (desde el domingo hasta el sábado) y, para ga:cohortNthMonth, el período debe alinearse con el mes (comienza en el primer día del mes y finaliza el último día del mes). En el caso de las solicitudes de LTV, no hay tales restricciones. No es necesario que proporciones un período para el campo reportsRequest.dateRanges.

Tipo

Es 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 en función de la fecha de la primera visita.

Denuncia

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 las columnas.

data

object(ReportData)

Datos de respuesta.

nextPageToken

string

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

ColumnHeader

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 las métricas en la respuesta

MetricHeader

Son los encabezados para 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 las tablas dinámicas en la respuesta.

MetricHeaderEntry

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 la sección de tabla dinámica.

totalPivotGroupsCount

number

La cantidad total de grupos para esta tabla dinámica.

PivotHeaderEntry

Los encabezados de cada columna de métricas correspondiente a las métricas solicitadas en la sección de elementos dinámicos de la respuesta.

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

string

Es el nombre de las dimensiones en la respuesta de tabla dinámica.

dimensionValues[]

string

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

metric

object(MetricHeaderEntry)

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

ReportData

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 un ReportRow para cada combinación única de dimensiones.

totals[]

object(DateRangeValues)

Por cada período solicitado, para 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 del 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 que coinciden para esta consulta.

minimums[]

object(DateRangeValues)

Valores mínimos y máximos observados en todas las filas coincidentes. Ambos están vacíos cuando la hideValueRanges de la solicitud es falsa o cuando rowCount es cero.

maximums[]

object(DateRangeValues)

Valores mínimos y máximos observados en todas las filas coincidentes. Ambos están vacíos cuando la hideValueRanges de la solicitud es falsa o cuando rowCount es cero.

samplesReadCounts[]

string (int64 format)

Si los resultados se muestrean, 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á. Si deseas obtener más información, consulta la guía para desarrolladores.

samplingSpaceSizes[]

string (int64 format)

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

isDataGolden

boolean

Indica si la respuesta a esta solicitud es dorada o no. Los datos son dorados cuando exactamente la misma solicitud no producirá ningún resultado nuevo si se solicita posteriormente.

dataLastRefreshed

string (Timestamp format)

Corresponde a la última vez que se actualizaron los datos del informe. Todos los hits recibidos 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".

ReportRow

Una fila en el 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.

DateRangeValues

Se usa para mostrar una lista de métricas para una sola combinación de período y 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.

PivotValueRegion

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 de tabla dinámica.

ResourceQuotasRemaining

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

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

number

Queda una cuota de recursos diarios restante.

hourlyQuotaTokensRemaining

number

Tokens de cuota de recursos por hora restantes.

Pruébalo