REST Resource: properties.reportTasks

Recurso: ReportTask

Uma configuração específica de tarefa de relatório.

Representação JSON 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Campos
name

string

Apenas saída. Identificador. O nome do recurso da tarefa de relatório atribuído durante a criação. Formato: "properties/{property}/reportTasks/{reportTask}"
reportDefinition

object (ReportDefinition)

Opcional. Uma definição de relatório para buscar dados de relatórios, que descreve a estrutura de um relatório. Ele geralmente inclui os campos que serão incluídos no relatório e os critérios que serão usados para filtrar os dados.
reportMetadata

object (ReportMetadata)

Apenas saída. Os metadados de relatório para uma tarefa de relatório específica, que fornece informações sobre um relatório. Ele geralmente inclui as seguintes informações: o nome do recurso, o estado e o carimbo de data/hora em que o relatório foi criado etc.

ReportDefinition

A definição de como um relatório deve ser gerado.

Representação 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. As dimensões solicitadas e exibidas.
metrics[]

object (Metric)

Opcional. As métricas solicitadas e exibidas.
dateRanges[]

object (DateRange)

Opcional. Períodos dos dados a serem lidos. Se vários períodos forem solicitados, cada linha da resposta conterá um índice de período baseado em zero. Se dois períodos se sobrepõem, os dados do evento para os dias em que há sobreposição são incluídos nas linhas de resposta para ambos os períodos. Em uma solicitação de coorte, esse dateRanges precisa não ser especificado.
dimensionFilter

object (FilterExpression)

Opcional. Com os filtros de dimensão, você pode solicitar apenas valores específicos de dimensão no relatório. Para saber mais, consulte Princípios básicos dos filtros de dimensão para ver exemplos. Não é possível usar métricas neste filtro.
metricFilter

object (FilterExpression)

Opcional. A cláusula de filtro de métricas. Aplicado após agregar as linhas do relatório, de maneira semelhante à cláusula do SQL. Não é possível usar dimensões neste filtro.
offset

string (int64 format)

Opcional. A contagem de linhas da linha inicial do armazenamento do Google Analytics. A primeira linha é contada como linha 0.

Ao criar uma tarefa de relatório, os parâmetros offset e limit definem o subconjunto de linhas de dados do armazenamento do Google Analytics que serão incluídos no relatório gerado. Por exemplo, se houver um total de 300.000 linhas no armazenamento do Google Analytics, a tarefa inicial de relatório pode ter as primeiras 10.000 linhas com um limite de 10.000 e um deslocamento de 0. Em seguida, outra tarefa de relatório pode abranger as próximas 10.000 linhas com um limite de 10.000 e um deslocamento de 10.000.
limit

string (int64 format)

Opcional. O número de linhas que serão retornadas no relatório. Se não for especificado, 10.000 linhas serão retornadas. A API retorna um máximo de 250.000 linhas por solicitação, não importa quantas você solicitar. limit precisa ser positivo.

A API também vai poder retornar menos linhas do que o limit solicitado, se não houver tantos valores de dimensão quanto o limit. Por exemplo, há menos de 300 valores possíveis para a dimensão country. Portanto, ao gerar relatórios apenas com country, não é possível receber mais de 300 linhas, mesmo que você defina limit como um valor maior.
metricAggregations[]

enum (MetricAggregation)

Opcional. Agregação de métricas. Os valores de métrica agregados vão aparecer em linhas em que os valores de dimensão estão definidos como "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Opcional. Especifica como as linhas são ordenadas na resposta.
currencyCode

string

Opcional. Um código de moeda no formato ISO4217, como "AED", "USD", "JPY". Se o campo estiver vazio, o relatório vai usar a moeda padrão da propriedade.
cohortSpec

object (CohortSpec)

Opcional. Grupo de coorte associado a esta solicitação. Se houver um grupo de coorte na solicitação, a dimensão "cohort" precisa estar presente.
keepEmptyRows

boolean

Opcional. Se for falso ou não especificado, cada linha com todas as métricas iguais a 0 não será retornada. Se verdadeiro, essas linhas serão retornadas se não forem removidas separadamente por um filtro.

Independentemente dessa configuração keepEmptyRows, apenas os dados registrados pela propriedade do Google Analytics podem ser mostrados em um relatório.

Por exemplo, se uma propriedade nunca registrar um evento purchase, uma consulta para a dimensão eventName e a métrica eventCount não terá uma linha com eventName: "purchase" e eventCount: 0.
samplingLevel

enum (SamplingLevel)

Opcional. O nível de amostragem do relatório.

Dimensão

As dimensões são atributos dos seus dados. Por exemplo, a cidade da dimensão indica a cidade de origem de um evento. Os valores de dimensão nas respostas do relatório são strings. Por exemplo, a cidade pode ser "Paris" ou "Nova York".

Representação JSON 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Campos
name

string

O nome da dimensão. Consulte Dimensões da API para conferir a lista de nomes de dimensões aceitos pelos métodos de relatórios principais, como runReport e batchRunReports. Consulte Dimensões em tempo real para a lista de nomes de dimensões compatíveis com o método runRealtimeReport. Consulte Dimensões do funil para ver a lista de nomes de dimensões compatíveis com o método runFunnelReport.

Se dimensionExpression for especificado, name poderá ser qualquer string dentro do conjunto de caracteres permitido. Por exemplo, se um dimensionExpression concatenar country e city, você poderá chamar essa dimensão de countryAndCity. Os nomes de dimensão escolhidos precisam corresponder à expressão regular ^[a-zA-Z0-9_]$.

As dimensões são referenciadas por name em dimensionFilter, orderBys, dimensionExpression e pivots.
dimensionExpression

object (DimensionExpression)

Uma dimensão pode ser o resultado de uma expressão de várias dimensões. Por exemplo, a dimensão "país, cidade": concatenate(country, ", ", city).

DimensionExpression

Usado para expressar uma dimensão que é o resultado de uma fórmula de várias dimensões. Exemplos de uso: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2).

Representação 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ão one_expression. Especifique um tipo de expressão de dimensão para DimensionExpression. one_expression pode ser apenas de um dos tipos a seguir:
lowerCase

object (CaseExpression)

Usado para converter um valor de dimensão em letras minúsculas.
upperCase

object (CaseExpression)

Usado para converter um valor de dimensão em letras maiúsculas.
concatenate

object (ConcatenateExpression)

Usado para combinar valores de dimensão em uma única dimensão. Por exemplo, a dimensão "país, cidade": concatenate(country, ", ", city).

CaseExpression

Usado para converter um valor de dimensão em um único caso.

Representação JSON 
{
  "dimensionName": string
}
Campos
dimensionName

string

Nome de uma dimensão. O nome precisa se referir a um nome no campo de dimensões da solicitação.

ConcatenateExpression

Usado para combinar valores de dimensão em uma única dimensão.

Representação JSON 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Campos
dimensionNames[]

string

Nomes das dimensões. Os nomes precisam se referir aos nomes no campo de dimensões da solicitação.
delimiter

string

O delimitador colocado entre os nomes das dimensões.

Os delimitadores geralmente são caracteres únicos, como "|" ou ",", mas podem ser strings mais longas. Se um valor de dimensão tiver o delimitador, ambos vão aparecer na resposta sem distinção. Por exemplo, se o valor da dimensão 1 for "US,FR", o valor da dimensão 2 = "JP" e o delimitador = ", a resposta conterá "US,FR,JP".

Métrica

As medições quantitativas de um relatório. Por exemplo, a métrica eventCount é o número total de eventos. As solicitações podem ter até 10 métricas.

Representação JSON 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Campos
name

string

O nome da métrica. Consulte Métricas da API para conferir a lista de nomes de métricas aceitas pelos métodos de relatórios principais, como runReport e batchRunReports. Consulte Métricas em tempo real para conferir a lista de nomes de métricas compatíveis com o método runRealtimeReport. Consulte Métricas de funil para conferir a lista de nomes de métricas compatíveis com o método runFunnelReport.

Se expression for especificado, name poderá ser qualquer string dentro do conjunto de caracteres permitido. Por exemplo, se expression for screenPageViews/sessions, você pode chamar o nome da métrica como viewsPerSession. Os nomes das métricas escolhidas precisam corresponder à expressão regular ^[a-zA-Z0-9_]$.

As métricas são referenciadas por name em metricFilter, orderBys e métrica expression.
expression

string

Uma expressão matemática para métricas derivadas. Por exemplo, a métrica "Contagem de eventos por usuário" é eventCount/totalUsers.
invisible

boolean

Indica se uma métrica está invisível na resposta do relatório. Se uma métrica for invisível, ela não vai produzir uma coluna na resposta, mas poderá ser usada em metricFilter, orderBys ou em uma métrica expression.

DateRange

Um conjunto contínuo de dias: startDate, startDate + 1, ..., endDate. As solicitações são permitidas para até quatro períodos.

Representação JSON 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Campos
startDate

string

A data de início inclusiva da consulta no formato YYYY-MM-DD. Não pode ser posterior a endDate. O formato NdaysAgo, yesterday ou today também é aceito. Nesse caso, a data é inferida com base no fuso horário de relatório da propriedade.
endDate

string

A data de término inclusiva da consulta no formato YYYY-MM-DD. Não pode ser anterior a startDate. O formato NdaysAgo, yesterday ou today também é aceito. Nesse caso, a data é inferida com base no fuso horário de relatório da propriedade.
name

string

Atribui um nome a esse intervalo de datas. A dimensão dateRange recebe esse nome em uma resposta de relatório. Se definido, não pode começar com date_range_ ou RESERVED_. Se não forem definidos, os períodos serão nomeados pelo índice baseado em zero na solicitação: date_range_0, date_range_1 etc.

FilterExpression

Para expressar filtros de dimensão ou métrica. Os campos na mesma FilterExpression precisam ter todas as dimensões ou todas as métricas.

Representação 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ão expr. Especifique um tipo de expressão de filtro para FilterExpression. expr pode ser apenas de um dos tipos a seguir:
andGroup

object (FilterExpressionList)

As FilterExpressions em andGroup têm uma relação AND.
orGroup

object (FilterExpressionList)

As FilterExpressions em orGroup têm uma relação OR.
notExpression

object (FilterExpression)

A FilterExpression não é de notExpression.
filter

object (Filter)

Um filtro primitivo. Na mesma FilterExpression, todos os nomes de campos do filtro precisam ser todas as dimensões ou todas as métricas.

FilterExpressionList

Uma lista de expressões de filtro.

Representação JSON 
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
Campos
expressions[]

object (FilterExpression)

Uma lista de expressões de filtro.

Filtro

Uma expressão para filtrar valores de dimensão ou métrica.

Representação 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)
  }
  // End of list of possible types for union field one_filter.
}
Campos
fieldName

string

O nome da dimensão ou da métrica. Precisa ser um nome definido nas dimensões ou métricas.
Campo de união one_filter. Especifique um tipo de filtro para Filter. one_filter pode ser apenas de um dos tipos a seguir:
stringFilter

object (StringFilter)

Filtro relacionado a strings.
inListFilter

object (InListFilter)

Um filtro para valores de lista.
numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data.
betweenFilter

object (BetweenFilter)

Um filtro entre dois valores.

StringFilter

O filtro para string

Representação JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Campos
matchType

enum (MatchType)

O tipo de correspondência desse filtro.
value

string

O valor da string usado para a correspondência.
caseSensitive

boolean

Se for verdadeiro, o valor da string vai diferenciar maiúsculas de minúsculas.

MatchType

O tipo de correspondência de um filtro de string

Enums
MATCH_TYPE_UNSPECIFIED Não especificado
EXACT Correspondência exata do valor da string.
BEGINS_WITH Começa com o valor da string.
ENDS_WITH Termina com o valor da string.
CONTAINS Contém o valor da string.
FULL_REGEXP Correspondência total da expressão regular com o valor da string.
PARTIAL_REGEXP Correspondência parcial da expressão regular com o valor da string.

InListFilter

O resultado precisa estar em uma lista de valores de string.

Representação JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Campos
values[]

string

A lista de valores de string. Precisa estar preenchido.
caseSensitive

boolean

Se for verdadeiro, o valor da string vai diferenciar maiúsculas de minúsculas.

NumericFilter

Filtra valores numéricos ou de data.

Representação JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Campos
operation

enum (Operation)

O tipo de operação desse filtro.
value

object (NumericValue)

Um valor numérico ou de data.

Operação

Operação aplicada a um filtro numérico

Enums
OPERATION_UNSPECIFIED Não especificado.
EQUAL Igual
LESS_THAN Menor que
LESS_THAN_OR_EQUAL menor ou igual a
GREATER_THAN maior que
GREATER_THAN_OR_EQUAL maior ou igual a

NumericValue

Para representar um número.

Representação 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ão one_value. Um de um valor numérico one_value pode ser apenas um destes:
int64Value

string (int64 format)

Número inteiro
doubleValue

number

Valor duplo

BetweenFilter

Para expressar que o resultado precisa estar entre dois números (inclusive).

Representação JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Campos
fromValue

object (NumericValue)

Começa com esse número.
toValue

object (NumericValue)

Termina com este número.

MetricAggregation

Representa a agregação de métricas.

Enums
METRIC_AGGREGATION_UNSPECIFIED Operador não especificado.
TOTAL Operador de soma.
MINIMUM Operador mínimo.
MAXIMUM Operador máximo.
COUNT Operador de contagem.

OrderBy

As ordenações definem como as linhas serão classificadas na resposta. Por exemplo, ordenar as linhas pela contagem de eventos decrescente é uma ordenação, e ordenar as linhas pela string de nome do evento é uma ordenação diferente.

Representação 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

Se for verdadeiro, classifica em ordem decrescente.
Campo de união one_order_by. Especifique um tipo de ordem por para OrderBy. one_order_by pode ser apenas de um dos tipos a seguir:
metric

object (MetricOrderBy)

Classifica os resultados pelos valores de uma métrica.
dimension

object (DimensionOrderBy)

Classifica os resultados pelos valores de uma dimensão.

MetricOrderBy

Ordena por valores de métrica.

Representação JSON 
{
  "metricName": string
}
Campos
metricName

string

Um nome de métrica na solicitação para ordenar por.

DimensionOrderBy

Ordena por valores de dimensão.

Representação JSON 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Campos
dimensionName

string

Um nome de dimensão na solicitação para ordenar por.
orderType

enum (OrderType)

Controla a regra de ordenação dos valores de dimensões.

OrderType

Regra para ordenar os valores da dimensão de string.

Enums
ORDER_TYPE_UNSPECIFIED Não especificado.
ALPHANUMERIC Classificação alfanumérica por ponto de código Unicode. Por exemplo, "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Classifica os caracteres alfanuméricos sem distinção entre maiúsculas e minúsculas pelo ponto de código Unicode em minúsculas. Por exemplo, "2" < "A" < "b" < "X" < "z".
NUMERIC Os valores das dimensões são convertidos em números antes da classificação. Por exemplo, na ordenação NUMÉRICA, "25" < "100", e na ordenação ALPHANUMERIC, "100" < "25". Os valores de dimensão não numéricos têm o mesmo valor de ordenação abaixo de todos os valores numéricos.

CohortSpec

Especificação de coortes para um relatório de coorte.

Os relatórios de coorte criam uma série temporal de retenção de usuários para a coorte. Por exemplo, você pode selecionar o coorte de usuários que foram adquiridos na primeira semana de setembro e acompanhar esse coorte nas próximas seis semanas. A seleção dos usuários adquiridos na primeira semana da coorte de setembro é especificada no objeto cohort. O acompanhamento dessa coorte nas próximas seis semanas é especificado no objeto cohortsRange.

Para conferir exemplos, consulte Exemplos de relatórios de coorte.

A resposta do relatório pode mostrar uma série temporal semanal em que o app reteve 60% da coorte após três semanas e 25% após seis semanas. Essas duas porcentagens podem ser calculadas pela métrica cohortActiveUsers/cohortTotalUsers e vão aparecer em linhas separadas no relatório.

Representação JSON 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Campos
cohorts[]

object (Cohort)

Define os critérios de seleção para agrupar usuários em coortes.

A maioria dos relatórios de coortes define apenas uma coorte. Se várias coortes forem especificadas, cada uma delas poderá ser reconhecida no relatório pelo nome.
cohortsRange

object (CohortsRange)

Os relatórios de coorte acompanham coortes em um período estendido. Esse intervalo especifica uma duração de deslocamento para acompanhar as coortes.
cohortReportSettings

object (CohortReportSettings)

Configurações opcionais para um relatório de coorte.

Coorte

Define um critério de seleção de coorte. Um coorte é um grupo de usuários que compartilham uma característica comum. Por exemplo, os usuários com o mesmo firstSessionDate pertencem à mesma coorte.

Representação JSON 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Campos
name

string

Atribui um nome à coorte. A dimensão cohort recebe esse nome em uma resposta de relatório. Se definido, não pode começar com cohort_ ou RESERVED_. Se não for definido, as coortes serão nomeadas pelo índice baseado em zero cohort_0, cohort_1 etc.
dimension

string

Dimensão usada pela coorte. Obrigatório e compatível apenas com firstSessionDate.
dateRange

object (DateRange)

A coorte seleciona usuários com data de primeiro contato entre a data de início e a data de término definidas em dateRange. Esse dateRange não especifica o período completo dos dados de eventos presentes em um relatório de coorte. Em um relatório de coorte, esse dateRange é estendido pela granularidade e pelo deslocamento presentes no cohortsRange. Os dados de eventos para o período estendido estão presentes em um relatório de coorte.

Em uma solicitação de coorte, esse dateRange é obrigatório, e o dateRanges no RunReportRequest ou RunPivotReportRequest precisa ser não especificado.

Em geral, esse dateRange precisa estar alinhado com a granularidade do grupo. Se CohortsRange usar granularidade diária, esse dateRange poderá ser um único dia. Se CohortsRange usar granularidade semanal, esse dateRange poderá ser alinhado a um limite de semana, começando no domingo e terminando no sábado. Se o CohortsRange usar granularidade mensal, esse dateRange poderá ser alinhado a um mês, começando no primeiro e terminando no último dia do mês.

CohortsRange

Configura o período estendido de relatórios para um relatório de coorte. Especifica uma duração de deslocamento para acompanhar as coortes.

Representação JSON 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Campos
granularity

enum (Granularity)

Obrigatório. É a granularidade usada para interpretar startOffset e endOffset no período estendido de um relatório de coorte.
startOffset

integer

startOffset especifica a data de início do período estendido de um relatório de coorte. startOffset geralmente é definido como 0 para que os relatórios contenham dados da aquisição da coorte em diante.

Se granularity for DAILY, o startDate do período estendido de relatórios será startDate da coorte mais startOffset dias.

Se granularity for WEEKLY, o startDate do período estendido de relatórios será startDate da coorte mais startOffset * 7 dias.

Se granularity for MONTHLY, o startDate do período estendido de relatórios será startDate da coorte mais startOffset * 30 dias.
endOffset

integer

Obrigatório. endOffset especifica a data de término do período estendido de um relatório de coorte. endOffset pode ser qualquer número inteiro positivo, mas geralmente é definido como 5 a 10 para que os relatórios contenham dados sobre a coorte para os próximos períodos de granularidade.

Se granularity for DAILY, o endDate do período estendido de relatórios será endDate da coorte mais endOffset dias.

Se granularity for WEEKLY, o endDate do período estendido de relatórios será endDate da coorte mais endOffset * 7 dias.

Se granularity for MONTHLY, o endDate do período estendido do relatório será endDate da coorte mais endOffset * 30 dias.

Granularidade

A granularidade usada para interpretar o startOffset e o endOffset para o período estendido de um relatório de coorte.

Enums
GRANULARITY_UNSPECIFIED Nunca deve ser especificado.
DAILY Granularidade diária. Usado normalmente se o dateRange da coorte for de um único dia e a solicitação contiver cohortNthDay.
WEEKLY Granularidade semanal. É usado com frequência quando o dateRange do grupo tem uma semana de duração (início no domingo e término no sábado) e a solicitação contém cohortNthWeek.
MONTHLY Granularidade mensal. É comumente usado quando a dateRange da coorte tem a duração de um mês e a solicitação contém cohortNthMonth.

CohortReportSettings

Configurações opcionais de um relatório de coorte.

Representação JSON 
{
  "accumulate": boolean
}
Campos
accumulate

boolean

Se verdadeiro, acumula o resultado do primeiro dia de contato até o dia de término. Não é compatível com RunReportRequest.

SamplingLevel

Categorias de níveis de amostragem para as solicitações.

Enums
SAMPLING_LEVEL_UNSPECIFIED Tipo não especificado.
LOW Aplica um nível de amostragem de 10 milhões às propriedades padrão e 100 milhões às propriedades do Google Analytics 360.
MEDIUM Exclusivo para propriedades do Google Analytics 360 com um nível de amostragem de 1 bilhão.
UNSAMPLED Exclusivo para propriedades do Google Analytics 360. As análises detalhadas sem amostragem são mais precisas e podem revelar insights que não aparecem em análises padrão. Para saber mais, acesse https://support.google.com/analytics/answer/10896953.

ReportMetadata

Os metadados do relatório de uma tarefa específica.

Representação JSON 
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Campos
creationQuotaTokensCharged

integer

Apenas saída. O total de tokens de cota cobrados durante a criação do relatório. Como essa contagem de tokens é baseada na atividade do estado CREATING, a cobrança desse token será corrigida quando uma tarefa de relatório entrar no estado ACTIVE ou FAILED.
state

enum (State)

Apenas saída. O estado atual da tarefa de relatório.
beginCreatingTime

string (Timestamp format)

Apenas saída. O horário em que reportTasks.create foi chamado e o relatório começou o estado CREATING.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
taskRowCount

integer

Apenas saída. O número total de linhas no resultado do relatório. Esse campo será preenchido quando o estado estiver ativo. É possível utilizar taskRowCount para paginação nos limites do relatório existente.
errorMessage

string

Apenas saída. A mensagem de erro é preenchida se uma tarefa de relatório falhar durante a criação.
totalRowCount

integer

Apenas saída. O número total de linhas no armazenamento do Google Analytics. Se você quiser consultar outras linhas de dados além do relatório atual, inicie uma nova tarefa de relatório com base no totalRowCount.

O taskRowCount representa o número de linhas especificamente relacionadas ao relatório atual, enquanto o totalRowCount abrange a contagem total de linhas em todos os dados extraídos do armazenamento do Google Analytics.

Por exemplo, suponha que a taskRowCount do relatório atual seja 20 e exiba os dados das primeiras 20 linhas. Ao mesmo tempo, o totalRowCount é 30, indicando a presença de dados em todas as 30 linhas. O taskRowCount pode ser usado para paginar as 20 linhas iniciais. Para expandir o relatório e incluir dados de todas as 30 linhas, uma nova tarefa de relatório pode ser criada usando totalRowCount para acessar o conjunto completo de dados das 30 linhas.

Estado

O estado de processamento.

Enums
STATE_UNSPECIFIED Um estado não especificado nunca será usado.
CREATING O relatório está sendo criado e será disponibilizado em breve. A criação ocorre imediatamente após a chamada CreateReport.
ACTIVE O relatório foi criado e está pronto para consultas.
FAILED Não foi possível criar o relatório.

Métodos

create

 Inicia a criação de uma tarefa de relatório.

get

 Recebe metadados sobre uma tarefa de relatório específica.

list

 Lista todas as tarefas de relatório de uma propriedade.

query

 Recupera o conteúdo de uma tarefa de relatório.