- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Funil
- FunnelStep
- FunnelFilterExpression
- FunnelFilterExpressionList
- FunnelFieldFilter
- FunnelEventFilter
- FunnelParameterFilterExpression
- FunnelParameterFilterExpressionList
- FunnelParameterFilter
- FunnelBreakdown
- FunnelNextAction
- FunnelVisualizationType
- Segmento
- UserSegment
- UserSegmentCriteria
- UserSegmentConditionGroup
- UserCriteriaScoping
- SegmentFilterExpression
- SegmentFilterExpressionList
- SegmentFilter
- SegmentFilterScoping
- SegmentEventFilter
- SegmentParameterFilterExpression
- SegmentParameterFilterExpressionList
- SegmentParameterFilter
- SegmentParameterFilterScoping
- UserSegmentSequenceGroup
- UserSequenceStep
- UserSegmentExclusion
- UserExclusionDuration
- SessionSegment
- SessionSegmentCriteria
- SessionSegmentConditionGroup
- SessionCriteriaScoping
- SessionSegmentExclusion
- SessionExclusionDuration
- EventSegment
- EventSegmentCriteria
- EventSegmentConditionGroup
- EventCriteriaScoping
- EventSegmentExclusion
- EventExclusionDuration
- FunnelSubReport
- FunnelResponseMetadata
- SamplingMetadata
- PropertyQuota
- QuotaStatus
- Faça um teste
Retorna um Relatório de funil personalizado com dados de eventos do Google Analytics. Os dados retornados da API são como uma tabela com colunas para as dimensões e métricas solicitadas.
Com a análise de funil, você vê as etapas que os usuários realizam até concluir uma tarefa e em quais delas eles permanecem no funil. Por exemplo, como os compradores em potencial começam uma compra e a finalizam? Como compradores únicos se tornam recorrentes? Com essas informações, você pode melhorar as jornadas do cliente evitando interrupções ou abandonos. Para saber mais, consulte Análises detalhadas de funil do GA4.
Esse método é introduzido na estabilidade Alfa com a intenção de coletar feedback sobre a sintaxe e os recursos antes de chegar à versão Beta. Para enviar seu feedback sobre essa API, preencha o Feedback sobre o relatório de funil da API Data do Google Analytics.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
property |
Opcional. Um identificador de propriedade do GA4 do Google Analytics com eventos rastreados. Especificado no caminho do URL, e não no corpo. Para saber mais, confira onde encontrar o ID da propriedade. Em uma solicitação em lote, essa propriedade deve ser não especificada ou consistente com a propriedade no nível do lote. Exemplo: properties/1234 |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "dateRanges": [ { object ( |
Campos | |
---|---|
dateRanges[] |
Opcional. Períodos de dados a serem lidos. Se vários períodos forem solicitados, cada linha de resposta terá um índice de período baseado em zero. Se dois períodos se sobrepuserem, os dados de eventos dos dias sobrepostos serão incluídos nas linhas de resposta dos dois períodos. |
funnel |
Opcional. A configuração do funil dessa solicitação. Esta configuração de funil é obrigatória. |
funnelBreakdown |
Opcional. Se especificado, esse detalhamento adiciona uma dimensão à resposta do subrelatório da tabela de funis. Essa dimensão de detalhamento expande cada etapa do funil para os valores exclusivos dela. Por exemplo, um detalhamento pela dimensão |
funnelNextAction |
Opcional. Se especificado, a próxima ação adiciona uma dimensão à resposta do subrelatório de visualização do funil. Essa dimensão de ação seguinte expande cada etapa do funil para os valores exclusivos da próxima ação. Por exemplo, uma ação seguinte da dimensão A ação "Próxima" só oferece suporte a |
funnelVisualizationType |
Opcional. O tipo de visualização de funil controla as dimensões presentes na resposta do subrelatório de visualização de funil. Se não for especificado, |
segments[] |
Opcional. As configurações dos segmentos. Os segmentos são subconjuntos dos dados de uma propriedade. Em um Relatório de funil com segmentos, o funil é avaliado em cada segmento. Cada segmento especificado nesta solicitação produz uma linha separada na resposta; na resposta, cada segmento identificado pelo seu nome. O parâmetro "segmentos" é opcional. As solicitações são limitadas a quatro segmentos. |
limit |
Opcional. O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 250.000 linhas por solicitação, independentemente de quantas linhas você solicitar. A API também pode retornar menos linhas do que o |
dimensionFilter |
Opcional. Com os filtros de dimensão, é possível solicitar somente valores de dimensão específicos no relatório. Para saber mais, consulte o artigo Como criar um relatório: filtros de dimensão para ver exemplos. Não é possível usar métricas neste filtro. |
returnPropertyQuota |
Opcional. Define se é necessário retornar o estado atual da cota dessa propriedade do Google Analytics. A cota é retornada em PropertyQuota. |
Corpo da resposta
A resposta do Relatório de funil contém dois subrelatórios. Os dois subrelatórios são combinações diferentes de dimensões e métricas.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "funnelTable": { object ( |
Campos | |
---|---|
funnelTable |
A tabela do funil é um relatório com etapa, segmento, dimensão de detalhamento, usuários ativos, taxa de conclusão, abandonos e taxa de abandono. A dimensão do segmento só estará presente nessa resposta se um segmento tiver sido solicitado. A dimensão de detalhamento só estará presente nessa resposta se tiver sido solicitada. |
funnelVisualization |
A visualização do funil é um relatório com a etapa, o segmento, a data, a dimensão da próxima ação e os usuários ativos do funil. A dimensão do segmento só estará presente nessa resposta se um segmento tiver sido solicitado. A dimensão de data só estará presente nessa resposta se tiver sido solicitada pelo tipo de funil |
propertyQuota |
O estado da cota desta propriedade do Google Analytics, incluindo a solicitação. |
kind |
Identifica o tipo de recurso dessa mensagem. Este |
Escopos de autorização
Requer um dos seguintes escopos de 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 ( |
Campos | |
---|---|
isOpenFunnel |
No funil aberto, os usuários podem entrar em qualquer etapa. Já no funil fechado, os usuários precisam entrar na primeira etapa. Opcional. Se não for especificado, será usado um funil fechado. |
steps[] |
As etapas sequenciais desse funil. |
FunnelStep
As etapas definem a jornada do usuário que você quer mensurar. As etapas contêm uma ou mais condições que os usuários precisam atender para serem incluídos nessa etapa do funil.
Representação JSON |
---|
{
"name": string,
"isDirectlyFollowedBy": boolean,
"filterExpression": {
object ( |
Campos | |
---|---|
name |
O nome distinto desta etapa. Se não for especificado, as etapas serão nomeadas com um nome indexado baseado em 1 (por exemplo, "0. ", "1. " etc.). Esse nome define o valor da string retornado pela dimensão |
isDirectlyFollowedBy |
Se verdadeiro, esta etapa deverá vir diretamente após a etapa anterior. Se for falso, poderá haver eventos entre a etapa anterior e esta etapa. Se não for especificado, |
filterExpression |
A condição que os usuários precisam atender para serem incluídos nessa etapa da jornada do funil. |
withinDurationFromPriorStep |
Se especificado, esta etapa precisa ser concluída dentro do intervalo em que a etapa anterior foi concluída.
Uma duração em segundos com até nove dígitos fracionários, terminando em " |
FunnelFilterExpression
Expressa combinações de filtros de funil.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união expr . Especifique um tipo de filtro para FunnelFilterExpression . expr pode ser apenas de um dos tipos a seguir: |
|
andGroup |
O FunnelFilterExpression em |
orGroup |
O FunnelFilterExpression em |
notExpression |
FunnelFilterExpression NÃO é |
funnelFieldFilter |
Um filtro de funil para uma dimensão ou métrica. |
funnelEventFilter |
Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento. |
FunnelFilterExpressionList
Uma lista de expressões de filtro de funil.
Representação JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
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 |
Campos | |
---|---|
fieldName |
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 |
Filtro relacionado a strings. |
inListFilter |
Um filtro para valores na lista. |
numericFilter |
Um filtro para valores numéricos ou de data. |
betweenFilter |
Um filtro para entre dois valores. |
FunnelEventFilter
Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento.
Representação JSON |
---|
{
"eventName": string,
"funnelParameterFilterExpression": {
object ( |
Campos | |
---|---|
eventName |
Este filtro corresponde a eventos deste nome de evento único. O nome do evento é obrigatório. |
funnelParameterFilterExpression |
Se especificado, este filtro corresponde a eventos que correspondem ao nome do evento único e às expressões de filtro do parâmetro. Na expressão de filtro de parâmetro, somente filtros de parâmetro estão disponíveis. |
FunnelParameterFilterExpression
Expressa combinações de filtros de funil em parâmetros.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união expr . Especifique um tipo de filtro para FunnelParameterFilterExpression . expr pode ser apenas de um dos tipos a seguir: |
|
andGroup |
O FunnelParameterFilterExpression em |
orGroup |
O FunnelParameterFilterExpression em |
notExpression |
O FunnelParameterFilterExpression NÃO é |
funnelParameterFilter |
Um filtro de parâmetro de funil primitivo. |
FunnelParameterFilterExpressionList
Uma lista de expressões de filtro do parâmetro de funil.
Representação JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
A lista de expressões de filtro do parâmetro de funil. |
FunnelParameterFilter
Uma expressão para filtrar valores de parâmetro em um funil.
Representação JSON |
---|
{ // Union field |
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 |
Este filtro será avaliado no parâmetro de evento especificado. Os parâmetros de evento são registrados como parâmetros do evento. Os parâmetros de evento incluem campos como "firebase_screen" e "currency". Os parâmetros de evento só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados. |
itemParameterName |
Este filtro será avaliado no parâmetro de item especificado. Os parâmetros do item são registrados como parâmetros na matriz do item. Os parâmetros do item incluem campos como "item_name" e "item_category". Os parâmetros do item só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados. Os parâmetros do item estão disponíveis apenas em eventos de e-commerce. Se quiser saber mais sobre os eventos de e-commerce, consulte o guia Medir e-commerce. |
Campo de união one_filter . Especifique um tipo de filtro. one_filter pode ser apenas de um dos tipos a seguir: |
|
stringFilter |
Filtro relacionado a strings. |
inListFilter |
Um filtro para valores na lista. |
numericFilter |
Um filtro para valores numéricos ou de data. |
betweenFilter |
Um filtro para entre dois valores. |
FunnelBreakdown
Eles adicionam uma dimensão à resposta do subrelatório da tabela de funil.
Representação JSON |
---|
{
"breakdownDimension": {
object ( |
Campos | |
---|---|
breakdownDimension |
A coluna de dimensão foi adicionada à resposta do subrelatório da tabela de funil. A dimensão de detalhamento detalha cada etapa do funil. Um |
limit |
O número máximo de valores distintos da dimensão de detalhamento a ser retornada na resposta. Um |
FunnelNextAction
As próximas ações definem o valor de uma dimensão após o usuário concluir uma etapa, mas antes de o mesmo usuário concluir a próxima etapa. Por exemplo, se nextActionDimension
for eventName
, nextActionDimension
na linha da i
a etapa do funil vai retornar o primeiro evento depois do evento que qualificou o usuário para a i
a etapa do funil, mas antes de o usuário atingir a i+1
a etapa do funil.
Representação JSON |
---|
{
"nextActionDimension": {
object ( |
Campos | |
---|---|
nextActionDimension |
A coluna de dimensão adicionada à resposta do subrelatório de visualização do funil. A dimensão de ação seguinte retorna o valor seguinte dessa dimensão depois que o usuário atinge a No momento, o |
limit |
O número máximo de valores distintos da dimensão de detalhamento a ser retornada na resposta. Um |
FunnelVisualizationType
Controla as dimensões presentes na resposta do subrelatório de visualização de funil.
Enums | |
---|---|
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED |
Tipo não especificado. |
STANDARD_FUNNEL |
Um funil padrão (em degraus). O subrelatório de visualização de funil na resposta não terá data. |
TRENDED_FUNNEL |
Um funil com tendências (gráfico de linhas). O subrelatório de visualização de funil na resposta terá a dimensão de data. |
Segmento
Um segmento é um subconjunto de dados do Google Analytics. que, por exemplo, pode ser composto por usuários de um determinado país ou cidade ou que compram uma determinada linha de produtos, acessam uma parte específica do seu site ou acionam certos eventos no app.
Para saber mais, consulte o Criador de segmentos do GA4.
Representação JSON |
---|
{ "name": string, // Union field |
Campos | |
---|---|
name |
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 |
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 |
Os segmentos de usuários são subconjuntos de usuários que interagiram com seu site ou app. |
sessionSegment |
Os segmentos de sessão são subconjuntos das sessões que ocorreram no seu site ou app. |
eventSegment |
Os segmentos de eventos são subconjuntos de eventos que foram acionados no seu site ou app. |
UserSegment
Os segmentos de usuários são subconjuntos de pessoas que interagiram com seu site ou app. Por exemplo, usuários que já fizeram uma compra ou que adicionaram itens ao carrinho, mas não concluíram uma compra.
Representação JSON |
---|
{ "userInclusionCriteria": { object ( |
Campos | |
---|---|
userInclusionCriteria |
Define quais usuários são incluídos no segmento. Opcional. |
exclusion |
Define quais usuários são excluídos do segmento. Opcional. |
UserSegmentCriteria
Um usuário corresponde a um critério quando os eventos dele atendem às condições deles.
Representação JSON |
---|
{ "andConditionGroups": [ { object ( |
Campos | |
---|---|
andConditionGroups[] |
Um usuário atenderá a esses critérios se corresponder a cada um desses |
andSequenceGroups[] |
Um usuário atenderá a esses critérios se corresponder a cada um desses |
UserSegmentConditionGroup
As condições informam ao Google Analytics quais dados incluir ou excluir do segmento.
Representação JSON |
---|
{ "conditionScoping": enum ( |
Campos | |
---|---|
conditionScoping |
Os dados são incluídos ou excluídos do segmento com base na correspondência com o grupo de condições. Esse escopo define quantos eventos a Opcional. Se não for especificado, |
segmentFilterExpression |
Os dados são incluídos ou excluídos do segmento com base na correspondência com essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros. |
UserCriteriaScoping
O escopo especifica quais eventos são considerados ao avaliar se um usuário atende a um critério.
Enums | |
---|---|
USER_CRITERIA_SCOPING_UNSPECIFIED |
Escopo de critérios não especificado. Não especifique. |
USER_CRITERIA_WITHIN_SAME_EVENT |
Se os critérios forem atendidos em um evento, o usuário vai atender aos critérios. |
USER_CRITERIA_WITHIN_SAME_SESSION |
Se os critérios são atendidos em uma sessão, o usuário atende aos critérios. |
USER_CRITERIA_ACROSS_ALL_SESSIONS |
Se os critérios forem atendidos por qualquer evento para o usuário, o usuário corresponderá aos critérios. |
SegmentFilterExpression
Expressa combinações de filtros de segmento.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união expr . Especifique um tipo de filtro para SegmentFilterExpression . expr pode ser apenas de um dos tipos a seguir: |
|
andGroup |
O SegmentFilterExpression em |
orGroup |
O SegmentFilterExpression em |
notExpression |
A SegmentFilterExpression NÃO é de |
segmentFilter |
Um filtro de segmento primitivo. |
segmentEventFilter |
Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento. |
SegmentFilterExpressionList
Uma lista de expressões de filtro de segmento.
Representação JSON |
---|
{
"expressions": [
{
object ( |
Campos | |
---|---|
expressions[] |
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 ( |
Campos | |
---|---|
fieldName |
O nome da dimensão ou da métrica. |
filterScoping |
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 |
Filtro relacionado a strings. |
inListFilter |
Um filtro para valores na lista. |
numericFilter |
Um filtro para valores numéricos ou de data. |
betweenFilter |
Um filtro para entre dois valores. |
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 |
Se Esse parâmetro Esse Se o escopo dos critérios for |
SegmentEventFilter
Cria um filtro que corresponde aos eventos de um único nome de evento. Se uma expressão de filtro de parâmetro for especificada, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro corresponderão ao filtro de evento.
Representação JSON |
---|
{
"eventName": string,
"segmentParameterFilterExpression": {
object ( |
Campos | |
---|---|
eventName |
Este filtro corresponde a eventos deste nome de evento único. O nome do evento é obrigatório. |
segmentParameterFilterExpression |
Se especificado, este filtro corresponde a eventos que correspondem ao nome do evento único e às expressões de filtro do parâmetro. Na expressão de filtro de parâmetro, somente filtros de parâmetro estão disponíveis. |
SegmentParameterFilterExpression
Expressa combinações de filtro de segmento em parâmetros.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união expr . Especifique um tipo de filtro para SegmentParameterFilterExpression . expr pode ser apenas de um dos tipos a seguir: |
|
andGroup |
O SegmentParameterFilterExpression em |
orGroup |
O SegmentParameterFilterExpression em |
notExpression |
O SegmentParameterFilterExpression NÃO é de |
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 ( |
Campos | |
---|---|
expressions[] |
A lista de expressões de filtro de parâmetro de segmento. |
SegmentParameterFilter
Uma expressão para filtrar valores de parâmetro em um segmento.
Representação JSON |
---|
{ "filterScoping": { object ( |
Campos | |
---|---|
filterScoping |
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 |
Este filtro será avaliado no parâmetro de evento especificado. Os parâmetros de evento são registrados como parâmetros do evento. Os parâmetros de evento incluem campos como "firebase_screen" e "currency". Os parâmetros de evento só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados. |
itemParameterName |
Este filtro será avaliado no parâmetro de item especificado. Os parâmetros do item são registrados como parâmetros na matriz do item. Os parâmetros do item incluem campos como "item_name" e "item_category". Os parâmetros do item só podem ser usados em segmentos e funis e só podem ser usados em um filtro descendente de um EventFilter. Em um filtro descendente de um EventFilter, os parâmetros de evento ou item devem ser usados. Os parâmetros do item estão disponíveis apenas em eventos de e-commerce. Se quiser saber mais sobre os eventos de e-commerce, consulte o guia Medir e-commerce. |
Campo de união one_filter . Especifique um tipo de filtro. one_filter pode ser apenas de um dos tipos a seguir: |
|
stringFilter |
Filtro relacionado a strings. |
inListFilter |
Um filtro para valores na lista. |
numericFilter |
Um filtro para valores numéricos ou de data. |
betweenFilter |
Um filtro para entre dois valores. |
SegmentParameterFilterScoping
Os escopos especificam como vários eventos devem ser considerados ao avaliar um filtro de parâmetros de segmento.
Representação JSON |
---|
{ "inAnyNDayPeriod": string } |
Campos | |
---|---|
inAnyNDayPeriod |
Acumula o parâmetro durante o período especificado de dias antes da aplicação do filtro. Compatível apenas se o escopo de critérios for Por exemplo, se O período não é estendido para que haja uma janela completa de N dias perto do início do período. Por exemplo, se um relatório for de 01/11/2021 a 10/11/2021 e
|
UserSegmentSequenceGroup
Defina as condições que devem ocorrer em uma ordem específica para que o usuário seja um membro do segmento.
Representação JSON |
---|
{ "sequenceScoping": enum ( |
Campos | |
---|---|
sequenceScoping |
Todas as etapas da sequência precisam ser atendidas no escopo para que o usuário faça a correspondência com a sequência. Por exemplo, se for Opcional. Se não for especificado, |
sequenceMaximumDuration |
Define o período em que toda a sequência precisa ocorrer, por exemplo, 30 minutos.
Uma duração em segundos com até nove dígitos fracionários, terminando em " |
userSequenceSteps[] |
Uma sequência ordenada de etapas de condição. Os eventos de um usuário precisam concluir cada etapa para que o usuário corresponda a |
UserSequenceStep
Uma condição que precisa ocorrer na ordem de etapas especificada para que esse usuário corresponda à sequência.
Representação JSON |
---|
{ "isDirectlyFollowedBy": boolean, "stepScoping": enum ( |
Campos | |
---|---|
isDirectlyFollowedBy |
Se verdadeiro, o evento que atende a essa etapa precisa ser o próximo evento após o evento que atende à última etapa. Se for falso, esta etapa seguirá indiretamente a etapa anterior; por exemplo, pode haver eventos entre a etapa anterior e esta etapa. |
stepScoping |
Essa etapa da sequência precisa ser cumprida no escopo para que o usuário faça a correspondência com a sequência. Por exemplo, se for Opcional. Se não for especificado, |
segmentFilterExpression |
Um usuário faz a correspondência dessa etapa da sequência se os eventos correspondem a essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros. |
UserSegmentExclusion
Especifica quais usuários são excluídos do segmento.
Representação JSON |
---|
{ "userExclusionDuration": enum ( |
Campos | |
---|---|
userExclusionDuration |
Especifica quanto tempo durará uma exclusão se um usuário corresponder a Opcional. Se não for especificado, |
userExclusionCriteria |
Se um usuário atender a essa condição, ele será excluído da associação ao segmento do |
UserExclusionDuration
Enumera as opções de quanto tempo uma exclusão durará se um usuário corresponder a userExclusionCriteria
.
Enums | |
---|---|
USER_EXCLUSION_DURATION_UNSPECIFIED |
Duração da exclusão não especificada. Não especifique. |
USER_EXCLUSION_TEMPORARY |
Exclua temporariamente os usuários do segmento durante os períodos em que eles atendem à condição userExclusionCriteria . |
USER_EXCLUSION_PERMANENT |
Excluirá permanentemente os usuários do segmento se eles já cumprirem a condição userExclusionCriteria . |
SessionSegment
Os segmentos de sessões são subconjuntos das sessões que ocorreram no seu site ou app, por exemplo, todas as originadas de uma determinada campanha publicitária.
Representação JSON |
---|
{ "sessionInclusionCriteria": { object ( |
Campos | |
---|---|
sessionInclusionCriteria |
Define quais sessões são incluídas nesse segmento. Opcional. |
exclusion |
Define quais sessões são excluídas nesse segmento. Opcional. |
SessionSegmentCriteria
Uma sessão corresponde a um critério quando os eventos dela atendem às condições deles.
Representação JSON |
---|
{
"andConditionGroups": [
{
object ( |
Campos | |
---|---|
andConditionGroups[] |
Uma sessão vai corresponder a esses critérios se corresponder a cada um desses |
SessionSegmentConditionGroup
As condições informam ao Google Analytics quais dados incluir ou excluir do segmento.
Representação JSON |
---|
{ "conditionScoping": enum ( |
Campos | |
---|---|
conditionScoping |
Os dados são incluídos ou excluídos do segmento com base na correspondência com o grupo de condições. Esse escopo define quantos eventos a Opcional. Se não for especificado, um |
segmentFilterExpression |
Os dados são incluídos ou excluídos do segmento com base na correspondência com essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros. |
SessionCriteriaScoping
O escopo especifica quais eventos são considerados ao avaliar se uma sessão atende a um critério.
Enums | |
---|---|
SESSION_CRITERIA_SCOPING_UNSPECIFIED |
Escopo de critérios não especificado. Não especifique. |
SESSION_CRITERIA_WITHIN_SAME_EVENT |
Se os critérios forem atendidos em um evento, a sessão vai corresponder aos critérios. |
SESSION_CRITERIA_WITHIN_SAME_SESSION |
Se os critérios são atendidos em uma sessão, ela corresponde aos critérios. |
SessionSegmentExclusion
Especifica quais sessões são excluídas no segmento.
Representação JSON |
---|
{ "sessionExclusionDuration": enum ( |
Campos | |
---|---|
sessionExclusionDuration |
Especifica quanto tempo durará uma exclusão se uma sessão corresponder a Opcional. Se não for especificado, um |
sessionExclusionCriteria |
Se uma sessão atender a essa condição, ela será excluída da associação no segmento da |
SessionExclusionDuration
Enumera opções de quanto tempo uma exclusão durará se uma sessão corresponder a sessionExclusionCriteria
.
Enums | |
---|---|
SESSION_EXCLUSION_DURATION_UNSPECIFIED |
Duração da exclusão não especificada. Não especifique. |
SESSION_EXCLUSION_TEMPORARY |
Excluir temporariamente sessões do segmento durante os períodos em que ela atende à condição sessionExclusionCriteria . |
SESSION_EXCLUSION_PERMANENT |
Excluirá permanentemente as sessões do segmento se ela já atender à condição sessionExclusionCriteria . |
EventSegment
Os segmentos de eventos são subconjuntos de eventos que foram acionados no seu site ou app. Por exemplo, todos os eventos de compra feitos em um determinado local ou eventos app_exception que ocorreram em um sistema operacional específico.
Representação JSON |
---|
{ "eventInclusionCriteria": { object ( |
Campos | |
---|---|
eventInclusionCriteria |
Define quais eventos serão incluídos no segmento. Opcional. |
exclusion |
Define quais eventos são excluídos do segmento. Opcional. |
EventSegmentCriteria
Um evento corresponde a um critério se atender às condições deles.
Representação JSON |
---|
{
"andConditionGroups": [
{
object ( |
Campos | |
---|---|
andConditionGroups[] |
Um evento corresponderá a esses critérios se corresponder a cada um desses |
EventSegmentConditionGroup
As condições informam ao Google Analytics quais dados incluir ou excluir do segmento.
Representação JSON |
---|
{ "conditionScoping": enum ( |
Campos | |
---|---|
conditionScoping |
Opcional. Se não for especificado, um |
segmentFilterExpression |
Os dados são incluídos ou excluídos do segmento com base na correspondência com essa expressão. As expressões expressam critérios de dimensão, métricas e/ou parâmetros. |
EventCriteriaScoping
O escopo especifica quais eventos são considerados ao avaliar se um evento atende a um critério.
Enums | |
---|---|
EVENT_CRITERIA_SCOPING_UNSPECIFIED |
Escopo de critérios não especificado. Não especifique. |
EVENT_CRITERIA_WITHIN_SAME_EVENT |
Se os critérios forem atendidos em um evento, ele vai corresponder aos critérios. |
EventSegmentExclusion
Especifica quais eventos são excluídos do segmento.
Representação JSON |
---|
{ "eventExclusionDuration": enum ( |
Campos | |
---|---|
eventExclusionDuration |
Opcional. Se não for especificado, um |
eventExclusionCriteria |
Se um evento atender a essa condição, ele será excluído da associação no segmento da |
EventExclusionDuration
Enumera as opções sobre a duração de uma exclusão se um evento corresponder a eventExclusionCriteria
.
Enums | |
---|---|
EVENT_EXCLUSION_DURATION_UNSPECIFIED |
Duração da exclusão não especificada. Não especifique. |
EVENT_EXCLUSION_PERMANENT |
Exclua eventos permanentemente do segmento se eles já cumprirem a condição eventExclusionCriteria . |
FunnelSubReport
Os subrelatórios do funil contêm os valores dos dados de dimensão e métrica. Por exemplo, 12 usuários chegaram à segunda etapa do funil.
Representação JSON |
---|
{ "dimensionHeaders": [ { object ( |
Campos | |
---|---|
dimensionHeaders[] |
Descreve as colunas de dimensão. Os relatórios de funil sempre incluem a dimensão de etapa do funil nas respostas do subrelatório. Outras dimensões, como detalhamentos, datas e próximas ações, podem estar presentes na resposta, se solicitado. |
metricHeaders[] |
Descreve as colunas de métricas. Os relatórios de funil sempre incluem usuários ativos nas respostas do subrelatório. A tabela do funil inclui outras métricas, como taxas de conclusão, de abandonos e de abandonos. |
rows[] |
Linhas de combinações de valores de dimensão e valores de métricas no relatório. |
metadata |
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 ( |
Campos | |
---|---|
samplingMetadatas[] |
Se os resultados do Relatório de funil forem de amostra, essa informação descreve a porcentagem de eventos que foi usada no Relatório de funil. Um No entanto, se os resultados não forem de amostra, esse campo não será definido. |
SamplingMetadata
Se os resultados do Relatório de funil forem amostrados, esses metadados descreverão a porcentagem de eventos usados neste Relatório de funil para um período. A amostragem é a prática de analisar um subconjunto de todos os dados para descobrir as informações significativas no conjunto de dados maior.
Representação JSON |
---|
{ "samplesReadCount": string, "samplingSpaceSize": string } |
Campos | |
---|---|
samplesReadCount |
O número total de eventos lidos neste relatório de amostra para um período. Este é o tamanho do subconjunto de dados dessa propriedade que foram analisados neste Relatório de funil. |
samplingSpaceSize |
O número total de eventos presentes nos dados dessa propriedade que poderiam ter sido analisados neste Relatório de funil para um período. A amostragem revela informações significativas sobre o conjunto de dados maior, que se refere ao tamanho do conjunto de dados maior. Para calcular a porcentagem de dados disponíveis que foram usados nesse Relatório de funil, calcule |
PropertyQuota
Estado atual de todas as cotas desta propriedade do Google Analytics. Se alguma cota de uma propriedade se esgotar, todas as solicitações para essa propriedade retornarão erros de recursos esgotados.
Representação JSON |
---|
{ "tokensPerDay": { object ( |
Campos | |
---|---|
tokensPerDay |
As propriedades padrão do Google Analytics podem usar até 200.000 tokens por dia, e as propriedades do Analytics 360 podem usar 2.000.000 de tokens por dia. A maioria das solicitações consome menos de 10 tokens. |
tokensPerHour |
As propriedades padrão do Google Analytics podem usar até 40.000 tokens por hora, enquanto as propriedades do Analytics 360 podem usar 400.000 tokens por hora. Uma solicitação de API consome um único número de tokens, que é deduzido de todas as cotas por hora, diárias e por hora do projeto. |
concurrentRequests |
As propriedades padrão do Google Analytics podem enviar até 10 solicitações simultâneas, e as propriedades do Google Analytics 360 podem usar até 50 solicitações simultâneas. |
serverErrorsPerProjectPerHour |
As propriedades padrão do Google Analytics e os pares de projetos do Google Cloud podem ter até 10 erros de servidor por hora. Já as propriedades do Google Analytics 360 e os pares de projetos do Google Cloud podem ter até 50 erros de servidor por hora. |
potentiallyThresholdedRequestsPerHour |
As propriedades do Google Analytics podem enviar até 120 solicitações com dimensões potencialmente limitadas por hora. Em uma solicitação em lote, cada solicitação de relatório será contabilizada individualmente para essa cota se a solicitação tiver dimensões potencialmente limitadas. |
tokensPerProjectPerHour |
As propriedades do Analytics podem usar até 35% dos tokens por projeto e por hora. Assim, as propriedades padrão do Google Analytics podem usar até 14.000 tokens por projeto a cada hora, enquanto as propriedades do Analytics 360 podem usar 140.000 tokens por projeto por hora. Uma solicitação de API consome um único número de tokens, que é deduzido de todas as cotas por hora, diárias e por hora do projeto. |
QuotaStatus
Estado atual de um determinado grupo de cotas.
Representação JSON |
---|
{ "consumed": integer, "remaining": integer } |
Campos | |
---|---|
consumed |
Cota consumida por esta solicitação. |
remaining |
Cota restante após essa solicitação. |