Method: properties.runFunnelReport

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

Com a exploração 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 Explorações de funis 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 fazer comentários sobre essa API, preencha o feedback de relatórios de funil da API de dados 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

Um identificador de propriedade do GA4 do Google Analytics cujos eventos são rastreados. Especificada no caminho do URL e não no corpo. Para saber mais, veja onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade não deve ser especificada nem 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)

Períodos de dados para leitura. Se vários períodos forem solicitados, cada linha de resposta conterá um índice de período com base em zero. Se dois períodos forem sobrepostos, os dados de eventos dos dias sobrepostos serão incluídos nas linhas das respostas dos dois períodos.

funnel

object (Funnel)

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

funnelBreakdown

object (FunnelBreakdown)

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

funnelNextAction

object (FunnelNextAction)

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

A próxima ação é compatível somente com eventName e com a maioria das dimensões de página / tela, como pageTitle e pagePath.

funnelVisualizationType

enum (FunnelVisualizationType)

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

segments[]

object (Segment)

As configurações de 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. Na resposta, cada segmento identificado por seu nome.

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

limit

string (int64 format)

O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna um máximo de 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)

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

returnPropertyQuota

boolean

Define se deve retornar o estado atual da cota desta propriedade do Google Analytics. A cota é retornada em PropertyQuota.

Corpo da resposta

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

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

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 a etapa do funil, o segmento, a dimensão detalhada, usuários ativos, taxa de conclusão, abandonos e taxa de abandonos.

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 for 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 do segmento só estará presente nessa resposta se um segmento tiver sido solicitado. A dimensão de data só estará presente nessa resposta se for solicitada por meio do tipo de funil TRENDED_FUNNEL. A próxima dimensão de ação só estará presente na resposta se ela tiver sido solicitada.

propertyQuota

object (PropertyQuota)

O estado de cota dessa propriedade do Google Analytics, incluindo essa solicitação.

kind

string

Identifica o tipo de recurso desta mensagem. Este kind é sempre a string fixa "analyticsData#runFunnelReport". Útil para distinguir entre os 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

Período

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 da consulta no formato YYYY-MM-DD. Não pode ser posterior a endDate. O formato NdaysAgo, yesterday ou today também é aceito e, nesse caso, a data é inferida com base no fuso horário do relatório da propriedade.

endDate

string

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

name

string

Atribui um nome a esse período. A dimensão dateRange é avaliada de acordo 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 pelo í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 informa os usuários à medida que eles passam por uma sequência de etapas.

Com a exploração 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 no funil em qualquer etapa e, em um funil fechado, os usuários devem entrar no funil na primeira etapa. Opcional. Se não for especificado, um funil fechado será usado.

steps[]

object (FunnelStep)

As etapas sequenciais deste funil.

Etapa de funil

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 característico 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 retornada pela dimensão funnelStepName. Por exemplo, especificar name = Purchase na etapa do terceiro funil da solicitação produzirá 3. Purchase na resposta do relatório de funil.

isDirectlyFollowedBy

boolean

Se for verdadeiro, esta etapa deve seguir diretamente a etapa anterior. Se for falso, pode haver eventos entre a etapa anterior e esta. Se não for especificado, isDirectlyFollowedBy será tratado como falso.

filterExpression

object (FunnelFilterExpression)

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

withinDurationFromPriorStep

string (Duration format)

Se especificado, essa etapa precisa ser concluída dentro do período da 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 a 4,9 ou 5,0 segundos, mas não 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 com "s". Exemplo: "3.5s".

Expressão de filtro de funil

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)

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

orGroup

object (FunnelFilterExpressionList)

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

notExpression

object (FunnelFilterExpression)

A 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, somente o subconjunto de eventos que correspondem ao nome do evento e às expressões de filtro de parâmetro corresponderem a esse filtro de evento.

FunilFilterExpressionList

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.

FunilFilter

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.

StringFiltro

O filtro da string

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

enum (MatchType)

O tipo de correspondência desse filtro.

value

string

O valor da string usada 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 completa para a expressão regular com o valor da string.
PARTIAL_REGEXP Correspondência parcial para a expressão regular com o valor da string.

FiltroInList

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 ficar em branco.

caseSensitive

boolean

Se verdadeiro, o valor da string diferencia maiúsculas de minúsculas.

Filtro numérico

Filtros para 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

Para representar um número.

Representação JSON
{

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

string (int64 format)

Número inteiro

doubleValue

number

Valor duplo

Entre um filtro

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.

Filtro de eventos do funil

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

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

string

Este filtro corresponde a eventos desse nome de evento. O nome do evento é obrigatório.

funnelParameterFilterExpression

object (FunnelParameterFilterExpression)

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

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

Expressão de parâmetro de funil

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.

FunilFilterFilterExpressionList

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 do filtro do parâmetro do funil.

FilterParameterFilter

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

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 e 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

Esse filtro será avaliado no parâmetro de item especificado. Os parâmetros de 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 e 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 de item só estão disponíveis em eventos de comércio eletrônico. 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 entre dois valores.

Detalhamento do funil

Os detalhamentos adicionam uma dimensão à resposta do subrelatório da tabela do funil.

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

object (Dimension)

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

limit

string (int64 format)

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 deve exceder 0 e não pode exceder 15.

Dimensão

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

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

string

O nome da dimensão. Consulte a seção Dimensões da API para ver a lista de nomes de dimensões.

Se dimensionExpression for especificado, name poderá ser qualquer string que você quiser no conjunto de caracteres permitido. Por exemplo, se uma dimensionExpression concatenar country e city, você pode chamar essa dimensão countryAndCity. Os nomes das dimensões que você escolher 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 "país, cidade": concatenate(país, ", ", cidade).

DimensionExpression

Usado para expressar uma dimensão que é o resultado de uma fórmula de várias dimensões. Exemplos de uso: 1) bottomCase(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 em uma única dimensão. Por exemplo, dimensão "país, cidade": concatenate(país, ", ", cidade).

Expressão de caso

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

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

string

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

Expressão de concatenação

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

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

string

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

delimiter

string

O delimitador colocado entre os nomes de dimensão.

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

FunilNextAction

As ações seguintes indicam o valor de uma dimensão depois que o usuário concluiu uma etapa, mas antes de o mesmo usuário concluir a próxima etapa. Por exemplo, se nextActionDimension for eventName, nextActionDimension na linha da etapa i do funil retornará o primeiro evento após o evento que qualificou o usuário para a ietapa do funil, mas antes de o usuário concluir 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 próxima dimensão de ação retorna o próximo valor de dimensão depois que o usuário tiver concluído a ia etapa do funil.

No momento, o nextActionDimension é compatível apenas com eventName e com 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)

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 deve exceder 0 e não pode exceder 5.

Tipo de visualização do funil

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

Enums
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED Tipo não especificado.
STANDARD_FUNNEL Um funil padrão (em degraus). O subrelatório de visualização do funil na resposta não conterá a data.
TRENDED_FUNNEL Um funil de tendência (gráfico de linhas). O subrelatório de visualização do funil na resposta 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 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 terão o nome "Segmento". Esse nome define o valor da string retornada pela dimensão segment. A dimensão segment prefixa nomes de segmentos pelo número de índice baseado em 1 do segmento na solicitação (por exemplo, "1. Segmento", "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ã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.

Segmento do usuário

Os segmentos de usuários são subconjuntos de usuários que interagiram com seu site ou app, por exemplo, usuários que compraram anteriormente ou que adicionaram itens ao carrinho, mas não concluíram a compra.

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

object (UserSegmentCriteria)

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

exclusion

object (UserSegmentExclusion)

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

Critérios do segmento do usuário

Um usuário corresponderá a um critério se os eventos do usuário atenderem às condições nos critérios.

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

object (UserSegmentConditionGroup)

Um usuário corresponderá a esse critério se ele corresponder a cada um desses andConditionGroups e a cada andSequenceGroups. andConditionGroups pode estar vazio se andSequenceGroups forem especificados.

andSequenceGroups[]

object (UserSegmentSequenceGroup)

Um usuário corresponderá a esse critério se ele corresponder a cada um desses andSequenceGroups e a cada andConditionGroups. andSequenceGroups pode estar vazio se andConditionGroups forem especificados.

GrupodeCondi%deGruposdeUsuários

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 serã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 a segmentFilterExpression é avaliada antes que o grupo de condições seja considerado correspondente. Por exemplo, se conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION, a expressão será avaliada em todos os eventos em uma sessão e, em seguida, 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, em seguida, 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 expressam critérios sobre dimensão, métricas e/ou parâmetros.

Escopo do critério de usuário

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 não especificado. Não especifique.
USER_CRITERIA_WITHIN_SAME_EVENT Se os critérios forem atendidos em um evento, o usuário corresponderá aos critérios.
USER_CRITERIA_WITHIN_SAME_SESSION Se os critérios forem atendidos em uma sessão, o usuário corresponderá aos critérios.
USER_CRITERIA_ACROSS_ALL_SESSIONS Se os critérios forem atendidos por quaisquer eventos para o usuário, o usuário corresponderá aos critérios.

Expressão de filtro de segmento

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 a eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, somente o subconjunto de eventos que correspondem ao nome do evento e às expressões de filtro de parâmetro corresponderem a esse filtro de evento.

SegmentoFilterExpressionList

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.

Filtragem de segmentos do Segment

O escopo especifica como as dimensões e métricas de vários eventos devem ser consideradas na avaliação de 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 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 eventos no período do relatório serão considerados na avaliação desse filtro.

Só será possível especificar atAnyPointInTime se o escopo dos critérios for ACROSS_ALL_SESSIONS e não for possível fazer isso em sequências.

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

Filtro de eventos de segmento

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

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

string

Este filtro corresponde a eventos desse nome de evento. O nome do evento é obrigatório.

segmentParameterFilterExpression

object (SegmentParameterFilterExpression)

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

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

Expressão de filtro de segmento

Expressa combinações de filtro de segmento nos 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)

A 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 do filtro de parâmetros de segmento.

Filtro de parâmetros do segmento

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 e 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

Esse filtro será avaliado no parâmetro de item especificado. Os parâmetros de 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 e 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 de item só estão disponíveis em eventos de comércio eletrônico. 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 entre dois valores.

SegmentParameterFilterScoping

O escopo especifica 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 em um período especificado de dias antes de aplicar o filtro. Compatível apenas se o escopo dos 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 de 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á os critérios desse filtro para serem incluídos nesse segmento se a contagem de eventos de compra exceder 5 em um período de três dias consecutivos. Por exemplo, os períodos de 01/11/2021 a 03/11/2021, 02/11/2021, 03/11/2021 a 05/11/2021 e assim por diante serão considerados.

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

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

GrupodeSequênciasdeUsuários

Defina as condições que devem 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 precisarão ser concluídas em uma sessão para que o usuário corresponda à sequência. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT não é compatível.

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 poderão ser concluídas em qualquer período.

Uma duração em segundos com até nove dígitos fracionários, terminando com "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 ao UserSegmentSequenceGroup.

Etapa da sequência do usuário

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 atender a essa etapa precisará ser o próximo evento após o evento satisfazer a última etapa. Se for falso, esta etapa seguirá indiretamente a etapa anterior. Por exemplo, pode haver eventos entre ela e esta etapa. isDirectlyFollowedBy precisa ser falso para a primeira etapa.

stepScoping

enum (UserCriteriaScoping)

Essa etapa da sequência precisa ser atendida no escopo para que o usuário corresponda à sequência. Por exemplo, se sequenceScoping = WITHIN_SAME_SESSION, essas etapas da sequência precisarão ser concluídas em uma sessão para que o usuário corresponda à 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 corresponderá a essa etapa da sequência se os eventos corresponderem a essa expressão. As expressões expressam critérios sobre 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 uma exclusão durará 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 no segmento de userExclusionDuration.

Duração da exclusão do usuário

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

Enums
USER_EXCLUSION_DURATION_UNSPECIFIED Duração de exclusão não especificada. Não especifique.
USER_EXCLUSION_TEMPORARY Exclua usuários temporariamente do segmento durante os períodos em que o usuário atende à condição userExclusionCriteria.
USER_EXCLUSION_PERMANENT Excluir permanentemente do segmento se o usuário atender à condição userExclusionCriteria.

Segmento da sessão

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 neste segmento. Opcional.

exclusion

object (SessionSegmentExclusion)

Define quais sessões serão excluídas do segmento. Opcional.

SessionSegmentCriteria

Uma sessão corresponderá a um critério se os eventos dela atenderem às condições dos critérios.

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

object (SessionSegmentConditionGroup)

Uma sessão corresponderá a esse critério se a sessão 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 serã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 a segmentFilterExpression é avaliada antes que o grupo de condições seja considerado correspondente. Por exemplo, se conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION, a expressão será avaliada em todos os eventos em uma sessão e, em seguida, o grupo de condições será determinado como correspondente ou não para essa sessão. Por exemplo, se conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT, a expressão será avaliada em um único evento e, em seguida, 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 expressam critérios sobre dimensão, métricas e/ou parâmetros.

Escopo de critérios da sessão

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 não especificado. Não especifique.
SESSION_CRITERIA_WITHIN_SAME_EVENT Se os critérios forem atendidos em um evento, a sessão corresponderá aos critérios.
SESSION_CRITERIA_WITHIN_SAME_SESSION Se os critérios forem atendidos em uma sessão, a sessão corresponderá aos critérios.

SessionSegmentExclusion

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

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

enum (SessionExclusionDuration)

Especifica quanto tempo uma exclusão durará se uma sessão corresponder à 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 de sessionExclusionDuration.

Duração da sessão

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

Enums
SESSION_EXCLUSION_DURATION_UNSPECIFIED Duração de exclusão não especificada. Não especifique.
SESSION_EXCLUSION_TEMPORARY Exclua sessões temporariamente do segmento durante os períodos em que a sessão atende à condição sessionExclusionCriteria.
SESSION_EXCLUSION_PERMANENT Excluir sessões permanentemente do segmento se elas atenderem à condição sessionExclusionCriteria.

Segmento do evento

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

exclusion

object (EventSegmentExclusion)

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

Critérios de segmento de evento

Um evento corresponderá a um critério se atender às condições nos critérios.

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

object (EventSegmentConditionGroup)

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

Grupo de eventos de segmento

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 sobre dimensão, métricas e/ou parâmetros.

Escopo do critério de evento

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

Enums
EVENT_CRITERIA_SCOPING_UNSPECIFIED Escopo não especificado. Não especifique.
EVENT_CRITERIA_WITHIN_SAME_EVENT Se os critérios forem atendidos em um evento, o evento 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 para a eventExclusionDuration.

Duração do evento

Enumera as opções de quanto tempo uma exclusão durará se um evento corresponder ao eventExclusionCriteria.

Enums
EVENT_EXCLUSION_DURATION_UNSPECIFIED Duração de exclusão não especificada. Não especifique.
EVENT_EXCLUSION_PERMANENT Excluir permanentemente os eventos do segmento se eles atenderem à 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 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)

O 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 métricas.

FilterExpressionList

Uma lista de expressões de filtro.

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

object (FilterExpression)

Uma lista de expressões de filtro.

Filtro

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

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

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Campos
fieldName

string

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

Campo de união one_filter. Especifique um tipo de filtro para Filter. one_filter pode ser apenas de um dos tipos a seguir:
stringFilter

object (StringFilter)

Filtro relacionado a strings.

inListFilter

object (InListFilter)

Um filtro para valores na lista.

numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data.

betweenFilter

object (BetweenFilter)

Um filtro para entre dois valores.

Relatório de funil

Os subrelatórios de funil contêm os valores de dados de métrica e dimensão. 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 colunas de dimensões. Os relatórios de funil sempre incluem a dimensão de etapa do funil em respostas de subrelatórios. Dimensões adicionais, como detalhamentos, datas e próximas ações, podem estar presentes na resposta, se solicitado.

metricHeaders[]

object (MetricHeader)

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

rows[]

object (Row)

Linhas de combinações de valores de dimensão e 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. Da mesma forma, 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 dentro de linhas e MetricHeaders. No entanto, as métricas usadas exclusivamente em filtros ou expressões não produzem colunas em um relatório. Da mesma forma, essas métricas 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

O 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 de ponto flutuante especial.
TYPE_MILLISECONDS Uma duração em milissegundos. Um tipo de ponto flutuante especial.
TYPE_MINUTES Uma duração em minutos, um tipo de ponto flutuante especial.
TYPE_HOURS Uma duração em horas, um tipo de ponto flutuante especial.
TYPE_STANDARD Uma métrica personalizada de tipo padrão; um tipo especial de ponto flutuante.
TYPE_CURRENCY Um valor em dinheiro. Um tipo de ponto flutuante especial.
TYPE_FEET Um comprimento em pés; um tipo de ponto flutuante especial.
TYPE_MILES Um comprimento em milhas; um tipo de ponto flutuante especial.
TYPE_METERS Um comprimento em metros. Um tipo de ponto flutuante especial.
TYPE_KILOMETERS Um comprimento em quilômetros. Um tipo de ponto flutuante especial.

Linha

Dados de relatórios 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 "countryId" e 15 como "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 relatório dinâmico, dimensionValues são listados apenas 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 um dos seguintes:
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 somente um dos seguintes:
value

string

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

FunnelResponseMetadata

Os metadados de resposta do relatório de funil contêm informações adicionais sobre o relatório de funil.

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

object (SamplingMetadata)

Se os resultados do relatório de funil são de amostra, isso descreve a porcentagem de eventos que foi usada nesse relatório de funil. 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 de amostra, esse campo não será definido.

SamplingMetadata

Se os resultados do relatório de funil forem de amostra, esses metadados descreverão a porcentagem de eventos que foi usada nesse relatório de funil para um período. A amostragem é a prática de analisar um subconjunto de todos os dados para descobrir 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 no relatório de amostra de um período. Este é o tamanho do subconjunto de dados da propriedade que foi analisado 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 nesse relatório de funil para um período. A amostragem revela as informações significativas sobre o conjunto de dados maior, e este é o 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 a cota de uma propriedade for esgotada, 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 do Google Analytics padrão podem usar até 200.000 tokens por dia. As propriedades do Google 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 do Google Analytics padrão podem usar até 40.000 tokens por hora. As propriedades do Google Analytics 360 podem usar 400.000 tokens por hora. Uma solicitação de API consome um único número de tokens, e esse número é deduzido de todas as cotas por hora, diárias e por projeto.

concurrentRequests

object (QuotaStatus)

As propriedades do Google Analytics padrão podem enviar até 10 solicitações simultâneas. 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 na nuvem podem ter até 10 erros de servidor por hora. Já as propriedades do Google Analytics 360 e os pares de projetos da nuvem 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 possivelmente limitadas por hora. Em uma solicitação em lote, cada solicitação de relatório será contada individualmente para essa cota se a solicitação contiver dimensões possivelmente limitadas.

tokensPerProjectPerHour

object (QuotaStatus)

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

QuotaStatus

Estado atual de um grupo de cotas específico.

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

integer

Cota consumida por esta solicitação.

remaining

integer

Cota restante após esta solicitação.