REST Resource: properties.audiences

Recurso: Audience

Un mensaje de recurso que representa un público de GA4.

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

string

Solo salida. El nombre de recurso de este recurso de público. Formato: properties/{propertyId}/audiences/{audienceId}
displayName

string

Obligatorio. Es el nombre visible del público.
description

string

Obligatorio. Es la descripción del público.
membershipDurationDays

integer

Obligatorio. Inmutable. Es el tiempo que un usuario debe permanecer en un público. No se puede establecer en más de 540 días.
adsPersonalizationEnabled

boolean

Solo salida. Google Analytics establece automáticamente esta opción como false si se trata de un público de NPA y se excluye de la personalización de anuncios.
eventTrigger

object (AudienceEventTrigger)

Opcional. Especifica un evento que se registrará cuando un usuario se una al público. Si no la estableces, no se registrará ningún evento cuando un usuario se una al público.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Inmutable. Especifica cuánto dura una exclusión para los usuarios que cumplen con el filtro de exclusión. Se aplica a todas las cláusulas de filtro EXCLUIR y se ignora cuando no existe una cláusula de filtro EXCLUIR en el público.
filterClauses[]

object (AudienceFilterClause)

Obligatorio. Inmutable. Lista sin ordenar. Cláusulas de filtro que definen el público. Todas las cláusulas se unirán mediante el operador AND.

AudienceEventTrigger

Especifica un evento que se registrará cuando un usuario se una al público.

Representación JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Campos
eventName

string

Obligatorio. El nombre del evento que se registrará
logCondition

enum (LogCondition)

Obligatorio. Cuándo registrar el evento

LogCondition

Determina cuándo registrar el evento.

Enumeradores
LOG_CONDITION_UNSPECIFIED No se especificó la condición de registro.
AUDIENCE_JOINED El evento solo se debe registrar cuando se une un usuario.
AUDIENCE_MEMBERSHIP_RENEWED El evento debe registrarse cada vez que se cumpla la condición de Público, incluso si el usuario ya es miembro del Público.

AudienceExclusionDurationMode

Especifica cuánto dura una exclusión para los usuarios que cumplen con el filtro de exclusión.

Enumeradores
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED No se especifica.
EXCLUDE_TEMPORARILY Excluir a los usuarios del Público durante los períodos en que cumplen con la cláusula de filtro
EXCLUDE_PERMANENTLY Excluye usuarios del público si alguna vez cumplieron con la cláusula de filtro.

AudienceFilterClause

Cláusula para definir un filtro simple o de secuencia. Un filtro puede ser inclusivo (por ejemplo, los usuarios que satisfacen la cláusula de filtro se incluyen en el Público) o exclusivo (por ejemplo, los usuarios que satisfacen la cláusula de filtro están excluidos del Público).

Representación 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)

Obligatorio. Especifica si esta es una cláusula de filtro de inclusión o exclusión.

Campo de unión filter.

filter puede ser una de las siguientes opciones:
simpleFilter

object (AudienceSimpleFilter)

Es un filtro simple que un usuario debe cumplir para ser miembro del público.
sequenceFilter

object (AudienceSequenceFilter)

Son los filtros que deben aplicarse en un orden específico para que el usuario sea miembro del público.

AudienceSimpleFilter

Define un filtro simple que un usuario debe cumplir para ser miembro del público.

Representación JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Campos
scope

enum (AudienceFilterScope)

Obligatorio. Inmutable. Especifica el alcance de este filtro.
filterExpression

object (AudienceFilterExpression)

Obligatorio. Inmutable. Una expresión lógica de los filtros de dimensión del público, métrica o evento.

AudienceFilterScope

Especifica cómo evaluar a los usuarios para unirse a un público.

Enumeradores
AUDIENCE_FILTER_SCOPE_UNSPECIFIED No se especificó el alcance.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT El usuario se une al Público si se cumple la condición del filtro en un evento.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION El usuario se une al público si se cumple la condición del filtro en una sesión.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS El usuario se une al público si algún evento cumple la condición del filtro en cualquier sesión.

AudienceFilterExpression

Una expresión lógica de los filtros de dimensión del público, métrica o evento.

Representación 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ón expr. La expresión aplicada a un filtro. Las direcciones (expr) solo pueden ser una de las siguientes opciones:
andGroup

object (AudienceFilterExpressionList)

Lista de expresiones que se unirán mediante el operador Y. Solo puede contener AudienceFilterExpressions con orGroup. Esto debe configurarse para la AudienceFilterExpression de nivel superior.
orGroup

object (AudienceFilterExpressionList)

Una lista de expresiones combinadas con el operador OR. No puede contener AudienceFilterExpressions con andGroup o orGroup.
notExpression

object (AudienceFilterExpression)

Una expresión de filtro que NO se debe agregar (por ejemplo, invertida, complementaria) Solo puede incluir una dimensionOrMetricFilter. Esto no se puede configurar en el nivel superior AudienceFilterExpression.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Es un filtro de una sola dimensión o métrica. Esto no se puede configurar en el nivel superior AudienceFilterExpression.
eventFilter

object (AudienceEventFilter)

Crea un filtro que coincide con un evento específico. Esto no se puede configurar en el nivel superior AudienceFilterExpression.

AudienceFilterExpressionList

Una lista de expresiones de filtro de público.

Representación JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Campos
filterExpressions[]

object (AudienceFilterExpression)

Una lista de expresiones de filtro de público.

AudienceDimensionOrMetricFilter

Es un filtro específico para una sola dimensión o métrica.

Representación 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

Obligatorio. Inmutable. El nombre de la dimensión o la métrica que se filtrará. Si el nombre del campo hace referencia a una dimensión o métrica personalizada, se agregará un prefijo de alcance al principio del nombre de las dimensiones o métricas personalizadas. Para obtener más información sobre los prefijos de alcance o las dimensiones y métricas personalizadas, consulta la documentación de la API de datos de Google Analytics.
atAnyPointInTime

boolean

Opcional. Indica si este filtro necesita evaluación dinámica o no. Si la estableces como verdadera, los usuarios se unirán al Público si alguna vez cumplieron con la condición (evaluación estática). Si no la estableces o la estableces como falsa, la evaluación de los usuarios de un público será dinámica. Los usuarios se agregarán a un público cuando cumplan las condiciones y, luego, se quitarán cuando ya no las cumplan.

Esto solo se puede configurar cuando el alcance del público es ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opcional. Si se configura, especifica el período durante el cual se evaluarán los datos en cantidad de días. Si no se establece, los datos del público se evalúan en comparación con los datos del ciclo de vida del cliente (por ejemplo, un período infinito).

Por ejemplo, si se establece en 1 día, solo se evalúan los datos del día actual. El punto de referencia es el día actual cuando atAnyPointInTime no está establecido o no se establece como falso.

Solo se puede configurar cuando el alcance del público es ACROSS_ALL_SESSIONS y no puede superar los 60 días.
Campo de unión one_filter. Uno de los filtros anteriores. Las direcciones (one_filter) solo pueden ser una de las siguientes opciones:
stringFilter

object (StringFilter)

Es un filtro para una dimensión de tipo string que coincide con un patrón en particular.
inListFilter

object (InListFilter)

Es un filtro para una dimensión de cadena que coincide con una lista específica de opciones.
numericFilter

object (NumericFilter)

Es un filtro para valores numéricos o de fecha en una dimensión o métrica.
betweenFilter

object (BetweenFilter)

Es un filtro para valores numéricos o de fecha entre ciertos valores en una dimensión o métrica.

StringFilter

Es un filtro para una dimensión de tipo string que coincide con un patrón en particular.

Representación JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Campos
matchType

enum (MatchType)

Obligatorio. El tipo de coincidencia del filtro de cadenas.
value

string

Obligatorio. El valor de cadena con el que se debe coincidir.
caseSensitive

boolean

Opcional. Si es verdadero, la coincidencia distingue mayúsculas de minúsculas. Si es falsa, la coincidencia no distingue mayúsculas de minúsculas.

MatchType

El tipo de coincidencia del filtro de cadenas.

Enumeradores
MATCH_TYPE_UNSPECIFIED Sin especificar
EXACT Coincidencia exacta del valor de la cadena.
BEGINS_WITH Comienza con el valor de cadena.
ENDS_WITH Termina con el valor de la cadena.
CONTAINS Contiene el valor de la cadena.
FULL_REGEXP La expresión regular completa coincide con el valor de la string.

InListFilter

Es un filtro para una dimensión de cadena que coincide con una lista específica de opciones.

Representación JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Campos
values[]

string

Obligatorio. La lista de posibles valores de cadena con los que debe coincidir. Este campo no puede estar vacío.
caseSensitive

boolean

Opcional. Si es verdadero, la coincidencia distingue mayúsculas de minúsculas. Si es falsa, la coincidencia no distingue mayúsculas de minúsculas.

NumericFilter

Es un filtro para valores numéricos o de fecha en una dimensión o métrica.

Representación JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Campos
operation

enum (Operation)

Obligatorio. La operación aplicada a un filtro numérico.
value

object (NumericValue)

Obligatorio. El valor numérico o de fecha con el que se buscarán coincidencias.

Operación

La operación aplicada a un filtro numérico.

Enumeradores
OPERATION_UNSPECIFIED No se especifica.
EQUAL Igual.
LESS_THAN Inferior a
GREATER_THAN Superior a

NumericValue

Representar un número

Representación 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ón one_value. Uno de un valor numérico. Las direcciones (one_value) solo pueden ser una de las siguientes opciones:
int64Value

string (int64 format)

Valor de número entero.
doubleValue

number

Valor doble.

BetweenFilter

Es un filtro para valores numéricos o de fecha entre ciertos valores en una dimensión o métrica.

Representación JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Campos
fromValue

object (NumericValue)

Obligatorio. Comienza con este número inclusive.
toValue

object (NumericValue)

Obligatorio. Termina con este número inclusive.

AudienceEventFilter

Un filtro que coincide con los eventos de un solo nombre de evento. Si se especifica un parámetro de evento, solo el subconjunto de eventos que coincide con el nombre del evento único y las expresiones de filtro de parámetros coincidirá con este filtro de evento.

Representación JSON 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Campos
eventName

string

Obligatorio. Inmutable. El nombre del evento con el que se buscarán coincidencias.
eventParameterFilterExpression

object (AudienceFilterExpression)

Opcional. Si se especifica, este filtro coincide con los eventos que coinciden con el nombre del evento único y las expresiones de filtro de parámetros. No se puede establecer AudienceEventFilter dentro de la expresión de filtro de parámetros (por ejemplo, no se admiten los filtros de eventos anidados). Debe ser un andGroup de dimensionOrMetricFilter o notExpression. No se admiten los AND de OR. Además, si incluye un filtro para "eventCount", solo se considerará ese uno; se ignorará el resto.

AudienceSequenceFilter

Define los filtros que deben aplicarse en un orden específico para que el usuario sea miembro del público.

Representación JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Campos
scope

enum (AudienceFilterScope)

Obligatorio. Inmutable. Especifica el alcance de este filtro.
sequenceMaximumDuration

string (Duration format)

Opcional. Define el período en el que debe ocurrir toda la secuencia.

Una duración en segundos con hasta nueve dígitos decimales que terminen en "s". Ejemplo: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Obligatorio. Una secuencia ordenada de pasos. Un usuario debe completar cada paso para unirse al filtro de secuencias.

AudienceSequenceStep

Una condición que debe ocurrir en el orden de pasos especificado para que este usuario coincida con la secuencia.

Representación JSON 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Campos
scope

enum (AudienceFilterScope)

Obligatorio. Inmutable. Especifica el alcance de este paso.
immediatelyFollows

boolean

Opcional. Si es verdadero, el evento que satisface este paso debe ser el evento siguiente después del evento que satisface el último paso. Si no se configura o es falso, este paso sigue indirectamente al paso anterior; por ejemplo, puede haber eventos entre el paso anterior y este. Se ignora para el primer paso.
constraintDuration

string (Duration format)

Opcional. Cuando se establece, este paso debe cumplirse dentro de la restricciónDuration del paso anterior (por ejemplo, t[i] - t[i-1] <= constraintDuration). Si no la estableces, no habrá requisitos de duración (la duración efectivamente es ilimitada). Se ignora para el primer paso.

Una duración en segundos con hasta nueve dígitos decimales que terminen en "s". Ejemplo: "3.5s".
filterExpression

object (AudienceFilterExpression)

Obligatorio. Inmutable. Una expresión lógica de los filtros de dimensión del público, métrica o evento en cada paso.

AudienceClauseType

Especifica si esta es una cláusula de filtro de inclusión o exclusión.

Enumeradores
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Tipo de cláusula no especificado.
INCLUDE Los usuarios se incluirán en el Público si se cumple la cláusula de filtro.
EXCLUDE Los usuarios se excluirán del Público si se cumple la cláusula de filtro.

Métodos

archive

 Archiva un público en una propiedad.

create

 Crea un público.

get

 Buscar un solo público

list

 Muestra una lista de los públicos de una propiedad.

patch

 Actualiza un público en una propiedad.