REST Resource: properties.audiences

Risorsa: pubblico

Un messaggio della risorsa che rappresenta un segmento di pubblico GA4.

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

string

Solo output. Il nome di questa risorsa pubblico. Formato: Properties/{propertyId}/audiences/{audienceId}
displayName

string

Obbligatoria. Il nome visualizzato del segmento di pubblico.
description

string

Obbligatoria. La descrizione del segmento di pubblico.
membershipDurationDays

integer

Obbligatoria. Immutabile. La durata della permanenza di un utente in un segmento di pubblico. Non può essere impostato su un valore superiore a 540 giorni.
adsPersonalizationEnabled

boolean

Solo output. Viene impostato automaticamente da GA su false se si tratta di un segmento di pubblico ANP ed è escluso dalla personalizzazione degli annunci.
eventTrigger

object (AudienceEventTrigger)

Campo facoltativo. Specifica un evento da registrare quando un utente entra nel segmento di pubblico. Se non viene configurato, non viene registrato alcun evento quando un utente entra a far parte del segmento di pubblico.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Immutabile. Specifica la durata di un'esclusione per gli utenti che soddisfano il filtro di esclusione. Viene applicato a tutte le clausole di filtro EXCLUDE e viene ignorato quando non è presente alcuna clausola di filtro EXCLUDE nel segmento di pubblico.
filterClauses[]

object (AudienceFilterClause)

Obbligatoria. Immutabile. Elenco non ordinato. Clausole di filtro che definiscono il segmento di pubblico. Tutte le clausole saranno unite insieme.

AudienceEventTrigger

Specifica un evento da registrare quando un utente entra nel segmento di pubblico.

Rappresentazione JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Campi
eventName

string

Obbligatoria. Il nome dell'evento che verrà registrato.
logCondition

enum (LogCondition)

Obbligatoria. Quando registrare l'evento.

LogCondition

Determina quando registrare l'evento.

Enum
LOG_CONDITION_UNSPECIFIED Condizione di log non specificata.
AUDIENCE_JOINED L'evento deve essere registrato solo quando un utente partecipa.
AUDIENCE_MEMBERSHIP_RENEWED L'evento deve essere registrato ogni volta che la condizione del segmento di pubblico è soddisfatta, anche se l'utente è già membro del segmento di pubblico.

AudienceExclusionDurationMode

Specifica la durata di un'esclusione per gli utenti che soddisfano il filtro di esclusione.

Enum
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Non specificato.
EXCLUDE_TEMPORARILY Escludi gli utenti dal segmento di pubblico durante i periodi in cui soddisfano la clausola del filtro.
EXCLUDE_PERMANENTLY Escludi dal segmento di pubblico gli utenti che hanno soddisfatto la clausola di filtro.

AudienceFilterClause

Una clausola per definire un filtro semplice o in sequenza. Un filtro può essere inclusivo (ad esempio, gli utenti che soddisfano la clausola di filtro sono inclusi nel segmento di pubblico) o esclusivo (ad esempio, gli utenti che soddisfano la clausola di filtro vengono esclusi dal segmento di pubblico).

Rappresentazione 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.
}
Campi
clauseType

enum (AudienceClauseType)

Obbligatoria. Specifica se si tratta di una clausola di filtro di inclusione o esclusione.

Campo di unione filter.

filter può essere solo uno dei seguenti:
simpleFilter

object (AudienceSimpleFilter)

Un semplice filtro che un utente deve soddisfare per diventare membro del segmento di pubblico.
sequenceFilter

object (AudienceSequenceFilter)

Filtri che devono essere applicati in un ordine specifico affinché l'utente diventi membro del segmento di pubblico.

AudienceSimpleFilter

Definisce un semplice filtro che un utente deve soddisfare per diventare membro del segmento di pubblico.

Rappresentazione JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Campi
scope

enum (AudienceFilterScope)

Obbligatoria. Immutabile. Specifica l'ambito di questo filtro.
filterExpression

object (AudienceFilterExpression)

Obbligatoria. Immutabile. Un'espressione logica di filtri di eventi, metriche o dimensioni Pubblico.

AudienceFilterScope

Consente di specificare come valutare gli utenti per partecipare a un segmento di pubblico.

Enum
AUDIENCE_FILTER_SCOPE_UNSPECIFIED L'ambito non è specificato.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT L'utente entra nel segmento di pubblico se la condizione del filtro è soddisfatta in un singolo evento.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION L'utente entra nel segmento di pubblico se la condizione del filtro è soddisfatta in una sessione.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS L'utente entra nel segmento di pubblico se la condizione del filtro è soddisfatta da un evento in una sessione.

AudienceFilterExpression

Un'espressione logica di filtri di eventi, metriche o dimensioni Pubblico.

Rappresentazione 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.
}
Campi
Campo di unione expr. L'espressione applicata a un filtro. expr può essere solo uno dei seguenti:
andGroup

object (AudienceFilterExpressionList)

Un elenco di espressioni da unire con una relazione AND. Può contenere solo AudienceFilterExpressions con orGroup. Deve essere impostato per AudienceFilterExpression di primo livello.
orGroup

object (AudienceFilterExpressionList)

Un elenco di espressioni da combinare con l'operatore OR. Non può contenere AudienceFilterExpressions con andGroup o orGroup.
notExpression

object (AudienceFilterExpression)

Un'espressione di filtro da NOTARE (ad esempio invertito, completato). Può includere solo un valore dimensionOrMetricFilter. Questa opzione non può essere impostata nel livello di primo livello di AudienceFilterExpression.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Un filtro su una singola dimensione o metrica. Questa opzione non può essere impostata nel livello di primo livello di AudienceFilterExpression.
eventFilter

object (AudienceEventFilter)

Crea un filtro che corrisponde a un evento specifico. Questa opzione non può essere impostata nel livello di primo livello di AudienceFilterExpression.

AudienceFilterExpressionList

Un elenco di espressioni di filtro del pubblico.

Rappresentazione JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Campi
filterExpressions[]

object (AudienceFilterExpression)

Un elenco di espressioni di filtro del pubblico.

AudienceDimensionOrMetricFilter

Un filtro specifico per una singola dimensione o metrica.

Rappresentazione 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.
}
Campi
fieldName

string

Obbligatoria. Immutabile. Il nome della dimensione o della metrica da filtrare. Se il nome del campo fa riferimento a una dimensione o a una metrica personalizzata, verrà aggiunto un prefisso dell'ambito alla parte anteriore del nome delle dimensioni o della metrica personalizzate. Per saperne di più sui prefissi degli ambiti o sulle dimensioni/metriche personalizzate, consulta la documentazione relativa all'API di dati di Google Analytics.
atAnyPointInTime

boolean

Campo facoltativo. Indica se questo filtro richiede o meno una valutazione dinamica. Se è impostato su true, gli utenti entrano a far parte del segmento di pubblico se hanno soddisfatto la condizione almeno una volta (valutazione statica). Se il criterio non viene configurato o se viene impostato su false, la valutazione degli utenti per un segmento di pubblico è dinamica; gli utenti vengono aggiunti a un segmento di pubblico quando soddisfano le condizioni e poi rimossi quando non le soddisfano più.

Può essere impostato solo quando l'ambito del pubblico è ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Campo facoltativo. Se impostato, specifica la finestra temporale per la valutazione dei dati, espressa in giorni. Se il criterio non viene configurato, i dati sul pubblico vengono valutati in base a dati relativi all'intero lifetime, ad esempio un periodo di tempo infinito.

Ad esempio, se è impostata su 1 giorno, vengono valutati solo i dati del giorno corrente. Il punto di riferimento è il giorno corrente in cui atAnyPointInTime non è impostato o è false.

Può essere impostato solo quando l'ambito del pubblico è ACROSS_ALL_SESSIONS e non può essere superiore a 60 giorni.
Campo di unione one_filter. Uno dei filtri precedenti. one_filter può essere solo uno dei seguenti:
stringFilter

object (StringFilter)

Un filtro per una dimensione di tipo stringa che corrisponde a un determinato pattern.
inListFilter

object (InListFilter)

Un filtro per una dimensione stringa che corrisponde a un determinato elenco di opzioni.
numericFilter

object (NumericFilter)

Un filtro per i valori numerici o di data in una dimensione o una metrica.
betweenFilter

object (BetweenFilter)

Un filtro per i valori numerici o di data tra determinati valori di una dimensione o una metrica.

StringFilter

Un filtro per una dimensione di tipo stringa che corrisponde a un determinato pattern.

Rappresentazione JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Campi
matchType

enum (MatchType)

Obbligatoria. Il tipo di corrispondenza per il filtro stringa.
value

string

Obbligatoria. Il valore della stringa di cui trovare una corrispondenza.
caseSensitive

boolean

Campo facoltativo. Se true, la corrispondenza è sensibile alle maiuscole. Se il valore è false, la corrispondenza non fa distinzione tra maiuscole e minuscole.

MatchType

Il tipo di corrispondenza per il filtro stringa.

Enum
MATCH_TYPE_UNSPECIFIED Non specificato
EXACT Corrispondenza esatta del valore della stringa.
BEGINS_WITH Inizia con il valore stringa.
ENDS_WITH Finisce con il valore stringa.
CONTAINS Contiene il valore della stringa.
FULL_REGEXP L'espressione regolare completa corrisponde al valore della stringa.

InListFilter

Un filtro per una dimensione stringa che corrisponde a un determinato elenco di opzioni.

Rappresentazione JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Campi
values[]

string

Obbligatoria. L'elenco di possibili valori di stringa con cui effettuare una corrispondenza. Il campo non deve essere vuoto.
caseSensitive

boolean

Campo facoltativo. Se true, la corrispondenza è sensibile alle maiuscole. Se il valore è false, la corrispondenza non fa distinzione tra maiuscole e minuscole.

NumericFilter

Un filtro per i valori numerici o di data in una dimensione o una metrica.

Rappresentazione JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Campi
operation

enum (Operation)

Obbligatoria. L'operazione applicata a un filtro numerico.
value

object (NumericValue)

Obbligatoria. Il valore numerico o di data da confrontare.

Operazione

L'operazione applicata a un filtro numerico.

Enum
OPERATION_UNSPECIFIED Non specificato.
EQUAL Uguale.
LESS_THAN Minore di.
GREATER_THAN Maggiore di.

NumericValue

Per rappresentare un numero.

Rappresentazione 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.
}
Campi
Campo di unione one_value. Uno di un valore numerico. one_value può essere solo uno dei seguenti:
int64Value

string (int64 format)

Valore intero.
doubleValue

number

Valore doppio.

BetweenFilter

Un filtro per i valori numerici o di data tra determinati valori di una dimensione o una metrica.

Rappresentazione JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Campi
fromValue

object (NumericValue)

Obbligatoria. Inizia con questo numero incluso.
toValue

object (NumericValue)

Obbligatoria. Termina con questo numero, incluso.

AudienceEventFilter

Un filtro che associa gli eventi di un singolo nome di evento. Se viene specificato un parametro evento, solo il sottoinsieme di eventi che corrispondono sia al nome del singolo evento sia alle espressioni di filtro dei parametri corrispondono a questo filtro eventi.

Rappresentazione JSON 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Campi
eventName

string

Obbligatoria. Immutabile. Il nome dell'evento con cui stabilire una corrispondenza.
eventParameterFilterExpression

object (AudienceFilterExpression)

Campo facoltativo. Se specificato, questo filtro crea corrispondenze per gli eventi che corrispondono sia al nome del singolo evento sia alle espressioni di filtro dei parametri. Impossibile impostare AudienceEventFilter all'interno dell'espressione di filtro del parametro (ad esempio, i filtri di eventi nidificati non sono supportati). Deve essere un singolo andGroup of dimensionOrMetricFilter o notExpression; gli AND di OR non sono supportati. Inoltre, se include un filtro per "eventCount", verrà preso in considerazione solo quello, mentre tutti gli altri filtri verranno ignorati.

AudienceSequenceFilter

Definisce i filtri che devono essere applicati in un ordine specifico affinché l'utente possa essere membro del segmento di pubblico.

Rappresentazione JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Campi
scope

enum (AudienceFilterScope)

Obbligatoria. Immutabile. Specifica l'ambito di questo filtro.
sequenceMaximumDuration

string (Duration format)

Campo facoltativo. Definisce il periodo di tempo in cui deve verificarsi l'intera sequenza.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Obbligatoria. Una sequenza ordinata di passaggi. Un utente deve completare ogni passaggio per unirsi al filtro della sequenza.

AudienceSequenceStep

Una condizione che deve verificarsi nell'ordine dei passaggi specificato affinché l'utente corrisponda alla sequenza.

Rappresentazione JSON 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Campi
scope

enum (AudienceFilterScope)

Obbligatoria. Immutabile. Specifica l'ambito di questo passaggio.
immediatelyFollows

boolean

Campo facoltativo. Se il valore è true, l'evento che soddisfa questo passaggio deve essere l'evento immediatamente successivo che soddisfa l'ultimo passaggio. Se il criterio non viene configurato o se viene impostato su false, questo passaggio segue indirettamente quello precedente; ad esempio, potrebbero verificarsi eventi tra il passaggio precedente e questo. Viene ignorato nel primo passaggio.
constraintDuration

string (Duration format)

Campo facoltativo. Se impostato, questo passaggio deve essere soddisfatto entro il vincoloDurata del passaggio precedente (ad esempio, t[i] - t[i-1] <= vincoloDuration). Se non viene configurato, non è prevista alcuna durata (la durata è effettivamente illimitata). Viene ignorato nel primo passaggio.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
filterExpression

object (AudienceFilterExpression)

Obbligatoria. Immutabile. Un'espressione logica di filtri eventi, metriche o dimensioni Pubblico in ogni passaggio.

AudienceClauseType

Specifica se si tratta di una clausola di filtro di inclusione o esclusione.

Enum
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Tipo di clausola non specificato.
INCLUDE Gli utenti verranno inclusi nel segmento di pubblico se viene soddisfatta la clausola del filtro.
EXCLUDE Gli utenti verranno esclusi dal segmento di pubblico se viene soddisfatta la clausola del filtro.

Metodi

archive

 Archivia un segmento di pubblico su una proprietà.

create

 Crea un segmento di pubblico.

get

 Ricerca per un singolo segmento di pubblico.

list

 Elenca i segmenti di pubblico all'interno di una proprietà.

patch

 Aggiorna un segmento di pubblico su una proprietà.