REST Resource: properties.audiences

Recurso: Audience

Es un mensaje de recurso que representa un público.

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. Es el nombre del recurso de este recurso de Audience. 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 la duración durante la 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 establece automáticamente como falso 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 para registrar cuando un usuario se une al público. Si no se configura, no se registrará ningún evento cuando un usuario se una al público.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

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

object (AudienceFilterClause)

Obligatorio. Inmutable. Lista sin ordenar. Son las cláusulas de filtro que definen el público. Todas las cláusulas se combinarán con el operador AND.
createTime

string (Timestamp format)

Solo salida. Fecha y hora en que se creó el público.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

Especifica un evento para registrar cuando un usuario se une al público.

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

string

Obligatorio. Es el nombre del evento que se registrará.
logCondition

enum (LogCondition)

Obligatorio. Fecha y hora en que se registró el evento.

LogCondition

Determina cuándo se debe registrar el evento.

Enums
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 se debe registrar cada vez que se cumpla la condición del público, incluso si el usuario ya es miembro del público.

AudienceExclusionDurationMode

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

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

AudienceFilterClause

Es una cláusula para definir un filtro simple o de secuencia. Un filtro puede ser inclusivo (por ejemplo, los usuarios que satisfacen la cláusula del filtro se incluyen en el público) o exclusivo (por ejemplo, los usuarios que satisfacen la cláusula del 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 satisfacer para ser miembro del público.
sequenceFilter

object (AudienceSequenceFilter)

Son los filtros que deben ocurrir 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. Es una expresión lógica de los filtros de dimensión, métrica o evento del público.

AudienceFilterScope

Especifica cómo evaluar a los usuarios para que se unan a un público.

Enums
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 se cumple la condición del filtro para cualquier evento en cualquier sesión.

AudienceFilterExpression

Es una expresión lógica de los filtros de dimensión, métrica o evento del 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. Es la expresión que se aplica a un filtro. expr puede ser solo uno de los parámetros siguientes:
andGroup

object (AudienceFilterExpressionList)

Es una lista de expresiones que se deben unir con el operador AND. Solo puede contener AudienceFilterExpressions con orGroup. Este parámetro se debe establecer para el AudienceFilterExpression de nivel superior.
orGroup

object (AudienceFilterExpressionList)

Es una lista de expresiones que se combinan con el operador OR. No puede contener AudienceFilterExpressions con andGroup o orGroup.
notExpression

object (AudienceFilterExpression)

Es una expresión de filtro que se debe negar (por ejemplo, invertir o complementar). Solo puede incluir un dimensionOrMetricFilter. No se puede establecer en el AudienceFilterExpression de nivel superior.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

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

object (AudienceEventFilter)

Crea un filtro que coincida con un evento específico. No se puede establecer en el AudienceFilterExpression de nivel superior.

AudienceFilterExpressionList

Es una lista de expresiones de filtro de público.

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

object (AudienceFilterExpression)

Es 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 la métrica por la 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 la dimensión o métrica personalizada. 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 una evaluación dinámica. Si se establece como verdadero, los usuarios se unen al público si alguna vez cumplieron la condición (evaluación estática). Si no se establece o se establece como falso, la evaluación de usuarios para un público es dinámica: los usuarios se agregan a un público cuando cumplen las condiciones y, luego, se quitan cuando ya no las cumplen.

Solo se puede establecer cuando el alcance del público es ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opcional. Si se configura, 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 función de los datos de ciclo de vida (por ejemplo, una ventana de tiempo infinita).

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á configurado o es falso.

Solo se puede configurar cuando el alcance del público es ACROSS_ALL_SESSIONS y no puede ser superior a 60 días.
Campo de unión one_filter. Uno de los filtros anteriores one_filter puede ser solo uno de los parámetros siguientes:
stringFilter

object (StringFilter)

Es un filtro para una dimensión de tipo cadena que coincide con un patrón determinado.
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 en una dimensión o métrica.

StringFilter

Es un filtro para una dimensión de tipo cadena que coincide con un patrón determinado.

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

enum (MatchType)

Obligatorio. Es el tipo de concordancia para el filtro de cadena.
value

string

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

boolean

Opcional. Si es verdadero, la coincidencia distingue mayúsculas de minúsculas. Si es falso, la coincidencia no distingue entre mayúsculas y minúsculas.

MatchType

Es el tipo de concordancia para el filtro de cadena.

Enums
MATCH_TYPE_UNSPECIFIED Sin especificar
EXACT Es la coincidencia exacta del 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 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 cadena con los que se puede hacer coincidir. No debe estar vacío.
caseSensitive

boolean

Opcional. Si es verdadero, la coincidencia distingue mayúsculas de minúsculas. Si es falso, 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. Operación aplicada a un filtro numérico.
value

object (NumericValue)

Obligatorio. Es el valor numérico o de fecha con el que se debe hacer coincidir.

Operación

Operación aplicada a un filtro numérico.

Enums
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. Uno de los valores numéricos. one_value puede ser solo uno de los parámetros siguientes:
int64Value

string (int64 format)

Es un valor de número entero.
doubleValue

number

Es un 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, incluido.
toValue

object (NumericValue)

Obligatorio. Termina con este número, incluido.

AudienceEventFilter

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

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

string

Obligatorio. Inmutable. Nombre del evento con el que se debe coincidir.
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 solo andGroup de dimensionOrMetricFilter o notExpression. No se admiten los AND de OR. Además, si incluye un filtro para "eventCount", solo se tendrá en cuenta ese filtro y se ignorarán todos los demás.

AudienceSequenceFilter

Define los filtros que deben ocurrir 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 terminan en “s”. Ejemplo: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

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

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 evento inmediatamente posterior al 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 paso. Se ignora en el primer paso.
constraintDuration

string (Duration format)

Opcional. Cuando se establece, este paso debe cumplirse dentro de constraintDuration del paso anterior (por ejemplo, t[i] - t[i-1] <= constraintDuration). Si no se establece, no hay ningún requisito de duración (la duración es prácticamente ilimitada). Se ignora en 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. Es una expresión lógica de los filtros de dimensiones, métricas o eventos del público en cada paso.

AudienceClauseType

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

Enums
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Es un tipo de cláusula sin especificar.
INCLUDE Los usuarios se incluirán en el público si se cumple la cláusula del filtro.
EXCLUDE Los usuarios se excluirán del público si se cumple la cláusula del filtro.

Métodos

archive

 Archiva un público en una propiedad.

create

 Crea un objeto Audience.

get

 Es una búsqueda de un solo público.

list

 Enumera los públicos de una propiedad.

patch

 Actualiza un público en una propiedad.