REST Resource: properties.audiences

Recurso: Audience

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 (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}
Campos
name

string

Apenas saída. O nome deste recurso de público-alvo. Formato: propriedades/{propertyId}/audiences/{audienceId}
displayName

string

Obrigatório. O nome de exibição do público-alvo.
description

string

Obrigatório. A descrição do público.
membershipDurationDays

integer

Obrigatório. Imutável. O tempo que um usuário deve ficar em um público-alvo. Ele não pode ser definido como mais de 540 dias.
adsPersonalizationEnabled

boolean

Apenas saída. Ele será definido automaticamente pelo GA como "false" se for um público-alvo de NPA e for excluído da personalização de anúncios.
eventTrigger

object (AudienceEventTrigger)

Opcional. Especifica um evento a ser registrado quando um usuário entrar no público. Se ela não for definida, nenhum evento será registrado quando um usuário entrar no público.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Imutável. Especifica a duração de uma exclusão para os usuários que atendem ao filtro de exclusão. Ela é aplicada a todas as cláusulas de filtro EXCLUI e é ignorada quando não há uma cláusula desse tipo no público-alvo.
filterClauses[]

object (AudienceFilterClause)

Obrigatório. Imutável. Lista não ordenada. Cláusulas de filtro que definem o público-alvo. Todas as cláusulas serão unidas por AND.
createTime

string (Timestamp format)

Apenas saída. Hora em que o público-alvo foi criado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

AudienceEventTrigger

Especifica um evento a ser registrado quando um usuário entrar no público.

Representação JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Campos
eventName

string

Obrigatório. O nome do evento que será registrado.
logCondition

enum (LogCondition)

Obrigatório. Quando registrar o evento.

LogCondition

Determina quando registrar o evento.

Enums
LOG_CONDITION_UNSPECIFIED A condição de registro não foi especificada.
AUDIENCE_JOINED O evento só deve ser registrado quando um usuário participa.
AUDIENCE_MEMBERSHIP_RENEWED O evento deve ser registrado sempre que a condição do público-alvo for atendida, mesmo que o usuário já seja membro do 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 sequencial. 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, os usuários que atendem à cláusula de filtro são excluídos do público).

Representação JSON 
{
  "clauseType": enum (AudienceClauseType),

  // Union field filter can be only one of the following:
  "simpleFilter": {
    object (AudienceSimpleFilter)
  },
  "sequenceFilter": {
    object (AudienceSequenceFilter)
  }
  // End of list of possible types for union field filter.
}
Campos
clauseType

enum (AudienceClauseType)

Obrigatório. Especifica se esta é uma cláusula de filtro de inclusão ou exclusão.

Campo de união filter.

filter pode ser apenas de um dos tipos a seguir:
simpleFilter

object (AudienceSimpleFilter)

Um filtro simples que um usuário precisa satisfazer para ser um membro do público-alvo.
sequenceFilter

object (AudienceSequenceFilter)

Filtros que precisam ocorrer em uma ordem específica para que o usuário seja membro do público.

AudienceSimpleFilter

Define um filtro simples que um usuário deve satisfazer para ser um membro do público.

Representação JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Campos
scope

enum (AudienceFilterScope)

Obrigatório. Imutável. Especifica o escopo deste filtro.
filterExpression

object (AudienceFilterExpression)

Obrigatório. Imutável. Uma expressão lógica de dimensões de público-alvo, métrica ou filtros de eventos.

AudienceFilterScope

Especifica como avaliar os usuários para participar de um público-alvo.

Enums
AUDIENCE_FILTER_SCOPE_UNSPECIFIED O escopo não foi especificado.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT O usuário vai ser incluído no público-alvo se a condição de filtro for atendida em um evento.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION O usuário vai participar do público-alvo se a condição de filtro for atendida em uma sessão.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS O usuário vai participar do público-alvo se a condição de filtro for atendida por qualquer evento em qualquer sessão.

AudienceFilterExpression

Uma expressão lógica de dimensões de público-alvo, métrica ou filtros de eventos.

Representação JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (AudienceFilterExpressionList)
  },
  "orGroup": {
    object (AudienceFilterExpressionList)
  },
  "notExpression": {
    object (AudienceFilterExpression)
  },
  "dimensionOrMetricFilter": {
    object (AudienceDimensionOrMetricFilter)
  },
  "eventFilter": {
    object (AudienceEventFilter)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de união expr. A expressão aplicada a um filtro. expr pode ser apenas de um dos tipos a seguir:
andGroup

object (AudienceFilterExpressionList)

Uma lista de expressões que devem ser unidas por AND. Ele só pode conter AudienceFilterExpressions com orGroup. Precisa ser definido para a AudienceFilterExpression de nível superior.
orGroup

object (AudienceFilterExpressionList)

Uma lista de expressões para OR unidas. Ele não pode conter AudienceFilterExpressions com andGroup ou orGroup.
notExpression

object (AudienceFilterExpression)

Uma expressão de filtro que deve ser NOT (por exemplo, invertida ou complementada). Ele só pode incluir um dimensionOrMetricFilter. Isso não pode ser definido na AudienceFilterExpression de nível superior.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Um filtro com base em uma única dimensão ou métrica. Isso não pode ser definido na AudienceFilterExpression de nível superior.
eventFilter

object (AudienceEventFilter)

Cria um filtro que corresponde a um evento específico. Isso não pode ser definido na AudienceFilterExpression de nível superior.

AudienceFilterExpressionList

Uma lista de expressões de filtro do público-alvo.

Representação JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Campos
filterExpressions[]

object (AudienceFilterExpression)

Uma lista de expressões de filtro do 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 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

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 vai ser adicionado na frente do nome delas. Para mais informações sobre prefixos de escopo ou dimensões/métricas personalizadas, consulte a documentação da API Google Analytics Data.
atAnyPointInTime

boolean

Opcional. Indica se esse filtro precisa de avaliação dinâmica ou não. Se a política for definida como verdadeira, os usuários participarão do público-alvo se já tiverem atendido à condição (avaliação estática). Se não for definida ou for definida como falsa, a avaliação do usuário para um público-alvo será dinâmica. os usuários são adicionados a um público-alvo quando atendem às condições e removidos quando deixam de atender.

Essa opção só pode ser definida quando o escopo de público-alvo é ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opcional. Se definido, especifica a janela de tempo para avaliar os dados em número de dias. Se ela não for definida, os dados do público-alvo serão avaliados em relação aos dados de ciclo de vida (por exemplo, uma janela de tempo infinita).

Por exemplo, se definida como 1 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 é falso.

Ele só pode ser definido quando o escopo de público-alvo é 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

object (StringFilter)

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.
inListFilter

object (InListFilter)

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções.
numericFilter

object (NumericFilter)

Um filtro para valores numéricos ou de data em uma dimensão ou métrica.
betweenFilter

object (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 do tipo string que corresponde a um padrão específico.

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

enum (MatchType)

Obrigatório. O tipo de correspondência do filtro de string.
value

string

Obrigatório. O valor da string a ser correspondida.
caseSensitive

boolean

Opcional. Se verdadeiro, a correspondência diferencia maiúsculas de minúsculas. Se for falso, 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 lista específica de opções.

Representação JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Campos
values[]

string

Obrigatório. A lista de possíveis valores de string para correspondência. Não pode ficar em branco.
caseSensitive

boolean

Opcional. Se verdadeiro, a correspondência diferencia maiúsculas de minúsculas. Se for falso, 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 (Operation),
  "value": {
    object (NumericValue)
  }
}
Campos
operation

enum (Operation)

Obrigatório. A operação aplicada a um filtro numérico.
value

object (NumericValue)

Obrigatório. O valor numérico ou de data que deve ser comparado.

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

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 de um valor numérico. one_value pode ser apenas de um dos tipos a seguir:
int64Value

string (int64 format)

Número inteiro.
doubleValue

number

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 (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Campos
fromValue

object (NumericValue)

Obrigatório. Começa com este número, inclusivo.
toValue

object (NumericValue)

Obrigatório. Termina com este número (valor inclusivo).

AudienceEventFilter

Um filtro que corresponde aos eventos de um único nome de evento. Se um parâmetro de evento for especificado, somente o subconjunto de eventos que correspondem ao nome do evento único e às expressões de filtro do parâmetro corresponderá a esse filtro de evento.

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

string

Obrigatório. Imutável. O nome do evento a ser comparado.
eventParameterFilterExpression

object (AudienceFilterExpression)

Opcional. Se especificado, esse filtro corresponde a eventos que correspondem ao nome do evento único e às expressões de filtro do parâmetro. Não é possível definir o AudienceEventFilter na expressão de filtro do parâmetro. Por exemplo, não é possível usar filtros de eventos aninhados. Deve ser um "andGroup" de dimensionOrMetricFilter ou "notExpression". Não é possível usar AND ou OR. Além disso, se ele incluir um filtro para "eventCount", apenas esse será considerado. todos os outros filtros serão ignorados.

AudienceSequenceFilter

Define filtros que devem ocorrer em uma ordem específica para que o usuário seja membro do público.

Representação JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Campos
scope

enum (AudienceFilterScope)

Obrigatório. Imutável. Especifica o escopo deste filtro.
sequenceMaximumDuration

string (Duration format)

Opcional. Define o período em que toda a sequência precisa ocorrer.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Obrigatório. Uma sequência ordenada de etapas. O usuário precisa concluir cada etapa para combinar 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 (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Campos
scope

enum (AudienceFilterScope)

Obrigatório. Imutável. Especifica o escopo desta etapa.
immediatelyFollows

boolean

Opcional. Se verdadeiro, o evento que satisfaz essa etapa precisa ser o próximo evento após o que satisfaz a última etapa. Se ela 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. Ela é ignorada na primeira etapa.
constraintDuration

string (Duration format)

Opcional. Quando definida, essa etapa precisa ser satisfeita dentro da constraintsDuration da etapa anterior (por exemplo, t[i] - t[i-1] <= constraintsDuration). Se não for definido, não haverá requisito de duração (a duração é efetivamente ilimitada). Ela é ignorada na primeira etapa.

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

object (AudienceFilterExpression)

Obrigatório. Imutável. Uma expressão lógica de dimensões de público-alvo, métrica ou filtros de eventos em cada etapa.

AudienceClauseType

Especifica se esta é 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 se a cláusula de filtro for atendida.

Métodos

archive

 Arquiva um público-alvo em uma propriedade.

create

 Cria um público-alvo.

get

 Pesquise um único público-alvo.

list

 Lista os públicos-alvo de uma propriedade.

patch

 Atualiza um público-alvo em uma propriedade.