REST Resource: properties.audiences

Ressource: Zielgruppe

Eine Ressourcenmeldung, die eine Zielgruppe darstellt.

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 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. Die Laufzeit darf 540 Tage nicht überschreiten.
adsPersonalizationEnabled

boolean

Nur Ausgabe. Der Wert wird automatisch von Google Analytics auf „false“ gesetzt, wenn es sich um eine Zielgruppe für nicht personalisierte Werbung handelt und sie von der personalisierten Werbung ausgeschlossen ist.
eventTrigger

object (AudienceEventTrigger)

Optional. Gibt ein Ereignis an, das protokolliert werden soll, wenn ein Nutzer der Zielgruppe beitritt. Wenn diese Option nicht festgelegt ist, 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 dem Ausschlussfilter entsprechen. Er 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 mit „UND“ verknüpft.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, an dem die Zielgruppe erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

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

Bestimmt, wann das Ereignis protokolliert wird.

Enums
LOG_CONDITION_UNSPECIFIED Die Log-Bedingung ist nicht angegeben.
AUDIENCE_JOINED Das Ereignis sollte nur protokolliert werden, wenn ein Nutzer beitritt.
AUDIENCE_MEMBERSHIP_RENEWED Das Ereignis sollte immer 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 dem Ausschlussfilter entsprechen.

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

AudienceFilterClause

Eine Klausel zum Definieren eines einfachen Filters oder eines Sequenzfilters. Ein Filter kann einschließend sein (z. B. werden Nutzer, die die Filterklausel erfüllen, in die Zielgruppe aufgenommen) oder ausschließend (z. B. werden Nutzer, die die Filterklausel erfüllen, 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 Ein- oder Ausschlussfilterklausel 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 sein.
sequenceFilter

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

Hier wird ein einfacher Filter definiert, den ein Nutzer erfüllen muss, um Mitglied der Zielgruppe zu sein.

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 von Zielgruppendimensionen, ‑messwerten oder ‑ereignisfiltern.

AudienceFilterScope

Gibt an, wie Nutzer für die Aufnahme in eine Zielgruppe ausgewertet 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 in 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 Ein Nutzer wird der Zielgruppe hinzugefügt, wenn die Filterbedingung durch ein beliebiges Ereignis in einer beliebigen Sitzung erfüllt wird.

AudienceFilterExpression

Ein logischer Ausdruck von Zielgruppendimensionen, ‑messwerten oder ‑ereignisfiltern.

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 AND verknüpft werden sollen. Sie kann nur AudienceFilterExpressions mit orGroup enthalten. Dieser Wert muss für den AudienceFilterExpression der obersten Ebene festgelegt werden.
orGroup

object (AudienceFilterExpressionList)

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

object (AudienceFilterExpression)

Ein Filterausdruck, der negiert werden soll (z. B. invertiert oder komplementiert). Er kann nur einen dimensionOrMetricFilter enthalten. Diese Option kann nicht für AudienceFilterExpression auf oberster Ebene festgelegt werden.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Ein Filter für eine einzelne Dimension oder einen einzelnen Messwert. Diese Option kann nicht für AudienceFilterExpression auf oberster Ebene festgelegt werden.
eventFilter

object (AudienceEventFilter)

Erstellt einen Filter, der einem bestimmten Ereignis entspricht. Diese Option kann nicht für AudienceFilterExpression auf oberster Ebene festgelegt werden.

AudienceFilterExpressionList

Eine Liste mit Ausdrücken für Zielgruppenfilter.

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

object (AudienceFilterExpression)

Eine Liste mit Ausdrücken für Zielgruppenfilter.

AudienceDimensionOrMetricFilter

Ein bestimmter 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, nach dem gefiltert werden soll. Wenn sich der Feldname auf eine benutzerdefinierte Dimension oder einen benutzerdefinierten Messwert bezieht, wird dem Namen der benutzerdefinierten Dimension oder des benutzerdefinierten Messwerts ein Bereichspräfix vorangestellt. Weitere Informationen zu Bereichspräfixen oder benutzerdefinierten Dimensionen/Messwerten finden Sie in der Google Analytics Data API-Dokumentation.
atAnyPointInTime

boolean

Optional. Gibt an, ob für diesen Filter eine dynamische Auswertung erforderlich ist. Wenn diese Option auf „true“ gesetzt ist, werden Nutzer in die Zielgruppe aufgenommen, wenn sie die Bedingung irgendwann einmal erfüllt haben (statische Auswertung). Wenn die Option nicht festgelegt oder auf „false“ gesetzt ist, ist die Nutzerauswertung für eine Zielgruppe dynamisch. Nutzer werden in eine Zielgruppe aufgenommen, wenn sie die Bedingungen erfüllen, und entfernt, wenn sie sie nicht mehr erfüllen.

Dieser Wert kann nur festgelegt werden, wenn „Audience scope“ auf „ACROSS_ALL_SESSIONS“ gesetzt ist.
inAnyNDayPeriod

integer

Optional. Wenn festgelegt, wird das Zeitfenster angegeben, für das Daten in Tagen ausgewertet werden sollen. Wenn nicht festgelegt, werden Zielgruppendaten anhand von Lifetime-Daten ausgewertet (z. B. unendliches Zeitfenster).

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

Sie kann nur festgelegt werden, wenn der Zielgruppenbereich ACROSS_ALL_SESSIONS ist, und darf nicht länger als 60 Tage sein.
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 String-Dimension, 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 für eine Dimension oder einen Messwert.

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, mit dem abgeglichen werden soll.
caseSensitive

boolean

Optional. Wenn „true“, wird beim Abgleich zwischen Groß- und Kleinschreibung unterschieden. Wenn „false“, wird beim Abgleich nicht zwischen Groß- und Kleinschreibung unterschieden.

MatchType

Der Übereinstimmungstyp für den Stringfilter.

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

InListFilter

Ein Filter für eine String-Dimension, 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. Darf nicht leer sein.
caseSensitive

boolean

Optional. Wenn „true“, wird beim Abgleich zwischen Groß- und Kleinschreibung unterschieden. Wenn „false“, wird beim Abgleich nicht zwischen Groß- und Kleinschreibung unterschieden.

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 Vorgang, der auf einen numerischen Filter angewendet wird.
value

object (NumericValue)

Erforderlich. Der numerische Wert oder Datumswert, mit dem verglichen 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

Eine Zahl darstellen.

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 der numerischen Werte. Für one_value ist nur einer der folgenden Werte zulässig:
int64Value

string (int64 format)

Ganzzahlwert.
doubleValue

number

Double-Wert.

BetweenFilter

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

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 mit Ereignissen eines einzelnen Ereignisnamens übereinstimmt. 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, werden mit diesem Filter Ereignisse abgeglichen, die sowohl dem einzelnen Ereignisnamen als auch den Parameterfilterausdrücken entsprechen. „AudienceEventFilter“ kann nicht im Parameterfilterausdruck festgelegt werden. Verschachtelte Ereignisfilter werden beispielsweise nicht unterstützt. Dies sollte ein einzelner andGroup von dimensionOrMetricFilter oder notExpression sein. AND-Verknüpfungen von OR-Ausdrücken werden nicht unterstützt. Wenn er 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 auftreten müssen, damit der Nutzer Mitglied der Zielgruppe ist.

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 in den Sequenzfilter aufgenommen zu werden.

AudienceSequenceStep

Eine Bedingung, die im angegebenen Schritt auftreten 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. Wenn „Wahr“, muss das Ereignis, das diesen Schritt erfüllt, das unmittelbar nächste Ereignis nach dem Ereignis sein, das den letzten Schritt erfüllt. Wenn der Wert nicht festgelegt oder „false“ ist, folgt dieser Schritt indirekt auf den vorherigen Schritt. Zwischen dem vorherigen und diesem Schritt können beispielsweise Ereignisse auftreten. Sie wird für den ersten Schritt ignoriert.
constraintDuration

string (Duration format)

Optional. Wenn festgelegt, muss dieser Schritt innerhalb der constraintDuration des vorherigen Schritts ausgeführt werden (z. B. t[i] – t[i-1] <= constraintDuration). Wenn nichts angegeben ist, gibt es keine Mindestdauer. Sie wird für den 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 von Zielgruppendimensionen, ‑messwerten oder ‑ereignisfiltern in jedem Schritt.

AudienceClauseType

Gibt an, ob es sich um eine Ein- oder Ausschlussfilterklausel 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 in einer Property.

create

 Erstellt eine Zielgruppe.

get

 Sucht nach einer einzelnen Zielgruppe.

list

 Listet Zielgruppen für eine Property auf.

patch

 Aktualisiert eine Zielgruppe für eine Property.