REST Resource: properties.audiences

Recurso: Audience

Uma mensagem de recurso que representa um público-alvo.

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 do recurso de público-alvo. Formato: properties/{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-alvo.
membershipDurationDays

integer

Obrigatório. Imutável. O período que um usuário deve permanecer em um público-alvo. Não é possível definir um período maior que 540 dias.
adsPersonalizationEnabled

boolean

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

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

Imutável. Especifica por quanto tempo uma exclusão dura para 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[]

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.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

Especifica um evento a ser registrado quando um usuário entra no público-alvo.

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.

Tipos enumerados
LOG_CONDITION_UNSPECIFIED A condição de registro não foi especificada.
AUDIENCE_JOINED O evento só deve ser registrado quando um usuário entra.
AUDIENCE_MEMBERSHIP_RENEWED O evento precisa ser registrado sempre que a condição do público-alvo for atendida, mesmo que o usuário já seja membro dele.

AudienceExclusionDurationMode

Especifica por quanto tempo uma exclusão dura para usuários que atendem ao filtro de exclusão.

Tipos enumerados
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Não especificado.
EXCLUDE_TEMPORARILY Exclua usuários do público-alvo durante os períodos em que eles atendem à cláusula de filtro.
EXCLUDE_PERMANENTLY Exclua 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, usuários que atendem à cláusula de filtro são incluídos no público-alvo) ou exclusivo (por exemplo, usuários que atendem à cláusula de filtro são excluídos do público-alvo).

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 atender para ser 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-alvo.

AudienceSimpleFilter

Define um filtro simples que um usuário precisa atender para ser membro do público-alvo.

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 filtros de dimensão, métrica ou evento de público-alvo.

AudienceFilterScope

Especifica como avaliar os usuários para que eles entrem em um público-alvo.

Tipos enumerados
AUDIENCE_FILTER_SCOPE_UNSPECIFIED O escopo não foi especificado.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT O usuário entra no público-alvo se a condição de filtro for atendida em um evento.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION O usuário entra no público-alvo se a condição de filtro for atendida em uma sessão.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS O usuário entra no 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 filtros de dimensão, métrica ou evento de público-alvo.

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 serão combinadas com AND. Ele só pode conter AudienceFilterExpressions com orGroup. Isso precisa ser definido para o AudienceFilterExpression de nível superior.
orGroup

object (AudienceFilterExpressionList)

Uma lista de expressões combinadas com "OR". Não pode conter AudienceFilterExpressions com andGroup ou orGroup.
notExpression

object (AudienceFilterExpression)

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

object (AudienceDimensionOrMetricFilter)

Um filtro 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 de público-alvo.

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

object (AudienceFilterExpression)

Uma lista de expressões de 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 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 que será filtrada. Se o nome do campo se referir a uma dimensão ou métrica personalizada, um prefixo de escopo será adicionado ao início do nome da dimensão ou métrica personalizada. 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 este filtro precisa de avaliação dinâmica ou não. Se definida como "true", os usuários vão entrar no público-alvo se já atenderam à condição (avaliação estática). Se não estiver definida ou estiver definida como "false", a avaliação de usuários para um público-alvo será dinâmica. Os usuários serão adicionados a um público-alvo quando atenderem às condições e removidos quando deixarem de atender.

Isso só pode ser definido quando o escopo de público-alvo é ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opcional. Se definido, especifica o período para avaliar os dados em número de dias. Se não for definido, os dados de público-alvo serão avaliados em relação aos dados de ciclo de vida (por exemplo, período infinito).

Por exemplo, se definido como "1 dia", apenas os dados do dia atual serão avaliados. O ponto de referência é o dia atual quando "atAnyPointInTime" não está definido ou é falso.

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 correspondido.
caseSensitive

boolean

Opcional. Se for "true", a correspondência vai diferenciar maiúsculas de minúsculas. Se for "false", a correspondência não vai diferenciar maiúsculas de minúsculas.

MatchType

O tipo de correspondência do filtro de string.

Tipos enumerados
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 estar vazio.
caseSensitive

boolean

Opcional. Se for "true", a correspondência vai diferenciar maiúsculas de minúsculas. Se for "false", a correspondência não vai diferenciar 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 a ser correspondido.

Operação

A operação aplicada a um filtro numérico.

Tipos enumerados
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 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 esse número, inclusive.
toValue

object (NumericValue)

Obrigatório. Termina com este número, inclusive.

AudienceEventFilter

Um filtro que corresponde a eventos com um único nome. 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 vai 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 vai corresponder a eventos que correspondem ao nome do evento único e às expressões de filtro de parâmetro. Não é possível definir AudienceEventFilter na expressão de filtro de parâmetro. Por exemplo, filtros de eventos aninhados não são aceitos. Precisa ser um único andGroup de dimensionOrMetricFilter ou notExpression. Não há suporte para ANDs de ORs. Além disso, se ele incluir um filtro para "eventCount", apenas esse será considerado. Todos os outros serão ignorados.

AudienceSequenceFilter

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

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. Um usuário precisa concluir cada etapa para participar do filtro de sequência.

AudienceSequenceStep

Uma condição que precisa ocorrer na ordem de etapa especificada para que o 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 for verdadeiro, o evento que satisfaz esta etapa precisa ser o próximo evento depois daquele que satisfaz a última etapa. Se não estiver definido ou for "false", essa etapa vai seguir indiretamente a anterior. Por exemplo, pode haver eventos entre a etapa anterior e esta. Ela é ignorada na primeira etapa.
constraintDuration

string (Duration format)

Opcional. Quando definido, essa etapa precisa ser concluída dentro do constraintDuration da etapa anterior. Por exemplo, t[i] - t[i-1] <= constraintDuration. Se não for definido, não haverá requisito de duração (a duração será 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 filtros de dimensão, métrica ou evento de público-alvo em cada etapa.

AudienceClauseType

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

Tipos enumerados
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

archive

 Arquiva um público-alvo em uma propriedade.

create

 Cria um público-alvo.

get

 Pesquisa por um único público-alvo.

list

 Lista os públicos-alvo em uma propriedade.

patch

 Atualiza um público-alvo em uma propriedade.