- Recurso: ReportTask
- ReportDefinition
- Dimensão
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Métrica
- DateRange
- FilterExpression
- FilterExpressionList
- Filtrar
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operação
- NumericValue (em inglês)
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Coorte
- CohortsRange
- Granularidade
- CohortReportSettings
- ReportMetadata
- Estado
- Métodos
Recurso: ReportTask
A configuração de uma tarefa de relatório específica.
Representação JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Campos | |
---|---|
name |
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 |
Opcional. Uma definição de relatório para buscar dados de relatório, que descreve a estrutura dele. Essa métrica 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 |
Apenas saída. Os metadados do relatório de uma tarefa específica, que fornecem informações sobre um relatório. Ela normalmente inclui as seguintes informações: o nome do recurso, o estado, 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 ( |
Campos | |
---|---|
dimensions[] |
Opcional. As dimensões solicitadas e exibidas. |
metrics[] |
Opcional. As métricas solicitadas e exibidas. |
dateRanges[] |
Opcional. Períodos de dados a serem lidos. Se vários períodos forem solicitados, cada linha de resposta terá um índice de período baseado em zero. Se dois períodos se sobrepuserem, os dados de eventos dos dias sobrepostos serão incluídos nas linhas de resposta dos dois períodos. Em uma solicitação de coorte, esse |
dimensionFilter |
Opcional. Com os filtros de dimensão, é possível solicitar somente valores de dimensão específicos 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 |
Opcional. A cláusula de filtro das métricas. Aplicado após agregar as linhas do relatório, semelhante à cláusula SQL. Não é possível usar dimensões neste filtro. |
offset |
Opcional. A contagem de linhas da primeira linha do armazenamento do Google Analytics. A primeira linha é contada como a linha 0. Ao criar uma tarefa de relatório, os parâmetros |
limit |
Opcional. O número de linhas a serem retornadas no relatório. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 250.000 linhas por solicitação, independentemente de quantas linhas você solicitar. A API também pode retornar menos linhas do que o |
metricAggregations[] |
Opcional. Agregação de métricas. Os valores das métricas agregadas serão mostrados nas linhas em que "dimensionValues" estiver definido como "RESERVED_(Metric separadamente)". |
orderBys[] |
Opcional. Especifica como as linhas são ordenadas na resposta. |
currencyCode |
Opcional. Um código de moeda no formato ISO4217, como "AED", "USD", "JPY". Se o campo estiver vazio, o relatório usará a moeda padrão da propriedade. |
cohortSpec |
Opcional. Grupo de coorte associado a esta solicitação. Se houver um grupo de coorte na solicitação, a dimensão "coorte" precisará estar presente. |
keepEmptyRows |
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 da configuração de Por exemplo, se uma propriedade nunca registrar um evento |
Dimensão
As dimensões são atributos dos seus dados. Por exemplo, a dimensão "cidade" 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 poderia ser "Paris" ou "Nova York".
Representação JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Campos | |
---|---|
name |
Nome da dimensão. Consulte as Dimensões da API para ver a lista de nomes de dimensões compatíveis com os principais métodos de geração de relatórios, como Se As dimensões são referenciadas por |
dimensionExpression |
Uma dimensão pode ser o resultado de uma expressão de várias dimensões. Por exemplo, dimensão "country, city": 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 |
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 |
Usado para converter um valor de dimensão em minúsculas. |
upperCase |
Usado para converter um valor de dimensão em maiúsculas. |
concatenate |
Usado para combinar valores de dimensão a uma única dimensão. Por exemplo, dimensão "country, city": concatenate(country, ", ", city). |
CaseExpression
Usado para converter um valor de dimensão em um único caso.
Representação JSON |
---|
{ "dimensionName": string } |
Campos | |
---|---|
dimensionName |
Nome de uma dimensão. O nome deve se referir a um nome no campo de dimensões da solicitação. |
ConcatenateExpression
Usado para combinar valores de dimensão a uma única dimensão.
Representação JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Campos | |
---|---|
dimensionNames[] |
Nomes de dimensões. Os nomes devem se referir aos nomes no campo de dimensões da solicitação. |
delimiter |
O delimitador colocado entre os nomes da dimensão. 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 estarão 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 = ", a resposta vai 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 |
O nome da métrica. Consulte as Métricas da API para acessar a lista de nomes de métricas compatíveis com os principais métodos de geração de relatórios, como Se As métricas são referenciadas por |
expression |
Uma expressão matemática para métricas derivadas. Por exemplo, a métrica "Contagem de eventos" por usuário é |
invisible |
Indica se uma métrica está invisível na resposta do relatório. Se uma métrica estiver invisível, ela não vai produzir uma coluna na resposta, mas vai poder ser usada em |
DateRange
Um conjunto contíguo de dias: startDate
, startDate + 1
, ..., endDate
. As solicitações podem ter até quatro períodos.
Representação JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Campos | |
---|---|
startDate |
A data de início inclusiva para a consulta no formato |
endDate |
A data de término inclusiva da consulta no formato |
name |
Atribui um nome ao período. A dimensão |
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 |
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 |
Os FilterExpressions em andGroup têm uma relação AND. |
orGroup |
Os FilterExpressions em orGroup têm uma relação OR. |
notExpression |
FilterExpression NÃO é de notExpression. |
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. |
FilterExpressionList
Uma lista de expressões de filtro.
Representação JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
Uma lista de expressões de filtro. |
Filtrar
Uma expressão para filtrar valores de dimensão ou métrica.
Representação JSON |
---|
{ "fieldName": string, // Union field |
Campos | |
---|---|
fieldName |
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 |
Filtro relacionado a strings. |
inListFilter |
Um filtro para valores na lista. |
numericFilter |
Um filtro para valores numéricos ou de data. |
betweenFilter |
Um filtro para entre dois valores. |
StringFilter
O filtro para string
Representação JSON |
---|
{
"matchType": enum ( |
Campos | |
---|---|
matchType |
O tipo de correspondência para este filtro. |
value |
O valor da string usado para a correspondência. |
caseSensitive |
Se verdadeiro, o valor da string diferencia 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 para a 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[] |
A lista de valores de string. Não pode estar em branco. |
caseSensitive |
Se verdadeiro, o valor da string diferencia maiúsculas de minúsculas. |
NumericFilter
Filtra os valores numéricos ou de data.
Representação JSON |
---|
{ "operation": enum ( |
Campos | |
---|---|
operation |
O tipo de operação para este filtro. |
value |
Um valor numérico ou um valor de data. |
Operação
A 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
Representar um número.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união one_value . Um dos valores numéricos one_value pode ser apenas uma das seguintes opções: |
|
int64Value |
Número inteiro |
doubleValue |
Valor duplo |
BetweenFilter
Para expressar que o resultado precisa estar entre dois números (inclusive).
Representação JSON |
---|
{ "fromValue": { object ( |
Campos | |
---|---|
fromValue |
Começa com este número. |
toValue |
Termina com este número. |
MetricAggregation
Representa a agregação de métricas.
Enums | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Operador não especificado. |
TOTAL |
Operador SUM. |
MINIMUM |
Operador mínimo. |
MAXIMUM |
Operador máximo. |
COUNT |
Operador de contagem. |
OrderBy
A ordenação por define como as linhas serão classificadas na resposta. Por exemplo, ordenar linhas pela contagem de eventos decrescentes é uma ordem, e ordenar linhas pela string do nome do evento é uma ordem diferente.
Representação JSON |
---|
{ "desc": boolean, // Union field |
Campos | |
---|---|
desc |
Se verdadeiro, classifica por 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 |
Classifica os resultados pelos valores de uma métrica. |
dimension |
Classifica os resultados pelos valores de uma dimensão. |
MetricOrderBy
Classifica por valores de métricas.
Representação JSON |
---|
{ "metricName": string } |
Campos | |
---|---|
metricName |
Um nome de métrica na solicitação para ordenar. |
DimensionOrderBy
Classifica por valores de dimensão.
Representação JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Campos | |
---|---|
dimensionName |
Um nome de dimensão na solicitação para ordenar. |
orderType |
Controla a regra de ordenação de valores de dimensão. |
OrderType
Regra para ordenar os valores de dimensão da 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ção alfanumérica sem distinção entre maiúsculas e minúsculas por ponto de código Unicode em minúsculas. Por exemplo, "2" < "A" < "b" < "X" < "z". |
NUMERIC |
Os valores de dimensão são convertidos em números antes da classificação. Por exemplo, na classificação NUMERIC, "25" < "100" e na classificação ALPHANUMERIC , "100" < "25". Todos os valores de dimensão não numéricos têm um valor de ordem igual abaixo de todos os valores numéricos. |
CohortSpec
A 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. Por exemplo, é possível selecionar a coorte de usuários que foram adquiridos na primeira semana de setembro e acompanhar essa coorte pelas 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 pelas próximas seis semanas é especificado no objeto cohortsRange
.
Para ver exemplos, consulte Exemplos de Relatório de coorte.
A resposta do relatório pode mostrar uma série temporal semanal em que digamos que seu 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 serão linhas separadas no relatório.
Representação JSON |
---|
{ "cohorts": [ { object ( |
Campos | |
---|---|
cohorts[] |
Define os critérios de seleção para agrupar usuários em coortes. A maioria dos relatórios define somente uma única coorte. Se várias coortes forem especificadas, cada uma delas poderá ser reconhecida no relatório pelo nome. |
cohortsRange |
Os relatórios de coorte seguem coortes para um período estendido de relatório. Esse intervalo especifica uma duração de deslocamento para seguir as coortes. |
cohortReportSettings |
Configurações opcionais para um relatório de coorte. |
Coorte
Define os critérios de seleção de uma coorte. Um coorte é um grupo de usuários que compartilham uma característica comum. Por exemplo, usuários com o mesmo firstSessionDate
pertencem à mesma coorte.
Representação JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
Campos | |
---|---|
name |
Atribui um nome a essa coorte. A dimensão |
dimension |
Dimensão usada pela coorte. Obrigatório e compatível apenas com |
dateRange |
A coorte seleciona usuários que tiveram o primeiro contato entre a data de início e de término definidas no Em uma solicitação de coorte, esse Em geral, esse |
CohortsRange
Configura o período estendido de um relatório de coorte. Especifica uma duração de deslocamento para seguir as coortes.
Representação JSON |
---|
{
"granularity": enum ( |
Campos | |
---|---|
granularity |
Obrigatório. A granularidade usada para interpretar |
startOffset |
Se Se Se |
endOffset |
Obrigatório. Se Se Se |
Granularidade
A granularidade usada para interpretar startOffset
e endOffset
para o período estendido de um relatório de coorte.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Nunca deve ser especificado. |
DAILY |
Granularidade diária. Geralmente usado se o dateRange da coorte for um único dia e a solicitação contiver cohortNthDay . |
WEEKLY |
Granularidade semanal. Usado normalmente se a dateRange da coorte tiver uma semana de duração (começando no domingo e terminando no sábado) e a solicitação contém cohortNthWeek . |
MONTHLY |
Granularidade mensal. Usado normalmente se o dateRange da coorte tiver um mês de duração e a solicitação contiver cohortNthMonth . |
CohortReportSettings
Configurações opcionais de um relatório de coorte.
Representação JSON |
---|
{ "accumulate": boolean } |
Campos | |
---|---|
accumulate |
Se verdadeiro, acumula o resultado do primeiro dia de contato até o dia de término. Indisponível em |
ReportMetadata
Os metadados do relatório de uma tarefa específica.
Representação JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Campos | |
---|---|
creationQuotaTokensCharged |
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 |
state |
Apenas saída. O estado atual desta tarefa de relatório. |
beginCreatingTime |
Apenas saída. A hora em que Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
taskRowCount |
Apenas saída. O número total de linhas no resultado do relatório. Este campo será preenchido quando o estado estiver ativo. Você pode usar |
errorMessage |
Apenas saída. A mensagem de erro será preenchida se uma tarefa de relatório falhar durante a criação. |
totalRowCount |
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, elas poderão iniciar uma nova tarefa de relatório com base no O Por exemplo, suponha que o |
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 no futuro. A criação ocorre imediatamente após a chamada CreateReport. |
ACTIVE |
O relatório está totalmente criado e pronto para consulta. |
FAILED |
Falha ao criar o relatório. |
Métodos |
|
---|---|
|
Inicia a criação de uma tarefa de relatório. |
|
Recebe os metadados do relatório sobre uma tarefa específica. |
|
Lista todas as tarefas de relatório de uma propriedade. |
|
Recupera o conteúdo de uma tarefa de relatório. |