REST Resource: properties.audiences

Risorsa: Audience

Un messaggio di risorsa che rappresenta un 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 per questa risorsa Audience. Formato: properties/{propertyId}/audiences/{audienceId}
displayName

string

Obbligatorio. Il nome visualizzato del segmento di pubblico.
description

string

Obbligatorio. La descrizione del pubblico.
membershipDurationDays

integer

Obbligatorio. Immutabile. La durata per cui un utente deve rimanere in un segmento di pubblico. Non può essere impostata 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 entra a far parte del segmento di pubblico. Se non è impostato, 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 del filtro ESCLUDI e viene ignorato quando non è presente alcuna clausola del filtro ESCLUDI nel segmento di pubblico.
filterClauses[]

object (AudienceFilterClause)

Obbligatorio. Immutabile. Elenco non ordinato. Clausole di filtro che definiscono il pubblico. Tutte le clausole verranno unite con l'operatore AND.
createTime

string (Timestamp format)

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

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. 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 entra a far parte del 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 viene soddisfatta la condizione del segmento di pubblico, anche se l'utente è già membro del 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 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 esempio, gli utenti che soddisfano la clausola del filtro vengono inclusi nel segmento di pubblico) o esclusivo (ad esempio, gli utenti che soddisfano la clausola del 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 tipi:
simpleFilter

object (AudienceSimpleFilter)

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

object (AudienceSequenceFilter)

Filtri che devono verificarsi 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 per questo filtro.
filterExpression

object (AudienceFilterExpression)

Obbligatorio. Immutabile. Un'espressione logica dei filtri di dimensioni, metriche o eventi del segmento di pubblico.

AudienceFilterScope

Specifica come valutare gli utenti per l'aggiunta a 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 viene 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 viene soddisfatta in una sessione.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS L'utente entra a far parte del segmento di pubblico se la condizione del filtro viene soddisfatta da qualsiasi evento in qualsiasi sessione.

AudienceFilterExpression

Un'espressione logica dei 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 tipi:
andGroup

object (AudienceFilterExpressionList)

Un elenco di espressioni da combinare con l'operatore AND. Può contenere solo AudienceFilterExpressions con orGroup. Questo valore deve essere impostato per AudienceFilterExpression di primo livello.
orGroup

object (AudienceFilterExpressionList)

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

object (AudienceFilterExpression)

Un'espressione di filtro da negare (ad esempio, invertita, complementare). Può includere solo un dimensionOrMetricFilter. Non può essere impostato nell'espressione di filtro del pubblico di primo livello.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Un filtro su una singola dimensione o metrica. Non può essere impostato nell'espressione di filtro del pubblico di primo livello.
eventFilter

object (AudienceEventFilter)

Crea un filtro che corrisponde a un evento specifico. Non può essere impostato nell'espressione di filtro del pubblico di primo livello.

AudienceFilterExpressionList

Un elenco di espressioni di filtro del segmento di pubblico.

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

object (AudienceFilterExpression)

Un elenco di espressioni di filtro del segmento 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 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 è impostata o è impostata su false, la valutazione degli utenti per un segmento di pubblico è dinamica: gli utenti vengono aggiunti al segmento quando soddisfano le condizioni e vengono rimossi quando non le soddisfano più.

Può essere impostato solo quando l'ambito del 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 del ciclo di vita (ad esempio, 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 è false.

Può essere impostato solo quando l'ambito del pubblico è ACROSS_ALL_SESSIONS e non può superare i 60 giorni.
Campo unione one_filter. Uno dei filtri precedenti. one_filter può essere solo uno dei seguenti tipi:
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 elenco specifico 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 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

Facoltativo. Se true, la corrispondenza è sensibile alle maiuscole. Se è falso, la corrispondenza non distingue 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 Corrispondenze complete dell'espressione regolare con il valore della stringa.

InListFilter

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

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

string

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

boolean

Facoltativo. Se true, la corrispondenza è sensibile alle maiuscole. Se è falso, la corrispondenza non distingue tra maiuscole e minuscole.

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 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 dei valori numerici. one_value può essere solo uno dei seguenti tipi:
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 con un singolo nome evento. Se viene specificato un parametro evento, a questo filtro eventi corrisponde solo il sottoinsieme di eventi che corrisponde sia al nome del singolo evento sia alle espressioni di filtro dei parametri.

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

string

Obbligatorio. Immutabile. Il nome dell'evento da confrontare.
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. AudienceEventFilter all'interno dell'espressione di filtro dei parametri non può essere impostato (ad esempio, i filtri eventi nidificati non sono supportati). Deve essere un singolo andGroup di dimensionOrMetricFilter o notExpression; le AND di OR non sono supportate. 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 verificarsi 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 per questo filtro.
sequenceMaximumDuration

string (Duration format)

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)

Obbligatorio. Una sequenza ordinata di passaggi. Per essere incluso nel filtro della sequenza, un utente deve completare ogni passaggio.

AudienceSequenceStep

Una condizione che deve verificarsi nell'ordine specificato del passaggio 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

Facoltativo. Se è vero, l'evento che soddisfa questo passaggio deve essere l'evento successivo a quello che soddisfa l'ultimo passaggio. Se non è impostato o è false, questo passaggio segue indirettamente quello 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 constraintDuration del passaggio precedente (ad esempio, t[i] - t[i-1] <= constraintDuration). 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 dei filtri per dimensione, metrica o evento 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 viene 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à.