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)
    }
  ],
  "createTime": string
}
Campos
name

string

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

string

Obligatorio. 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. GA lo configura automáticamente como falso si se trata de un público de este tipo y se excluye de la personalización de anuncios.
eventTrigger

object (AudienceEventTrigger)

Opcional. Especifica un evento que se registra cuando un usuario se une 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 hay 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 estarán juntas mediante el operador AND.
createTime

string (Timestamp format)

Solo salida. Hora en la que se creó el público.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

AudienceEventTrigger

Especifica un evento que se registra cuando un usuario se une 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.

Enumeraciones
LOG_CONDITION_UNSPECIFIED No se especificó la condición de registro.
AUDIENCE_JOINED El evento solo debe registrarse cuando se une un usuario.
AUDIENCE_MEMBERSHIP_RENEWED El evento debe registrarse cada vez que se cumple 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.

Enumeraciones
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED No se especifica.
EXCLUDE_TEMPORARILY Excluye a los usuarios del público durante los períodos en que cumplan con la cláusula de filtro.
EXCLUDE_PERMANENTLY Excluir a los usuarios del público si alguna vez han cumplido 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 excluyente (por ejemplo, los usuarios que satisfacen la cláusula de filtro se excluyen 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 se trata de 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 filtros que deben aparecer en un orden específico para que el usuario se convierta en un miembro del público.

AudienceSimpleFilter

Define un filtro simple que un usuario debe satisfacer para ser miembro de un 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, métrica o evento de Público.

AudienceFilterScope

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

Enumeraciones
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 dentro de 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 de cualquier sesión cumple la condición del filtro.

AudienceFilterExpression

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

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)

Una lista de expresiones que se unirán con AND. Solo puede contener AudienceFilterExpressions con orGroup. Se debe configurar para el elemento AudienceFilterExpression de nivel superior.
orGroup

object (AudienceFilterExpressionList)

Una lista de expresiones unidas por OR No puede contener AudienceFilterExpressions con andGroup ni orGroup.
notExpression

object (AudienceFilterExpression)

Una expresión de filtro a la que NO se debe agregar (por ejemplo, invertido, complementada). Solo puede incluir una dimensionOrMetricFilter. No se puede establecer en el nivel superior de AudienceFilterExpression.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

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

object (AudienceEventFilter)

Crea un filtro que coincide con un evento específico. No se puede establecer en el nivel superior de 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. Es el nombre de la dimensión o de 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 frente de estas. Para obtener más información sobre los prefijos del alcance o las dimensiones o 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 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 agregan a un público cuando cumplen con las condiciones y, luego, se quitan cuando ya no las cumplen.

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

integer

Opcional. Si está establecido, especifica el período para el que se deben evaluar los datos en cantidad de días. Si no se configura, los datos de 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 es 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)

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 particular 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 de una dimensión o métrica.

StringFilter

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 concordancia para el filtro de cadenas.
value

string

Obligatorio. Valor de cadena con el que se buscará coincidencias.
caseSensitive

boolean

Opcional. Si es verdadera, la coincidencia distingue entre mayúsculas y minúsculas. Si es falsa, la coincidencia no distingue entre mayúsculas y minúsculas.

MatchType

El tipo de concordancia para el filtro de cadenas.

Enumeraciones
MATCH_TYPE_UNSPECIFIED Sin especificar
EXACT Concordancia exacta con el valor de la cadena
BEGINS_WITH Comienza con el valor de la 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 cadena.

InListFilter

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

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

string

Obligatorio. Es la lista de posibles valores de string con los que debe coincidir. No puede estar vacío.
caseSensitive

boolean

Opcional. Si es verdadera, la coincidencia distingue entre mayúsculas y minúsculas. Si es falsa, la coincidencia no distingue entre mayúsculas y 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 que se aplica a un filtro numérico.
value

object (NumericValue)

Obligatorio. Valor numérico o de fecha con el que se debe comparar

Operación

La operación que se aplica a un filtro numérico.

Enumeraciones
OPERATION_UNSPECIFIED Sin especificar.
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. Es 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 de 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 del parámetro coinciden con este filtro de evento.

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

string

Obligatorio. Inmutable. Es 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, los filtros de eventos anidados no son compatibles). Debe ser un único andGroup de dimensionOrMetricFilter o notExpression; No se admiten los operadores Y de O. Además, si incluye un filtro para "eventCount", solo se considerará ese filtro. se ignorarán todos los demás filtros.

AudienceSequenceFilter

Define los filtros que deben ocurrir en un orden específico para que el usuario se convierta en un 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 terminan 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

Es 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 próximo evento después del evento que satisface el último paso. Si no se establece 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 constraintDuration del paso anterior (por ejemplo, t[i] - t[i-1] <= constraintDuration). Si no se establece, no habrá ningún requisito de duración (la duración es efectivamente ilimitada). Se ignora para el primer paso.

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

object (AudienceFilterExpression)

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

AudienceClauseType

Especifica si se trata de una cláusula de filtro de inclusión o exclusión.

Enumeraciones
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Tipo de cláusula sin especificar.
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

 Permite buscar un público único.

list

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

patch

 Actualiza un público en una propiedad.