REST Resource: properties.audiences

{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ]
}

string

Apenas saída. O nome do recurso deste recurso Audience. Formato: properties/{propertyId}/audiences/{audienceId}

string

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

string

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

integer

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.

boolean

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.

object (AudienceEventTrigger)

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.

enum (AudienceExclusionDurationMode)

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.

object (AudienceFilterClause)

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.

{
  "eventName": string,
  "logCondition": enum (LogCondition)
}

string

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

enum (LogCondition)

Obrigatório. Quando registrar o evento.

{
  "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.
}

enum (AudienceClauseType)

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

object (AudienceSimpleFilter)

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

object (AudienceSequenceFilter)

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

{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}

enum (AudienceFilterScope)

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

object (AudienceFilterExpression)

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

{

  // 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.
}

object (AudienceFilterExpressionList)

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.

object (AudienceFilterExpressionList)

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

object (AudienceFilterExpression)

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.

object (AudienceDimensionOrMetricFilter)

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

object (AudienceEventFilter)

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

{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}

object (AudienceFilterExpression)

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

{
  "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.
}

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

boolean

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.

integer

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.

object (StringFilter)

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

object (InListFilter)

Um filtro para uma dimensão de string que corresponde a uma determinada lista de opções.

object (NumericFilter)

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

object (BetweenFilter)

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

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

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

string

Obrigatório. O valor da string a ser comparado.

boolean

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.

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

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

boolean

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.

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

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

object (NumericValue)

Obrigatório. O valor numérico ou de data com o qual fazer a correspondência.

{

  // 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.
}

string (int64 format)

Número inteiro.

number

Valor duplo.

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

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

object (NumericValue)

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

{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}

string

Obrigatório. Imutável. O nome do evento para fazer a correspondência.

object (AudienceFilterExpression)

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.

{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}

enum (AudienceFilterScope)

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

string (Duration format)

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 "s". Exemplo: "3.5s".

object (AudienceSequenceStep)

Obrigatório. Uma sequência ordenada de etapas. Um usuário precisa concluir cada etapa para mesclar o filtro de sequência.

{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}

enum (AudienceFilterScope)

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

boolean

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.

string (Duration format)

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 "s". Exemplo: "3.5s".

object (AudienceFilterExpression)

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.