Method: properties.runFunnelReport

Retorna um Relatório de funil personalizado com dados de eventos do Google Analytics. Os dados retornados da API são como uma tabela com colunas para as dimensões e métricas solicitadas.

Com a análise de funil, você vê as etapas que os usuários realizam até concluir uma tarefa e em quais delas eles permanecem no funil. Por exemplo, como os compradores em potencial começam uma compra e a finalizam? Como compradores únicos se tornam recorrentes? Com essas informações, você pode melhorar as jornadas do cliente evitando interrupções ou abandonos. Para saber mais, consulte Análises detalhadas de funil do GA4.

Esse método é introduzido na estabilidade Alfa com a intenção de coletar feedback sobre a sintaxe e os recursos antes de chegar à versão Beta. Para enviar seu feedback sobre essa API, preencha o Feedback sobre o relatório de funil da API Data do Google Analytics.

Solicitação HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
property

string

Opcional. Um identificador de propriedade do GA4 do Google Analytics com eventos rastreados. Especificado no caminho do URL, e não no corpo. Para saber mais, confira onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade deve ser não especificada ou consistente com a propriedade no nível do lote.

Exemplo: properties/1234

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
Campos
dateRanges[]

object (DateRange)

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.

funnel

object (Funnel)

Opcional. A configuração do funil dessa solicitação. Esta configuração de funil é obrigatória.

funnelBreakdown

object (FunnelBreakdown)

Opcional. Se especificado, esse detalhamento adiciona uma dimensão à resposta do subrelatório da tabela de funis. Essa dimensão de detalhamento expande cada etapa do funil para os valores exclusivos dela. Por exemplo, um detalhamento pela dimensão deviceCategory criará linhas para mobile, tablet, desktop e o total.

funnelNextAction

object (FunnelNextAction)

Opcional. Se especificado, a próxima ação adiciona uma dimensão à resposta do subrelatório de visualização do funil. Essa dimensão de ação seguinte expande cada etapa do funil para os valores exclusivos da próxima ação. Por exemplo, uma ação seguinte da dimensão eventName criará linhas para vários eventos (por exemplo, session_start e click) e o total.

A ação "Próxima" só oferece suporte a eventName e à maioria das dimensões de página / tela, como pageTitle e pagePath.

funnelVisualizationType

enum (FunnelVisualizationType)

Opcional. O tipo de visualização de funil controla as dimensões presentes na resposta do subrelatório de visualização de funil. Se não for especificado, STANDARD_FUNNEL será usado.

segments[]

object (Segment)

Opcional. As configurações dos segmentos. Os segmentos são subconjuntos dos dados de uma propriedade. Em um Relatório de funil com segmentos, o funil é avaliado em cada segmento.

Cada segmento especificado nesta solicitação produz uma linha separada na resposta; na resposta, cada segmento identificado pelo seu nome.

O parâmetro "segmentos" é opcional. As solicitações são limitadas a quatro segmentos.

limit

string (int64 format)

Opcional. O número de linhas a serem retornadas. 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. 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.

dimensionFilter

object (FilterExpression)

Opcional. Com os filtros de dimensão, é possível solicitar somente valores de dimensão específicos no relatório. Para saber mais, consulte o artigo Como criar um relatório: filtros de dimensão para ver exemplos. Não é possível usar métricas neste filtro.

returnPropertyQuota

boolean

Opcional. Define se é necessário retornar o estado atual da cota dessa propriedade do Google Analytics. A cota é retornada em PropertyQuota.

Corpo da resposta

A resposta do Relatório de funil contém dois subrelatórios. Os dois subrelatórios são combinações diferentes de dimensões e métricas.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Campos
funnelTable

object (FunnelSubReport)

A tabela do funil é um relatório com etapa, segmento, dimensão de detalhamento, usuários ativos, taxa de conclusão, abandonos e taxa de abandono.

A dimensão do segmento só estará presente nessa resposta se um segmento tiver sido solicitado. A dimensão de detalhamento só estará presente nessa resposta se tiver sido solicitada.

funnelVisualization

object (FunnelSubReport)

A visualização do funil é um relatório com a etapa, o segmento, a data, a dimensão da próxima ação e os usuários ativos do funil.

A dimensão do segmento só estará presente nessa resposta se um segmento tiver sido solicitado. A dimensão de data só estará presente nessa resposta se tiver sido solicitada pelo tipo de funil TRENDED_FUNNEL. A próxima dimensão de ação só estará presente na resposta se tiver sido solicitada.

propertyQuota

object (PropertyQuota)

O estado da cota desta propriedade do Google Analytics, incluindo a solicitação.

kind

string

Identifica o tipo de recurso dessa mensagem. Este kind é sempre a string fixa "analyticsData#runFunnelReport". Útil para distinguir entre tipos de resposta em JSON.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

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

string

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

name

string

Atribui um nome ao período. A dimensão dateRange é avaliada com esse nome em uma resposta de relatório. Se definido, não pode começar com date_range_ ou RESERVED_. Se não for definido, os períodos serão nomeados de acordo com o índice baseado em zero na solicitação: date_range_0, date_range_1 etc.

Funil

Configura o funil em uma solicitação de Relatório de funil. Um funil gera relatórios sobre os usuários à medida que eles passam por uma sequência de etapas.

Com a análise de funil, você vê as etapas que os usuários realizam até concluir uma tarefa e em quais delas eles permanecem no funil. Por exemplo, como os compradores em potencial começam uma compra e a finalizam? Como compradores únicos se tornam recorrentes? Com essas informações, você pode melhorar as jornadas do cliente evitando interrupções ou abandonos.

Representação JSON
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
Campos
isOpenFunnel

boolean

No funil aberto, os usuários podem entrar em qualquer etapa. Já no funil fechado, os usuários precisam entrar na primeira etapa. Opcional. Se não for especificado, será usado um funil fechado.

steps[]

object (FunnelStep)

As etapas sequenciais desse funil.

FunnelStep

As etapas definem a jornada do usuário que você quer mensurar. As etapas contêm uma ou mais condições que os usuários precisam atender para serem incluídos nessa etapa do funil.

Representação JSON
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
Campos
name

string

O nome distinto desta etapa. Se não for especificado, as etapas serão nomeadas com um nome indexado baseado em 1 (por exemplo, "0. ", "1. " etc.). Esse nome define o valor da string retornado pela dimensão funnelStepName. Por exemplo, especificar name = Purchase na terceira etapa do funil da solicitação vai produzir 3. Purchase na resposta do relatório.

isDirectlyFollowedBy

boolean

Se verdadeiro, esta etapa deverá vir diretamente após a etapa anterior. Se for falso, poderá haver eventos entre a etapa anterior e esta etapa. Se não for especificado, isDirectlyFollowedBy será tratado como falso.

filterExpression

object (FunnelFilterExpression)

A condição que os usuários precisam atender para serem incluídos nessa etapa da jornada do funil.

withinDurationFromPriorStep

string (Duration format)

Se especificado, esta etapa precisa ser concluída dentro do intervalo em que a etapa anterior foi concluída. withinDurationFromPriorStep: inclui o endpoint na granularidade de microssegundos. Por exemplo, uma duração de 5 segundos pode ser concluída a 4,9 ou 5 segundos, mas não a 5 segundos e 1 microssegundo.

withinDurationFromPriorStep é opcional e, se não for especificado, as etapas poderão ser separadas por qualquer duração.

Uma duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

FunnelFilterExpression

Expressa combinações de filtros de funil.

Representação JSON
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de união expr. Especifique um tipo de filtro para FunnelFilterExpression. expr pode ser apenas de um dos tipos a seguir:
andGroup

object (FunnelFilterExpressionList)

O FunnelFilterExpression em andGroup tem uma relação AND.

orGroup

object (FunnelFilterExpressionList)

O FunnelFilterExpression em orGroup tem uma relação OR.

notExpression

object (FunnelFilterExpression)

FunnelFilterExpression NÃO é notExpression.

funnelFieldFilter

object (FunnelFieldFilter)

Um filtro de funil para uma dimensão ou métrica.

funnelEventFilter

object (FunnelEventFilter)

Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento.

FunnelFilterExpressionList

Uma lista de expressões de filtro de funil.

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

object (FunnelFilterExpression)

A lista de expressões de filtro de funil.

FunnelFieldFilter

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.

Campo de união one_filter. Especifique um tipo de filtro. 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 na lista.

numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data.

betweenFilter

object (BetweenFilter)

Um filtro para 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 para este filtro.

value

string

O valor da string usado para a correspondência.

caseSensitive

boolean

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[]

string

A lista de valores de string. Não pode estar em branco.

caseSensitive

boolean

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 (Operation),
  "value": {
    object (NumericValue)
  }
}
Campos
operation

enum (Operation)

O tipo de operação para este filtro.

value

object (NumericValue)

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 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 dos valores numéricos one_value pode ser apenas uma das seguintes opções:
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 este número.

toValue

object (NumericValue)

Termina com este número.

FunnelEventFilter

Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento.

Representação JSON
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
Campos
eventName

string

Este filtro corresponde a eventos deste nome de evento único. O nome do evento é obrigatório.

funnelParameterFilterExpression

object (FunnelParameterFilterExpression)

Se especificado, este filtro corresponde a eventos que correspondem ao nome do evento único e às expressões de filtro do parâmetro.

Na expressão de filtro de parâmetro, somente filtros de parâmetro estão disponíveis.

FunnelParameterFilterExpression

Expressa combinações de filtros de funil em parâmetros.

Representação JSON
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de união expr. Especifique um tipo de filtro para FunnelParameterFilterExpression. expr pode ser apenas de um dos tipos a seguir:
andGroup

object (FunnelParameterFilterExpressionList)

O FunnelParameterFilterExpression em andGroup tem uma relação AND.

orGroup

object (FunnelParameterFilterExpressionList)

O FunnelParameterFilterExpression em orGroup tem uma relação OR.

notExpression

object (FunnelParameterFilterExpression)

O FunnelParameterFilterExpression NÃO é notExpression.

funnelParameterFilter

object (FunnelParameterFilter)

Um filtro de parâmetro de funil primitivo.

FunnelParameterFilterExpressionList

Uma lista de expressões de filtro do parâmetro de funil.

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

object (FunnelParameterFilterExpression)

A lista de expressões de filtro do parâmetro de funil.

FunnelParameterFilter

Uma expressão para filtrar valores de parâmetro em um funil.

Representação JSON
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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
Campo de união one_parameter. O campo que está sendo filtrado. one_parameter pode ser apenas de um dos tipos a seguir:
eventParameterName

string

Este filtro será avaliado no parâmetro de evento especificado. Os parâmetros de evento são registrados como parâmetros do evento. Os parâmetros de evento incluem campos como "firebase_screen" e "currency".

Os parâmetros de evento só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados.

itemParameterName

string

Este filtro será avaliado no parâmetro de item especificado. Os parâmetros do item são registrados como parâmetros na matriz do item. Os parâmetros do item incluem campos como "item_name" e "item_category".

Os parâmetros do item só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados.

Os parâmetros do item estão disponíveis apenas em eventos de e-commerce. Se quiser saber mais sobre os eventos de e-commerce, consulte o guia Medir e-commerce.

Campo de união one_filter. Especifique um tipo de filtro. 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 na lista.

numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data.

betweenFilter

object (BetweenFilter)

Um filtro para entre dois valores.

FunnelBreakdown

Eles adicionam uma dimensão à resposta do subrelatório da tabela de funil.

Representação JSON
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
Campos
breakdownDimension

object (Dimension)

A coluna de dimensão foi adicionada à resposta do subrelatório da tabela de funil. A dimensão de detalhamento detalha cada etapa do funil. Um breakdownDimension válido será necessário se funnelBreakdown for especificado.

limit

string (int64 format)

O número máximo de valores distintos da dimensão de detalhamento a ser retornada na resposta. Um limit de 5 será usado se o limite não for especificado. O limite precisa ser maior que 0 e não pode exceder 15.

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 (DimensionExpression)
  }
}
Campos
name

string

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 runReport e batchRunReports. Consulte Dimensões em tempo real para ver 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 que você quiser dentro do conjunto de caracteres permitidos. Por exemplo, se um dimensionExpression concatenar country e city, essa dimensão poderá ser chamada de countryAndCity. Os nomes de dimensões 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, 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 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 minúsculas.

upperCase

object (CaseExpression)

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

concatenate

object (ConcatenateExpression)

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

string

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[]

string

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

delimiter

string

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

FunnelNextAction

As próximas ações definem o valor de uma dimensão após o usuário concluir uma etapa, mas antes de o mesmo usuário concluir a próxima etapa. Por exemplo, se nextActionDimension for eventName, nextActionDimension na linha da ia etapa do funil vai retornar o primeiro evento depois do evento que qualificou o usuário para a ia etapa do funil, mas antes de o usuário atingir a i+1a etapa do funil.

Representação JSON
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
Campos
nextActionDimension

object (Dimension)

A coluna de dimensão adicionada à resposta do subrelatório de visualização do funil. A dimensão de ação seguinte retorna o valor seguinte dessa dimensão depois que o usuário atinge a ia etapa do funil.

No momento, o nextActionDimension só oferece suporte a eventName e à maioria das dimensões de página / tela, como pageTitle e pagePath. nextActionDimension não pode ser uma expressão de dimensão.

limit

string (int64 format)

O número máximo de valores distintos da dimensão de detalhamento a ser retornada na resposta. Um limit de 5 será usado se o limite não for especificado. O limite precisa ser maior que zero e não pode exceder 5.

FunnelVisualizationType

Controla as dimensões presentes na resposta do subrelatório de visualização de funil.

Enums
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Tipo não especificado.
STANDARD_FUNNEL Um funil padrão (em degraus). O subrelatório de visualização de funil na resposta não terá data.
TRENDED_FUNNEL Um funil com tendências (gráfico de linhas). O subrelatório de visualização de funil na resposta terá a dimensão de data.

Segmento

Um segmento é um subconjunto de dados do Google Analytics. que, por exemplo, pode ser composto por usuários de um determinado país ou cidade ou que compram uma determinada linha de produtos, acessam uma parte específica do seu site ou acionam certos eventos no app.

Para saber mais, consulte o Criador de segmentos do GA4.

Representação JSON
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
Campos
name

string

O nome deste segmento. Se não for especificado, os segmentos serão chamados de "Segmento". Esse nome define o valor da string retornado pela dimensão segment. A dimensão segment prefixa nomes de segmento pelo número de índice com base em 1 na solicitação (por exemplo, "1. Segment", "2. Segment" etc.).

Campo de união one_segment_scope. Um segmento é especificado em um escopo. one_segment_scope pode ser apenas de um dos tipos a seguir:
userSegment

object (UserSegment)

Os segmentos de usuários são subconjuntos de usuários que interagiram com seu site ou app.

sessionSegment

object (SessionSegment)

Os segmentos de sessão são subconjuntos das sessões que ocorreram no seu site ou app.

eventSegment

object (EventSegment)

Os segmentos de eventos são subconjuntos de eventos que foram acionados no seu site ou app.

UserSegment

Os segmentos de usuários são subconjuntos de pessoas que interagiram com seu site ou app. Por exemplo, usuários que já fizeram uma compra ou que adicionaram itens ao carrinho, mas não concluíram uma compra.

Representação JSON
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
Campos
userInclusionCriteria

object (UserSegmentCriteria)

Define quais usuários são incluídos no segmento. Opcional.

exclusion

object (UserSegmentExclusion)

Define quais usuários são excluídos do segmento. Opcional.

UserSegmentCriteria

Um usuário corresponde a um critério quando os eventos dele atendem às condições deles.

Representação JSON
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
Campos
andConditionGroups[]

object (UserSegmentConditionGroup)

Um usuário atenderá a esses critérios se corresponder a cada um desses andConditionGroups e a cada um dos andSequenceGroups. andConditionGroups poderá ficar vazio se andSequenceGroups for especificado.

andSequenceGroups[]

object (UserSegmentSequenceGroup)

Um usuário atenderá a esses critérios se corresponder a cada um desses andSequenceGroups e a cada um dos andConditionGroups. andSequenceGroups poderá ficar vazio se andConditionGroups for especificado.

UserSegmentConditionGroup

As condições informam ao Google Analytics quais dados incluir ou excluir do segmento.

Representação JSON
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
conditionScoping

enum (UserCriteriaScoping)

Os dados são incluídos ou excluídos do segmento com base na correspondência com o grupo de condições. Esse escopo define quantos eventos a segmentFilterExpression é avaliada antes que seja determinado que o grupo de condições tem correspondência ou não. Por exemplo, se for conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION, a expressão será avaliada em todos os eventos de uma sessão e, em seguida, será determinado que o grupo de condições corresponde ou não a esse usuário. Por exemplo, se for conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT, a expressão será avaliada em um único evento e, em seguida, será determinado que o grupo de condições corresponde ou não a esse usuário.

Opcional. Se não for especificado, conditionScoping = ACROSS_ALL_SESSIONS será usado.

segmentFilterExpression

object (SegmentFilterExpression)

Os dados são incluídos ou excluídos do segmento com base na correspondência com essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros.

UserCriteriaScoping

O escopo especifica quais eventos são considerados ao avaliar se um usuário atende a um critério.

Enums
USER_CRITERIA_SCOPING_UNSPECIFIED Escopo de critérios não especificado. Não especifique.
USER_CRITERIA_WITHIN_SAME_EVENT Se os critérios forem atendidos em um evento, o usuário vai atender aos critérios.
USER_CRITERIA_WITHIN_SAME_SESSION Se os critérios são atendidos em uma sessão, o usuário atende aos critérios.
USER_CRITERIA_ACROSS_ALL_SESSIONS Se os critérios forem atendidos por qualquer evento para o usuário, o usuário corresponderá aos critérios.

SegmentFilterExpression

Expressa combinações de filtros de segmento.

Representação JSON
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de união expr. Especifique um tipo de filtro para SegmentFilterExpression. expr pode ser apenas de um dos tipos a seguir:
andGroup

object (SegmentFilterExpressionList)

O SegmentFilterExpression em andGroup tem uma relação AND.

orGroup

object (SegmentFilterExpressionList)

O SegmentFilterExpression em orGroup tem uma relação OR.

notExpression

object (SegmentFilterExpression)

A SegmentFilterExpression NÃO é de notExpression.

segmentFilter

object (SegmentFilter)

Um filtro de segmento primitivo.

segmentEventFilter

object (SegmentEventFilter)

Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento.

SegmentFilterExpressionList

Uma lista de expressões de filtro de segmento.

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

object (SegmentFilterExpression)

A lista de expressões de filtro de segmento

SegmentFilter

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

Representação JSON
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

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

filterScoping

object (SegmentFilterScoping)

Especifica o escopo do filtro.

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 na lista.

numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data.

betweenFilter

object (BetweenFilter)

Um filtro para entre dois valores.

SegmentFilterScoping

Os escopos especificam como as dimensões e métricas de vários eventos devem ser consideradas ao avaliar um filtro de segmento.

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

boolean

Se atAnyPointInTime for verdadeiro, esse filtro será avaliado como verdadeiro para todos os eventos se for avaliado como verdadeiro para qualquer evento no período da solicitação.

Esse parâmetro atAnyPointInTime não estende o período dos eventos no relatório. Se atAnyPointInTime for verdadeiro, somente os eventos dentro do período do relatório serão considerados na avaliação desse filtro.

Esse atAnyPointInTime só pode ser especificado se o escopo dos critérios for ACROSS_ALL_SESSIONS e não puder ser especificado em sequências.

Se o escopo dos critérios for ACROSS_ALL_SESSIONS, atAnyPointInTime = falso será usado se não for especificado.

SegmentEventFilter

Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento.

Representação JSON
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
Campos
eventName

string

Este filtro corresponde a eventos deste nome de evento único. O nome do evento é obrigatório.

segmentParameterFilterExpression

object (SegmentParameterFilterExpression)

Se especificado, este filtro corresponde a eventos que correspondem ao nome do evento único e às expressões de filtro do parâmetro.

Na expressão de filtro de parâmetro, somente filtros de parâmetro estão disponíveis.

SegmentParameterFilterExpression

Expressa combinações de filtro de segmento em parâmetros.

Representação JSON
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de união expr. Especifique um tipo de filtro para SegmentParameterFilterExpression. expr pode ser apenas de um dos tipos a seguir:
andGroup

object (SegmentParameterFilterExpressionList)

O SegmentParameterFilterExpression em andGroup tem uma relação AND.

orGroup

object (SegmentParameterFilterExpressionList)

O SegmentParameterFilterExpression em orGroup tem uma relação OR.

notExpression

object (SegmentParameterFilterExpression)

O SegmentParameterFilterExpression NÃO é de notExpression.

segmentParameterFilter

object (SegmentParameterFilter)

Um filtro de parâmetro de segmento primitivo.

SegmentParameterFilterExpressionList

Uma lista de expressões de filtro de parâmetro de segmento.

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

object (SegmentParameterFilterExpression)

A lista de expressões de filtro de parâmetro de segmento.

SegmentParameterFilter

Uma expressão para filtrar valores de parâmetro em um segmento.

Representação JSON
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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
filterScoping

object (SegmentParameterFilterScoping)

Especifica o escopo do filtro.

Campo de união one_parameter. O campo que está sendo filtrado. one_parameter pode ser apenas de um dos tipos a seguir:
eventParameterName

string

Este filtro será avaliado no parâmetro de evento especificado. Os parâmetros de evento são registrados como parâmetros do evento. Os parâmetros de evento incluem campos como "firebase_screen" e "currency".

Os parâmetros de evento só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados.

itemParameterName

string

Este filtro será avaliado no parâmetro de item especificado. Os parâmetros do item são registrados como parâmetros na matriz do item. Os parâmetros do item incluem campos como "item_name" e "item_category".

Os parâmetros do item só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados.

Os parâmetros do item estão disponíveis apenas em eventos de e-commerce. Se quiser saber mais sobre os eventos de e-commerce, consulte o guia Medir e-commerce.

Campo de união one_filter. Especifique um tipo de filtro. 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 na lista.

numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data.

betweenFilter

object (BetweenFilter)

Um filtro para entre dois valores.

SegmentParameterFilterScoping

Os escopos especificam como vários eventos devem ser considerados ao avaliar um filtro de parâmetros de segmento.

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

string (int64 format)

Acumula o parâmetro durante o período especificado de dias antes da aplicação do filtro. Compatível apenas se o escopo de critérios for ACROSS_ALL_SESSIONS ou WITHIN_SAME_SESSION. Compatível apenas se o parâmetro for event_count.

Por exemplo, se inAnyNDayPeriod for 3, o eventName for "purchase", o parâmetro do evento for "event_count" e os critérios do filtro forem maiores que 5, esse filtro acumulará a contagem de eventos de compra em cada período de três dias consecutivos no período do relatório. Um usuário passará o critério desse filtro para ser incluído nesse segmento se sua contagem de eventos de compra exceder cinco em um período de três dias consecutivos. Por exemplo, serão considerados os períodos de 01/11/2021 a 03/11/2021, 02/02/11/2021 a 04/11/2021, 03/11/2021 a 05/11/2021 etc.

O período não é estendido para que haja uma janela completa de N dias perto do início do período. Por exemplo, se um relatório for de 01/11/2021 a 10/11/2021 e inAnyNDayPeriod = 3, o primeiro período de dois dias será reduzido porque nenhum dado de eventos fora do período do relatório será lido. Por exemplo, os quatro primeiros períodos serão: 01/11/2021 a 01/11/2021, 01/11/2021 a 02/11/2021, 01/11/2021 a 03/11/2021 e 01/11/2021 a 01/11/2021.

inAnyNDayPeriod é opcional. Se não for especificado, o segmentParameterFilter vai ser aplicado a cada evento individualmente.

UserSegmentSequenceGroup

Defina as condições que devem ocorrer em uma ordem específica para que o usuário seja um membro do segmento.

Representação JSON
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
Campos
sequenceScoping

enum (UserCriteriaScoping)

Todas as etapas da sequência precisam ser atendidas no escopo para que o usuário faça a correspondência com a sequência. Por exemplo, se for sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, todas as etapas da sequência precisarão ser concluídas em uma sessão para que o usuário faça a correspondência com a sequência. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT não tem suporte.

Opcional. Se não for especificado, conditionScoping = ACROSS_ALL_SESSIONS será usado.

sequenceMaximumDuration

string (Duration format)

Define o período em que toda a sequência precisa ocorrer, por exemplo, 30 minutos. sequenceMaximumDuration: inclui o endpoint na granularidade de microssegundos. Por exemplo, uma sequência com duração máxima de 5 segundos pode ser concluída a 4,9 ou 5 segundos, mas não a 5 segundos e 1 microssegundo.

sequenceMaximumDuration é opcional e, se não for especificado, as sequências podem ser concluídas em qualquer duração.

Uma duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

userSequenceSteps[]

object (UserSequenceStep)

Uma sequência ordenada de etapas de condição. Os eventos de um usuário precisam concluir cada etapa para que o usuário corresponda a UserSegmentSequenceGroup.

UserSequenceStep

Uma condição que precisa ocorrer na ordem de etapas especificada para que esse usuário corresponda à sequência.

Representação JSON
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
isDirectlyFollowedBy

boolean

Se verdadeiro, o evento que atende a essa etapa precisa ser o próximo evento após o evento que atende à última etapa. Se for falso, esta etapa seguirá indiretamente a etapa anterior; por exemplo, pode haver eventos entre a etapa anterior e esta etapa. isDirectlyFollowedBy precisa ser falso na primeira etapa.

stepScoping

enum (UserCriteriaScoping)

Essa etapa da sequência precisa ser cumprida no escopo para que o usuário faça a correspondência com a sequência. Por exemplo, se for sequenceScoping = WITHIN_SAME_SESSION, estas etapas da sequência precisarão ser concluídas em uma sessão para que o usuário faça a correspondência com a sequência. stepScoping = ACROSS_ALL_SESSIONS só é permitido se sequenceScoping = ACROSS_ALL_SESSIONS.

Opcional. Se não for especificado, stepScoping usará o mesmo UserCriteriaScoping que o sequenceScoping.

segmentFilterExpression

object (SegmentFilterExpression)

Um usuário faz a correspondência dessa etapa da sequência se os eventos correspondem a essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros.

UserSegmentExclusion

Especifica quais usuários são excluídos do segmento.

Representação JSON
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
Campos
userExclusionDuration

enum (UserExclusionDuration)

Especifica quanto tempo durará uma exclusão se um usuário corresponder a userExclusionCriteria.

Opcional. Se não for especificado, userExclusionDuration de USER_EXCLUSION_TEMPORARY será usado.

userExclusionCriteria

object (UserSegmentCriteria)

Se um usuário atender a essa condição, ele será excluído da associação ao segmento do userExclusionDuration.

UserExclusionDuration

Enumera as opções de quanto tempo uma exclusão durará se um usuário corresponder a userExclusionCriteria.

Enums
USER_EXCLUSION_DURATION_UNSPECIFIED Duração da exclusão não especificada. Não especifique.
USER_EXCLUSION_TEMPORARY Exclua temporariamente os usuários do segmento durante os períodos em que eles atendem à condição userExclusionCriteria.
USER_EXCLUSION_PERMANENT Excluirá permanentemente os usuários do segmento se eles já cumprirem a condição userExclusionCriteria.

SessionSegment

Os segmentos de sessões são subconjuntos das sessões que ocorreram no seu site ou app, por exemplo, todas as originadas de uma determinada campanha publicitária.

Representação JSON
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
Campos
sessionInclusionCriteria

object (SessionSegmentCriteria)

Define quais sessões são incluídas nesse segmento. Opcional.

exclusion

object (SessionSegmentExclusion)

Define quais sessões são excluídas nesse segmento. Opcional.

SessionSegmentCriteria

Uma sessão corresponde a um critério quando os eventos dela atendem às condições deles.

Representação JSON
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
Campos
andConditionGroups[]

object (SessionSegmentConditionGroup)

Uma sessão vai corresponder a esses critérios se corresponder a cada um desses andConditionGroups.

SessionSegmentConditionGroup

As condições informam ao Google Analytics quais dados incluir ou excluir do segmento.

Representação JSON
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
conditionScoping

enum (SessionCriteriaScoping)

Os dados são incluídos ou excluídos do segmento com base na correspondência com o grupo de condições. Esse escopo define quantos eventos a segmentFilterExpression é avaliada antes que seja determinado que o grupo de condições tem correspondência ou não. Por exemplo, se for conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION, a expressão será avaliada em todos os eventos de uma sessão e, em seguida, será determinado que o grupo de condições corresponde ou não à sessão. Por exemplo, se for conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT, a expressão será avaliada em um único evento e, em seguida, será determinado que o grupo de condições corresponde ou não a essa sessão.

Opcional. Se não for especificado, um conditionScoping de WITHIN_SAME_SESSION será usado.

segmentFilterExpression

object (SegmentFilterExpression)

Os dados são incluídos ou excluídos do segmento com base na correspondência com essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros.

SessionCriteriaScoping

O escopo especifica quais eventos são considerados ao avaliar se uma sessão atende a um critério.

Enums
SESSION_CRITERIA_SCOPING_UNSPECIFIED Escopo de critérios não especificado. Não especifique.
SESSION_CRITERIA_WITHIN_SAME_EVENT Se os critérios forem atendidos em um evento, a sessão vai corresponder aos critérios.
SESSION_CRITERIA_WITHIN_SAME_SESSION Se os critérios são atendidos em uma sessão, ela corresponde aos critérios.

SessionSegmentExclusion

Especifica quais sessões são excluídas no segmento.

Representação JSON
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
Campos
sessionExclusionDuration

enum (SessionExclusionDuration)

Especifica quanto tempo durará uma exclusão se uma sessão corresponder a sessionExclusionCriteria.

Opcional. Se não for especificado, um sessionExclusionDuration de SESSION_EXCLUSION_TEMPORARY será usado.

sessionExclusionCriteria

object (SessionSegmentCriteria)

Se uma sessão atender a essa condição, ela será excluída da associação no segmento da sessionExclusionDuration.

SessionExclusionDuration

Enumera opções de quanto tempo uma exclusão durará se uma sessão corresponder a sessionExclusionCriteria.

Enums
SESSION_EXCLUSION_DURATION_UNSPECIFIED Duração da exclusão não especificada. Não especifique.
SESSION_EXCLUSION_TEMPORARY Excluir temporariamente sessões do segmento durante os períodos em que ela atende à condição sessionExclusionCriteria.
SESSION_EXCLUSION_PERMANENT Excluirá permanentemente as sessões do segmento se ela já atender à condição sessionExclusionCriteria.

EventSegment

Os segmentos de eventos são subconjuntos de eventos que foram acionados no seu site ou app. Por exemplo, todos os eventos de compra feitos em um determinado local ou eventos app_exception que ocorreram em um sistema operacional específico.

Representação JSON
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
Campos
eventInclusionCriteria

object (EventSegmentCriteria)

Define quais eventos serão incluídos no segmento. Opcional.

exclusion

object (EventSegmentExclusion)

Define quais eventos são excluídos do segmento. Opcional.

EventSegmentCriteria

Um evento corresponde a um critério se atender às condições deles.

Representação JSON
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
Campos
andConditionGroups[]

object (EventSegmentConditionGroup)

Um evento corresponderá a esses critérios se corresponder a cada um desses andConditionGroups.

EventSegmentConditionGroup

As condições informam ao Google Analytics quais dados incluir ou excluir do segmento.

Representação JSON
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
Campos
conditionScoping

enum (EventCriteriaScoping)

conditionScoping precisa ser sempre EVENT_CRITERIA_WITHIN_SAME_EVENT.

Opcional. Se não for especificado, um conditionScoping de EVENT_CRITERIA_WITHIN_SAME_EVENT será usado.

segmentFilterExpression

object (SegmentFilterExpression)

Os dados são incluídos ou excluídos do segmento com base na correspondência com essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros.

EventCriteriaScoping

O escopo especifica quais eventos são considerados ao avaliar se um evento atende a um critério.

Enums
EVENT_CRITERIA_SCOPING_UNSPECIFIED Escopo de critérios não especificado. Não especifique.
EVENT_CRITERIA_WITHIN_SAME_EVENT Se os critérios forem atendidos em um evento, ele vai corresponder aos critérios.

EventSegmentExclusion

Especifica quais eventos são excluídos do segmento.

Representação JSON
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
Campos
eventExclusionDuration

enum (EventExclusionDuration)

eventExclusionDuration precisa ser sempre PERMANENTLY_EXCLUDE.

Opcional. Se não for especificado, um eventExclusionDuration de EVENT_EXCLUSION_PERMANENT será usado.

eventExclusionCriteria

object (EventSegmentCriteria)

Se um evento atender a essa condição, ele será excluído da associação no segmento da eventExclusionDuration.

EventExclusionDuration

Enumera as opções sobre a duração de uma exclusão se um evento corresponder a eventExclusionCriteria.

Enums
EVENT_EXCLUSION_DURATION_UNSPECIFIED Duração da exclusão não especificada. Não especifique.
EVENT_EXCLUSION_PERMANENT Exclua eventos permanentemente do segmento se eles já cumprirem a condição eventExclusionCriteria.

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)

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

orGroup

object (FilterExpressionList)

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

notExpression

object (FilterExpression)

FilterExpression NÃO é de notExpression.

filter

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.

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.

Filtrar

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 na lista.

numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data.

betweenFilter

object (BetweenFilter)

Um filtro para entre dois valores.

FunnelSubReport

Os subrelatórios do funil contêm os valores dos dados de dimensão e métrica. Por exemplo, 12 usuários chegaram à segunda etapa do funil.

Representação JSON
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
Campos
dimensionHeaders[]

object (DimensionHeader)

Descreve as colunas de dimensão. Os relatórios de funil sempre incluem a dimensão de etapa do funil nas respostas do subrelatório. Outras dimensões, como detalhamentos, datas e próximas ações, podem estar presentes na resposta, se solicitado.

metricHeaders[]

object (MetricHeader)

Descreve as colunas de métricas. Os relatórios de funil sempre incluem usuários ativos nas respostas do subrelatório. A tabela do funil inclui outras métricas, como taxas de conclusão, de abandonos e de abandonos.

rows[]

object (Row)

Linhas de combinações de valores de dimensão e valores de métricas no relatório.

metadata

object (FunnelResponseMetadata)

Metadados do Relatório de funil.

DimensionHeader

Descreve uma coluna de dimensão no relatório. As dimensões solicitadas em um relatório produzem entradas de coluna nas linhas e DimensionHeaders. No entanto, as dimensões usadas exclusivamente em filtros ou expressões não produzem colunas em um relatório; portanto, essas dimensões não produzem cabeçalhos.

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

string

O nome da dimensão.

MetricHeader

Descreve uma coluna de métrica no relatório. As métricas visíveis solicitadas em um relatório produzem entradas de coluna nas linhas e MetricHeaders. No entanto, as métricas usadas exclusivamente em filtros ou expressões não produzem colunas em um relatório, ou seja, elas não produzem cabeçalhos.

Representação JSON
{
  "name": string,
  "type": enum (MetricType)
}
Campos
name

string

O nome da métrica.

type

enum (MetricType)

O tipo de dados da métrica.

MetricType

Tipo de valor de uma métrica.

Enums
METRIC_TYPE_UNSPECIFIED Tipo não especificado.
TYPE_INTEGER Tipo de número inteiro.
TYPE_FLOAT Tipo de ponto flutuante.
TYPE_SECONDS Uma duração de segundos. Um tipo especial de ponto flutuante.
TYPE_MILLISECONDS Uma duração em milissegundos. Um tipo especial de ponto flutuante.
TYPE_MINUTES Uma duração em minutos. Um tipo especial de ponto flutuante.
TYPE_HOURS Uma duração em horas. Um tipo especial de ponto flutuante.
TYPE_STANDARD Uma métrica personalizada do tipo padrão. Um tipo especial de ponto flutuante.
TYPE_CURRENCY Uma quantia em dinheiro, um tipo especial de ponto flutuante.
TYPE_FEET Um comprimento em pés; um tipo especial de ponto flutuante.
TYPE_MILES Um comprimento em milhas; um tipo especial de ponto flutuante.
TYPE_METERS Um comprimento em metros; um tipo especial de ponto flutuante.
TYPE_KILOMETERS Um comprimento em quilômetros. Um tipo especial de ponto flutuante.

Linha

Dados do relatório para cada linha. Por exemplo, se RunReportRequest contiver:

"dimensions": [
  {
    "name": "eventName"
  },
  {
    "name": "countryId"
  }
],
"metrics": [
  {
    "name": "eventCount"
  }
]

Uma linha com "in_app_purchase" como eventName, "JP" como o countryId e 15 como o eventCount, seria:

"dimensionValues": [
  {
    "value": "in_app_purchase"
  },
  {
    "value": "JP"
  }
],
"metricValues": [
  {
    "value": "15"
  }
]
Representação JSON
{
  "dimensionValues": [
    {
      object (DimensionValue)
    }
  ],
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
Campos
dimensionValues[]

object (DimensionValue)

Lista de valores de dimensão solicitados. Em um pivotReport, dimensionValues só é listado para dimensões incluídas em uma tabela dinâmica.

metricValues[]

object (MetricValue)

Lista de valores de métricas visíveis solicitados.

DimensionValue

O valor de uma dimensão.

Representação JSON
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Campos
Campo de união one_value. Um tipo de valor de dimensão one_value pode ser apenas de um dos seguintes tipos:
value

string

Valor como uma string se o tipo de dimensão for uma string.

MetricValue

O valor de uma métrica.

Representação JSON
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Campos
Campo de união one_value. Um dos valores de métrica one_value pode ser apenas um dos seguintes:
value

string

Valor de medição. Consulte MetricHeader para ver o tipo.

FunnelResponseMetadata

Os metadados de resposta do Relatório de funil contêm mais informações sobre ele.

Representação JSON
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
Campos
samplingMetadatas[]

object (SamplingMetadata)

Se os resultados do Relatório de funil forem de amostra, essa informação descreve a porcentagem de eventos que foi usada no Relatório de funil. Um samplingMetadatas é preenchido para cada período. Cada samplingMetadatas corresponde a um período na ordem em que os períodos foram especificados na solicitação.

No entanto, se os resultados não forem de amostra, esse campo não será definido.

SamplingMetadata

Se os resultados do Relatório de funil forem amostrados, esses metadados descreverão a porcentagem de eventos usados neste Relatório de funil para um período. A amostragem é a prática de analisar um subconjunto de todos os dados para descobrir as informações significativas no conjunto de dados maior.

Representação JSON
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
Campos
samplesReadCount

string (int64 format)

O número total de eventos lidos neste relatório de amostra para um período. Este é o tamanho do subconjunto de dados dessa propriedade que foram analisados neste Relatório de funil.

samplingSpaceSize

string (int64 format)

O número total de eventos presentes nos dados dessa propriedade que poderiam ter sido analisados neste Relatório de funil para um período. A amostragem revela informações significativas sobre o conjunto de dados maior, que se refere ao tamanho do conjunto de dados maior.

Para calcular a porcentagem de dados disponíveis que foram usados nesse Relatório de funil, calcule samplesReadCount/samplingSpaceSize.

PropertyQuota

Estado atual de todas as cotas desta propriedade do Google Analytics. Se alguma cota de uma propriedade se esgotar, todas as solicitações para essa propriedade retornarão erros de recursos esgotados.

Representação JSON
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  },
  "concurrentRequests": {
    object (QuotaStatus)
  },
  "serverErrorsPerProjectPerHour": {
    object (QuotaStatus)
  },
  "potentiallyThresholdedRequestsPerHour": {
    object (QuotaStatus)
  },
  "tokensPerProjectPerHour": {
    object (QuotaStatus)
  }
}
Campos
tokensPerDay

object (QuotaStatus)

As propriedades padrão do Google Analytics podem usar até 200.000 tokens por dia, e as propriedades do Analytics 360 podem usar 2.000.000 de tokens por dia. A maioria das solicitações consome menos de 10 tokens.

tokensPerHour

object (QuotaStatus)

As propriedades padrão do Google Analytics podem usar até 40.000 tokens por hora, enquanto as propriedades do Analytics 360 podem usar 400.000 tokens por hora. Uma solicitação de API consome um único número de tokens, que é deduzido de todas as cotas por hora, diárias e por hora do projeto.

concurrentRequests

object (QuotaStatus)

As propriedades padrão do Google Analytics podem enviar até 10 solicitações simultâneas, e as propriedades do Google Analytics 360 podem usar até 50 solicitações simultâneas.

serverErrorsPerProjectPerHour

object (QuotaStatus)

As propriedades padrão do Google Analytics e os pares de projetos do Google Cloud podem ter até 10 erros de servidor por hora. Já as propriedades do Google Analytics 360 e os pares de projetos do Google Cloud podem ter até 50 erros de servidor por hora.

potentiallyThresholdedRequestsPerHour

object (QuotaStatus)

As propriedades do Google Analytics podem enviar até 120 solicitações com dimensões potencialmente limitadas por hora. Em uma solicitação em lote, cada solicitação de relatório será contabilizada individualmente para essa cota se a solicitação tiver dimensões potencialmente limitadas.

tokensPerProjectPerHour

object (QuotaStatus)

As propriedades do Analytics podem usar até 35% dos tokens por projeto e por hora. Assim, as propriedades padrão do Google Analytics podem usar até 14.000 tokens por projeto a cada hora, enquanto as propriedades do Analytics 360 podem usar 140.000 tokens por projeto por hora. Uma solicitação de API consome um único número de tokens, que é deduzido de todas as cotas por hora, diárias e por hora do projeto.

QuotaStatus

Estado atual de um determinado grupo de cotas.

Representação JSON
{
  "consumed": integer,
  "remaining": integer
}
Campos
consumed

integer

Cota consumida por esta solicitação.

remaining

integer

Cota restante após essa solicitação.