REST Resource: properties.audiences

Ressource: Audience

Message de ressource représentant une audience GA4.

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

string

Uniquement en sortie. Nom de la ressource d'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 être définie sur plus de 540 jours.

adsPersonalizationEnabled

boolean

Uniquement en sortie. Elle est automatiquement définie par GA sur "false" s'il s'agit d'une audience ANP et si elle est exclue de la personnalisation des annonces.

eventTrigger

object (AudienceEventTrigger)

Facultatif. Spécifie un événement à consigner lorsqu'un utilisateur rejoint l'audience. Si cette règle n'est pas configurée, aucun événement n'est enregistré lorsqu'un utilisateur rejoint l'audience.

exclusionDurationMode

enum (AudienceExclusionDurationMode)

Immuable. Indique la durée d'une exclusion pour les utilisateurs correspondant au filtre d'exclusion. Elle est appliquée à toutes les clauses de filtre EXCLURE et est ignorée si aucune clause de filtre EXCLURE n'existe dans l'audience.

filterClauses[]

object (AudienceFilterClause)

Obligatoire. Immuable. Liste à puces. Clauses de filtre qui définissent l'audience. Toutes les clauses doivent être reliées par l'opérateur AND.

AudienceEventTrigger

Spécifie un événement à consigner 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 consigné.

logCondition

enum (LogCondition)

Obligatoire. Quand consigner l'événement

LogCondition

Détermine à quel moment 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 enregistré que lorsqu'un utilisateur rejoint l'appel.
AUDIENCE_MEMBERSHIP_RENEWED L'événement doit être enregistré chaque fois que la condition de l'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 correspondant au filtre d'exclusion.

Enums
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Non spécifié.
EXCLUDE_TEMPORARILY Exclure des utilisateurs de l'audience pendant les périodes où ils répondent à 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 un filtre 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 exclusifs (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)

Un filtre simple qu'un utilisateur doit satisfaire pour faire partie de l'audience.

sequenceFilter

object (AudienceSequenceFilter)

Filtres qui doivent apparaître dans un ordre spécifique pour que l'utilisateur soit membre de l'audience.

AudienceSimpleFilter

Définit un filtre simple qu'un utilisateur doit satisfaire pour faire partie de l'audience.

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

enum (AudienceFilterScope)

Obligatoire. Immuable. Spécifie la portée de ce filtre.

filterExpression

object (AudienceFilterExpression)

Obligatoire. Immuable. Expression logique des filtres de dimensions, de métriques ou d'événements d'audience.

AudienceFilterScope

Indique comment évaluer les utilisateurs susceptibles de rejoindre 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 de 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 au cours d'une session.

AudienceFilterExpression

Expression logique des filtres de dimensions, de métriques ou d'événements 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 à associer avec l'opérateur AND. Il ne peut contenir que des AudienceFilterExpressions avec orGroup. Doit être défini pour l'AudienceFilterExpression de premier niveau.

orGroup

object (AudienceFilterExpressionList)

Liste d'expressions auxquelles les opérateurs OR sont associés. Il ne peut pas contenir d'AudienceFilterExpressions avec andGroup ou orGroup.

notExpression

object (AudienceFilterExpression)

Expression de filtre à NE PAS AJOUTER (par exemple, inversée ou complétée). Il ne peut inclure qu'un élément dimensionOrMetricFilter. Impossible de définir cet élément au niveau "AudienceFilterExpression" de niveau supérieur.

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Filtre sur une seule dimension ou métrique. Impossible de définir cet élément au niveau "AudienceFilterExpression" de niveau supérieur.

eventFilter

object (AudienceEventFilter)

Crée un filtre qui correspond à un événement spécifique. Impossible de définir cet élément au niveau "AudienceFilterExpression" de niveau supérieur.

AudienceFilterExpressionList

Liste d'expressions de filtre d'audience.

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

object (AudienceFilterExpression)

Liste d'expressions de filtre d'audience.

AudienceDimensionOrMetricFilter

Un 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 sur 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 elle est définie sur "True", les utilisateurs rejoignent l'audience s'ils ont déjà rempli la condition (évaluation statique). Si cette règle n'est pas configurée ou si elle est définie sur "False", l'évaluation par les utilisateurs pour une audience est dynamique. Les utilisateurs sont ajoutés à une audience lorsqu'ils remplissent les conditions, puis sont supprimés lorsqu'ils ne les remplissent plus.

Vous ne pouvez définir ce paramètre que si la portée de l'audience est ACROSS_ALL_SESSIONS.

inAnyNDayPeriod

integer

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

Par exemple, si la valeur est "1 jour", seules les données du jour en cours sont évaluées. Le point de référence correspond au jour actuel quand atAnyPointInTime n'est pas défini ou est "false".

Elle ne peut être définie que si la portée de l'audience est ACROSS_ALL_SESSIONS et ne peut pas être supérieure à 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 d'une dimension de type chaîne correspondant à une règle particulière.

inListFilter

object (InListFilter)

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

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

Il s'agit d'un filtre pour les valeurs numériques ou de date entre certaines valeurs d'une dimension ou d'une métrique.

StringFilter

Filtre d'une dimension de type chaîne correspondant à une règle particulière.

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 à mettre en correspondance.

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ée
EXACT Correspondance exacte de la valeur de la chaîne.
BEGINS_WITH Commence par la valeur de la chaîne.
ENDS_WITH Se termine par la valeur de la chaîne.
CONTAINS Contient la valeur de la chaîne.
FULL_REGEXP L'expression régulière complète correspond à la valeur de la chaîne.

InListFilter

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

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

string

Obligatoire. Liste des valeurs de chaîne pouvant être mises en correspondance. Ce champ 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 à mettre en correspondance.

Opération

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

Enums
OPERATION_UNSPECIFIED URL indéterminée.
EQUAL Égal.
LESS_THAN Inférieur à
GREATER_THAN Supérieur à

NumericValue

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. Il peut s'agir d'une 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

Il s'agit d'un filtre pour les valeurs numériques ou de date 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

Un 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 correspond à la fois au nom de l'événement unique et aux expressions de filtre des paramètres 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. S'il est spécifié, ce filtre met en correspondance les événements qui correspondent à la fois au nom de l'événement unique et aux expressions de filtre des paramètres. Impossible de définir AudienceEventFilter dans l'expression de filtre des paramètres (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 notExpression. Les opérateurs AND des OR ne sont pas acceptés. De plus, s'il inclut un filtre "eventCount", seul celui-ci sera pris en compte. Tous les autres filtres seront ignorés.

AudienceSequenceFilter

Définit les filtres qui doivent apparaître 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 la portée de ce filtre.

sequenceMaximumDuration

string (Duration format)

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

Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par "s". Exemple: "3.5s".

sequenceSteps[]

object (AudienceSequenceStep)

Obligatoire. Séquence ordonnée d'étapes. L'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 l'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 le tout suivant après que celui-ci a satisfait à la dernière étape. Si elle n'est pas définie ou si elle est définie sur "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 cette étape. 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 contrainteDuration de l'étape précédente (par exemple, t[i] - t[i-1] <= constraintsDuration). Si cette règle n'est pas configurée, aucune durée n'est requise (elle est en réalité illimitée). Il est ignoré pour la première étape.

Durée en secondes avec un maximum de neuf chiffres après la virgule, 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 "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 remplie.
EXCLUDE Les utilisateurs seront exclus de l'audience si la clause de filtre est remplie.

Méthodes

archive

Archive une audience sur une propriété.

create

Crée une audience.

get

Recherche pour une audience unique.

list

Liste les audiences d'une propriété.

patch

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