REST Resource: properties.reportTasks

{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}

string

Solo salida. Identificador. El nombre del recurso de la tarea de informes que se asignó durante la creación. Formato: "properties/{property}/reportTasks/{reportTask}"

object (ReportDefinition)

Opcional. Una definición de informe para recuperar datos de informes, 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.

object (ReportMetadata)

Solo salida. Los metadatos de informes para una tarea de informes específica, que proporcionan información sobre un informe. Suele incluir 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.

{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean
}

object (Dimension)

Opcional. Las dimensiones solicitadas y mostradas.

object (Metric)

Opcional. Las métricas solicitadas y que se muestran.

object (DateRange)

Opcional. Períodos de datos para leer. Si se solicitan varios períodos, cada fila de respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los datos de eventos de esos días se incluirán en las filas de respuesta de ambos períodos. En una solicitud de cohorte, no se debe especificar este dateRanges.

object (FilterExpression)

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 Fundamentos de los filtros de dimensión para ver ejemplos. No se pueden usar métricas en este filtro.

object (FilterExpression)

Opcional. La cláusula de filtro de las métricas. Se aplica después de agregar las filas del informe, de manera similar a la cláusula “Tening” de SQL. No se pueden utilizar dimensiones en este filtro.

string (int64 format)

Opcional. Es el recuento de filas de la fila de inicio del almacenamiento de Google Analytics. La primera fila se cuenta como fila 0.

Cuando se crea una tarea de informe, los parámetros offset y limit definen el subconjunto de filas de datos del almacenamiento de Google Analytics que se incluirán en el informe generado. Por ejemplo, si hay un total de 300,000 filas en el almacenamiento de Google Analytics, la tarea de informes inicial puede tener las primeras 10,000 filas con un límite de 10,000 y una compensación de 0. Posteriormente, otra tarea de informe podría abarcar las siguientes 10,000 filas con un límite de 10,000 y una compensación de 10,000.

string (int64 format)

Opcional. Es la cantidad de filas que se mostrarán en el informe. Si no se especifica, se muestran 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, independientemente de cuántas solicites. El valor de limit debe ser positivo.

La API también puede mostrar menos filas que la limit solicitada si no hay tantos valores de dimensión como limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando se informa solo sobre country, no puedes obtener más de 300 filas, incluso si estableces limit con un valor más alto.

enum (MetricAggregation)

Opcional. Agregación de métricas. Los valores agregados de las métricas se mostrarán en las filas donde los valores de dimensionValues se establezcan en "RESERVED_(MetricAggregation)".

object (OrderBy)

Opcional. Especifica cómo se ordenan las filas en la respuesta.

string

Opcional. Es un código de moneda en formato ISO4217, como “AED”, “USD” o “JPY”. Si el campo está vacío, el informe usará la moneda predeterminada de la propiedad.

object (CohortSpec)

Opcional. Grupo de cohorte asociado con esta solicitud. Si hay un grupo de cohorte en la solicitud, la "cohorte" debe estar presente.

boolean

Opcional. Si es falso o no se especifica, no se mostrará cada fila con todas las métricas iguales a 0. Si el valor es verdadero, se mostrarán estas filas si un filtro no las quita por separado.

Independientemente de este parámetro de configuración de keepEmptyRows, solo se pueden mostrar en un informe los datos registrados por la propiedad de Google Analytics (GA4).

Por ejemplo, si una propiedad nunca registra un evento purchase, una consulta para la dimensión eventName y la métrica eventCount no tendrá una fila que contenga eventName: "purchase". y eventCount: 0.

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

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

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

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

object (DimensionExpression)

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

{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

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

{
  "dimensionName": string
}

string

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

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

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

string

Es el delimitador ubicado entre los nombres de las dimensiones.

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

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

Es el nombre de la métrica. Consulta las Métricas de la API para ver la lista de nombres de métricas compatibles con los métodos de informes principales, como runReport y batchRunReports. Consulta Métricas en tiempo real para ver la lista de nombres de métricas compatibles con el método runRealtimeReport. Consulta Métricas de embudo para ver la lista de nombres de métricas compatibles con el método runFunnelReport.

Si se especifica expression, name puede ser cualquier cadena que desees dentro del grupo de caracteres permitido. Por ejemplo, si expression es screenPageViews/sessions, podrías llamar al nombre de esa métrica = viewsPerSession. Los nombres de las métricas que elijas deben coincidir con la expresión regular ^[a-zA-Z0-9_]$.

name hace referencia a las métricas en metricFilter, orderBys y la métrica expression.

string

Una expresión matemática para métricas derivadas. Por ejemplo, la métrica Recuento de eventos por usuario es eventCount/totalUsers.

boolean

Indica si una métrica es invisible en la respuesta del informe. Si una métrica es invisible, esta no generará una columna en la respuesta, pero se puede usar en metricFilter, orderBys o una métrica expression.

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

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

string

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

string

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

{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}

object (FilterExpressionList)

Las FilterExpressions de andGroup tienen una relación AND.

object (FilterExpressionList)

Las FilterExpressions de orGroup tienen una relación O.

object (FilterExpression)

FilterExpression NO es un elemento de notExpression.

object (Filter)

Un filtro primitivo. En la misma FilterExpression, todos los nombres de campo del filtro deben ser todas las dimensiones o todas las métricas.

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

Una lista de expresiones de filtro.

{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}

string

Es el nombre de la dimensión o de la métrica. Debe ser un nombre definido en dimensiones o métricas.

object (StringFilter)

Filtro relacionado con las cadenas.

object (InListFilter)

Un filtro para los valores de lista.

object (NumericFilter)

Es un filtro para valores numéricos o de fecha.

object (BetweenFilter)

Un filtro entre dos valores.

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

El tipo de concordancia de este filtro.

string

El valor de cadena usado para la coincidencia.

boolean

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

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

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

boolean

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

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

El tipo de operación para este filtro.

object (NumericValue)

Un valor numérico o un valor de fecha.

{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}

string (int64 format)

Valor del número entero

number

Valor doble

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

Comienza con este número.

object (NumericValue)

Termina con este número.

{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}

boolean

Si es verdadero, ordena de forma descendente.

object (MetricOrderBy)

Ordena los resultados según los valores de una métrica.

object (DimensionOrderBy)

Ordena los resultados según los valores de una dimensión.

{
  "metricName": string
}

string

Un nombre de métrica en la solicitud que se debe ordenar.

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

Es un nombre de dimensión en la solicitud para ordenar.

enum (OrderType)

Controla la regla para el orden de los valores de las dimensiones.

{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}

object (Cohort)

Define los criterios de selección para agrupar usuarios en cohortes.

La mayoría de los informes de cohorte definen solo una cohorte. Si se especifican varias cohortes, cada una se puede reconocer en el informe por su nombre.

object (CohortsRange)

Los informes de cohorte siguen las cohortes durante un período de informe extendido. Este rango especifica una duración de compensación para seguir las cohortes.

object (CohortReportSettings)

Son los parámetros de configuración opcionales para un informe de cohorte.

{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}

string

Asigna un nombre a esta cohorte. La dimensión cohort se valora con este nombre en la respuesta de un informe. Si está establecido, no puede comenzar con cohort_ ni RESERVED_. Si no se establece, las cohortes se nombran según su índice basado en cero cohort_0, cohort_1, etcétera.

string

Es la dimensión que usa la cohorte. Es obligatorio y solo es compatible con firstSessionDate.

object (DateRange)

La cohorte selecciona a los usuarios cuya fecha de primer contacto se encuentra entre las fechas de inicio y finalización que se definen en el dateRange. Este dateRange no especifica el período completo de los datos de eventos presentes en un informe de cohorte. En un informe de cohorte, este dateRange se extiende por el nivel de detalle y el desplazamiento presentes en cohortsRange. Los datos de eventos para el período extendido del informe están presentes en un informe de cohorte.

En una solicitud de cohorte, este dateRange es obligatorio y no se debe especificar el dateRanges de RunReportRequest o RunPivotReportRequest.

Por lo general, este dateRange debe alinearse con el nivel de detalle de la cohorte. Si CohortsRange usa el nivel de detalle diario, este dateRange puede ser de un solo día. Si CohortsRange usa el nivel de detalle semanal, este dateRange se puede alinear con un límite de semana, que comienza el domingo y finaliza el sábado. Si CohortsRange usa un nivel de detalle mensual, este dateRange se puede alinear con un mes, comenzando por el primero y hasta el último día del mes.

{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}

enum (Granularity)

Obligatorio. Es el nivel de detalle que se usa para interpretar los valores de startOffset y endOffset del período extendido del informe de un informe de cohorte.

integer

startOffset especifica la fecha de inicio del período extendido del informe para un informe de cohorte. Por lo general, startOffset se establece en 0 para que los informes contengan datos de la adquisición de la cohorte en adelante.

Si granularity es DAILY, el startDate del período extendido del informe es startDate de la cohorte más startOffset días.

Si granularity es WEEKLY, el startDate del período extendido del informe es startDate de la cohorte más startOffset * 7 días.

Si granularity es MONTHLY, el startDate del período extendido del informe es startDate de la cohorte más startOffset * 30 días.

integer

Obligatorio. endOffset especifica la fecha de finalización del período del informe extendido para un informe de cohorte. endOffset puede ser cualquier número entero positivo, pero se suele establecer en 5 a 10 para que los informes contengan datos en la cohorte para los siguientes períodos de detalle.

Si granularity es DAILY, el endDate del período extendido del informe es endDate de la cohorte más endOffset días.

Si granularity es WEEKLY, el endDate del período extendido del informe es endDate de la cohorte más endOffset * 7 días.

Si granularity es MONTHLY, el endDate del período extendido del informe es endDate de la cohorte más endOffset * 30 días.

{
  "accumulate": boolean
}

boolean

Si es verdadero, acumula el resultado desde el día del primer contacto hasta el día de finalización. No se admite en RunReportRequest.

{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}

integer

Solo salida. El total de tokens de cuota que se cobraron durante la creación del informe. Debido a que este recuento de tokens se basa en la actividad del estado CREATING, este cargo de tokens se fijará una vez que una tarea de informe entre en el estado ACTIVE o FAILED.

enum (State)

Solo salida. El estado actual de esta tarea de informe.

string (Timestamp format)

Solo salida. La hora en la que se llamó a reportTasks.create y el informe comenzó con el estado CREATING.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

integer

Solo salida. Es la cantidad total de filas en el resultado del informe. Este campo se completará cuando el estado esté activo. Puedes usar taskRowCount para la paginación dentro de los límites de su informe existente.

string

Solo salida. El mensaje de error se propaga si la tarea del informe falla durante su creación.

integer

Solo salida. Es la cantidad total de filas en el almacenamiento de Google Analytics. Si deseas consultar filas de datos adicionales además del informe actual, el cliente puede iniciar una nueva tarea de informe en función de la totalRowCount.

El taskRowCount representa la cantidad de filas que pertenecen específicamente al informe actual, mientras que totalRowCount abarca el recuento total de filas en todos los datos recuperados del almacenamiento de Google Analytics.

Por ejemplo, supongamos que el taskRowCount del informe actual es 20 y muestra los datos de las primeras 20 filas. A la vez, la totalRowCount es 30, lo que indica la presencia de datos en las 30 filas. La taskRowCount se puede utilizar para paginar las 20 filas iniciales. Para expandir el informe e incluir datos de las 30 filas, se puede crear una nueva tarea de informe con totalRowCount para acceder al conjunto completo de 30 filas de datos.