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)
    }
  ],
  "createTime": string
}
Campi
name

string

Solo output. Il nome della risorsa per questa risorsa Audience. 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 più di 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)

(Facoltativo) Specifica un evento da registrare quando un utente si unisce al segmento di pubblico. Se il criterio 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 ESCLUDI e viene ignorato quando nel segmento di pubblico non è presente alcuna clausola di filtro ESCLUDI.
filterClauses[]

object (AudienceFilterClause)

Obbligatorio. Immutabile. Elenco non ordinato. Clausole di filtro che definiscono il segmento di pubblico. Tutte le clausole saranno unite insieme tramite AND.
createTime

string (Timestamp format)

Solo output. Data e ora di creazione del segmento di pubblico.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

AudienceEventTrigger

Specifica un evento da registrare quando un utente si unisce al 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 di log non è specificata.
AUDIENCE_JOINED L'evento deve essere registrato solo quando un utente si unisce.
AUDIENCE_MEMBERSHIP_RENEWED L'evento deve essere registrato ogni volta che la condizione del segmento di pubblico è soddisfatta, anche se l'utente è già membro di tale segmento.

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 nei periodi in cui soddisfano la clausola di filtro.
EXCLUDE_PERMANENTLY Escludi dal segmento di pubblico gli utenti che hanno mai soddisfatto la clausola di filtro.

AudienceFilterClause

Una 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 unione filter.

filter può essere solo uno dei seguenti:
simpleFilter

object (AudienceSimpleFilter)

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

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

Definisce un filtro semplice 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 relativi a dimensione, metrica o eventi relativi al pubblico.

AudienceFilterScope

Specifica come valutare gli utenti per l'inclusione in un segmento di pubblico.

Enum
AUDIENCE_FILTER_SCOPE_UNSPECIFIED L'ambito non è specificato.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT L'utente entra a far parte del segmento di pubblico se la condizione del filtro è soddisfatta in un evento.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION L'utente entra a far parte del segmento di pubblico se la condizione del filtro è soddisfatta entro 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 relativi a dimensione, metrica o eventi relativi al 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 unione expr. L'espressione applicata a un filtro. expr può essere solo uno dei seguenti:
andGroup

object (AudienceFilterExpressionList)

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

object (AudienceFilterExpressionList)

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

object (AudienceFilterExpression)

Un'espressione di filtro da NON modificare (ad esempio, invertita, completata). Può includere solo un valore dimensionOrMetricFilter. Impossibile impostare AudienceFilterExpression di primo livello.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Un filtro su una singola dimensione o metrica. Impossibile impostare AudienceFilterExpression di primo livello.
eventFilter

object (AudienceEventFilter)

Crea un filtro che corrisponde a un evento specifico. Impossibile impostare AudienceFilterExpression di primo livello.

AudienceFilterExpressionList

Un elenco di espressioni di filtro per i segmenti di pubblico.

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

object (AudienceFilterExpression)

Un elenco di espressioni di filtro per i 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 fa riferimento a una dimensione o a una metrica personalizzata, verrà aggiunto un prefisso di ambito all'inizio del nome delle dimensioni o delle metriche personalizzate. Per saperne di più sui prefissi dell'ambito o sulle dimensioni/metriche personalizzate, consulta la documentazione dell'API di dati di Google Analytics.
atAnyPointInTime

boolean

(Facoltativo) Indica se questo filtro richiede o meno una valutazione dinamica. Se impostato su true, gli utenti si uniscono al 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 li soddisfano più.

Può essere impostato solo se l'ambito del segmento di pubblico è ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

(Facoltativo) Se impostato, specifica l'intervallo di tempo durante il quale valutare i dati in numero di giorni. Se il criterio non viene configurato, i dati sul pubblico vengono valutati in base ai dati relativi al lifetime dell'utente (ad esempio, una finestra temporale infinita).

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

Può essere impostato solo se l'ambito del segmento di pubblico è ACROSS_ALL_SESSIONS e non può essere superiore a 60 giorni.
Campo 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 corrispondente 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 valori numerici o relativi alle date tra determinati valori in una dimensione o metrica.

StringFilter

Un filtro per una dimensione di tipo stringa corrispondente 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 abbinare.
caseSensitive

boolean

(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 della stringa.
ENDS_WITH Termina con il valore della 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 creare una corrispondenza. Il campo non può essere vuoto.
caseSensitive

boolean

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

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

enum (Operation)

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

object (NumericValue)

Obbligatorio. Il valore numerico o della data da abbinare.

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 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 valori numerici o delle date tra determinati valori in 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 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

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

object (AudienceFilterExpression)

(Facoltativo) Se specificato, questo filtro associa 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 dei parametri (ad esempio, i filtri di eventi nidificati non sono supportati). Deve essere un singolo andGroup di dimensionOrMetricFilter o notExpression; Gli AND degli OR non sono supportati. Inoltre, se include un filtro per "eventCount", verrà preso in considerazione solo questo: tutti gli altri filtri verranno ignorati.

AudienceSequenceFilter

Definisce i filtri che devono essere applicati 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)

(Facoltativo) Definisce il periodo di tempo in cui deve verificarsi l'intera sequenza.

Durata in secondi con un massimo di nove cifre frazionarie e termina con "s". Esempio: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Obbligatorio. Una sequenza ordinata di passaggi. Un utente deve completare ogni passaggio per poter unire il filtro sequenza.

AudienceSequenceStep

Una condizione che deve verificarsi nell'ordine dei passaggi specificato affinché questo 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

(Facoltativo) Se true, l'evento che soddisfa questo passaggio deve essere l'evento successivo dopo quello che soddisfa l'ultimo passaggio. Se il criterio non viene configurato o se è false, questo passaggio segue indirettamente quello precedente. Ad esempio, potrebbero verificarsi eventi tra il passaggio precedente e questo. Viene ignorato per il primo passaggio.
constraintDuration

string (Duration format)

(Facoltativo) Se impostato, questo passaggio deve essere soddisfatto entro il constraintDuration del passaggio precedente (ad esempio, t[i] - t[i-1] <= constraintDuration). Se il criterio non viene configurato, non è previsto alcun requisito di durata (la durata è a tutti gli effetti illimitata). Viene ignorato per il primo passaggio.

Durata in secondi con un massimo di nove cifre frazionarie e termina con "s". Esempio: "3.5s".
filterExpression

object (AudienceFilterExpression)

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

Metodi

archive

 Archivia un segmento di pubblico su una proprietà.

create

 Crea un segmento di pubblico.

get

 Cerca per un singolo segmento di pubblico.

list

 Elenca i segmenti di pubblico in una proprietà.

patch

 Aggiorna un segmento di pubblico su una proprietà.