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 per questa risorsa pubblico. Formato: proprietà/{propertyId}/audiences/{audienceId}

displayName

string

Obbligatorio. Il nome visualizzato del segmento di pubblico.

description

string

Obbligatorio. La descrizione del segmento di pubblico.

membershipDurationDays

integer

Obbligatorio. 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 nel 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)

Obbligatorio. Immutabile. Elenco non ordinato. Clausole di filtro che definiscono il segmento di pubblico. Tutte le clausole verranno 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

Obbligatorio. Il nome dell'evento che verrà registrato.

logCondition

enum (LogCondition)

Obbligatorio. Quando registrare l'evento.

LogCondition

Determina quando registrare l'evento.

Enum
LOG_CONDITION_UNSPECIFIED La condizione del 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 di filtro.
EXCLUDE_PERMANENTLY Escludi dal segmento di pubblico gli utenti che hanno soddisfatto la clausola di filtro.

AudienceFilterClause

Clausola per la definizione di un filtro semplice o di una 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)

Obbligatorio. 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 essere membro del segmento di pubblico.

sequenceFilter

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

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

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

enum (AudienceFilterScope)

Obbligatorio. Immutabile. Specifica l'ambito di questo filtro.

filterExpression

object (AudienceFilterExpression)

Obbligatorio. Immutabile. Un'espressione logica dei filtri della dimensione Pubblico, della metrica o degli eventi.

AudienceFilterScope

Specifica come valutare gli utenti che entrano a far parte di 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 viene 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 qualsiasi sessione.

AudienceFilterExpression

Un'espressione logica dei filtri della dimensione Pubblico, della metrica o degli eventi.

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 tramite AND. Può contenere solo AudienceFilterExpressions con orGroup. Deve essere impostato per AudienceFilterExpression di primo livello.

orGroup

object (AudienceFilterExpressionList)

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

notExpression

object (AudienceFilterExpression)

Un'espressione di filtro che deve essere NOT (per esempio invertita, completata). Può includere solo un elemento dimensionOrMetricFilter. Questa opzione non può essere impostata nel livello AudienceFilterExpression di primo livello.

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

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

eventFilter

object (AudienceEventFilter)

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

AudienceFilterExpressionList

Un elenco di espressioni di filtro dei segmenti di pubblico.

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

object (AudienceFilterExpression)

Un elenco di espressioni di filtro dei segmenti di 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

Obbligatorio. Immutabile. Il nome della dimensione o della metrica da filtrare. Se il nome del campo si riferisce a una dimensione o a una metrica personalizzata, prima del nome della metrica o della dimensione personalizzata verrà aggiunto un prefisso ambito. 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 l'intervallo di tempo per cui valutare i dati in numero di giorni. Se il criterio non è impostato, i dati sul pubblico vengono valutati in base ai dati relativi all'intera durata (ad esempio una finestra temporale infinita).

Ad esempio, se impostato 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 metrica.

betweenFilter

object (BetweenFilter)

Un filtro per i valori numerici o di data compresi tra determinati valori di una dimensione o 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)

Obbligatorio. Il tipo di corrispondenza per il filtro stringa.

value

string

Obbligatorio. Il valore della stringa da confrontare.

caseSensitive

boolean

Campo facoltativo. Se il valore è true, la corrispondenza è sensibile alle maiuscole. Se è 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 Termina 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

Obbligatorio. L'elenco di possibili valori di stringa con cui effettuare una corrispondenza. Il campo non può essere vuoto.

caseSensitive

boolean

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

NumericFilter

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

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

enum (Operation)

Obbligatorio. Operazione applicata a un filtro numerico.

value

object (NumericValue)

Obbligatorio. Il valore numerico o data con cui stabilire una corrispondenza.

Operazione

Operazione applicata a un filtro numerico.

Enum
OPERATION_UNSPECIFIED Non specificato.
EQUAL Uguale.
LESS_THAN Meno 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 compresi tra determinati valori di una dimensione o metrica.

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

object (NumericValue)

Obbligatorio. Inizia con questo numero (incluso).

toValue

object (NumericValue)

Obbligatorio. Termina con questo numero (incluso).

AudienceEventFilter

Un filtro che corrisponde agli eventi di un singolo nome di evento. Se viene specificato un parametro evento, solo il sottoinsieme di eventi che corrisponde al nome del singolo evento e alle espressioni di filtro dei parametri corrisponde a questo filtro eventi.

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

string

Obbligatorio. Immutabile. Il nome dell'evento da confrontare.

eventParameterFilterExpression

object (AudienceFilterExpression)

Campo facoltativo. Se specificato, questo filtro abbina 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; tutti gli altri filtri verranno ignorati.

AudienceSequenceFilter

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

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

enum (AudienceFilterScope)

Obbligatorio. Immutabile. Specifica l'ambito di questo filtro.

sequenceMaximumDuration

string (Duration format)

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

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

sequenceSteps[]

object (AudienceSequenceStep)

Obbligatorio. Una sequenza ordinata di passaggi. Un utente deve completare ogni passaggio per unirsi al filtro 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)

Obbligatorio. 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 dopo l'evento che soddisfa l'ultimo passaggio. Se non viene configurato o se viene impostato su false, questo passaggio segue indirettamente quello precedente; ad esempio, potrebbero esserci 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 valore vincolo di durata del passaggio precedente (ad esempio, t[i] - t[i-1] <= vincoloDuration). Se il criterio non viene configurato, non è previsto alcun requisito relativo alla durata (la durata è di fatto 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)

Obbligatorio. Immutabile. Un'espressione logica dei filtri evento, metrica o dimensione 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 di filtro.
EXCLUDE Gli utenti verranno esclusi dal segmento di pubblico se viene soddisfatta la clausola di filtro.

Metodi

archive

Archivia un segmento di pubblico in una proprietà.

create

Crea un segmento di pubblico.

get

Ricerca per un singolo segmento di pubblico.

list

Elenca i segmenti di pubblico presenti in una proprietà.

patch

Consente di aggiornare un segmento di pubblico su una proprietà.