REST Resource: properties.audiences

Zasób: Audience

Wiadomość zasobu reprezentująca odbiorców.

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

string

Tylko dane wyjściowe. Nazwa zasobu związana z tym zasobem Audience. Format: properties/{propertyId}/audiences/{audienceId}
displayName

string

Wymagane. Wyświetlana nazwa listy odbiorców.
description

string

Wymagane. Opis odbiorców.
membershipDurationDays

integer

Wymagane. Niezmienna. Okres, przez jaki użytkownik powinien pozostawać na liście odbiorców. Nie może być dłuższy niż 540 dni.
adsPersonalizationEnabled

boolean

Tylko dane wyjściowe. Jeśli jest to lista odbiorców NPA i jest ona wykluczona z personalizacji reklam, GA automatycznie ustawia wartość „false” (fałsz).
eventTrigger

object (AudienceEventTrigger)

Opcjonalnie. Określa zdarzenie, które ma być rejestrowane, gdy użytkownik dołącza do grupy odbiorców. Jeśli nie jest ustawiona, gdy użytkownik dołączy do grupy odbiorców, nie zostanie zarejestrowane żadne zdarzenie.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Niezmienna. Określa, jak długo ma trwać wykluczenie użytkowników, którzy spełniają warunki filtra wykluczeń. Jest on stosowany do wszystkich klauzul filtra WYKLUCZ i jest ignorowany, gdy w grupie odbiorców nie ma klauzuli filtra WYKLUCZ.
filterClauses[]

object (AudienceFilterClause)

Wymagane. Niezmienna. Lista nieuporządkowana. Klauzule filtra, które definiują odbiorców. Wszystkie klauzule zostaną połączone operatorem ORAZ.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia listy odbiorców.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

Określa zdarzenie, które ma być rejestrowane, gdy użytkownik dołącza do grupy odbiorców.

Zapis JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Pola
eventName

string

Wymagane. Nazwa zdarzenia, które zostanie zarejestrowane.
logCondition

enum (LogCondition)

Wymagane. Kiedy rejestrować zdarzenie.

LogCondition

Określa, kiedy należy rejestrować zdarzenie.

Wartości w polu enum
LOG_CONDITION_UNSPECIFIED Nie określono warunku logu.
AUDIENCE_JOINED Zdarzenie powinno być rejestrowane tylko wtedy, gdy użytkownik dołączy do spotkania.
AUDIENCE_MEMBERSHIP_RENEWED Zdarzenie powinno być rejestrowane za każdym razem, gdy warunek dotyczący grupy odbiorców jest spełniony, nawet jeśli użytkownik należy już do tej grupy.

AudienceExclusionDurationMode

Określa, jak długo ma trwać wykluczenie użytkowników, którzy spełniają warunki filtra wykluczeń.

Wartości w polu enum
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Nie określono.
EXCLUDE_TEMPORARILY wykluczać użytkowników z listy odbiorców w okresach, w których spełniają klauzulę filtra.
EXCLUDE_PERMANENTLY Wyklucz użytkowników z listy odbiorców, jeśli kiedykolwiek spełnili klauzulę filtra.

AudienceFilterClause

Klauzula służąca do definiowania filtra prostego lub sekwencyjnego. Filtr może być włączający (np. użytkownicy spełniający klauzulę filtra są uwzględniani na liście odbiorców) lub wyłączający (np. użytkownicy spełniający klauzulę filtra są wykluczani z listy odbiorców).

Zapis 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.
}
Pola
clauseType

enum (AudienceClauseType)

Wymagane. Określa, czy jest to klauzula filtra uwzględniająca czy wykluczająca.

Pole zbiorcze filter.

Pole filter może mieć tylko jedną z tych wartości:
simpleFilter

object (AudienceSimpleFilter)

Prosty filtr, który użytkownik musi spełnić, aby należeć do listy odbiorców.
sequenceFilter

object (AudienceSequenceFilter)

Filtry, które muszą wystąpić w określonej kolejności, aby użytkownik mógł należeć do grupy odbiorców.

AudienceSimpleFilter

Określa prosty filtr, który użytkownik musi spełnić, aby należeć do listy odbiorców.

Zapis JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Pola
scope

enum (AudienceFilterScope)

Wymagane. Niezmienna. Określa zakres tego filtra.
filterExpression

object (AudienceFilterExpression)

Wymagane. Niezmienna. Wyrażenie logiczne filtrów wymiarów, danych lub zdarzeń dotyczących odbiorców.

AudienceFilterScope

Określa, jak oceniać użytkowników pod kątem dołączenia do listy odbiorców.

Wartości w polu enum
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Nie określono zakresu.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Użytkownik dołącza do listy odbiorców, jeśli warunek filtra zostanie spełniony w ramach jednego zdarzenia.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Użytkownik dołącza do listy odbiorców, jeśli warunek filtra zostanie spełniony w ramach jednej sesji.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Użytkownik dołącza do grupy odbiorców, jeśli warunek filtra jest spełniony przez dowolne zdarzenie w dowolnej sesji.

AudienceFilterExpression

Wyrażenie logiczne filtrów wymiarów, danych lub zdarzeń dotyczących odbiorców.

Zapis 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.
}
Pola
Pole zbiorcze expr. Wyrażenie zastosowane do filtra. expr może mieć tylko jedną z tych wartości:
andGroup

object (AudienceFilterExpressionList)

Lista wyrażeń, które mają być połączone operatorem AND. Może zawierać tylko elementy AudienceFilterExpressions z warunkiem orGroup. Musi być ustawiony dla wyrażenia AudienceFilterExpression najwyższego poziomu.
orGroup

object (AudienceFilterExpressionList)

Lista wyrażeń połączonych za pomocą operatora logicznego „LUB”. Nie może zawierać elementów AudienceFilterExpressions z elementami andGroup ani orGroup.
notExpression

object (AudienceFilterExpression)

Wyrażenie filtra, które ma zostać zanegowane (np. odwrócone, uzupełnione). Może zawierać tylko element dimensionOrMetricFilter. Nie można go ustawić w przypadku wyrażenia AudienceFilterExpression najwyższego poziomu.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Filtr dotyczący jednego wymiaru lub rodzaju danych. Nie można go ustawić w przypadku wyrażenia AudienceFilterExpression najwyższego poziomu.
eventFilter

object (AudienceEventFilter)

Tworzy filtr, który pasuje do określonego zdarzenia. Nie można go ustawić w przypadku wyrażenia AudienceFilterExpression najwyższego poziomu.

AudienceFilterExpressionList

Lista wyrażeń filtra odbiorców.

Zapis JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Pola
filterExpressions[]

object (AudienceFilterExpression)

Lista wyrażeń filtra odbiorców.

AudienceDimensionOrMetricFilter

Konkretny filtr dla pojedynczego wymiaru lub rodzaju danych.

Zapis 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.
}
Pola
fieldName

string

Wymagane. Niezmienna. Nazwa wymiaru lub danych do filtrowania. Jeśli nazwa pola odnosi się do wymiaru niestandardowego lub rodzaju danych niestandardowych, do nazwy wymiaru niestandardowego lub rodzaju danych niestandardowych zostanie dodany prefiks zakresu. Więcej informacji o prefiksach zakresu oraz wymiarach i danych niestandardowych znajdziesz w dokumentacji interfejsu Google Analytics Data API.
atAnyPointInTime

boolean

Opcjonalnie. Wskazuje, czy ten filtr wymaga dynamicznej oceny. Jeśli wartość to „true”, użytkownicy są dodawani do listy odbiorców, jeśli kiedykolwiek spełnili warunek (ocena statyczna). Jeśli ta opcja nie jest ustawiona lub ma wartość „fałsz”, ocena użytkowników w przypadku listy odbiorców jest dynamiczna. Użytkownicy są dodawani do listy odbiorców, gdy spełniają warunki, i usuwani z niej, gdy ich już nie spełniają.

Można go ustawić tylko wtedy, gdy zakres odbiorców to ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opcjonalnie. Jeśli jest ustawiona, określa okno czasowe, w którym mają być oceniane dane, w liczbie dni. Jeśli nie jest ustawiona, dane o odbiorcach są porównywane z danymi od początku śledzenia (np. w nieskończonym przedziale czasu).

Jeśli na przykład ustawisz 1 dzień, oceniane będą tylko dane z bieżącego dnia. Punktem odniesienia jest bieżący dzień, gdy parametr atAnyPointInTime jest nieustawiony lub ma wartość false.

Można go ustawić tylko wtedy, gdy zakres odbiorców to ACROSS_ALL_SESSIONS, i nie może on być dłuższy niż 60 dni.
Pole zbiorcze one_filter. jeden z powyższych filtrów. one_filter może mieć tylko jedną z tych wartości:
stringFilter

object (StringFilter)

Filtr wymiaru typu ciąg znaków, który pasuje do określonego wzorca.
inListFilter

object (InListFilter)

Filtr wymiaru tekstowego, który pasuje do określonej listy opcji.
numericFilter

object (NumericFilter)

Filtr wartości liczbowych lub dat w wymiarze lub danych.
betweenFilter

object (BetweenFilter)

Filtr wartości liczbowych lub dat w określonym zakresie w przypadku wymiaru lub danych.

StringFilter

Filtr wymiaru typu ciąg znaków, który pasuje do określonego wzorca.

Zapis JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Pola
matchType

enum (MatchType)

Wymagane. Typ dopasowania filtra ciągu znaków.
value

string

Wymagane. Wartość ciągu znaków, do której ma nastąpić dopasowanie.
caseSensitive

boolean

Opcjonalnie. Jeśli ma wartość true, w dopasowaniu jest rozróżniana wielkość liter. Jeśli ma wartość „false”, wielkość liter nie jest rozróżniana.

MatchType

Typ dopasowania filtra ciągu znaków.

Wartości w polu enum
MATCH_TYPE_UNSPECIFIED Nie określono
EXACT Dopasowanie ścisłe do wartości ciągu.
BEGINS_WITH Zaczyna się od wartości ciągu tekstowego.
ENDS_WITH Kończy się wartością ciągu znaków.
CONTAINS Zawiera wartość w postaci ciągu znaków.
FULL_REGEXP Pełne wyrażenie regularne pasuje do wartości ciągu tekstowego.

InListFilter

Filtr wymiaru tekstowego, który pasuje do określonej listy opcji.

Zapis JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Pola
values[]

string

Wymagane. Lista możliwych wartości ciągu znaków, do których ma nastąpić dopasowanie. Nie może być puste.
caseSensitive

boolean

Opcjonalnie. Jeśli ma wartość true, w dopasowaniu jest rozróżniana wielkość liter. Jeśli ma wartość „false”, wielkość liter nie jest rozróżniana.

NumericFilter

Filtr wartości liczbowych lub dat w wymiarze lub danych.

Zapis JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Pola
operation

enum (Operation)

Wymagane. Operacja zastosowana do filtra numerycznego.
value

object (NumericValue)

Wymagane. Wartość liczbowa lub data, do której ma nastąpić dopasowanie.

Operacja

Operacja zastosowana do filtra numerycznego.

Wartości w polu enum
OPERATION_UNSPECIFIED Nie określono.
EQUAL Równa się.
LESS_THAN Mniej niż.
GREATER_THAN Większe niż.

NumericValue

reprezentować liczbę.

Zapis 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.
}
Pola
Pole zbiorcze one_value. Wartość liczbowa. one_value może mieć tylko jedną z tych wartości:
int64Value

string (int64 format)

Wartość w formie liczby całkowitej.
doubleValue

number

Wartość typu double.

BetweenFilter

Filtr wartości liczbowych lub dat w określonym zakresie w przypadku wymiaru lub danych.

Zapis JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Pola
fromValue

object (NumericValue)

Wymagane. Zaczyna się od tej liczby (włącznie).
toValue

object (NumericValue)

Wymagane. Kończy się tym numerem (włącznie z wartościami granicznymi).

AudienceEventFilter

Filtr, który pasuje do zdarzeń o jednej nazwie. Jeśli określono parametr zdarzenia, do tego filtra zdarzeń pasuje tylko podzbiór zdarzeń, które są zgodne zarówno z nazwą pojedynczego zdarzenia, jak i z wyrażeniami filtra parametrów.

Zapis JSON 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Pola
eventName

string

Wymagane. Niezmienna. Nazwa zdarzenia, z którą ma być porównywana.
eventParameterFilterExpression

object (AudienceFilterExpression)

Opcjonalnie. Jeśli ten filtr jest określony, pasuje do zdarzeń, które są zgodne zarówno z nazwą pojedynczego zdarzenia, jak i z wyrażeniami filtra parametrów. Nie można ustawić elementu AudienceEventFilter w wyrażeniu filtra parametru (np. zagnieżdżone filtry zdarzeń nie są obsługiwane). Powinien to być pojedynczy element andGroup typu DimensionOrMetricFilter lub notExpression. Nie są obsługiwane operatory AND z operatorami OR. Jeśli zawiera filtr „eventCount”, będzie brany pod uwagę tylko ten filtr, a wszystkie pozostałe zostaną zignorowane.

AudienceSequenceFilter

Określa filtry, które muszą wystąpić w określonej kolejności, aby użytkownik mógł należeć do grupy odbiorców.

Zapis JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Pola
scope

enum (AudienceFilterScope)

Wymagane. Niezmienna. Określa zakres tego filtra.
sequenceMaximumDuration

string (Duration format)

Opcjonalnie. Określa przedział czasu, w którym musi wystąpić cała sekwencja.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Wymagane. Uporządkowana sekwencja kroków. Aby dołączyć do filtra sekwencji, użytkownik musi wykonać wszystkie kroki.

AudienceSequenceStep

Warunek, który musi wystąpić w określonej kolejności, aby użytkownik pasował do sekwencji.

Zapis JSON 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Pola
scope

enum (AudienceFilterScope)

Wymagane. Niezmienna. Określa zakres tego kroku.
immediatelyFollows

boolean

Opcjonalnie. Jeśli wartość to „true”, zdarzenie spełniające ten krok musi być następnym zdarzeniem po zdarzeniu spełniającym ostatni krok. Jeśli to pole nie jest ustawione lub ma wartość „false”, ten krok pośrednio poprzedza poprzedni krok. Między poprzednim a tym krokiem mogą wystąpić inne zdarzenia. W przypadku pierwszego kroku jest ona ignorowana.
constraintDuration

string (Duration format)

Opcjonalnie. Jeśli ten warunek jest ustawiony, musi zostać spełniony w czasie trwania ograniczenia poprzedniego kroku (np. t[i] – t[i-1] <= constraintDuration). Jeśli nie jest ustawiona, nie ma wymogu dotyczącego czasu trwania (czas trwania jest w zasadzie nieograniczony). W przypadku pierwszego kroku jest ona ignorowana.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".
filterExpression

object (AudienceFilterExpression)

Wymagane. Niezmienna. Wyrażenie logiczne zawierające filtry wymiarów, danych lub zdarzeń odbiorców w poszczególnych krokach.

AudienceClauseType

Określa, czy jest to klauzula filtra uwzględniająca czy wykluczająca.

Wartości w polu enum
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Nieokreślony typ klauzuli.
INCLUDE Użytkownicy zostaną dodani do listy odbiorców, jeśli klauzula filtra zostanie spełniona.
EXCLUDE Użytkownicy zostaną wykluczeni z listy odbiorców, jeśli zostanie spełniona klauzula filtra.

Metody

archive

 Archiwizuje listę odbiorców w usłudze.

create

 Tworzy listę odbiorców.

get

 Wyszukiwanie pojedynczej listy odbiorców.

list

 Wyświetla listy odbiorców w usłudze.

patch

 Aktualizuje listę odbiorców w usłudze.