REST Resource: properties.audiences

Ressource: Zielgruppe

Ressourcennachricht für eine GA4-Zielgruppe

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

string

Nur Ausgabe. Der Ressourcenname für diese Audience-Ressource. Format: properties/{propertyId}/audiences/{audienceId}
displayName

string

Erforderlich. Der Anzeigename der Zielgruppe.
description

string

Erforderlich. Die Beschreibung der Zielgruppe.
membershipDurationDays

integer

Erforderlich. Nicht veränderbar. Die Dauer, die ein Nutzer in einer Zielgruppe bleiben soll. Es kann maximal 540 Tage festgelegt werden.
adsPersonalizationEnabled

boolean

Nur Ausgabe. Er wird von Google Analytics automatisch auf „false“ gesetzt, wenn es sich um eine NPA-Zielgruppe handelt, die von personalisierten Anzeigen ausgeschlossen ist.
eventTrigger

object (AudienceEventTrigger)

Optional. Gibt ein Ereignis an, das protokolliert wird, wenn ein Nutzer der Zielgruppe beitritt. Ist die Richtlinie nicht konfiguriert, wird kein Ereignis protokolliert, wenn ein Nutzer der Zielgruppe beitritt.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Nicht veränderbar. Gibt an, wie lange ein Ausschluss für Nutzer gilt, die den Ausschlussfilter erfüllen. Sie wird auf alle EXCLUDE-Filterklauseln angewendet und ignoriert, wenn in der Zielgruppe keine EXCLUDE-Filterklausel vorhanden ist.
filterClauses[]

object (AudienceFilterClause)

Erforderlich. Nicht veränderbar. Unsortierte Liste. Filterklauseln, die die Zielgruppe definieren. Alle Klauseln werden durch eine UND-Verbindung verknüpft.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem die Zielgruppe erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

AudienceEventTrigger

Gibt ein Ereignis an, das protokolliert wird, wenn ein Nutzer der Zielgruppe beitritt.

JSON-Darstellung 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Felder
eventName

string

Erforderlich. Der Ereignisname, der protokolliert wird.
logCondition

enum (LogCondition)

Erforderlich. Wann das Ereignis protokolliert werden soll

LogCondition

Legt fest, wann das Ereignis protokolliert wird.

Enums
LOG_CONDITION_UNSPECIFIED Logbedingung ist nicht angegeben.
AUDIENCE_JOINED Das Ereignis sollte nur dann protokolliert werden, wenn ein Nutzer beigetreten ist.
AUDIENCE_MEMBERSHIP_RENEWED Das Ereignis sollte immer dann erfasst werden, wenn die Zielgruppenbedingung erfüllt ist, auch wenn der Nutzer bereits Mitglied der Zielgruppe ist.

AudienceExclusionDurationMode

Gibt an, wie lange ein Ausschluss für Nutzer gilt, die den Ausschlussfilter erfüllen.

Enums
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Nicht angegeben.
EXCLUDE_TEMPORARILY Sie können Nutzer in bestimmten Zeiträumen aus der Zielgruppe ausschließen, in denen sie die Filterklausel erfüllen.
EXCLUDE_PERMANENTLY Schließen Sie Nutzer aus der Zielgruppe aus, wenn sie schon einmal die Filterklausel erfüllt haben.

AudienceFilterClause

Eine Klausel zum Definieren eines einfachen oder Sequenzfilters. Ein Filter kann einschließend sein, z. B. werden Nutzer, die die Filterbedingung erfüllen, in die Zielgruppe aufgenommen, oder exklusiv (Nutzer, die die Filterbedingung erfüllen, werden aus der Zielgruppe ausgeschlossen).

JSON-Darstellung 
{
  "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.
}
Felder
clauseType

enum (AudienceClauseType)

Erforderlich. Gibt an, ob dies eine Filterklausel zum Ein- oder Ausschließen ist.

Union-Feld filter.

Für filter ist nur einer der folgenden Werte zulässig:
simpleFilter

object (AudienceSimpleFilter)

Ein einfacher Filter, den ein Nutzer erfüllen muss, um Mitglied einer Zielgruppe zu werden.
sequenceFilter

object (AudienceSequenceFilter)

Filter, die in einer bestimmten Reihenfolge angezeigt werden müssen, damit der Nutzer Mitglied der Zielgruppe wird.

AudienceSimpleFilter

Definiert einen einfachen Filter, den ein Nutzer erfüllen muss, um Mitglied der Zielgruppe zu werden.

JSON-Darstellung 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Felder
scope

enum (AudienceFilterScope)

Erforderlich. Nicht veränderbar. Gibt den Umfang für diesen Filter an.
filterExpression

object (AudienceFilterExpression)

Erforderlich. Nicht veränderbar. Ein logischer Ausdruck für Zielgruppendimension, Messwert oder Ereignisfilter

AudienceFilterScope

Gibt an, wie Nutzer hinsichtlich des Beitritts zu einer Zielgruppe bewertet werden.

Enums
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Bereich ist nicht angegeben.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Der Nutzer wird der Zielgruppe hinzugefügt, wenn die Filterbedingung bei einem Ereignis erfüllt ist.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Der Nutzer wird der Zielgruppe hinzugefügt, wenn die Filterbedingung innerhalb einer Sitzung erfüllt ist.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Der Nutzer wird der Zielgruppe hinzugefügt, wenn die Filterbedingung von einem Ereignis in einer beliebigen Sitzung erfüllt ist.

AudienceFilterExpression

Ein logischer Ausdruck für Zielgruppendimension, Messwert oder Ereignisfilter

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld expr. Der Ausdruck, der auf einen Filter angewendet wird. Für expr ist nur einer der folgenden Werte zulässig:
andGroup

object (AudienceFilterExpressionList)

Eine Liste von Ausdrücken, die mit UND verbunden werden sollen. Er darf nur AudienceFilterExpressions mit orGroup enthalten. Dies muss für die oberste Ebene "AudienceFilterExpression" festgelegt werden.
orGroup

object (AudienceFilterExpressionList)

Eine Liste von Ausdrücken, die mit OR verknüpft werden sollen. Er darf keine AudienceFilterExpressions mit andGroup oder orGroup enthalten.
notExpression

object (AudienceFilterExpression)

Ein Filterausdruck, der NICHT verwendet werden soll (z. B. invertiert, komplementiert). Er darf nur eine DimensionOrMetricFilter enthalten. Dies kann nicht auf der obersten Ebene "AudienceFilterExpression" festgelegt werden.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Ein Filter für eine einzelne Dimension oder einen einzelnen Messwert. Dies kann nicht auf der obersten Ebene "AudienceFilterExpression" festgelegt werden.
eventFilter

object (AudienceEventFilter)

Erstellt einen Filter, der einem bestimmten Ereignis entspricht. Dies kann nicht auf der obersten Ebene "AudienceFilterExpression" festgelegt werden.

AudienceFilterExpressionList

Eine Liste mit Zielgruppenfilterausdrücken.

JSON-Darstellung 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Felder
filterExpressions[]

object (AudienceFilterExpression)

Eine Liste mit Zielgruppenfilterausdrücken.

AudienceDimensionOrMetricFilter

Ein spezifischer Filter für eine einzelne Dimension oder einen einzelnen Messwert.

JSON-Darstellung 
{
  "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.
}
Felder
fieldName

string

Erforderlich. Nicht veränderbar. Der Name der Dimension oder des Messwerts, der gefiltert werden soll. Wenn sich der Feldname auf eine benutzerdefinierte Dimension oder einen benutzerdefinierten Messwert bezieht, wird dem benutzerdefinierten Dimension oder Messwert ein Präfix für den Umfang vorangestellt. Weitere Informationen zu Bereichspräfixen oder benutzerdefinierten Dimensionen und Messwerten finden Sie in der Dokumentation zur Google Analytics Data API.
atAnyPointInTime

boolean

Optional. Gibt an, ob dieser Filter eine dynamische Auswertung erfordert oder nicht. Ist sie auf „true“ gesetzt, werden Nutzer der Zielgruppe hinzugefügt, die die Bedingung irgendwann einmal erfüllt haben (statische Auswertung). Wenn die Richtlinie nicht konfiguriert oder auf „false“ gesetzt ist, erfolgt die Nutzerauswertung für eine Zielgruppe dynamisch. Nutzer werden einer Zielgruppe hinzugefügt, wenn sie die Bedingungen erfüllen, und entfernt, wenn sie sie nicht mehr erfüllen.

Dies kann nur festgelegt werden, wenn der Zielgruppenumfang ACROSS_ALL_SESSIONS ist.
inAnyNDayPeriod

integer

Optional. Gibt das Zeitfenster in Tagen für die Auswertung von Daten an. Wenn die Richtlinie nicht konfiguriert ist, werden Zielgruppendaten anhand der Lifetime-Daten ausgewertet (z. B. unendliches Zeitfenster).

Wenn Sie beispielsweise 1 Tag festlegen, werden nur die Daten des aktuellen Tages ausgewertet. Der Bezugspunkt ist der aktuelle Tag, wenn „atAnyPointInTime“ nicht festgelegt oder auf „false“ gesetzt ist.

Sie kann nur festgelegt werden, wenn der Zielgruppenumfang ACROSS_ALL_SESSIONS ist und nicht länger als 60 Tage sein darf.
Union-Feld one_filter. Einer der oben genannten Filter. Für one_filter ist nur einer der folgenden Werte zulässig:
stringFilter

object (StringFilter)

Ein Filter für eine Dimension vom Typ „String“, die einem bestimmten Muster entspricht.
inListFilter

object (InListFilter)

Ein Filter für eine Stringdimension, der mit einer bestimmten Liste von Optionen übereinstimmt.
numericFilter

object (NumericFilter)

Ein Filter für numerische Werte oder Datumswerte für eine Dimension oder einen Messwert.
betweenFilter

object (BetweenFilter)

Ein Filter für numerische Werte oder Datumswerte zwischen bestimmten Werten einer Dimension oder eines Messwerts.

StringFilter

Ein Filter für eine Dimension vom Typ „String“, die einem bestimmten Muster entspricht.

JSON-Darstellung 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Felder
matchType

enum (MatchType)

Erforderlich. Der Übereinstimmungstyp für den Stringfilter.
value

string

Erforderlich. Der Stringwert, der abgeglichen werden soll.
caseSensitive

boolean

Optional. Falls wahr, wird bei der Übereinstimmung zwischen Groß- und Kleinschreibung unterschieden. Bei „false“ wird die Groß-/Kleinschreibung nicht berücksichtigt.

MatchType

Der Übereinstimmungstyp für den Stringfilter.

Enums
MATCH_TYPE_UNSPECIFIED Ohne Angabe
EXACT Genaue Übereinstimmung mit dem Stringwert.
BEGINS_WITH Beginnt mit dem Stringwert.
ENDS_WITH Endet mit dem Stringwert.
CONTAINS Enthält den Stringwert.
FULL_REGEXP Der vollständige reguläre Ausdruck stimmt mit dem Stringwert überein.

InListFilter

Ein Filter für eine Stringdimension, der mit einer bestimmten Liste von Optionen übereinstimmt.

JSON-Darstellung 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Felder
values[]

string

Erforderlich. Die Liste der möglichen Stringwerte für den Abgleich. Das Feld darf nicht leer sein.
caseSensitive

boolean

Optional. Falls wahr, wird bei der Übereinstimmung zwischen Groß- und Kleinschreibung unterschieden. Bei „false“ wird die Groß-/Kleinschreibung nicht berücksichtigt.

NumericFilter

Ein Filter für numerische Werte oder Datumswerte für eine Dimension oder einen Messwert.

JSON-Darstellung 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Felder
operation

enum (Operation)

Erforderlich. Der auf einen numerischen Filter angewendete Vorgang.
value

object (NumericValue)

Erforderlich. Der numerische Wert oder Datumswert für den Abgleich.

Vorgang

Der auf einen numerischen Filter angewendete Vorgang.

Enums
OPERATION_UNSPECIFIED Nicht angegeben
EQUAL Gleich
LESS_THAN Kleiner als.
GREATER_THAN Größer als.

NumericValue

Um eine Zahl darzustellen.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld one_value. Einer von einem numerischen Wert. Für one_value ist nur einer der folgenden Werte zulässig:
int64Value

string (int64 format)

Ganzzahlwert.
doubleValue

number

Doppelter Wert.

BetweenFilter

Ein Filter für numerische Werte oder Datumswerte zwischen bestimmten Werten einer Dimension oder eines Messwerts.

JSON-Darstellung 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Felder
fromValue

object (NumericValue)

Erforderlich. Beginnt mit dieser Zahl (einschließlich).
toValue

object (NumericValue)

Erforderlich. Endet mit dieser Zahl (einschließlich).

AudienceEventFilter

Ein Filter, der nach Ereignissen mit einem einzelnen Ereignisnamen sucht. Wenn ein Ereignisparameter angegeben ist, stimmt nur die Teilmenge der Ereignisse, die sowohl mit dem Namen des einzelnen Ereignisses als auch mit den Ausdrücken des Parameterfilters übereinstimmen, mit diesem Ereignisfilter überein.

JSON-Darstellung 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Felder
eventName

string

Erforderlich. Nicht veränderbar. Der Name des Ereignisses, mit dem abgeglichen werden soll.
eventParameterFilterExpression

object (AudienceFilterExpression)

Optional. Wenn angegeben, sucht dieser Filter nach Ereignissen, die sowohl mit dem Namen des einzelnen Ereignisses als auch mit den Ausdrücken des Parameterfilters übereinstimmen. AudienceEventFilter innerhalb des Parameterfilterausdrucks kann nicht festgelegt werden. Verschachtelte Ereignisfilter werden beispielsweise nicht unterstützt. Dies sollte eine einzelne andGroup von DimensionOrMetricFilter oder notExpression sein. UNDs von ODERs werden nicht unterstützt. Wenn sie außerdem einen Filter für "eventCount" enthält, wird nur dieser berücksichtigt. werden alle anderen Filter ignoriert.

AudienceSequenceFilter

Definiert Filter, die in einer bestimmten Reihenfolge auftreten müssen, damit der Nutzer Mitglied einer Zielgruppe wird.

JSON-Darstellung 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Felder
scope

enum (AudienceFilterScope)

Erforderlich. Nicht veränderbar. Gibt den Umfang für diesen Filter an.
sequenceMaximumDuration

string (Duration format)

Optional. Definiert den Zeitraum, in dem die gesamte Sequenz ablaufen muss.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Erforderlich. Eine geordnete Abfolge von Schritten. Ein Nutzer muss jeden Schritt ausführen, um mit dem Sequenzfilter verknüpft werden zu können.

AudienceSequenceStep

Eine Bedingung, die in der angegebenen Schrittreihenfolge eintreten muss, damit dieser Nutzer der Sequenz entspricht.

JSON-Darstellung 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Felder
scope

enum (AudienceFilterScope)

Erforderlich. Nicht veränderbar. Gibt den Umfang für diesen Schritt an.
immediatelyFollows

boolean

Optional. Falls wahr, muss das Ereignis, das diesen Schritt erfüllt, das nächste Ereignis nach dem Ereignis sein, das den letzten Schritt erfüllt. Wenn kein Wert oder „false“ festgelegt ist, folgt dieser Schritt indirekt auf den vorherigen Schritt. Beispielsweise können zwischen dem vorherigen und diesem Schritt Ereignisse auftreten. Er wird im ersten Schritt ignoriert.
constraintDuration

string (Duration format)

Optional. Wenn dieser Schritt festgelegt ist, muss er im Rahmen der „constraintDuration“ des vorherigen Schritts erfüllt werden (z. B. t[i] – t[i-1] <=constrainDuration). Wenn die Richtlinie nicht konfiguriert ist, gibt es keine Anforderung für die Dauer (die Dauer ist praktisch unbegrenzt). Er wird im ersten Schritt ignoriert.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
filterExpression

object (AudienceFilterExpression)

Erforderlich. Nicht veränderbar. Ein logischer Ausdruck für Zielgruppendimension, Messwert oder Ereignisfilter in den einzelnen Schritten

AudienceClauseType

Gibt an, ob dies eine Filterklausel zum Ein- oder Ausschließen ist.

Enums
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Nicht angegebener Klauseltyp.
INCLUDE Nutzer werden in die Zielgruppe aufgenommen, wenn die Filterbedingung erfüllt ist.
EXCLUDE Nutzer werden aus der Zielgruppe ausgeschlossen, wenn die Filterbedingung erfüllt ist.

Methoden

archive

 Archiviert eine Zielgruppe in einer Property.

create

 Erstellt eine Zielgruppe.

get

 Suche nach einer einzelnen Zielgruppe.

list

 Listet Zielgruppen für eine Property auf.

patch

 Aktualisiert eine Zielgruppe für eine Property.