REST Resource: properties.audiences

Ressource : Audience

Message de ressource représentant une audience.

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

string

Uniquement en sortie. Nom de ressource de cette ressource Audience. Format : properties/{propertyId}/audiences/{audienceId}
displayName

string

Obligatoire. Nom à afficher de l'audience.
description

string

Obligatoire. Description de l'audience.
membershipDurationDays

integer

Obligatoire. Immuable. Durée pendant laquelle un utilisateur doit rester dans une audience. Elle ne peut pas dépasser 540 jours.
adsPersonalizationEnabled

boolean

Uniquement en sortie. GA le définit automatiquement sur "false" s'il s'agit d'une audience ANP et qu'elle est exclue de la personnalisation des annonces.
eventTrigger

object (AudienceEventTrigger)

Facultatif. Spécifie un événement à enregistrer lorsqu'un utilisateur rejoint l'audience. Si aucune valeur n'est définie, aucun événement n'est consigné lorsqu'un utilisateur rejoint l'audience.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Immuable. Indique la durée d'une exclusion pour les utilisateurs qui correspondent au filtre d'exclusion. Il s'applique à toutes les clauses de filtre EXCLUDE et est ignoré lorsqu'il n'y a pas de clause de filtre EXCLUDE dans l'audience.
filterClauses[]

object (AudienceFilterClause)

Obligatoire. Immuable. Liste non triée. Clauses de filtre qui définissent l'audience. Toutes les clauses seront combinées avec l'opérateur AND.
createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle l'audience a été créée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

Spécifie un événement à enregistrer lorsqu'un utilisateur rejoint l'audience.

Représentation JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Champs
eventName

string

Obligatoire. Nom de l'événement qui sera enregistré.
logCondition

enum (LogCondition)

Obligatoire. Quand enregistrer l'événement.

LogCondition

Détermine le moment où l'événement doit être consigné.

Enums
LOG_CONDITION_UNSPECIFIED La condition de journal n'est pas spécifiée.
AUDIENCE_JOINED L'événement ne doit être consigné que lorsqu'un utilisateur rejoint la réunion.
AUDIENCE_MEMBERSHIP_RENEWED L'événement doit être enregistré chaque fois que la condition d'audience est remplie, même si l'utilisateur est déjà membre de l'audience.

AudienceExclusionDurationMode

Indique la durée d'une exclusion pour les utilisateurs qui correspondent au filtre d'exclusion.

Enums
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Non spécifié.
EXCLUDE_TEMPORARILY Excluez les utilisateurs de l'audience au cours des périodes où ils remplissent la clause de filtre.
EXCLUDE_PERMANENTLY Excluez les utilisateurs de l'audience s'ils ont déjà rempli la clause de filtre.

AudienceFilterClause

Clause permettant de définir un filtre simple ou de séquence. Un filtre peut être inclusif (par exemple, les utilisateurs qui répondent à la clause de filtre sont inclus dans l'audience) ou exclusif (par exemple, les utilisateurs qui répondent à la clause de filtre sont exclus de l'audience).

Représentation 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.
}
Champs
clauseType

enum (AudienceClauseType)

Obligatoire. Indique s'il s'agit d'une clause de filtre d'inclusion ou d'exclusion.

Champ d'union filter.

filter ne peut être qu'un des éléments suivants :
simpleFilter

object (AudienceSimpleFilter)

Filtre simple qu'un utilisateur doit remplir pour être membre de l'audience.
sequenceFilter

object (AudienceSequenceFilter)

Filtres qui doivent se produire dans un ordre spécifique pour que l'utilisateur soit membre de l'audience.

AudienceSimpleFilter

Définit un filtre simple qu'un utilisateur doit remplir pour être membre de l'audience.

Représentation JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Champs
scope

enum (AudienceFilterScope)

Obligatoire. Immuable. Spécifie le champ d'application de ce filtre.
filterExpression

object (AudienceFilterExpression)

Obligatoire. Immuable. Expression logique des filtres de dimension, de métrique ou d'événement d'audience.

AudienceFilterScope

Indique comment évaluer les utilisateurs pour qu'ils rejoignent une audience.

Enums
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Le champ d'application n'est pas spécifié.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT L'utilisateur rejoint l'audience si la condition de filtre est remplie dans un événement.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION L'utilisateur rejoint l'audience si la condition du filtre est remplie au cours d'une session.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS L'utilisateur rejoint l'audience si la condition de filtre est remplie par un événement dans n'importe quelle session.

AudienceFilterExpression

Expression logique des filtres de dimension, de métrique ou d'événement d'audience.

Représentation 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.
}
Champs
Champ d'union expr. Expression appliquée à un filtre. expr ne peut être qu'un des éléments suivants :
andGroup

object (AudienceFilterExpressionList)

Liste d'expressions à combiner avec un opérateur AND. Il ne peut contenir que des AudienceFilterExpressions avec orGroup. Cette valeur doit être définie pour AudienceFilterExpression de premier niveau.
orGroup

object (AudienceFilterExpressionList)

Liste d'expressions à combiner avec l'opérateur OR. Il ne peut pas contenir d'expressions AudienceFilter avec andGroup ou orGroup.
notExpression

object (AudienceFilterExpression)

Expression de filtre à inverser (par exemple, inversée ou complémentée). Il ne peut inclure qu'un dimensionOrMetricFilter. Ce paramètre ne peut pas être défini sur AudienceFilterExpression de premier niveau.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Filtre appliqué à une seule dimension ou métrique. Ce paramètre ne peut pas être défini sur AudienceFilterExpression de premier niveau.
eventFilter

object (AudienceEventFilter)

Crée un filtre qui correspond à un événement spécifique. Ce paramètre ne peut pas être défini sur AudienceFilterExpression de premier niveau.

AudienceFilterExpressionList

Liste des expressions de filtre d'audience.

Représentation JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Champs
filterExpressions[]

object (AudienceFilterExpression)

Liste des expressions de filtre d'audience.

AudienceDimensionOrMetricFilter

Filtre spécifique pour une seule dimension ou métrique.

Représentation 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.
}
Champs
fieldName

string

Obligatoire. Immuable. Nom de la dimension ou de la métrique à filtrer. Si le nom du champ fait référence à une dimension ou une métrique personnalisée, un préfixe de portée sera ajouté au début du nom de la dimension ou de la métrique personnalisée. Pour en savoir plus sur les préfixes de portée ou les dimensions/métriques personnalisées, consultez la documentation de l'API Google Analytics Data.
atAnyPointInTime

boolean

Facultatif. Indique si ce filtre nécessite une évaluation dynamique ou non. Si la valeur est définie sur "true", les utilisateurs rejoignent l'audience s'ils ont déjà rempli la condition (évaluation statique). Si cette option n'est pas définie ou est définie sur "false", l'évaluation des utilisateurs pour une audience est dynamique. Les utilisateurs sont ajoutés à une audience lorsqu'ils remplissent les conditions spécifiées et sont supprimés lorsqu'ils n'y répondent plus.

Cette valeur ne peut être définie que lorsque le champ "Portée de l'audience" est défini sur ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Facultatif. Si cette option est définie, elle spécifie la période pour laquelle évaluer les données (en nombre de jours). Si elle n'est pas définie, les données d'audience sont évaluées par rapport aux données de durée de vie (par exemple, une période infinie).

Par exemple, si vous définissez la période sur un jour, seules les données du jour actuel sont évaluées. Le point de référence est le jour actuel lorsque atAnyPointInTime n'est pas défini ou est défini sur "false".

Elle ne peut être définie que lorsque le champ "Portée de l'audience" est défini sur ACROSS_ALL_SESSIONS et ne peut pas dépasser 60 jours.
Champ d'union one_filter. L'un des filtres ci-dessus. one_filter ne peut être qu'un des éléments suivants :
stringFilter

object (StringFilter)

Filtre pour une dimension de type chaîne qui correspond à un modèle particulier.
inListFilter

object (InListFilter)

Filtre pour une dimension de chaîne correspondant à une liste d'options spécifiques.
numericFilter

object (NumericFilter)

Filtre pour les valeurs numériques ou de date d'une dimension ou d'une métrique.
betweenFilter

object (BetweenFilter)

Filtre pour les valeurs numériques ou de date comprises entre certaines valeurs d'une dimension ou d'une métrique.

StringFilter

Filtre pour une dimension de type chaîne qui correspond à un modèle particulier.

Représentation JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Champs
matchType

enum (MatchType)

Obligatoire. Type de correspondance du filtre de chaîne.
value

string

Obligatoire. Valeur de chaîne à comparer.
caseSensitive

boolean

Facultatif. Si la valeur est "true", la correspondance est sensible à la casse. Si la valeur est "false", la correspondance n'est pas sensible à la casse.

MatchType

Type de correspondance du filtre de chaîne.

Enums
MATCH_TYPE_UNSPECIFIED Non spécifié
EXACT Correspondance exacte de la valeur de la chaîne.
BEGINS_WITH Commence par la valeur de chaîne.
ENDS_WITH Se termine par la valeur de la chaîne.
CONTAINS Contient la valeur de chaîne.
FULL_REGEXP L'expression régulière correspond à la totalité de la valeur de chaîne.

InListFilter

Filtre pour une dimension de chaîne correspondant à une liste d'options spécifiques.

Représentation JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Champs
values[]

string

Obligatoire. Liste des valeurs de chaîne possibles à mettre en correspondance. Ne doit pas être vide.
caseSensitive

boolean

Facultatif. Si la valeur est "true", la correspondance est sensible à la casse. Si la valeur est "false", la correspondance n'est pas sensible à la casse.

NumericFilter

Filtre pour les valeurs numériques ou de date d'une dimension ou d'une métrique.

Représentation JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Champs
operation

enum (Operation)

Obligatoire. Opération appliquée à un filtre numérique.
value

object (NumericValue)

Obligatoire. Valeur numérique ou de date à faire correspondre.

Opération

Opération appliquée à un filtre numérique.

Enums
OPERATION_UNSPECIFIED Non spécifié.
EQUAL Égal.
LESS_THAN Inférieur à
GREATER_THAN Supérieur à

NumericValue

Pour représenter un nombre.

Représentation 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.
}
Champs
Champ d'union one_value. Valeur numérique. one_value ne peut être qu'un des éléments suivants :
int64Value

string (int64 format)

Valeur de nombre entier ("int").
doubleValue

number

Valeur double.

BetweenFilter

Filtre pour les valeurs numériques ou de date comprises entre certaines valeurs d'une dimension ou d'une métrique.

Représentation JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Champs
fromValue

object (NumericValue)

Obligatoire. Commence par ce nombre (inclus).
toValue

object (NumericValue)

Obligatoire. Se termine par ce nombre (inclus).

AudienceEventFilter

Filtre qui correspond aux événements d'un seul nom d'événement. Si un paramètre d'événement est spécifié, seul le sous-ensemble d'événements qui correspondent à la fois au nom d'événement unique et aux expressions de filtre de paramètre correspond à ce filtre d'événement.

Représentation JSON 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Champs
eventName

string

Obligatoire. Immuable. Nom de l'événement à mettre en correspondance.
eventParameterFilterExpression

object (AudienceFilterExpression)

Facultatif. Si ce filtre est spécifié, il correspond aux événements qui correspondent à la fois au nom d'événement unique et aux expressions de filtre de paramètre. AudienceEventFilter ne peut pas être défini dans l'expression de filtre de paramètre (par exemple, les filtres d'événements imbriqués ne sont pas acceptés). Il doit s'agir d'un seul andGroup de dimensionOrMetricFilter ou d'une notExpression. Les AND de OR ne sont pas acceptés. De plus, s'il inclut un filtre pour "eventCount", seul celui-ci sera pris en compte. Tous les autres filtres seront ignorés.

AudienceSequenceFilter

Définit les filtres qui doivent se produire dans un ordre spécifique pour que l'utilisateur soit membre de l'audience.

Représentation JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Champs
scope

enum (AudienceFilterScope)

Obligatoire. Immuable. Spécifie le champ d'application de ce filtre.
sequenceMaximumDuration

string (Duration format)

Facultatif. Définit la période au cours de laquelle toute la séquence doit se dérouler.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
sequenceSteps[]

object (AudienceSequenceStep)

Obligatoire. Séquence ordonnée d'étapes. Un utilisateur doit effectuer chaque étape pour rejoindre le filtre de séquence.

AudienceSequenceStep

Condition qui doit se produire dans l'ordre des étapes spécifié pour que cet utilisateur corresponde à la séquence.

Représentation JSON 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Champs
scope

enum (AudienceFilterScope)

Obligatoire. Immuable. Spécifie le champ d'application de cette étape.
immediatelyFollows

boolean

Facultatif. Si la valeur est "true", l'événement correspondant à cette étape doit être l'événement suivant immédiatement après celui correspondant à l'étape précédente. Si la valeur n'est pas définie ou est "false", cette étape suit indirectement l'étape précédente. Par exemple, il peut y avoir des événements entre l'étape précédente et celle-ci. Il est ignoré pour la première étape.
constraintDuration

string (Duration format)

Facultatif. Lorsqu'elle est définie, cette étape doit être satisfaite dans la constraintDuration de l'étape précédente (par exemple, t[i] - t[i-1] <= constraintDuration). Si elle n'est pas définie, aucune durée n'est requise (la durée est en fait illimitée). Il est ignoré pour la première étape.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
filterExpression

object (AudienceFilterExpression)

Obligatoire. Immuable. Expression logique des filtres de dimension, de métrique ou d'événement d'audience à chaque étape.

AudienceClauseType

Indique s'il s'agit d'une clause de filtre d'inclusion ou d'exclusion.

Enums
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Type de clause non spécifié.
INCLUDE Les utilisateurs seront inclus dans l'audience si la clause de filtre est respectée.
EXCLUDE Les utilisateurs seront exclus de l'audience si la clause de filtre est respectée.

Méthodes

archive

 Archive une audience dans une propriété.

create

 Crée une audience.

get

 Rechercher une seule audience.

list

 Liste les audiences d'une propriété.

patch

 Met à jour une audience dans une propriété.