- Recurso: ReportTask
- ReportDefinition
- Dimensión
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Métrica
- DateRange
- FilterExpression
- FilterExpressionList
- Filtro
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operación
- NumericValue
- BetweenFilter
- EmptyFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Cohorte
- CohortsRange
- Nivel de detalle
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- Estado
- Métodos
Recurso: ReportTask
Es la configuración de una tarea de informe específica.
| Representación JSON |
|---|
{ "name": string, "reportDefinition": { object ( |
| Campos | |
|---|---|
name |
Solo salida. Es el identificador. Es el nombre del recurso de la tarea del informe que se asignó durante la creación. Formato: "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
Opcional. Es una definición del informe para recuperar datos del informe, que describe la estructura de un informe. Por lo general, incluye los campos que se incluirán en el informe y los criterios que se usarán para filtrar los datos. |
reportMetadata |
Solo salida. Son los metadatos del informe para una tarea de informe específica, que proporcionan información sobre un informe. Por lo general, incluye la siguiente información: el nombre del recurso del informe, el estado del informe, la marca de tiempo en la que se creó el informe, etcétera. |
ReportDefinition
Es la definición de cómo se debe ejecutar un informe.
| Representación JSON |
|---|
{ "dimensions": [ { object ( |
| Campos | |
|---|---|
dimensions[] |
Opcional. Son las dimensiones solicitadas y mostradas. |
metrics[] |
Opcional. Son las métricas solicitadas y que se muestran. |
dateRanges[] |
Opcional. Son los períodos de los datos que se leerán. Si se solicitan varios períodos, cada fila de la respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los datos del evento para los días superpuestos se incluyen en las filas de respuesta para ambos períodos. En una solicitud de cohorte, este |
dimensionFilter |
Opcional. Los filtros de dimensión te permiten solicitar solo valores de dimensión específicos en el informe. Para obtener más información, consulta Conceptos básicos de los filtros de dimensiones y mira los ejemplos. Las métricas no se pueden usar en este filtro. |
metricFilter |
Opcional. Es la cláusula de filtro de las métricas. Se aplica después de agregar las filas del informe, de forma similar a la cláusula having de SQL. No se pueden usar dimensiones en este filtro. |
offset |
Opcional. Es el recuento de filas de la fila inicial del almacenamiento de Google Analytics. La primera fila se cuenta como la fila 0. Cuando se crea una tarea de informe, los parámetros |
limit |
Opcional. Es la cantidad de filas que se devolverán en el informe. Si no se especifica, se devuelven 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas solicites. La API también puede devolver menos filas que el |
metricAggregations[] |
Opcional. Es la agregación de métricas. Los valores de las métricas agregadas se mostrarán en las filas en las que dimensionValues esté establecido como "RESERVED_(MetricAggregation)". |
orderBys[] |
Opcional. Especifica cómo se ordenan las filas en la respuesta. |
currencyCode |
Opcional. Es un código de moneda en formato ISO4217, como "AED", "USD" o "JPY". Si el campo está vacío, el informe usa la moneda predeterminada de la propiedad. |
cohortSpec |
Opcional. Es el grupo de cohortes asociado a esta solicitud. Si hay un grupo de cohortes en la solicitud, debe estar presente la dimensión "cohorte". |
keepEmptyRows |
Opcional. Si es falso o no se especifica, no se mostrará cada fila con todas las métricas iguales a 0. Si es verdadero, se devolverán estas filas si no se quitan por separado con un filtro. Independientemente de este parámetro de configuración de Por ejemplo, si una propiedad nunca registra un evento |
samplingLevel |
Opcional. Es el nivel de muestreo del informe. |
Dimensión
Las dimensiones son atributos de tus datos. Por ejemplo, la dimensión Ciudad indica la ciudad en la que se origina un evento. Los valores de dimensión en las respuestas de los informes son cadenas. Por ejemplo, la ciudad podría ser "París" o "Nueva York".
| Representación JSON |
|---|
{
"name": string,
"dimensionExpression": {
object ( |
| Campos | |
|---|---|
name |
Es el nombre de la dimensión. Consulta las dimensiones de la API para ver la lista de nombres de dimensiones compatibles con los métodos de informes principales, como Si se especifica Las dimensiones se referencian con |
dimensionExpression |
Una dimensión puede ser el resultado de una expresión de varias dimensiones. Por ejemplo, dimensión "país, ciudad": concatenate(país, ", ", ciudad). |
DimensionExpression
Se usa para expresar una dimensión que es el resultado de una fórmula de varias dimensiones. Ejemplos de uso: 1) lowerCase(dimensión) 2) concatenate(dimensión1, símbolo, dimensión2).
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión one_expression. Especifica un tipo de expresión de dimensión para DimensionExpression. one_expression puede ser solo uno de los siguientes: |
|
lowerCase |
Se usa para convertir un valor de dimensión en minúsculas. |
upperCase |
Se usa para convertir un valor de dimensión en mayúsculas. |
concatenate |
Se usa para combinar valores de dimensiones en una sola dimensión. Por ejemplo, dimensión "país, ciudad": concatenate(país, ", ", ciudad). |
CaseExpression
Se usa para convertir un valor de dimensión en un solo caso.
| Representación JSON |
|---|
{ "dimensionName": string } |
| Campos | |
|---|---|
dimensionName |
Es el nombre de una dimensión. El nombre debe hacer referencia a un nombre en el campo de dimensiones de la solicitud. |
ConcatenateExpression
Se usa para combinar valores de dimensiones en una sola dimensión.
| Representación JSON |
|---|
{ "dimensionNames": [ string ], "delimiter": string } |
| Campos | |
|---|---|
dimensionNames[] |
Nombres de las dimensiones. Los nombres deben hacer referencia a los nombres del campo de dimensiones de la solicitud. |
delimiter |
Es el delimitador que se coloca entre los nombres de las dimensiones. Los delimitadores suelen ser caracteres únicos, como "|" o ",", pero pueden ser cadenas más largas. Si un valor de dimensión contiene el delimitador, ambos estarán presentes en la respuesta sin distinción. Por ejemplo,si el valor de la dimensión 1 es "US,FR", el valor de la dimensión 2 es "JP" y el delimitador es ",", la respuesta contendrá "US,FR,JP". |
Métrica
Son las mediciones cuantitativas de un informe. Por ejemplo, la métrica eventCount es la cantidad total de eventos. Se permiten solicitudes de hasta 10 métricas.
| Representación JSON |
|---|
{ "name": string, "expression": string, "invisible": boolean } |
| Campos | |
|---|---|
name |
Es el nombre de la métrica. Consulta las métricas de la API para ver la lista de nombres de métricas admitidos por los métodos de informes básicos, como Si se especifica Las métricas se referencian con |
expression |
Es una expresión matemática para las métricas derivadas. Por ejemplo, la métrica Recuento de eventos por usuario es |
invisible |
Indica si una métrica es invisible en la respuesta del informe. Si una métrica es invisible, no generará una columna en la respuesta, pero se puede usar en |
DateRange
Es un conjunto contiguo de días: startDate, startDate + 1, …, endDate. Se permiten hasta 4 períodos.
| Representación JSON |
|---|
{ "startDate": string, "endDate": string, "name": string } |
| Campos | |
|---|---|
startDate |
Es la fecha de inicio inclusiva de la búsqueda en formato |
endDate |
Fecha de finalización inclusiva de la consulta en el formato |
name |
Asigna un nombre a este período. La dimensión |
FilterExpression
Para expresar filtros de dimensiones o métricas Los campos de la misma FilterExpression deben ser todas dimensiones o todas métricas.
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión expr. Especifica un tipo de expresión de filtro para FilterExpression. expr puede ser solo uno de los siguientes: |
|
andGroup |
Las FilterExpressions de andGroup tienen una relación AND. |
orGroup |
Las FilterExpressions de orGroup tienen una relación OR. |
notExpression |
La FilterExpression NO es de tipo notExpression. |
filter |
Es un filtro primitivo. En la misma FilterExpression, todos los nombres de los campos del filtro deben ser todas las dimensiones o todas las métricas. |
FilterExpressionList
Es una lista de expresiones de filtro.
| Representación JSON |
|---|
{
"expressions": [
{
object ( |
| Campos | |
|---|---|
expressions[] |
Es una lista de expresiones de filtro. |
Filtro
Es una expresión para filtrar valores de dimensiones o métricas.
| Representación JSON |
|---|
{ "fieldName": string, // Union field |
| Campos | |
|---|---|
fieldName |
Es el nombre de la dimensión o de la métrica. Debe ser un nombre definido en dimensiones o métricas. |
Campo de unión one_filter. Especifica un tipo de filtro para Filter. one_filter puede ser solo uno de los siguientes: |
|
stringFilter |
Es el filtro relacionado con cadenas. |
inListFilter |
Es un filtro para los valores de la lista. |
numericFilter |
Es un filtro para valores numéricos o de fecha. |
betweenFilter |
Es un filtro para valores entre dos valores. |
emptyFilter |
Es un filtro para valores vacíos, como los valores "(not set)" y "". |
StringFilter
El filtro para la cadena
| Representación JSON |
|---|
{
"matchType": enum ( |
| Campos | |
|---|---|
matchType |
Es el tipo de coincidencia de este filtro. |
value |
Es el valor de cadena que se usa para la coincidencia. |
caseSensitive |
Si es verdadero, el valor de la cadena distingue mayúsculas de minúsculas. |
MatchType
Es el tipo de concordancia de un filtro de cadena.
| Enums | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
Sin especificar |
EXACT |
Es la coincidencia exacta del valor de la cadena. |
BEGINS_WITH |
Comienza con el valor de la cadena. |
ENDS_WITH |
Termina con el valor de la cadena. |
CONTAINS |
Contiene el valor de cadena. |
FULL_REGEXP |
Coincidencia completa de la expresión regular con el valor de la cadena. |
PARTIAL_REGEXP |
Es una coincidencia parcial de la expresión regular con el valor de la cadena. |
InListFilter
El resultado debe ser una lista de valores de cadena.
| Representación JSON |
|---|
{ "values": [ string ], "caseSensitive": boolean } |
| Campos | |
|---|---|
values[] |
Es la lista de valores de cadena. No debe estar vacío. |
caseSensitive |
Si es verdadero, el valor de la cadena distingue mayúsculas de minúsculas. |
NumericFilter
Filtros para valores numéricos o de fecha
| Representación JSON |
|---|
{ "operation": enum ( |
| Campos | |
|---|---|
operation |
Es el tipo de operación de este filtro. |
value |
Es un valor numérico o de fecha. |
Operación
Operación aplicada a un filtro numérico
| Enums | |
|---|---|
OPERATION_UNSPECIFIED |
Sin especificar. |
EQUAL |
Igual |
LESS_THAN |
Menor que |
LESS_THAN_OR_EQUAL |
Menor o igual que |
GREATER_THAN |
Mayor que |
GREATER_THAN_OR_EQUAL |
Mayor o igual que |
NumericValue
Representar un número
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión one_value. Uno de los valores numéricos one_value solo puede ser uno de los siguientes: |
|
int64Value |
Valor del número entero |
doubleValue |
Valor doble |
BetweenFilter
Se usa para expresar que el resultado debe estar entre dos números (inclusive).
| Representación JSON |
|---|
{ "fromValue": { object ( |
| Campos | |
|---|---|
fromValue |
Comienza con este número. |
toValue |
Termina con este número. |
EmptyFilter
Este tipo no tiene campos.
Filtra los valores vacíos.
MetricAggregation
Representa la agregación de métricas.
| Enums | |
|---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Operador no especificado. |
TOTAL |
Operador SUM. |
MINIMUM |
Operador mínimo. |
MAXIMUM |
Es el operador máximo. |
COUNT |
Es el operador de recuento. |
OrderBy
Las cláusulas Order by definen cómo se ordenarán las filas en la respuesta. Por ejemplo, ordenar las filas por recuento de eventos descendente es un orden, y ordenar las filas por la cadena del nombre del evento es un orden diferente.
| Representación JSON |
|---|
{ "desc": boolean, // Union field |
| Campos | |
|---|---|
desc |
Si es verdadero, se ordena de forma descendente. |
Campo de unión one_order_by. Especifica un tipo de ordenamiento para OrderBy. one_order_by puede ser solo uno de los siguientes: |
|
metric |
Ordena los resultados según los valores de una métrica. |
dimension |
Ordena los resultados según los valores de una dimensión. |
MetricOrderBy
Ordena por valores de métrica.
| Representación JSON |
|---|
{ "metricName": string } |
| Campos | |
|---|---|
metricName |
Es el nombre de una métrica en la solicitud según la cual se ordenará. |
DimensionOrderBy
Ordena por valores de dimensión.
| Representación JSON |
|---|
{
"dimensionName": string,
"orderType": enum ( |
| Campos | |
|---|---|
dimensionName |
Es el nombre de una dimensión en la solicitud para ordenar los resultados. |
orderType |
Controla la regla para el orden de los valores de la dimensión. |
OrderType
Es la regla para ordenar los valores de la dimensión de cadena.
| Enums | |
|---|---|
ORDER_TYPE_UNSPECIFIED |
Sin especificar. |
ALPHANUMERIC |
Orden alfanumérico por punto de código Unicode. Por ejemplo, "2" < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Orden alfanumérico que no distingue mayúsculas de minúsculas según el punto de código Unicode en minúsculas. Por ejemplo, "2" < "A" < "b" < "X" < "z". |
NUMERIC |
Los valores de dimensión se convierten en números antes de ordenarse. Por ejemplo, en la clasificación NUMÉRICA, "25" < "100", y en la clasificación ALPHANUMERIC, "100" < "25". Todos los valores de dimensión no numéricos tienen el mismo valor de ordenamiento, que es inferior a todos los valores numéricos. |
CohortSpec
Es la especificación de las cohortes para un informe de cohortes.
Los informes de cohortes crean una serie temporal de la retención de usuarios para la cohorte. Por ejemplo, podrías seleccionar la cohorte de usuarios que se adquirieron en la primera semana de septiembre y hacer un seguimiento de esa cohorte durante las próximas seis semanas. La selección de los usuarios adquiridos en la cohorte de la primera semana de septiembre se especifica en el objeto cohort. El seguimiento de esa cohorte durante las próximas seis semanas se especifica en el objeto cohortsRange.
Para ver ejemplos, consulta Ejemplos de informes de cohortes.
La respuesta del informe podría mostrar una serie temporal semanal en la que, por ejemplo, tu app retuvo el 60% de esta cohorte después de tres semanas y el 25% después de seis semanas. Estos dos porcentajes se pueden calcular con la métrica cohortActiveUsers/cohortTotalUsers y se mostrarán en filas separadas en el informe.
| Representación JSON |
|---|
{ "cohorts": [ { object ( |
| Campos | |
|---|---|
cohorts[] |
Define los criterios de selección para agrupar a los usuarios en cohortes. La mayoría de los informes de cohortes definen solo una cohorte. Si se especifican varias cohortes, cada una se puede reconocer en el informe por su nombre. |
cohortsRange |
Los informes de cohortes hacen un seguimiento de las cohortes durante un período de informes extendido. Este rango especifica una duración de desfase para hacer un seguimiento de las cohortes. |
cohortReportSettings |
Es la configuración opcional para un informe de cohortes. |
Cohorte
Define los criterios de selección de una cohorte. Una cohorte es un grupo de usuarios que comparten una característica en común. Por ejemplo, los usuarios con el mismo firstSessionDate pertenecen a la misma cohorte.
| Representación JSON |
|---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
| Campos | |
|---|---|
name |
Asigna un nombre a esta cohorte. La dimensión |
dimension |
Es la dimensión que usa la cohorte. Es obligatorio y solo admite |
dateRange |
La cohorte selecciona a los usuarios cuya primera fecha de contacto se encuentra entre la fecha de inicio y la fecha de finalización definidas en En una solicitud de cohorte, este Por lo general, este |
CohortsRange
Configura el período extendido del informe para un informe de cohortes. Especifica una duración de desfase para hacer un seguimiento de las cohortes.
| Representación JSON |
|---|
{
"granularity": enum ( |
| Campos | |
|---|---|
granularity |
Obligatorio. Es la granularidad que se usa para interpretar |
startOffset |
Si Si Si |
endOffset |
Obligatorio. Si Si Si |
Nivel de detalle
Es la granularidad que se usa para interpretar startOffset y endOffset para el período extendido del informe de cohortes.
| Enums | |
|---|---|
GRANULARITY_UNSPECIFIED |
Nunca se debe especificar. |
DAILY |
Nivel de detalle diario. De uso frecuente si el dateRange de la cohorte es un solo día y la solicitud contiene cohortNthDay. |
WEEKLY |
Es la granularidad semanal. De uso frecuente si el dateRange de la cohorte dura una semana (comienza el domingo y finaliza el sábado) y la solicitud contiene cohortNthWeek. |
MONTHLY |
Nivel de detalle mensual. De uso frecuente si el dateRange de la cohorte dura un mes y la solicitud contiene cohortNthMonth. |
CohortReportSettings
Es la configuración opcional de un informe de cohortes.
| Representación JSON |
|---|
{ "accumulate": boolean } |
| Campos | |
|---|---|
accumulate |
Si es verdadero, acumula el resultado desde el día del primer contacto hasta el día final. No se admite en |
SamplingLevel
Son las categorías de los niveles de muestreo para las solicitudes.
| Enums | |
|---|---|
SAMPLING_LEVEL_UNSPECIFIED |
Tipo no especificado |
LOW |
Aplica un nivel de muestreo de 10 millones a las propiedades estándares y de 100 millones a las propiedades de Google Analytics 360. |
MEDIUM |
Exclusivo para las propiedades de Google Analytics 360 con un nivel de muestreo de 1,000 millones. |
UNSAMPLED |
Es exclusiva de las propiedades de Google Analytics 360. Las exploraciones sin muestreos son más precisas y pueden revelar estadísticas que no se observan en las exploraciones estándares. Para obtener más información, consulta https://support.google.com/analytics/answer/10896953. |
ReportMetadata
Son los metadatos del informe para una tarea de informe específica.
| Representación JSON |
|---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
| Campos | |
|---|---|
creationQuotaTokensCharged |
Solo salida. Es la cantidad total de tokens de cuota que se cobraron durante la creación del informe. Dado que este recuento de tokens se basa en la actividad del estado |
state |
Solo salida. Es el estado actual de esta tarea de informe. |
beginCreatingTime |
Solo salida. Es la fecha y hora en que se llamó a Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
taskRowCount |
Solo salida. Es la cantidad total de filas en el resultado del informe. Este campo se completará cuando el estado esté activo. Puedes usar |
errorMessage |
Solo salida. El mensaje de error se completa si falla una tarea de informe durante la creación. |
totalRowCount |
Solo salida. Es la cantidad total de filas en el almacenamiento de Google Analytics. Si deseas consultar filas de datos adicionales más allá del informe actual, puedes iniciar una nueva tarea de informe basada en El Por ejemplo, supongamos que el |
Estado
Es el estado de procesamiento.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
El estado sin especificar nunca se usará. |
CREATING |
El informe se está creando y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada a CreateReport. |
ACTIVE |
El informe se creó por completo y está listo para las consultas. |
FAILED |
No se pudo crear el informe. |
Métodos |
|
|---|---|
|
Inicia la creación de una tarea de informe. |
|
Obtiene metadatos del informe sobre una tarea de informe específica. |
|
Enumera todas las tareas de informes de una propiedad. |
|
Recupera el contenido de una tarea de informe. |