REST Resource: properties.audiences

Ressource: Zielgruppe

Eine Ressourcennachricht, 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, für die ein Nutzer in einer Zielgruppe bleiben soll. Sie darf nicht länger als 540 Tage sein.
adsPersonalizationEnabled

boolean

Nur Ausgabe. In GA wird dieser Wert automatisch auf „false“ gesetzt, wenn es sich um eine Zielgruppe ohne Berücksichtigung von Conversions handelt, die von personalisierter Werbung ausgeschlossen ist.
eventTrigger

object (AudienceEventTrigger)

Optional. Hier wird ein Ereignis angegeben, das protokolliert werden soll, wenn ein Nutzer der Zielgruppe beitritt. Wenn das 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 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 „UND“ miteinander verknüpft.
createTime

string (Timestamp format)

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

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig.Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

Hier wird ein Ereignis angegeben, 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 werden soll.

Enums
LOG_CONDITION_UNSPECIFIED Die Protokollierungsbedingung ist nicht angegeben.
AUDIENCE_JOINED Das Ereignis sollte nur protokolliert werden, wenn ein Nutzer beigetreten ist.
AUDIENCE_MEMBERSHIP_RENEWED Das Ereignis sollte 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 Nutzer in bestimmten Zeiträumen von der Zielgruppe ausschließen, wenn sie die Filterklausel erfüllen.
EXCLUDE_PERMANENTLY Nutzer aus der Zielgruppe ausschließen, die die Filterklausel schon einmal erfüllt haben.

AudienceFilterClause

Eine Klausel zum Definieren eines einfachen oder Sequenzfilters. Ein Filter kann einschließend (z. B. werden Nutzer, die der Filterklausel entsprechen, in die Zielgruppe aufgenommen) oder ausschließend (z. B. werden Nutzer, die der Filterklausel entsprechen, aus der Zielgruppe ausgeschlossen) sein.

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 Filterklausel für einzuschließende oder auszuschließende Daten 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 zur Zielgruppe zu gehören.
sequenceFilter

object (AudienceSequenceFilter)

Filter, die in einer bestimmten Reihenfolge auftreten müssen, damit der Nutzer zur Zielgruppe gehört.

AudienceSimpleFilter

Hier wird ein einfacher Filter definiert, den ein Nutzer erfüllen muss, um zur Zielgruppe zu gehören.

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 aus Zielgruppendimensionen, Messwerten oder Ereignisfiltern.

AudienceFilterScope

Hier wird festgelegt, wie Nutzer für die Aufnahme in eine Zielgruppe bewertet werden.

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

AudienceFilterExpression

Ein logischer Ausdruck aus 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 durch „AND“ miteinander verknüpft werden sollen. Sie darf nur AudienceFilterExpressions mit orGroup enthalten. Dies muss für den AudienceFilterExpression der obersten Ebene festgelegt werden.
orGroup

object (AudienceFilterExpressionList)

Eine Liste von Ausdrücken, die mit OR kombiniert werden sollen. Er darf keine Zielgruppenfilterausdrücke mit „andGroup“ oder „orGroup“ enthalten.
notExpression

object (AudienceFilterExpression)

Ein Filterausdruck, der durch NOT negiert werden soll (z. B. invertiert oder ergänzt). Er darf nur einen „dimensionOrMetricFilter“ enthalten. Diese Einstellung kann nicht auf der obersten Ebene von „AudienceFilterExpression“ festgelegt werden.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Ein Filter auf eine einzelne Dimension oder einen einzelnen Messwert. Diese Einstellung kann nicht auf der obersten Ebene von „AudienceFilterExpression“ festgelegt werden.
eventFilter

object (AudienceEventFilter)

Erstellt einen Filter, der mit einem bestimmten Ereignis übereinstimmt. Diese Einstellung kann nicht auf der obersten Ebene von „AudienceFilterExpression“ festgelegt werden.

AudienceFilterExpressionList

Eine Liste von Zielgruppenfilterausdrücken.

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

object (AudienceFilterExpression)

Eine Liste von Zielgruppenfilterausdrücken.

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 Sie filtern möchten. Wenn sich der Feldname auf eine benutzerdefinierte Dimension oder einen benutzerdefinierten Messwert bezieht, wird vor dem Namen der benutzerdefinierten Dimension oder des benutzerdefinierten Messwerts ein Präfix für den Umfang eingefügt. Weitere Informationen zu Präfixen für den Gültigkeitsbereich 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 „wahr“ gesetzt ist, werden Nutzer der Zielgruppe hinzugefügt, wenn sie die Bedingung irgendwann einmal erfüllt haben (statische Auswertung). Wenn diese Option nicht festgelegt 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.

Diese Option kann nur festgelegt werden, wenn der Zielgruppenbereich „ACROSS_ALL_SESSIONS“ ist.
inAnyNDayPeriod

integer

Optional. Wenn festgelegt, gibt das Zeitfenster an, für das Daten in Tagen ausgewertet werden sollen. Wenn Sie diese Option nicht festlegen, werden Zielgruppendaten mit Lifetime-Daten verglichen (z. B. mit einem unendlichen Zeitfenster).

Wenn Sie beispielsweise „1 Tag“ festlegen, werden nur die Daten des aktuellen Tages ausgewertet. Wenn „atAnyPointInTime“ nicht festgelegt oder falsch ist, ist der Referenzpunkt der aktuelle Tag.

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. Einen 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 oder Datumswerte für eine Dimension oder einen Messwert.
betweenFilter

object (BetweenFilter)

Ein Filter für numerische 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. Die Keyword-Option für den Stringfilter.
value

string

Erforderlich. Der Stringwert, mit dem verglichen werden soll.
caseSensitive

boolean

Optional. Wenn „wahr“ festgelegt ist, wird bei der Übereinstimmung zwischen Groß- und Kleinschreibung unterschieden. Wenn „false“ festgelegt ist, wird bei der Übereinstimmung nicht zwischen Groß- und Kleinschreibung unterschieden.

MatchType

Die Keyword-Option 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 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, mit denen abgeglichen werden soll. Darf nicht leer sein.
caseSensitive

boolean

Optional. Wenn „wahr“ festgelegt ist, wird bei der Übereinstimmung zwischen Groß- und Kleinschreibung unterschieden. Wenn „false“ festgelegt ist, wird bei der Übereinstimmung nicht zwischen Groß- und Kleinschreibung unterschieden.

NumericFilter

Ein Filter für numerische 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 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

Zur Darstellung einer Zahl.

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

Doppelter Wert.

BetweenFilter

Ein Filter für numerische 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 auf diese Zahl, einschließlich.

AudienceEventFilter

Ein Filter, der Ereignisse mit einem einzelnen Ereignisnamen abgleicht. Wenn ein Ereignisparameter angegeben ist, wird nur der Teil der Ereignisse berücksichtigt, der sowohl mit dem einzelnen Ereignisnamen als auch mit den Parameterfilterausdrücken übereinstimmt.

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

string

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

object (AudienceFilterExpression)

Optional. Wenn dieser Filter angegeben ist, werden Ereignisse berücksichtigt, die sowohl dem Namen des einzelnen Ereignisses als auch den Parameterfilterausdrücken entsprechen. „AudienceEventFilter“ kann nicht innerhalb des Parameterfilterausdrucks festgelegt werden. Verschachtelte Ereignisfilter werden beispielsweise nicht unterstützt. Dies sollte eine einzelne „andGroup“ von „dimensionOrMetricFilter“ oder „notExpression“ sein. ANDs von ORs werden nicht unterstützt. Wenn die Abfrage 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 zur Zielgruppe gehört.

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 alle Schritte ausführen, um dem Sequenzfilter beitreten zu können.

AudienceSequenceStep

Eine Bedingung, die in der angegebenen Schrittreihenfolge erfüllt werden 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 diese Option aktiviert ist, muss das Ereignis, das diesen Schritt erfüllt, direkt auf das Ereignis folgen, das den letzten Schritt erfüllt. Wenn diese Option nicht festgelegt oder „falsch“ ist, folgt dieser Schritt indirekt auf den vorherigen Schritt. Zwischen dem vorherigen Schritt und diesem Schritt können beispielsweise Ereignisse auftreten. Für den ersten Schritt wird sie ignoriert.
constraintDuration

string (Duration format)

Optional. Wenn dieser Wert festgelegt ist, muss dieser Schritt innerhalb der constraintDuration des vorherigen Schritts erfüllt werden (z. B. t[i] – t[i-1] <= constraintDuration). Wenn keine Angabe erfolgt, gibt es keine Daueranforderung. Die Dauer ist praktisch unbegrenzt. Für den ersten Schritt wird sie 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 Zielgruppendimensionen, Messwerte oder Ereignisfilter in jedem Schritt.

AudienceClauseType

Gibt an, ob es sich um eine Filterklausel für einzuschließende oder auszuschließende Daten 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

 Nach einer einzelnen Zielgruppe suchen

list

 Hier werden Zielgruppen in einer Property aufgelistet.

patch

 Aktualisiert eine Zielgruppe in einer Property.