- Recurso: ReportTask
- ReportDefinition
- Dimensión
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Métrica
- DateRange
- FilterExpression
- FilterExpressionList
- Filtrar
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operación
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Cohorte
- CohortsRange
- Nivel de detalle
- CohortReportSettings
- ReportMetadata
- Estado
- Métodos
Recurso: ReportTask
Una configuración específica de tareas de informes.
Representación JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Campos | |
---|---|
name |
Solo salida. Identificador. El nombre del recurso de la tarea de informes asignado durante la creación. Formato: “properties/{property}/reportTasks/{reportTask}” |
reportDefinition |
Opcional. Definición de informe para recuperar datos de un informe, que describe la estructura de un informe. Suele incluir los campos que se incluirán en el informe y los criterios que se utilizarán para filtrar los datos. |
reportMetadata |
Solo salida. Los metadatos de informe para una tarea específica de informe, 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 que se muestran. |
metrics[] |
Opcional. Las métricas solicitadas y que se muestran. |
dateRanges[] |
Opcional. Períodos de los datos que se leerán. 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 los días superpuestos se incluyen en las filas de respuesta de ambos períodos. En una solicitud de cohorte, no se debe especificar este |
dimensionFilter |
Opcional. Los filtros de dimensiones te permiten solicitar solo valores de dimensión específicos en el informe. Si deseas obtener más información, consulta ejemplos del artículo Aspectos básicos de los filtros de dimensión. No se pueden usar métricas en este filtro. |
metricFilter |
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 de cláusula de SQL. No se pueden usar dimensiones en este filtro. |
offset |
Opcional. El recuento de filas de la fila de inicio 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 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, sin importar cuántas tengas. La API también puede mostrar menos filas que la |
metricAggregations[] |
Opcional. Agregación de métricas. Los valores de métricas agregados se mostrarán en las filas en las que dimensionValues se configuren como "RESERVED_(MetricAggregation)". |
orderBys[] |
Opcional. Especifica cómo se ordenan las filas en la respuesta. |
currencyCode |
Opcional. Un código de moneda en formato ISO4217, como “AED”, “USD” o “JPY”. Si el campo está vacío, el informe utilizará la moneda predeterminada de la propiedad. |
cohortSpec |
Opcional. Grupo de cohorte asociado con esta solicitud. Si hay un grupo de cohorte en la solicitud, la dimensión "cohorte" debe estar presente. |
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, estas filas se mostrarán si un filtro no las quita por separado. Independientemente de este parámetro de configuración de Por ejemplo, si una propiedad nunca registra un evento |
Dimensión
Las dimensiones son atributos de tus datos. Por ejemplo, la dimensión "ciudad" indica la ciudad donde se origina un evento. Los valores de dimensiones en las respuestas del informe 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 la sección Dimensiones de la API para obtener la lista de los nombres de las dimensiones compatibles con los principales métodos de informes, como Si se especifica
|
dimensionExpression |
Una dimensión puede ser el resultado de una expresión de varias dimensiones. Por ejemplo, dimensión "país, ciudad": concatenar(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 utiliza para convertir el valor de una dimensión a minúsculas. |
upperCase |
Se utiliza para convertir el valor de una dimensión en mayúsculas. |
concatenate |
Se utiliza para combinar valores de dimensión en una sola dimensión. Por ejemplo, dimensión "país, ciudad": concatenar(país, ", ", ciudad). |
CaseExpression
Se utiliza para convertir el valor de una 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 utiliza para combinar valores de dimensión en una sola dimensión.
Representación JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Campos | |
---|---|
dimensionNames[] |
Son los nombres de las dimensiones. Los nombres deben referirse a los nombres en el campo de dimensiones de la solicitud. |
delimiter |
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 = "US,FR", el valor de 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. Se permiten hasta 10 métricas de solicitud.
Representación JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Campos | |
---|---|
name |
Es el nombre de la métrica. Consulta Métricas de API para obtener la lista de nombres de métricas compatibles con los principales métodos de informes, como Si se especifica
|
expression |
Una expresión matemática para 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
Un conjunto contiguo de días: startDate
, startDate + 1
, ..., endDate
. Las solicitudes se permiten en un máximo de 4 períodos.
Representación JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Campos | |
---|---|
startDate |
La fecha de inicio inclusiva de la consulta en el formato |
endDate |
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: |
|
andGroup |
Las FilterExpressions en andGroup tienen una relación de AND. |
orGroup |
Las FilterExpressions en orGroup tienen una relación de OR. |
notExpression |
FilterExpression NO es notExpression. |
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. |
FilterExpressionList
Una lista de expresiones de filtro.
Representación JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
Una lista de expresiones de filtro. |
Filtro
Una expresión para filtrar valores de dimensión o métrica.
Representación JSON |
---|
{ "fieldName": string, // Union field |
Campos | |
---|---|
fieldName |
El nombre de la dimensión o 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 |
Filtro relacionado con strings. |
inListFilter |
Un filtro para los valores en la lista. |
numericFilter |
Un filtro para valores numéricos o de fecha. |
betweenFilter |
Es un filtro para entre dos valores. |
StringFilter
El filtro para una cadena
Representación JSON |
---|
{
"matchType": enum ( |
Campos | |
---|---|
matchType |
El tipo de concordancia de este filtro. |
value |
El valor de string que se usa para la coincidencia. |
caseSensitive |
Si es verdadero, el valor de la string distingue mayúsculas de minúsculas. |
MatchType
El tipo de concordancia de un filtro de string
Enumeradores | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Sin especificar |
EXACT |
Coincidencia exacta del valor de la cadena. |
BEGINS_WITH |
Comienza con el valor de cadena. |
ENDS_WITH |
Termina con el valor de la cadena. |
CONTAINS |
Contiene el valor de la cadena. |
FULL_REGEXP |
Coincidencia completa para la expresión regular con el valor de cadena. |
PARTIAL_REGEXP |
Coincidencia parcial para la expresión regular con el valor de string. |
InListFilter
El resultado debe estar en una lista de valores de cadena.
Representación JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Campos | |
---|---|
values[] |
La lista de valores de cadena. Este campo no puede estar vacío. |
caseSensitive |
Si es verdadero, el valor de la string distingue mayúsculas de minúsculas. |
NumericFilter
Filtra por valores numéricos o de fecha.
Representación JSON |
---|
{ "operation": enum ( |
Campos | |
---|---|
operation |
El tipo de operación de este filtro. |
value |
Es un valor numérico o de fecha. |
Operación
La operación aplicada a un filtro numérico
Enumeradores | |
---|---|
OPERATION_UNSPECIFIED |
No se especifica. |
EQUAL |
Igual |
LESS_THAN |
Menor que |
LESS_THAN_OR_EQUAL |
Menor que o igual |
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 puede ser solo una de las siguientes opciones: |
|
int64Value |
Valor del número entero |
doubleValue |
Valor doble |
BetweenFilter
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. |
MetricAggregation
Representa la agregación de métricas.
Enumeradores | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Operador no especificado. |
TOTAL |
SUMA. |
MINIMUM |
Operador mínimo. |
MAXIMUM |
Operador máximo. |
COUNT |
Operador de recuento. |
OrderBy
El criterio Ordenar por define 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 de nombre del evento es un orden diferente.
Representación JSON |
---|
{ "desc": boolean, // Union field |
Campos | |
---|---|
desc |
Si el valor es verdadero, se ordena por orden descendente. |
Campo de unión one_order_by . Especifica un tipo de pedido por 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étricas.
Representación JSON |
---|
{ "metricName": string } |
Campos | |
---|---|
metricName |
Un nombre de métrica en la solicitud para ordenar. |
DimensionOrderBy
Ordena por valores de dimensión.
Representación JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Campos | |
---|---|
dimensionName |
Un nombre de dimensión en la solicitud para ordenar. |
orderType |
Controla la regla para el orden de los valores de dimensión. |
OrderType
Regla para ordenar los valores de dimensión de la cadena.
Enumeradores | |
---|---|
ORDER_TYPE_UNSPECIFIED |
No se especifica. |
ALPHANUMERIC |
Orden alfabético por punto de código Unicode. Por ejemplo, “2” < “A” < “X” < “b” < “z”. |
CASE_INSENSITIVE_ALPHANUMERIC |
Orden alfanumérico que no distingue entre mayúsculas y minúsculas por punto de código Unicode en minúscula. 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”. Todos los valores de dimensión no numéricos tienen el mismo valor de orden por debajo de todos los valores numéricos. |
CohortSpec
Es la especificación de cohortes para un informe de cohorte.
Los informes de cohorte crean una serie temporal de retención de usuarios para la cohorte. Por ejemplo, puedes seleccionar la cohorte de usuarios que se adquirieron en la primera semana de septiembre y seguir esa cohorte durante las próximas seis semanas. La selección de los usuarios adquiridos en la primera semana de la cohorte de septiembre se especifica en el objeto cohort
. La siguiente cohorte de las próximas seis semanas se especifica en el objeto cohortsRange
.
Para ver ejemplos, consulta Ejemplos de informes de cohorte.
La respuesta del informe podría mostrar una serie temporal semanal en la que supongamos que tu app retuvo un 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 serán filas separadas en el informe.
Representación JSON |
---|
{ "cohorts": [ { object ( |
Campos | |
---|---|
cohorts[] |
Define los criterios de selección para agrupar usuarios en cohortes. La mayoría de los informes de cohorte definen una sola cohorte. Si se especifican varias cohortes, cada una se puede reconocer en el informe por su nombre. |
cohortsRange |
Los informes de cohorte siguen cohortes durante un período de informe extendido. Este rango especifica una duración de desplazamiento para seguir a las cohortes. |
cohortReportSettings |
Configuración opcional para un informe de cohorte. |
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 |
Dimensión que usa la cohorte. Obligatorio y solo admite |
dateRange |
La cohorte selecciona a los usuarios cuya fecha de primer 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 cohorte. Especifica una duración de desplazamiento para seguir las cohortes.
Representación JSON |
---|
{
"granularity": enum ( |
Campos | |
---|---|
granularity |
Obligatorio. Es el nivel de detalle que se usa para interpretar los valores de |
startOffset |
Si Si Si |
endOffset |
Obligatorio. Si Si Si |
Nivel de detalle
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.
Enumeradores | |
---|---|
GRANULARITY_UNSPECIFIED |
Nunca se debe especificar. |
DAILY |
Nivel de detalle diario: Se suele usar si el dateRange de la cohorte es de un solo día y la solicitud contiene cohortNthDay . |
WEEKLY |
Nivel de detalle semanal. Se suele usar si la dateRange de la cohorte tiene una duración de una semana (comienza el domingo y finaliza el sábado) y la solicitud contiene cohortNthWeek . |
MONTHLY |
Nivel de detalle mensual: Se suele usar si la dateRange de la cohorte tiene una duración de un mes 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 de finalización. No se admite en |
ReportMetadata
Los metadatos de informes para una tarea específica de informe.
Representación JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Campos | |
---|---|
creationQuotaTokensCharged |
Solo salida. Son los tokens de cuota totales 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 informes. |
beginCreatingTime |
Solo salida. El momento en 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: |
taskRowCount |
Solo salida. Es la cantidad total de filas en el resultado del informe. Este campo se propagará cuando el estado esté activo. Puedes usar |
errorMessage |
Solo salida. Se propaga un mensaje de error si una tarea de informe falla durante la creación. |
totalRowCount |
Solo salida. Es la cantidad total de filas en el almacenamiento de Google Analytics. Si quieres consultar filas de datos adicionales aparte del informe actual, el propietario puede iniciar una nueva tarea de informe en función del
Por ejemplo, supongamos que el |
Estado
El estado de procesamiento.
Enumeradores | |
---|---|
STATE_UNSPECIFIED |
Nunca se usará el estado no especificado. |
CREATING |
Se está creando el informe y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada CreateReport. |
ACTIVE |
El informe está completamente creado y listo para realizar consultas. |
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 específica de informes. |
|
Muestra una lista de todas las tareas de informes de una propiedad. |
|
Recupera el contenido de una tarea de informe. |