REST Resource: properties.audiences

Risorsa: Pubblico

Un messaggio della risorsa che rappresenta un segmento di pubblico.

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 Segmento di pubblico. Formato: properties/{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 per cui un utente deve rimanere in un segmento di pubblico. Non può essere impostato su più di 540 giorni.
adsPersonalizationEnabled

boolean

Solo output. Viene impostato automaticamente su false da GA 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 iscrive al segmento di pubblico. Se non è impostato, non viene registrato alcun evento quando un utente si iscrive al 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 del filtro EXCLUDE ed è ignorato se non è presente alcuna clausola del 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 saranno unite da AND.
createTime

string (Timestamp format)

Solo output. Ora in cui è stato creato il segmento di pubblico.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

Specifica un evento da registrare quando un utente si iscrive 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 iscrive.
AUDIENCE_MEMBERSHIP_RENEWED L'evento deve essere registrato ogni volta che viene soddisfatta la condizione del segmento di pubblico, 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 gli utenti dal segmento di pubblico se hanno soddisfatto la clausola del filtro almeno una volta.

AudienceFilterClause

Una clausola per definire un filtro semplice o di sequenza. Un filtro può essere inclusivo (ad es. gli utenti che soddisfano la clausola del filtro sono inclusi nel segmento di pubblico) o esclusivo (ad es. gli utenti che soddisfano la clausola del filtro sono 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 semplice filtro che un utente deve soddisfare per far parte del segmento di pubblico.
sequenceFilter

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

Definisce un semplice filtro che un utente deve soddisfare per far parte 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 di filtri di dimensioni, metriche o eventi del segmento di pubblico.

AudienceFilterScope

Specifica in che modo 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 viene aggiunto al segmento di pubblico se la condizione del filtro è soddisfatta in un evento.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION L'utente viene aggiunto al segmento di pubblico se la condizione del filtro è soddisfatta in una sessione.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS L'utente viene aggiunto al segmento di pubblico se la condizione del filtro è soddisfatta da qualsiasi evento in qualsiasi sessione.

AudienceFilterExpression

Un'espressione logica di filtri di dimensioni, metriche o eventi del segmento di 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 combinare con AND. Può contenere solo espressioni AudienceFilter con orGroup. Questo valore deve essere impostato per AudienceFilterExpression di primo livello.
orGroup

object (AudienceFilterExpressionList)

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

object (AudienceFilterExpression)

Un'espressione di filtro da negare (ad es. invertita, completata). Può includere solo un dimensionOrMetricFilter. Non è possibile impostarlo a livello di AudienceFilterExpression di primo livello.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Un filtro su una singola dimensione o metrica. Non è possibile impostarlo a livello di AudienceFilterExpression di primo livello.
eventFilter

object (AudienceEventFilter)

Crea un filtro che corrisponde a un evento specifico. Non è possibile impostarlo a livello di 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 fa riferimento a una dimensione o una metrica personalizzata, verrà aggiunto un prefisso di ambito all'inizio del nome della dimensione o della metrica personalizzata. Per saperne di più sui prefissi di 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 impostata su true, gli utenti vengono inclusi nel segmento di pubblico se hanno soddisfatto la condizione almeno una volta (valutazione statica). Se non è impostato o è 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 vengono rimossi quando non le soddisfano più.

Questo valore può essere impostato solo quando l'ambito del segmento di pubblico è ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

(Facoltativo) Se impostato, specifica la finestra temporale per la quale valutare i dati in numero di giorni. Se non viene impostato, i dati sul pubblico vengono valutati in base ai dati sul lifetime (ad es. 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 quando atAnyPointInTime non è impostato o è falso.

Può essere impostato solo quando 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 che corrisponde a un determinato pattern.
inListFilter

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

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

string

Obbligatorio. Il valore della stringa da abbinare.
caseSensitive

boolean

(Facoltativo) Se true, la corrispondenza è sensibile alle maiuscole. Se è falso, la corrispondenza non è sensibile alle maiuscole.

MatchType

Il tipo di corrispondenza per il filtro di 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 di stringa che corrisponde a un determinato elenco di opzioni.

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

string

Obbligatorio. L'elenco dei possibili valori di stringa da confrontare. Non deve essere vuoto.
caseSensitive

boolean

(Facoltativo) Se true, la corrispondenza è sensibile alle maiuscole. Se è falso, la corrispondenza non è sensibile alle maiuscole.

NumericFilter

Un filtro per valori numerici o di data in una dimensione o una 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 di data da confrontare.

Operazione

L'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 unione one_value. Uno dei valori numerici. 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 di data compresi tra determinati valori in una dimensione o una 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 corrisponde sia al nome del singolo evento sia alle espressioni del filtro dei parametri corrisponde a questo filtro eventi.

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

string

Obbligatorio. Immutabile. Il nome dell'evento con cui eseguire la corrispondenza.
eventParameterFilterExpression

object (AudienceFilterExpression)

(Facoltativo) Se specificato, questo filtro corrisponde agli eventi che corrispondono sia al nome del singolo evento sia alle espressioni di filtro dei parametri. Non è possibile impostare AudienceEventFilter all'interno dell'espressione del filtro dei parametri (ad es. i filtri eventi nidificati non sono supportati). Deve trattarsi di un singolo gruppoAnd di dimensioneOrMetricFilter o notExpression; le operazioni AND di OR non sono supportate. Inoltre, se include un filtro per "eventCount", verrà considerato solo quello; tutti gli altri filtri verranno ignorati.

AudienceSequenceFilter

Definisce i filtri che devono verificarsi in un ordine specifico affinché l'utente sia un 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 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 partecipare al filtro della 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 immediatamente successivo a quello che soddisfa l'ultimo passaggio. Se non impostato o se è False, questo passaggio segue indirettamente il passaggio precedente. Ad esempio, potrebbero esserci 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 la durata del vincolo del passaggio precedente (ad esempio, t[i] - t[i-1] <= durataVincolo). Se non è impostato, non è previsto alcun requisito di durata (la durata è effettivamente illimitata). Viene ignorato per il 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 di filtri di dimensioni, metriche o eventi del segmento di 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 la clausola del filtro è soddisfatta.
EXCLUDE Gli utenti verranno esclusi dal segmento di pubblico se la clausola del filtro viene soddisfatta.

Metodi

archive

 Archivia un segmento di pubblico in una proprietà.

create

 Crea un segmento di pubblico.

get

 Cerca un singolo segmento di pubblico.

list

 Elenca i segmenti di pubblico di una proprietà.

patch

 Aggiorna un segmento di pubblico in una proprietà.