REST Resource: properties.audiences

Ressource: Zielgruppe

Eine 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)
    }
  ]
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname für diese Zielgruppenressource. 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. Er darf nicht auf mehr als 540 Tage festgelegt werden.
adsPersonalizationEnabled

boolean

Nur Ausgabe. Er wird von GA automatisch auf „false“ gesetzt, wenn es sich um eine Zielgruppe für NPA handelt und sie von der Personalisierung von Anzeigen ausgeschlossen ist.
eventTrigger

object (AudienceEventTrigger)

Optional. Gibt ein Ereignis an, das protokolliert werden soll, 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 AUSSCHLUSS-Filterklauseln angewendet und ignoriert, wenn in der Zielgruppe keine AUSSCHLIESSEN-Filterklausel vorhanden ist.
filterClauses[]

object (AudienceFilterClause)

Erforderlich. Nicht veränderbar. Unsortierte Liste. Filterklauseln, die die Zielgruppe definieren Alle Klauseln werden durch UND verbunden.

AudienceEventTrigger

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

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

string

Erforderlich. Der Name des Ereignisses, das 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 protokolliert werden, wenn ein Nutzer beigetreten ist.
AUDIENCE_MEMBERSHIP_RENEWED Das Ereignis sollte immer dann protokolliert 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 Nutzer aus der Zielgruppe ausschließen, die schon einmal die Filterklausel erfüllt haben

AudienceFilterClause

Eine Klausel zum Definieren eines einfachen oder Sequenzfilters. Ein Filter kann inklusiv sein, d. h., Nutzer, die die Filterklausel erfüllen, werden in die Zielgruppe aufgenommen, oder exklusiv. Nutzer, die die Filterklausel erfüllen, werden beispielsweise 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 es sich um eine Einschließen- oder Ausschließen-Filterklausel handelt.

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 der Zielgruppe zu werden.
sequenceFilter

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

Hier ist ein einfacher Filter definiert, 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 Bereich für diesen Filter an.
filterExpression

object (AudienceFilterExpression)

Erforderlich. Nicht veränderbar. Ein logischer Ausdruck für Dimensionen, Messwerte oder Ereignisfilter des Typs „Zielgruppe“.

AudienceFilterScope

Gibt an, wie Nutzer für den Beitritt zu einer Zielgruppe bewertet werden.

Enums
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Der Bereich ist nicht angegeben.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Der Nutzer wird der Zielgruppe hinzugefügt, wenn die Filterbedingung innerhalb eines Ereignisses 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 in einer Sitzung durch ein Ereignis erfüllt ist.

AudienceFilterExpression

Ein logischer Ausdruck für Dimensionen, Messwerte oder Ereignisfilter des Typs „Zielgruppe“.

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. 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 AND verbunden werden sollen. Er darf nur AudienceFilterExpressions mit orGroup enthalten. Dies muss für die AudienceFilterExpression der obersten Ebene festgelegt werden.
orGroup

object (AudienceFilterExpressionList)

Eine Liste von Ausdrücken, die mit ODER verbunden 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 einen „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 Filterausdrücken für Zielgruppen.

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

object (AudienceFilterExpression)

Eine Liste mit Filterausdrücken für Zielgruppen.

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 Namen der benutzerdefinierten Dimension oder des Messwerts ein Präfix für den Umfang hinzugefügt. 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 dynamisch ausgewertet werden muss. Wenn die Richtlinie auf „true“ gesetzt ist, werden Nutzer der Zielgruppe hinzugefügt, sobald sie die Bedingung irgendwann einmal erfüllt haben (statische Auswertung). Wenn die Richtlinie nicht konfiguriert oder auf „false“ gesetzt ist, ist 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 an, für das Daten in Tagen ausgewertet werden sollen. Wenn die Richtlinie nicht konfiguriert ist, werden die Zielgruppendaten mit den Lifetime-Daten verglichen (z. B. ein unbegrenztes Zeitfenster).

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

Er kann nur festgelegt werden, wenn der Umfang der Zielgruppe „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 mit einem bestimmten Muster übereinstimmt.
inListFilter

object (InListFilter)

Ein Filter für eine Stringdimension, die einer bestimmten Liste von Optionen entspricht.
numericFilter

object (NumericFilter)

Ein Filter für numerische Werte oder Datumswerte in einer Dimension oder einem 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 mit einem bestimmten Muster übereinstimmt.

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

enum (MatchType)

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

string

Erforderlich. Stringwert, der abgeglichen werden soll
caseSensitive

boolean

Optional. Wenn „true“ festgelegt ist, wird 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 Er 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, die einer bestimmten Liste von Optionen entspricht.

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

string

Erforderlich. Die Liste möglicher Stringwerte für den Abgleich. Darf nicht leer sein.
caseSensitive

boolean

Optional. Wenn „true“ festgelegt ist, wird zwischen Groß- und Kleinschreibung unterschieden. Bei „false“ wird die Groß-/Kleinschreibung nicht berücksichtigt.

NumericFilter

Ein Filter für numerische Werte oder Datumswerte in einer Dimension oder einem Messwert.

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

enum (Operation)

Erforderlich. Der Vorgang, der auf einen numerischen Filter angewendet wird.
value

object (NumericValue)

Erforderlich. Der numerische oder Datumswert, der abgeglichen werden soll.

Vorgang

Der Vorgang, der auf einen numerischen Filter angewendet wird.

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. Ein Wert mit 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 Ereignissen eines einzelnen Ereignisnamens entspricht. Wenn ein Ereignisparameter angegeben ist, entspricht nur die Teilmenge der Ereignisse, die sowohl dem einzelnen Ereignisnamen als auch den Parameterfilterausdrücken entsprechen, diesem Ereignisfilter.

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

string

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

object (AudienceFilterExpression)

Optional. Wenn angegeben, ermittelt dieser Filter Ereignisse, die sowohl mit dem einzelnen Ereignisnamen als auch mit den Parameterfilterausdrücken übereinstimmen. „AudienceEventFilter“ innerhalb des Parameterfilterausdrucks kann nicht festgelegt werden. Verschachtelte Ereignisfilter werden beispielsweise nicht unterstützt. Dies sollte eine einzelne andGroup mit „dimensionOrMetricFilter“ oder „notExpression“ sein. UNDs von ORs werden nicht unterstützt. Wenn es einen Filter für „eventCount“ enthält, wird nur dieser berücksichtigt. Alle anderen Filter werden ignoriert.

AudienceSequenceFilter

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

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

enum (AudienceFilterScope)

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

string (Duration format)

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

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Erforderlich. Eine geordnete Abfolge von Schritten. Ein Nutzer muss jeden Schritt ausführen, um den Sequenzfilter verwenden zu können.

AudienceSequenceStep

Eine Bedingung, die in der angegebenen Schrittreihenfolge eintreten muss, damit der 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 Bereich für diesen Schritt an.
immediatelyFollows

boolean

Optional. Bei „true“ muss das Ereignis, das diesen Schritt erfüllt, das nächste Ereignis nach dem Ereignis sein, das den letzten Schritt erfüllt. Wenn nicht festgelegt oder „false“, folgt dieser Schritt indirekt dem vorherigen Schritt. Es können beispielsweise Ereignisse zwischen dem vorherigen und diesem Schritt auftreten. Er wird im ersten Schritt ignoriert.
constraintDuration

string (Duration format)

Optional. Wenn dieser Schritt festgelegt ist, muss er innerhalb der constraintDuration des vorherigen Schritts erfüllt sein (z. B. t[i] - t[i-1] <= constraintDuration). Wenn die Richtlinie nicht konfiguriert ist, ist keine Dauer erforderlich (die Dauer ist praktisch unbegrenzt). Er wird im ersten Schritt ignoriert.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".
filterExpression

object (AudienceFilterExpression)

Erforderlich. Nicht veränderbar. Ein logischer Ausdruck für die Dimension „Zielgruppe“, den Messwert oder die Ereignisfilter in jedem Schritt.

AudienceClauseType

Gibt an, ob es sich um eine Einschließen- oder Ausschließen-Filterklausel handelt.

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

Methoden

archive

 Archiviert eine Zielgruppe für eine Property.

create

 Eine Zielgruppe wird erstellt.

get

 Suchen Sie nach einer einzelnen Zielgruppe.

list

 Listet Zielgruppen für eine Property auf.

patch

 Aktualisiert eine Zielgruppe für eine Property.