REST Resource: properties.reportTasks

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}"

object (ReportDefinition)

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

object (ReportMetadata)

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

object (Dimension)

Opcional. As dimensões solicitadas e exibidas.

object (Metric)

Opcional. As métricas solicitadas e exibidas.

object (DateRange)

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

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 Noções básicas sobre filtros de dimensão e confira exemplos. Não é possível usar métricas neste filtro.

object (FilterExpression)

Opcional. A cláusula de filtro de métricas. Aplicado após a agregação das linhas do relatório, semelhante à cláusula SQL having. Não é possível usar dimensões neste filtro.

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.

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

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)".

object (OrderBy)

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

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.

object (CohortSpec)

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

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.

enum (SamplingLevel)

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

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 conferir 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 aceitos pelo 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.

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

object (CaseExpression)

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

object (CaseExpression)

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

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

string

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

string

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

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 estar presentes na resposta sem distinção. Por exemplo,se o valor da dimensão 1 for "US,FR", o valor da dimensão 2 for "JP" e o delimitador for ",", a resposta conterá "US,FR,JP".

string

O nome da métrica. Consulte Métricas da API para conferir a lista de nomes de métricas aceitos 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.

string

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

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.

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.

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.

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.

object (FilterExpressionList)

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

object (FilterExpressionList)

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

object (FilterExpression)

A FilterExpression não é de notExpression.

object (Filter)

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

object (FilterExpression)

Uma lista de expressões de filtro.

string

O nome da dimensão ou da métrica. Precisa ser um nome definido em dimensões ou métricas.

object (StringFilter)

Filtro relacionado a strings.

object (InListFilter)

Um filtro para valores de lista.

object (NumericFilter)

Um filtro para valores numéricos ou de data.

object (BetweenFilter)

Um filtro entre dois valores.

object (EmptyFilter)

Um filtro para valores vazios, como "(not set)" e "".

enum (MatchType)

O tipo de correspondência desse filtro.

string

O valor de string usado para a correspondência.

boolean

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

string

A lista de valores de string. Precisa estar preenchido.

boolean

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

enum (Operation)

O tipo de operação desse filtro.

object (NumericValue)

Um valor numérico ou de data.

string (int64 format)

Número inteiro

number

Valor duplo

object (NumericValue)

Começa com esse número.

object (NumericValue)

Termina com esse número.

boolean

Se for verdadeiro, classifica em ordem decrescente.

object (MetricOrderBy)

Classifica os resultados pelos valores de uma métrica.

object (DimensionOrderBy)

Classifica os resultados pelos valores de uma dimensão.

string

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

string

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

enum (OrderType)

Controla a regra de ordenação do valor da dimensão.

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.

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.

object (CohortReportSettings)

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

string

Atribui um nome a essa 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.

string

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

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 a granularidade diária, esse dateRange pode ser um único dia. Se CohortsRange usar granularidade semanal, 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.

enum (Granularity)

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

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.

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 de relatórios será endDate da coorte mais endOffset * 30 dias.

boolean

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

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 desses tokens será corrigida quando uma tarefa de relatório entrar no estado ACTIVE ou FAILED.

enum (State)

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

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

integer

Apenas saída. O número total de linhas no resultado do relatório. Esse campo será preenchido quando o estado estiver ativo. Você pode usar taskRowCount para paginação dentro dos limites do relatório atual.

string

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

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 o taskRowCount do relatório atual seja 20, mostrando 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, é possível criar uma nova tarefa de relatório usando o totalRowCount para acessar o conjunto completo de 30 linhas de dados.