- Recurso: público-alvo
- AudienceEventTrigger
- LogCondition
- AudienceExclusionDurationMode
- AudienceFilterClause
- AudienceSimpleFilter
- AudienceFilterScope
- AudienceFilterExpression
- AudienceFilterExpressionList
- AudienceDimensionOrMetricFilter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operação
- NumericValue (em inglês)
- BetweenFilter
- AudienceEventFilter
- AudienceSequenceFilter
- AudienceSequenceStep
- AudienceClauseType
- Métodos
Recurso: público-alvo
Uma mensagem de recurso que representa um público-alvo do GA4.
Representação JSON |
---|
{ "name": string, "displayName": string, "description": string, "membershipDurationDays": integer, "adsPersonalizationEnabled": boolean, "eventTrigger": { object ( |
Campos | |
---|---|
name |
Apenas saída. O nome do recurso deste recurso Audience. Formato: properties/{propertyId}/audiences/{audienceId} |
displayName |
Obrigatório. O nome de exibição do público-alvo. |
description |
Obrigatório. A descrição do público-alvo. |
membershipDurationDays |
Obrigatório. Imutável. O tempo que um usuário permanece em um público-alvo. Ele não pode ser definido como mais de 540 dias. |
adsPersonalizationEnabled |
Apenas saída. Ele é definido automaticamente pelo GA como falso se esse for um público-alvo NPA e for excluído da personalização de anúncios. |
eventTrigger |
Opcional. Especifica um evento a ser registrado quando um usuário se juntar ao público-alvo. Se não for definido, nenhum evento será registrado quando um usuário entrar no público-alvo. |
exclusionDurationMode |
Imutável. Especifica a duração de uma exclusão para os usuários que atendem ao filtro de exclusão. Ele é aplicado a todas as cláusulas de filtro EXCLUDE e é ignorado quando não há uma cláusula de filtro EXCLUDE no público-alvo. |
filterClauses[] |
Obrigatório. Imutável. Lista não ordenada. Cláusulas de filtro que definem o público-alvo. Todas as cláusulas são unidas por AND. |
AudienceEventTrigger
Especifica um evento a ser registrado quando um usuário se juntar ao público-alvo.
Representação JSON |
---|
{
"eventName": string,
"logCondition": enum ( |
Campos | |
---|---|
eventName |
Obrigatório. O nome do evento que será registrado. |
logCondition |
Obrigatório. Quando registrar o evento. |
LogCondition
Determina quando registrar o evento.
Enums | |
---|---|
LOG_CONDITION_UNSPECIFIED |
A condição do registro não foi especificada. |
AUDIENCE_JOINED |
O evento deve ser registrado somente quando um usuário entrar. |
AUDIENCE_MEMBERSHIP_RENEWED |
O evento precisa ser registrado sempre que a condição de público-alvo for atendida, mesmo que o usuário já seja um membro desse público. |
AudienceExclusionDurationMode
Especifica a duração de uma exclusão para os usuários que atendem ao filtro de exclusão.
Enums | |
---|---|
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED |
Não especificado. |
EXCLUDE_TEMPORARILY |
Excluir usuários do público-alvo durante os períodos em que eles atendem à cláusula de filtro. |
EXCLUDE_PERMANENTLY |
Excluir usuários do público-alvo se eles já atenderam à cláusula de filtro. |
AudienceFilterClause
Uma cláusula para definir um filtro simples ou de sequência. Um filtro pode ser inclusivo (por exemplo, os usuários que atendem à cláusula de filtro são incluídos no público-alvo) ou exclusivo (por exemplo, usuários que atendem a ela são excluídos do público-alvo).
Representação JSON |
---|
{ "clauseType": enum ( |
Campos | |
---|---|
clauseType |
Obrigatório. Especifica se é uma cláusula de filtro de inclusão ou exclusão. |
Campo de união
|
|
simpleFilter |
Um filtro simples que um usuário precisa satisfazer para ser membro do público-alvo. |
sequenceFilter |
Filtros que precisam ocorrer em uma ordem específica para que o usuário participe do público. |
AudienceSimpleFilter
Define um filtro simples que um usuário precisa atender para fazer parte do público-alvo.
Representação JSON |
---|
{ "scope": enum ( |
Campos | |
---|---|
scope |
Obrigatório. Imutável. Especifica o escopo deste filtro. |
filterExpression |
Obrigatório. Imutável. Uma expressão lógica de filtros de evento, métrica ou dimensão de público-alvo. |
AudienceFilterScope
Especifica como avaliar os usuários para participar de um público.
Enums | |
---|---|
AUDIENCE_FILTER_SCOPE_UNSPECIFIED |
O escopo não foi especificado. |
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT |
O usuário vai fazer parte do público-alvo se a condição do filtro for atendida em um evento. |
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION |
O usuário vai ingressar no público-alvo se a condição do filtro for atendida em uma sessão. |
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS |
O usuário vai fazer parte do público-alvo se a condição do filtro for atendida por qualquer evento em qualquer sessão. |
AudienceFilterExpression
Uma expressão lógica de filtros de evento, métrica ou dimensão de público-alvo.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união expr . A expressão aplicada a um filtro. expr pode ser apenas de um dos tipos a seguir: |
|
andGroup |
Uma lista de expressões que precisam ser combinadas com AND. Ela só pode conter AudienceFilterExpressions com orGroup. Precisa ser definido para o AudienceFilterExpression de nível superior. |
orGroup |
Uma lista de expressões unidas com OR. e não pode conter AudienceFilterExpressions com andGroup ou orGroup. |
notExpression |
Uma expressão de filtro NOT (por exemplo, invertida, complementada). Ele só pode incluir um dimensionOrMetricFilter. Isso não pode ser definido no AudienceFilterExpression de nível superior. |
dimensionOrMetricFilter |
Um filtro em uma única dimensão ou métrica. Isso não pode ser definido no AudienceFilterExpression de nível superior. |
eventFilter |
Cria um filtro que corresponde a um evento específico. Isso não pode ser definido no AudienceFilterExpression de nível superior. |
AudienceFilterExpressionList
Uma lista de expressões do filtro de público-alvo.
Representação JSON |
---|
{
"filterExpressions": [
{
object ( |
Campos | |
---|---|
filterExpressions[] |
Uma lista de expressões do filtro de público-alvo. |
AudienceDimensionOrMetricFilter
Um filtro específico para uma única dimensão ou métrica.
Representação JSON |
---|
{ "fieldName": string, "atAnyPointInTime": boolean, "inAnyNDayPeriod": integer, // Union field |
Campos | |
---|---|
fieldName |
Obrigatório. Imutável. O nome da dimensão ou da métrica a ser filtrada. Se o nome do campo se referir a uma dimensão ou métrica personalizada, um prefixo de escopo será adicionado à frente do nome da métrica ou das dimensões personalizadas. Para mais informações sobre prefixos de escopo ou dimensões/métricas personalizadas, consulte a documentação da API Data do Google Analytics. |
atAnyPointInTime |
Opcional. Indica se esse filtro precisa de avaliação dinâmica ou não. Se ela for definida como verdadeira, os usuários participarão do público-alvo se já atenderam à condição (avaliação estática). Se ela não for definida ou for definida como "false", a avaliação será dinâmica. Os usuários serão adicionados a um público-alvo quando atenderem às condições e removidos quando deixarem de cumprir esses critérios. Só pode ser definido quando o escopo de público é ACROSS_ALL_SESSIONS. |
inAnyNDayPeriod |
Opcional. Se definido, especifica a janela de tempo para avaliar dados em número de dias. Se ela não for definida, os dados de público-alvo serão avaliados em relação aos dados de ciclo de vida (por exemplo, uma janela de tempo infinito). Por exemplo, se for definido como um dia, somente os dados do dia atual serão avaliados. O ponto de referência é o dia atual em que atAnyPointInTime não está definido ou é "false". Ela só pode ser definida quando o escopo de público-alvo for ACROSS_ALL_SESSIONS e não pode ser maior que 60 dias. |
Campo de união one_filter . Um dos filtros acima. one_filter pode ser apenas de um dos tipos a seguir: |
|
stringFilter |
Um filtro para uma dimensão de tipo de string que corresponde a um padrão específico. |
inListFilter |
Um filtro para uma dimensão de string que corresponde a uma determinada lista de opções. |
numericFilter |
Um filtro para valores numéricos ou de data em uma dimensão ou métrica. |
betweenFilter |
Um filtro para valores numéricos ou de data entre determinados valores em uma dimensão ou métrica. |
StringFilter
Um filtro para uma dimensão de tipo de string que corresponde a um padrão específico.
Representação JSON |
---|
{
"matchType": enum ( |
Campos | |
---|---|
matchType |
Obrigatório. O tipo de correspondência do filtro de string. |
value |
Obrigatório. O valor da string a ser comparado. |
caseSensitive |
Opcional. Se verdadeiro, a correspondência diferencia maiúsculas de minúsculas. Se for "false", a correspondência não diferencia maiúsculas de minúsculas. |
MatchType
O tipo de correspondência do 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 |
A expressão regular completa corresponde ao valor da string. |
InListFilter
Um filtro para uma dimensão de string que corresponde a uma determinada lista de opções.
Representação JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Campos | |
---|---|
values[] |
Obrigatório. A lista de possíveis valores de string para correspondência. Não pode estar em branco. |
caseSensitive |
Opcional. Se verdadeiro, a correspondência diferencia maiúsculas de minúsculas. Se for "false", a correspondência não diferencia maiúsculas de minúsculas. |
NumericFilter
Um filtro para valores numéricos ou de data em uma dimensão ou métrica.
Representação JSON |
---|
{ "operation": enum ( |
Campos | |
---|---|
operation |
Obrigatório. A operação aplicada a um filtro numérico. |
value |
Obrigatório. O valor numérico ou de data com o qual fazer a correspondência. |
Operação
A operação aplicada a um filtro numérico.
Enums | |
---|---|
OPERATION_UNSPECIFIED |
Não especificado. |
EQUAL |
Igual. |
LESS_THAN |
Menor que |
GREATER_THAN |
Maior que |
NumericValue
Representar um número.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união one_value . Um de um valor numérico. one_value pode ser apenas de um dos tipos a seguir: |
|
int64Value |
Número inteiro. |
doubleValue |
Valor duplo. |
BetweenFilter
Um filtro para valores numéricos ou de data entre determinados valores em uma dimensão ou métrica.
Representação JSON |
---|
{ "fromValue": { object ( |
Campos | |
---|---|
fromValue |
Obrigatório. Começa com este número, inclusive. |
toValue |
Obrigatório. Termina com este número, inclusive. |
AudienceEventFilter
Um filtro que corresponde a eventos de um único nome de evento. Se um parâmetro de evento for especificado, 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,
"eventParameterFilterExpression": {
object ( |
Campos | |
---|---|
eventName |
Obrigatório. Imutável. O nome do evento para fazer a correspondência. |
eventParameterFilterExpression |
Opcional. Se especificado, este filtro corresponde a eventos que correspondem ao nome do evento único e às expressões de filtro do parâmetro. AudienceEventFilter dentro da expressão de filtro do parâmetro não pode ser definido (por exemplo, filtros de eventos aninhados não são compatíveis). Precisa ser um único andGroup de dimensionOrMetricFilter ou notExpression. ANDs de ORs não são aceitos. Além disso, se ele incluir um filtro para "eventCount", somente esse será considerado. Todos os outros filtros serão ignorados. |
AudienceSequenceFilter
Define os filtros que precisam ocorrer em uma ordem específica para que o usuário seja membro do público.
Representação JSON |
---|
{ "scope": enum ( |
Campos | |
---|---|
scope |
Obrigatório. Imutável. Especifica o escopo deste filtro. |
sequenceMaximumDuration |
Opcional. Define o período em que toda a sequência precisa ocorrer. Uma duração em segundos com até nove dígitos fracionários, terminando em " |
sequenceSteps[] |
Obrigatório. Uma sequência ordenada de etapas. Um usuário precisa concluir cada etapa para mesclar o filtro de sequência. |
AudienceSequenceStep
Uma condição que precisa ocorrer na ordem de etapas especificada para que esse usuário corresponda à sequência.
Representação JSON |
---|
{ "scope": enum ( |
Campos | |
---|---|
scope |
Obrigatório. Imutável. Especifica o escopo desta etapa. |
immediatelyFollows |
Opcional. Se verdadeiro, o evento que atende a essa etapa precisa ser o próximo evento após o evento da última etapa. Se a política não for definida ou for falsa, esta etapa seguirá indiretamente a etapa anterior. Por exemplo, pode haver eventos entre a etapa anterior e esta. Ele é ignorado na primeira etapa. |
constraintDuration |
Opcional. Quando definida, essa etapa precisa ser satisfeita dentro da constraintsDuration da etapa anterior (por exemplo, t[i] - t[i-1] <= restrictedDuration). Se não for definido, não há requisito de duração (a duração é efetivamente ilimitada). Ele é ignorado na primeira etapa. Uma duração em segundos com até nove dígitos fracionários, terminando em " |
filterExpression |
Obrigatório. Imutável. Uma expressão lógica da dimensão, da métrica ou dos filtros de evento do público-alvo em cada etapa. |
AudienceClauseType
Especifica se é uma cláusula de filtro de inclusão ou exclusão.
Enums | |
---|---|
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED |
Tipo de cláusula não especificado. |
INCLUDE |
Os usuários serão incluídos no público-alvo se a cláusula de filtro for atendida. |
EXCLUDE |
Os usuários serão excluídos do público-alvo se a cláusula de filtro for atendida. |
Métodos |
|
---|---|
|
Arquiva um público em uma propriedade. |
|
Cria um público. |
|
Procurar um único público-alvo. |
|
Lista os públicos-alvo de uma propriedade. |
|
Atualiza um público-alvo em uma propriedade. |