REST Resource: properties.reportTasks

Recurso: ReportTask

Una configuración específica de la tarea de informe.

Representación JSON
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Campos
name

string

Solo salida. Identificador. Es el nombre del recurso de la tarea del informe asignado durante la creación. Formato: "properties/{property}/reportTasks/{reportTask}"

reportDefinition

object (ReportDefinition)

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

reportMetadata

object (ReportMetadata)

Solo salida. Los metadatos del informe de 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 (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,
  "samplingLevel": enum (SamplingLevel)
}
Campos
dimensions[]

object (Dimension)

Opcional. Las dimensiones solicitadas y mostradas

metrics[]

object (Metric)

Opcional. Las métricas solicitadas y mostradas

dateRanges[]

object (DateRange)

Opcional. Son los períodos de los datos que se deben leer. 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 de eventos de los días superpuestos se incluyen en las filas de respuesta de ambos períodos. En una solicitud de cohorte, este dateRanges no se debe especificar.

dimensionFilter

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 Conceptos básicos de los filtros de dimensiones y obtén ejemplos. No se pueden usar métricas en este filtro.

metricFilter

object (FilterExpression)

Opcional. Es 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 having de SQL. No se pueden usar dimensiones en este filtro.

offset

string (int64 format)

Opcional. Es el recuento de filas de la fila inicial de Google Analytics Storage. 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á en el informe generado. Por ejemplo, si hay un total de 300,000 filas en el almacenamiento de Google Analytics, la tarea del informe inicial puede tener las primeras 10,000 filas con un límite de 10,000 y un desplazamiento de 0. Posteriormente, otra tarea de informe podría abarcar las siguientes 10,000 filas con un límite de 10,000 y un desplazamiento de 10,000.

limit

string (int64 format)

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

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

metricAggregations[]

enum (MetricAggregation)

Opcional. Agregación de métricas. Los valores de las métricas agregadas se mostrarán en las filas en las que los dimensionValues estén configurados como "RESERVED_(MetricAggregation)".

orderBys[]

object (OrderBy)

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

currencyCode

string

Opcional. Un código de moneda en formato ISO 4217, como "AED", "USD" o "JPY". Si el campo está vacío, el informe usará la moneda predeterminada de la propiedad.

cohortSpec

object (CohortSpec)

Opcional. Es el grupo de cohorte asociado con esta solicitud. Si hay un grupo de cohortes en la solicitud, la dimensión "cohort" debe estar presente.

keepEmptyRows

boolean

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 mostrarán estas filas si no se quitan por separado con un filtro.

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

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.

samplingLevel

enum (SamplingLevel)

Opcional. 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 las dimensiones 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 (DimensionExpression)
  }
}
Campos
name

string

Es el nombre de la dimensión. Consulta Dimensiones de la API para ver la lista de nombres de dimensiones compatibles con los métodos de informes principales, 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 de embudo para ver 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 conjunto 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.

dimensionExpression

object (DimensionExpression)

Una dimensión puede ser el resultado de una expresión de varias dimensiones. Por ejemplo, la dimensión "country, city": concatenate(country, ", ", city).

DimensionExpression

Se usa para expresar una dimensión que es el resultado de una fórmula de varias dimensiones. Ejemplos de uso: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2).

Representación JSON
{

  // 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.
}
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

object (CaseExpression)

Se usa para convertir un valor de dimensión a minúsculas.

upperCase

object (CaseExpression)

Se usa para convertir un valor de dimensión a mayúsculas.

concatenate

object (ConcatenateExpression)

Se usa para combinar valores de dimensión en una sola dimensión. Por ejemplo, la dimensión "country, city": concatenate(country, ", ", city).

CaseExpression

Se usa para convertir un valor de dimensión a un solo caso.

Representación JSON
{
  "dimensionName": string
}
Campos
dimensionName

string

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 dimensión en una sola dimensión.

Representación JSON
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Campos
dimensionNames[]

string

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

delimiter

string

Es el delimitador que se coloca entre los nombres de las dimensiones.

Los delimitadores suelen ser caracteres individuales, 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 = "US,FR", el valor de la dimensión 2 = "JP" y el delimitador = ",", 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. Las solicitudes pueden tener hasta 10 métricas.

Representación JSON
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Campos
name

string

Es el nombre de la métrica. Consulta 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 conjunto de caracteres permitido. Por ejemplo, si expression es screenPageViews/sessions, puedes 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.

expression

string

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

invisible

boolean

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

DateRange

Es un conjunto contiguo de días: startDate, startDate + 1, …, endDate. Las solicitudes pueden incluir hasta 4 períodos.

Representación JSON
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Campos
startDate

string

Es la fecha de inicio inclusiva de la consulta en formato YYYY-MM-DD. No puede ser posterior al 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 de informes de la propiedad.

endDate

string

Es 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 de informes de la propiedad.

name

string

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

FilterExpression

Para expresar filtros de dimensiones o métricas. Los campos de la misma FilterExpression deben ser todas las dimensiones o todas las métricas.

Representación JSON
{

  // 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.
}
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

object (FilterExpressionList)

Las FilterExpressions en andGroup tienen una relación AND.

orGroup

object (FilterExpressionList)

Las FilterExpressions en orGroup tienen una relación O.

notExpression

object (FilterExpression)

FilterExpression NO es de notExpression.

filter

object (Filter)

Un filtro primitivo. En la misma FilterExpression, todos los nombres de 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 (FilterExpression)
    }
  ]
}
Campos
expressions[]

object (FilterExpression)

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 one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
Campos
fieldName

string

El nombre de la dimensión o de la métrica. Debe ser un nombre definido en las 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

object (StringFilter)

Filtro relacionado con cadenas.

inListFilter

object (InListFilter)

Es un filtro para valores de la lista.

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

Es un filtro para un valor entre dos.

emptyFilter

object (EmptyFilter)

Es un filtro para valores vacíos, como "(no establecido)" y "".

StringFilter

El filtro para cadenas

Representación JSON
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Campos
matchType

enum (MatchType)

Es el tipo de concordancia de este filtro.

value

string

Es el valor de cadena que se usa para la coincidencia.

caseSensitive

boolean

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

MatchType

El tipo de concordancia de un filtro de cadena

Enumeraciones
MATCH_TYPE_UNSPECIFIED Sin especificar
EXACT Es la concordancia exacta del valor de la cadena.
BEGINS_WITH Comienza con el valor de cadena.
ENDS_WITH Termina con el valor de cadena.
CONTAINS Contiene el valor de cadena.
FULL_REGEXP Coincidencia completa de la expresión regular con el valor de la cadena.
PARTIAL_REGEXP Coincidencia parcial para la expresión regular con el valor de la cadena.

InListFilter

El resultado debe estar en una lista de valores de cadena.

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

string

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

caseSensitive

boolean

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 (Operation),
  "value": {
    object (NumericValue)
  }
}
Campos
operation

enum (Operation)

Es el tipo de operación de este filtro.

value

object (NumericValue)

Un valor numérico o de fecha.

Operación

La operación aplicada a un filtro numérico

Enumeraciones
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

Para representar un número.

Representación JSON
{

  // 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.
}
Campos
Campo de unión one_value. Uno de los valores numéricos one_value puede ser uno de los siguientes:
int64Value

string (int64 format)

Valor del número entero

doubleValue

number

Valor doble

BetweenFilter

Para expresar que el resultado debe estar entre dos números (inclusive).

Representación JSON
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Campos
fromValue

object (NumericValue)

Comienza con este número.

toValue

object (NumericValue)

Termina con este número.

EmptyFilter

Este tipo no tiene campos.

Filtra los valores vacíos.

MetricAggregation

Representa la agregación de métricas.

Enumeraciones
METRIC_AGGREGATION_UNSPECIFIED Operador no especificado.
TOTAL Operador SUM.
MINIMUM Operador mínimo.
MAXIMUM Operador máximo.
COUNT Operador de recuento.

OrderBy

Los ordenes definen cómo se ordenarán las filas en la respuesta. Por ejemplo, ordenar las filas por recuento de eventos descendente es una ordenación, y ordenar las filas por la cadena de nombre del evento es una ordenación diferente.

Representación JSON
{
  "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.
}
Campos
desc

boolean

Si es verdadero, ordena de forma descendente.

Campo de unión one_order_by. Especifica un tipo de orden para OrderBy. one_order_by puede ser solo uno de los siguientes:
metric

object (MetricOrderBy)

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

dimension

object (DimensionOrderBy)

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

string

Es un nombre de métrica en la solicitud para ordenar.

DimensionOrderBy

Ordena los datos por valores de dimensión.

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

string

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

orderType

enum (OrderType)

Controla la regla para el orden de los valores de dimensión.

OrderType

Es la regla por la que se ordenan los valores de la dimensión de cadena.

Enumeraciones
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 sin distinción entre mayúsculas y minúsculas por punto de código Unicode en minúsculas Por ejemplo, "2" < "A" < "b" < "X" < "z".
NUMERIC Los valores de las dimensiones se convierten en números antes de ordenarlos. Por ejemplo, en el orden NUMERIC, “25” < “100” y, en el orden ALPHANUMERIC, “100” < “25”. Los valores de las dimensiones no numéricas tienen el mismo valor de ordenamiento debajo de todos los valores numéricos.

CohortSpec

La especificación de cohortes para un informe de cohorte.

Los informes de cohortes crean una serie temporal de la retención de usuarios de la cohorte. Por ejemplo, podrías seleccionar la cohorte de usuarios que se adquirieron en la primera semana de septiembre y seguirla durante las siguientes seis semanas. La selección de los usuarios adquiridos en la cohorte de la primera semana de septiembre se especifica en el objeto cohort. En el objeto cohortsRange, se especifica el seguimiento de esa cohorte durante las próximas seis semanas.

Para ver ejemplos, consulta Ejemplos de informes de cohorte.

La respuesta del informe podría mostrar una serie temporal semanal en la que se indique que tu aplicación 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 aparecerán en filas separadas en el informe.

Representación JSON
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Campos
cohorts[]

object (Cohort)

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

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

cohortsRange

object (CohortsRange)

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

cohortReportSettings

object (CohortReportSettings)

Configuración opcional para un informe de cohorte.

Cohorte

Define un criterio de selección de 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 (DateRange)
  }
}
Campos
name

string

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

dimension

string

Es la dimensión que usa la cohorte. Es obligatorio y solo admite firstSessionDate.

dateRange

object (DateRange)

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

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

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 un solo día. Si CohortsRange usa 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 nivel de detalle mensual, este dateRange se puede alinear con un mes, comenzando el primer día y finalizando el último día del mes.

CohortsRange

Configura el período del informe extendido para un informe de cohorte. Especifica una duración de compensación para seguir a las cohortes.

Representación JSON
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Campos
granularity

enum (Granularity)

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

startOffset

integer

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

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

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

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

endOffset

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 entre 5 y 10 para que los informes contengan datos sobre la cohorte para los próximos períodos de nivel de detalle.

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

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

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

Nivel de detalle

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

Enumeraciones
GRANULARITY_UNSPECIFIED Nunca se debe especificar.
DAILY Nivel de detalle diario Se usa comúnmente si el dateRange de la cohorte es un solo día y la solicitud contiene cohortNthDay.
WEEKLY Nivel de detalle semanal. Se usa con frecuencia si el dateRange de la cohorte tiene una duración de una semana (comienza el domingo y termina el sábado) y la solicitud contiene cohortNthWeek.
MONTHLY Nivel de detalle mensual. Se usa con frecuencia si el dateRange de la cohorte tiene un mes de duración y la solicitud contiene cohortNthMonth.

CohortReportSettings

Configuración opcional de un informe de cohorte.

Representación JSON
{
  "accumulate": boolean
}
Campos
accumulate

boolean

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

SamplingLevel

Categorías de niveles de muestreo para las solicitudes.

Enumeraciones
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 Exclusivo para 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 de una tarea de informe específica.

Representación JSON
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Campos
creationQuotaTokensCharged

integer

Solo salida. Es la cantidad 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 corregirá una vez que una tarea de informe entre en el estado ACTIVE o FAILED.

state

enum (State)

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

beginCreatingTime

string (Timestamp format)

Solo salida. Es la hora en la que se llamó a reportTasks.create y el informe comenzó 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".

taskRowCount

integer

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

errorMessage

string

Solo salida. Se propaga un mensaje de error si una tarea de informe falla durante la creación.

totalRowCount

integer

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 totalRowCount.

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, lo que muestra los datos de las primeras 20 filas. Simultáneamente, totalRowCount es 30, lo que indica la presencia de datos para las 30 filas. Se puede usar taskRowCount para paginar las 20 filas iniciales. Para expandir el informe y, además, incluir datos de las 30 filas, se puede crear una nueva tarea de informe con el totalRowCount para acceder al conjunto completo de datos de 30 filas.

Estado

Es el estado de procesamiento.

Enumeraciones
STATE_UNSPECIFIED Nunca se usará el estado sin especificar.
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 consultarse.
FAILED No se pudo crear el informe.

Métodos

create

Inicia la creación de una tarea de informe.

get

Obtiene metadatos de informes sobre una tarea de informe específica.

list

Muestra una lista de todas las tareas de informes de una propiedad.

query

Recupera el contenido de una tarea de informe.