- 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
Una configuración específica de la tarea de informe.
Representación JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Campos | |
---|---|
name |
Solo salida. Identificador. Es el nombre del recurso de la tarea del informe asignado durante la creación. Formato: "properties/{property}/reportTasks/{reportTask}" |
report |
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. |
report |
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 ( |
Campos | |
---|---|
dimensions[] |
Opcional. Las dimensiones solicitadas y mostradas |
metrics[] |
Opcional. Las métricas solicitadas y mostradas |
date |
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 |
dimension |
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. |
metric |
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 |
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 |
limit |
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. La API también puede mostrar menos filas que el |
metric |
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)". |
order |
Opcional. Especifica cómo se ordenan las filas en la respuesta. |
currency |
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. |
cohort |
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. |
keep |
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 Por ejemplo, si una propiedad nunca registra un evento |
sampling |
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 ( |
Campos | |
---|---|
name |
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 Si se especifica
|
dimension |
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 |
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: |
|
lower |
Se usa para convertir un valor de dimensión a minúsculas. |
upper |
Se usa para convertir un valor de dimensión a mayúsculas. |
concatenate |
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 | |
---|---|
dimension |
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 | |
---|---|
dimension |
Son los 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 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 |
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 Si se especifica
|
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 producirá una columna en la respuesta, pero se puede usar en |
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 | |
---|---|
start |
Es la fecha de inicio inclusiva de la consulta en formato |
end |
Es la 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 las dimensiones o todas las 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: |
|
and |
Las FilterExpressions en andGroup tienen una relación AND. |
or |
Las FilterExpressions en orGroup tienen una relación O. |
not |
FilterExpression NO es de notExpression. |
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 ( |
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 | |
---|---|
field |
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: |
|
string |
Filtro relacionado con cadenas. |
in |
Es un filtro para valores de la lista. |
numeric |
Es un filtro para valores numéricos o de fecha. |
between |
Es un filtro para un valor entre dos. |
empty |
Es un filtro para valores vacíos, como "(no establecido)" y "". |
StringFilter
El filtro para cadenas
Representación JSON |
---|
{
"matchType": enum ( |
Campos | |
---|---|
match |
Es el tipo de concordancia de este filtro. |
value |
Es el valor de cadena que se usa para la coincidencia. |
case |
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[] |
Es la lista de valores de cadena. No debe estar vacío. |
case |
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 |
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 |
Campos | |
---|---|
Campo de unión one_value . Uno de los valores numéricos one_value puede ser uno de los siguientes: |
|
int64 |
Valor del número entero |
double |
Valor doble |
BetweenFilter
Para expresar que el resultado debe estar entre dos números (inclusive).
Representación JSON |
---|
{ "fromValue": { object ( |
Campos | |
---|---|
from |
Comienza con este número. |
to |
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 |
Campos | |
---|---|
desc |
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 |
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 | |
---|---|
metric |
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 ( |
Campos | |
---|---|
dimension |
Es un nombre de dimensión en la solicitud para ordenar. |
order |
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 ( |
Campos | |
---|---|
cohorts[] |
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. |
cohorts |
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. |
cohort |
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 ( |
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 |
date |
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 En una solicitud de cohorte, este Por lo general, este |
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 ( |
Campos | |
---|---|
granularity |
Obligatorio. Es el nivel de detalle que se usa para interpretar |
start |
Si Si Si |
end |
Obligatorio. Si Si Si |
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 |
Si es verdadero, acumula el resultado desde el día del primer contacto hasta el día final. No se admite en |
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 ( |
Campos | |
---|---|
creation |
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 |
state |
Solo salida. El estado actual de esta tarea de informe. |
begin |
Solo salida. Es la hora en la que se llamó a Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
task |
Solo salida. Es la cantidad total de filas en el resultado del informe. Este campo se propagará cuando el estado esté activo. Puedes usar |
error |
Solo salida. Se propaga un mensaje de error si una tarea de informe falla durante la creación. |
total |
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
Por ejemplo, supongamos que el |
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 |
|
---|---|
|
Inicia la creación de una tarea de informe. |
|
Obtiene metadatos de informes sobre una tarea de informe específica. |
|
Muestra una lista de todas las tareas de informes de una propiedad. |
|
Recupera el contenido de una tarea de informe. |