Method: properties.runFunnelReport

Retorna um relatório de funil personalizado dos dados de eventos do Google Analytics. Os dados retornados da API são 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 sua opinião sobre essa API, preencha o Feedback de relatório do 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 Google Analytics cujos eventos são rastreados. Especificado no caminho do URL, não no corpo. Para saber mais, consulte onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade não deve ser especificada ou precisa ser 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 dos dados a serem lidos. Se vários períodos forem solicitados, cada linha de resposta vai conter um índice de período com base zero. Se dois períodos se sobrepuserem, os dados de eventos dos dias em comum serão incluídos nas linhas de resposta dos dois períodos.
funnel

object (Funnel)

Opcional. A configuração do funil desta solicitação. Essa configuração de funil é obrigatória.
funnelBreakdown

object (FunnelBreakdown)

Opcional. Se especificado, esse detalhamento adiciona uma dimensão à resposta do sub-relatório da tabela de funil. Essa dimensão de detalhamento expande cada etapa do funil para os valores únicos da dimensão de detalhamento. Por exemplo, um detalhamento pela dimensão deviceCategory cria 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 sub-relatório de visualização do funil. Essa dimensão de próxima ação expande cada etapa do funil para os valores únicos da próxima ação. Por exemplo, uma próxima ação da dimensão eventName vai criar linhas para vários eventos (por exemplo, session_start e click) e o total.

A próxima ação só é compatível com eventName e a 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 sub-relató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 nessa solicitação produz uma linha separada na resposta, e cada segmento é identificado pelo nome.

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

string (int64 format)

Opcional. O número de linhas que serão retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 250.000 linhas por solicitação, não importa quantas você peça. 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 apenas valores específicos de dimensão no relatório. Para saber mais, consulte Como criar um relatório: filtros de dimensão para ver exemplos. Não é possível usar métricas nesse filtro.
returnPropertyQuota

boolean

Opcional. Alterna se o estado atual da cota desta propriedade do Google Analytics será retornado. A cota é retornada em PropertyQuota.

Corpo da resposta

A resposta do relatório de funil contém dois sub-relatórios. Os dois sub-relató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 de funil é um relatório com a etapa do funil, o segmento, a dimensão de detalhamento, os usuários ativos, a taxa de conclusão, os abandonos e a taxa de abandono.

A dimensão de segmento só está presente nessa resposta se um segmento foi solicitado. A dimensão de detalhamento só aparece nesta resposta se foi solicitada.
funnelVisualization

object (FunnelSubReport)

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

A dimensão de segmento só está presente nessa resposta se um segmento foi solicitado. A dimensão de data só aparece nessa resposta se foi solicitada pelo tipo de funil TRENDED_FUNNEL. A dimensão "Próxima ação" só aparece na resposta se foi solicitada.
propertyQuota

object (PropertyQuota)

O estado da cota da propriedade do Google Analytics, incluindo esta solicitação.
kind

string

Identifica o tipo de recurso da mensagem. Esse 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 do OAuth:

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

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

Em um funil aberto, os usuários podem entrar em qualquer etapa. Em um funil fechado, eles precisam entrar na primeira etapa. Opcional. Se não for especificado, um funil fechado será usado.
steps[]

object (FunnelStep)

As etapas sequenciais do 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 por um nome indexado com base 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 gerar 3. Purchase na resposta do relatório de funil.
isDirectlyFollowedBy

boolean

Se for verdadeiro, essa etapa precisa seguir diretamente a anterior. Se for "false", pode haver eventos entre a etapa anterior e esta. Se não for especificado, isDirectlyFollowedBy será tratado como "false".
filterExpression

object (FunnelFilterExpression)

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

string (Duration format)

Se especificado, essa etapa precisa ser concluída dentro desse período após a conclusão da etapa anterior. withinDurationFromPriorStep inclui o endpoint na granularidade de microssegundos. Por exemplo, uma duração de 5 segundos pode ser concluída em 4,9 ou 5,0 segundos, mas não em 5 segundos e 1 microssegundo.

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

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)

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

object (FunnelFilterExpression)

O FunnelFilterExpression NÃO é de notExpression.
funnelFieldFilter

object (FunnelFieldFilter)

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

object (FunnelEventFilter)

Cria um filtro que corresponde a 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 vai corresponder a esse 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 valores entre dois valores.

FunnelEventFilter

Cria um filtro que corresponde a 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 vai corresponder a esse filtro de evento.

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

string

Esse filtro corresponde a eventos com esse nome. O nome do evento é obrigatório.
funnelParameterFilterExpression

object (FunnelParameterFilterExpression)

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

Dentro da expressão de filtro de parâmetro, apenas 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 é de notExpression.
funnelParameterFilter

object (FunnelParameterFilter)

Um filtro de parâmetro de funil primitivo.

FunnelParameterFilterExpressionList

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

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

object (FunnelParameterFilterExpression)

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

FunnelParameterFilter

Uma expressão para filtrar valores de parâmetros 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

Esse 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, bem como em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, parâmetros de evento ou de item precisam ser usados.
itemParameterName

string

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

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

Os parâmetros de item estão disponíveis apenas em eventos de e-commerce. Para saber mais sobre os eventos de e-commerce, consulte o guia Medir o 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 valores entre dois valores.

FunnelBreakdown

Os detalhamentos adicionam uma dimensão à resposta do sub-relatório da tabela de funil.

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

object (Dimension)

A coluna de dimensão adicionada à resposta do sub-relatório da tabela de funil. A dimensão de detalhamento divide cada etapa do funil. Um breakdownDimension válido é necessário se funnelBreakdown for especificado.
limit

string (int64 format)

O número máximo de valores distintos da dimensão de detalhamento a serem retornados 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 15.

FunnelNextAction

As próximas ações informam o valor de uma dimensão depois que o usuário conclui uma etapa, mas antes de concluir a próxima. Por exemplo, se nextActionDimension for eventName, nextActionDimension na linha da iª etapa do funil vai retornar o primeiro evento depois daquele que qualificou o usuário para a iª etapa do funil, mas antes de ele alcançar a i+1ª etapa.

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

object (Dimension)

A coluna de dimensão adicionada à resposta do sub-relatório de visualização de funil. A dimensão "Próxima ação" retorna o próximo valor de dimensão depois que o usuário atinge a iª etapa do funil.

No momento, o nextActionDimension só é compatível com eventName e a 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 serem retornados 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 sub-relatório de visualização do funil.

Tipos enumerados
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Tipo não especificado.
STANDARD_FUNNEL Um funil padrão (em degraus). O sub-relatório de visualização do funil na resposta não vai conter a data.
TRENDED_FUNNEL Um funil de tendência (gráfico de linhas). O sub-relatório de visualização do funil na resposta vai conter 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 Criador de segmentos.

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. O prefixo da dimensão segment os nomes de segmento pelo número de índice de base 1 do segmento na solicitação (por exemplo, "1. Segment", "2. Segmento" 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ões 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 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, que fizeram compras 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 estão incluídos neste segmento. Opcional.
exclusion

object (UserSegmentExclusion)

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

UserSegmentCriteria

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

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

object (UserSegmentConditionGroup)

Um usuário atende a esse critério se corresponder a cada um dos andConditionGroups e a cada um dos andSequenceGroups. andConditionGroups pode estar vazio se andSequenceGroups for especificado.
andSequenceGroups[]

object (UserSegmentSequenceGroup)

Um usuário atende a esse critério se corresponder a cada um dos andSequenceGroups e a cada um dos andConditionGroups. andSequenceGroups pode estar 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 em quantos eventos o segmentFilterExpression é avaliado antes de o grupo de condições ser considerado correspondente ou não. Por exemplo, se conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION, a expressão será avaliada em todos os eventos de uma sessão. Depois, o grupo de condições será determinado como correspondente ou não para esse usuário. Por exemplo, se conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT, a expressão será avaliada em um único evento, e o grupo de condições será determinado como correspondente ou não para 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 indicam critérios em dimensões, 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.

Tipos enumerados
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 corresponder a eles.
USER_CRITERIA_WITHIN_SAME_SESSION Se os critérios forem atendidos em uma sessão, o usuário vai corresponder a eles.
USER_CRITERIA_ACROSS_ALL_SESSIONS Se os critérios forem atendidos por algum evento do usuário, ele vai 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)

O SegmentFilterExpression NÃO é de notExpression.
segmentFilter

object (SegmentFilter)

Um filtro de segmento primitivo.
segmentEventFilter

object (SegmentEventFilter)

Cria um filtro que corresponde a 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 vai corresponder a esse 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 valores 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 do pedido.

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 ao avaliar esse filtro.

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

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

SegmentEventFilter

Cria um filtro que corresponde a 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 vai corresponder a esse filtro de evento.

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

string

Esse filtro corresponde a eventos com esse nome. O nome do evento é obrigatório.
segmentParameterFilterExpression

object (SegmentParameterFilterExpression)

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

Dentro da expressão de filtro de parâmetro, apenas 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âmetros 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âmetros 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

Esse 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, bem como em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, parâmetros de evento ou de item precisam ser usados.
itemParameterName

string

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

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

Os parâmetros de item estão disponíveis apenas em eventos de e-commerce. Para saber mais sobre os eventos de e-commerce, consulte o guia Medir o 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 valores entre dois valores.

SegmentParameterFilterScoping

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

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

string (int64 format)

Acumula o parâmetro no período especificado de dias antes de aplicar o filtro. Só é compatível se o escopo de critérios for ACROSS_ALL_SESSIONS ou WITHIN_SAME_SESSION. Só é compatível se o parâmetro for event_count.

Por exemplo, se inAnyNDayPeriod for 3, o eventName for "purchase", o parâmetro de evento for "event_count" e o critério do filtro for maior que 5, esse filtro vai acumular a contagem de eventos de compra em todos os períodos de três dias consecutivos no período do relatório. Um usuário vai atender aos critérios desse filtro para ser incluído no segmento se a contagem de eventos de compra exceder 5 em qualquer período de três dias consecutivos. Por exemplo, os períodos de 01/11/2021 a 03/11/2021, 02/11/2021 a 04/11/2021, 03/11/2021 a 05/11/2021 e assim por diante serão considerados.

O período não é estendido para ter 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á encurtado porque nenhum dado de evento fora do período do relatório será lido. Por exemplo, os quatro primeiros períodos seriam: 2021-11-01 a 2021-11-01, 2021-11-01 a 2021-11-02, 2021-11-01 a 2021-11-03 e 2021-11-02 a 2021-11-04.

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

UserSegmentSequenceGroup

Defina condições que precisam ocorrer em uma ordem específica para que o usuário seja 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 corresponda à sequência. Por exemplo, se sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, todas as etapas da sequência precisam ser concluídas em uma sessão para que o usuário corresponda à 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 em 4,9 ou 5,0 segundos, mas não em 5 segundos e 1 microssegundo.

sequenceMaximumDuration é opcional e, se não for especificado, as sequências poderão ser concluídas em qualquer período.

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 ele corresponda ao UserSegmentSequenceGroup.

UserSequenceStep

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

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

boolean

Se for verdadeiro, o evento que satisfaz esta etapa precisa ser o próximo evento após o evento que satisfaz a última etapa. Se for "false", essa etapa segue indiretamente a anterior. Por exemplo, pode haver eventos entre a etapa anterior e esta. isDirectlyFollowedBy precisa ser "false" na primeira etapa.
stepScoping

enum (UserCriteriaScoping)

Essa etapa precisa ser atendida no escopo para que o usuário corresponda à sequência. Por exemplo, se sequenceScoping = WITHIN_SAME_SESSION, essas etapas precisam ser concluídas em uma sessão para que o usuário corresponda à sequência. stepScoping = ACROSS_ALL_SESSIONS só é permitido se o sequenceScoping = ACROSS_ALL_SESSIONS.

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

object (SegmentFilterExpression)

Um usuário corresponde a esta etapa de sequência se os eventos dele corresponderem a essa expressão. As expressões indicam critérios em dimensões, métricas e/ou parâmetros.

UserSegmentExclusion

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

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

enum (UserExclusionDuration)

Especifica a duração de uma exclusão se um usuário corresponder ao 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 por userExclusionDuration.

UserExclusionDuration

Enumera as opções de duração de uma exclusão se um usuário corresponder ao userExclusionCriteria.

Tipos enumerados
USER_EXCLUSION_DURATION_UNSPECIFIED Duração da exclusão não especificada. Não especifique.
USER_EXCLUSION_TEMPORARY Excluir temporariamente usuários do segmento durante os períodos em que eles atendem à condição userExclusionCriteria.
USER_EXCLUSION_PERMANENT Excluir permanentemente usuários do segmento se eles atenderem à 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 estão incluídas neste segmento. Opcional.
exclusion

object (SessionSegmentExclusion)

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

SessionSegmentCriteria

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

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

object (SessionSegmentConditionGroup)

Uma sessão atende a esse critério 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 em quantos eventos o segmentFilterExpression é avaliado antes de o grupo de condições ser considerado correspondente ou não. Por exemplo, se conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION, a expressão será avaliada em todos os eventos de uma sessão. Depois, o grupo de condições será determinado como correspondente ou não a essa sessão. Por exemplo, se conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT, a expressão será avaliada em um único evento, e o grupo de condições será determinado como correspondente ou não para 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 indicam critérios em dimensões, 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.

Tipos enumerados
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 a eles.
SESSION_CRITERIA_WITHIN_SAME_SESSION Se os critérios forem atendidos em uma sessão, ela vai corresponder a eles.

SessionSegmentExclusion

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

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

enum (SessionExclusionDuration)

Especifica por quanto tempo uma exclusão vai durar se uma sessão corresponder ao 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 ao segmento do sessionExclusionDuration.

SessionExclusionDuration

Enumera as opções de duração de uma exclusão se uma sessão corresponder ao sessionExclusionCriteria.

Tipos enumerados
SESSION_EXCLUSION_DURATION_UNSPECIFIED Duração da exclusão não especificada. Não especifique.
SESSION_EXCLUSION_TEMPORARY Excluir temporariamente as sessões do segmento durante os períodos em que elas atendem à condição sessionExclusionCriteria.
SESSION_EXCLUSION_PERMANENT Excluir permanentemente as sessões do segmento se elas atenderem à condição sessionExclusionCriteria.

EventSegment

Os segmentos de eventos são subconjuntos de eventos acionados no seu site ou app, por exemplo, todos os eventos de compra registrados 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 estão incluídos neste segmento. Opcional.
exclusion

object (EventSegmentExclusion)

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

EventSegmentCriteria

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

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

object (EventSegmentConditionGroup)

Um evento corresponde a esse critério 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 indicam critérios em dimensões, 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.

Tipos enumerados
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 neste 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 participação no segmento para o eventExclusionDuration.

EventExclusionDuration

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

Tipos enumerados
EVENT_EXCLUSION_DURATION_UNSPECIFIED Duração da exclusão não especificada. Não especifique.
EVENT_EXCLUSION_PERMANENT Excluir permanentemente eventos do segmento se eles atenderem à condição eventExclusionCriteria.

FunnelSubReport

Os sub-relatórios do funil contêm os valores de 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 "Etapa do funil" nas respostas dos sub-relatórios. Outras dimensões, como detalhamentos, datas e próximas ações, podem estar presentes na resposta, se solicitadas.
metricHeaders[]

object (MetricHeader)

Descreve as colunas de métricas. Os relatórios de funil sempre incluem usuários ativos nas respostas dos sub-relatórios. A tabela de funil inclui outras métricas, como taxa de conclusão, desistências e taxa de desistência.
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.

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 amostrados, isso descreve qual porcentagem de eventos foi usada nesse relatório. Um samplingMetadatas é preenchido para cada período. Cada samplingMetadatas corresponde a um período na ordem em que foram especificados na solicitação.

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