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 cette 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 supérieure à 540 jours.

adsPersonalizationEnabled

boolean

Uniquement en sortie. Il est automatiquement défini sur GA sur "false" s'il s'agit d'une audience ANP et qu'il est exclu de la personnalisation des annonces.

eventTrigger

object (AudienceEventTrigger)

Facultatif. Spécifie un événement à enregistrer lorsqu'un utilisateur rejoint l'audience. Si ce champ n'est pas défini, aucun événement n'est consigné lorsqu'un utilisateur rejoint l'audience.

exclusionDurationMode

enum (AudienceExclusionDurationMode)

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

filterClauses[]

object (AudienceFilterClause)

Obligatoire. Immuable. Liste à puces. Filtrer les clauses définissant l'audience Toutes les clauses sont reliées par l'opérateur ET.

Déclencheur d'événement d'audience

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 consigner l'événement.

Condition de journalisation

Détermine quand consigner l'événement.

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 est rejoint.
AUDIENCE_MEMBERSHIP_RENEWED L'événement doit être consigné 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 de l'exclusion pour les utilisateurs correspondant au filtre d'exclusion.

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

Clause de filtrage d'audience

Clause permettant de définir un filtre simple ou de séquence. Un filtre peut être inclusif (par exemple, les utilisateurs qui respectent la clause de filtre sont inclus dans l'audience) ou exclusif (par exemple, les utilisateurs qui respectent 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 "Inclure" ou "Exclure".

Champ d'union filter.

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

simpleFilter

object (AudienceSimpleFilter)

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

sequenceFilter

object (AudienceSequenceFilter)

Filtres 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 ê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. Une expression logique de filtres de dimension, de métrique ou d'événement d'audience.

Champ d'application du filtre d'audience

Indique comment évaluer l'appartenance d'un utilisateur à une audience.

Enums
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Champ d'application non spécifié.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT L'utilisateur rejoint l'audience si la condition de filtre est remplie au cours d'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.

Expression de filtre d'audience

Une expression logique de 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 à associer par l'opérateur ET. Il ne peut contenir que des "AudienceFilterExpressions" avec orGroup. Ce champ doit être défini pour "AudienceFilterExpression" de premier niveau.

orGroup

object (AudienceFilterExpressionList)

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

notExpression

object (AudienceFilterExpression)

Expression de filtre à ne PAS inclure (par exemple, inversée, complétée). Il ne peut inclure qu'un dimensionOrOrFilter. Cette valeur ne peut pas être définie au niveau de l'élément "AudienceFilterExpression" de premier niveau.

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Un filtre sur une seule dimension ou métrique. Cette valeur ne peut pas être définie au niveau de l'élément "AudienceFilterExpression" de premier niveau.

eventFilter

object (AudienceEventFilter)

Crée un filtre correspondant à un événement spécifique. Cette valeur ne peut pas être définie au niveau de l'élément "AudienceFilterExpression" de premier niveau.

ListeExpressionExpressionFiltre

Liste d'expressions de filtre d'audience.

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

object (AudienceFilterExpression)

Liste d'expressions de filtre d'audience.

AudienceAudienceOrMetricFilter

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 champ d'application est 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 champ d'application 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 ce paramètre est défini sur "true", les utilisateurs rejoignent l'audience s'ils ont rempli la condition (évaluation statique). Si cette règle n'est pas configurée ou qu'elle est définie sur "False", l'évaluation par les utilisateurs est dynamique. Les utilisateurs sont ajoutés à une audience lorsqu'ils remplissent les conditions spécifiées et sont supprimés lorsqu'ils ne les remplissent plus.

Ce paramètre ne peut être défini que si le champ d'application de l'audience est ACROSS_ALL_SESSIONS.

inAnyNDayPeriod

integer

Facultatif. Si ce champ est défini, spécifie la période pour laquelle évaluer les données en nombre de jours. Si ce champ n'est pas défini, les données d'audience sont évaluées par rapport aux données permanentes (par exemple, la période est illimitée).

Par exemple, si elle est définie sur 1 jour, seules les données du jour sont évaluées. Le point de référence correspond au jour actuel où atanyPointInTime n'est pas défini ou est faux.

Il ne peut être défini que si le champ d'application de l'audience est 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 d'une dimension de type chaîne correspondant à un modèle particulier.

inListFilter

object (InListFilter)

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

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

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

Filtre de chaîne

Filtre d'une dimension de type chaîne correspondant à un modèle particulier.

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

enum (MatchType)

Obligatoire. Type de correspondance pour le 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 définie sur "false", la correspondance n'est pas sensible à la casse.

MatchType

Type de correspondance pour le 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 la chaîne.
FULL_REGEXP L'expression régulière complète correspond à la valeur de la chaîne.

Filtre InList

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

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

string

Obligatoire. Liste des valeurs de chaîne possibles. Ce champ est obligatoire.

caseSensitive

boolean

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

Filtre numérique

Filtre pour les valeurs numériques ou de date sur une dimension ou 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.

Operations

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

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. 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.

Filtre de filtre

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.

Filtre d'événement d'audience

Filtre correspondant 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 correspondant à 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 de l'événement unique et aux expressions de filtre de paramètres. Impossible de définir "AudienceEventFilter" dans l'expression de filtre de paramètre (par exemple, les filtres d'événement imbriqués ne sont pas acceptés). Il doit s'agir d'un seul et unique groupe de dimensionOrMetricFilter ou notExpression. Les opérateurs AND ou OR ne sont pas acceptés. De plus, si elle inclut un filtre pour "eventCount", seul celui-ci sera pris en compte. Tous les autres filtres seront ignorés.

Filtre de séquence d'audience

Définit les filtres qui doivent se produire dans un ordre spécifique pour que les utilisateurs soient membres 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 pendant laquelle toute la séquence doit se produire.

Durée en secondes avec neuf chiffres au maximum, finissant par "s". Exemple: "3.5s".

sequenceSteps[]

object (AudienceSequenceStep)

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

Étape de l'audience

Une 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 définie sur "true", l'événement satisfaisant à cette étape doit être le tout suivant après celui de la dernière étape. Si cette règle n'est pas configurée ou qu'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 remplie dans les limites de la durée de l'étape précédente (par exemple, t[i] - t[i-1] <= contrainteDuration). Si elle n'est pas définie, aucune durée n'est requise (la durée est illimitée). Il est ignoré pour la première étape.

Durée en secondes avec neuf chiffres au maximum, finissant par "s". Exemple: "3.5s".

filterExpression

object (AudienceFilterExpression)

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

Type de clause d'audience

Indique s'il s'agit d'une clause de filtre "Inclure" ou "Exclure".

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 sur une propriété.

create

crée une audience ;

get

Recherchez une seule audience.

list

Liste les audiences d'une propriété.

patch

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