REST Resource: properties.audiences

Zasób: odbiorcy

Komunikat zasobu reprezentujący listę odbiorców GA4.

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ązanego z odbiorcami. Format: usługi/{propertyId}/audiences/{audienceId}
displayName

string

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

string

Wymagane. Opis listy odbiorców.
membershipDurationDays

integer

Wymagane. Stały. Czas, przez jaki użytkownik powinien pozostawać na liście odbiorców. Nie może być ustawiony na więcej niż 540 dni.
adsPersonalizationEnabled

boolean

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

object (AudienceEventTrigger)

Opcjonalnie: Określa zdarzenie do rejestrowania, gdy użytkownik dołączy do listy odbiorców. Jeśli jej nie skonfigurujesz, żadne zdarzenie nie będzie rejestrowane, gdy użytkownik dołączy do listy odbiorców.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Stały. Określa, jak długo ma zastosowanie wykluczenie w przypadku użytkowników spełniających warunki filtra wykluczania. Jest stosowana we wszystkich klauzulach filtra WYKLUCZ i jest ignorowana, gdy w sekcji Odbiorcy nie ma klauzuli WYKLUCZ.
filterClauses[]

object (AudienceFilterClause)

Wymagane. Stały. Lista nieuporządkowana. Filtruj klauzule definiujące listę odbiorców. Wszystkie klauzule będą połączone operatorem ORAZ.
createTime

string (Timestamp format)

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

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

AudienceEventTrigger

Określa zdarzenie do rejestrowania, gdy użytkownik dołączy do listy odbiorców.

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

string

Wymagane. Nazwa zdarzenia, która zostanie zarejestrowana.
logCondition

enum (LogCondition)

Wymagane. Kiedy rejestrować zdarzenie.

LogCondition

Określa, kiedy ma być rejestrowane zdarzenie.

Wartości w polu enum
LOG_CONDITION_UNSPECIFIED Warunek logu nie jest określony.
AUDIENCE_JOINED Zdarzenie powinno być rejestrowane dopiero po dołączeniu użytkownika.
AUDIENCE_MEMBERSHIP_RENEWED Zdarzenie powinno być rejestrowane za każdym razem, gdy jest spełniony warunek listy odbiorców, nawet jeśli użytkownik już należy do tej listy.

AudienceExclusionDurationMode

Określa, jak długo ma zastosowanie wykluczenie w przypadku użytkowników spełniających warunki filtra wykluczania.

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

AudienceFilterClause

Klauzula określająca filtr prosty lub sekwencyjny. Filtr może być włączający (np. użytkownicy, którzy spełniają warunki klauzuli filtra, są uwzględniani na liście odbiorców) lub wykluczające (np. użytkownicy spełniający klauzulę filtra są wykluczeni 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ędniania czy wykluczania.

Pole sumy filter.

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

object (AudienceSimpleFilter)

Prosty filtr, który musi spełniać użytkownik, aby znaleźć się na liście odbiorców.
sequenceFilter

object (AudienceSequenceFilter)

Filtry, które muszą wystąpić w określonej kolejności, aby użytkownik znalazł się na liście odbiorców.

AudienceSimpleFilter

Definiuje prosty filtr, który użytkownik musi spełnić, by zostać członkiem listy odbiorców.

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

enum (AudienceFilterScope)

Wymagane. Stały. Określa zakres tego filtra.
filterExpression

object (AudienceFilterExpression)

Wymagane. Stały. Wyrażenie logiczne filtrów wymiarów, danych lub zdarzeń.

AudienceFilterScope

Określa sposób oceny użytkowników pod kątem dołączenia do listy odbiorców.

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

AudienceFilterExpression

Wyrażenie logiczne filtrów wymiarów, danych lub zdarzeń.

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 sumy 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 ORAZ. Może zawierać tylko wyrażenia AudienceFilterExpressions z parametrem orGroup. Trzeba go ustawić dla parametru AudienceFilterExpression najwyższego poziomu.
orGroup

object (AudienceFilterExpressionList)

Lista wyrażeń połączonych operatorem LUB. Nie może zawierać wyrażeń AudienceFilterExpressions z parametrami andGroup lub Group.
notExpression

object (AudienceFilterExpression)

Wyrażenie filtra, które ma być NIEOBSŁUGIWANE (np. odwrócone, uzupełnione). Może zawierać tylko wymiardimensionOrMetricFilter. Nie można go ustawić na najwyższym poziomie reguły AudienceFilterExpression.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Filtrowanie według jednego wymiaru lub jednego rodzaju danych. Nie można go ustawić na najwyższym poziomie reguły AudienceFilterExpression.
eventFilter

object (AudienceEventFilter)

Tworzy filtr, który pasuje do określonego zdarzenia. Nie można go ustawić na najwyższym poziomie reguły AudienceFilterExpression.

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. Stały. Nazwa wymiaru lub danych do filtrowania. Jeśli nazwa pola odnosi się do wymiaru niestandardowego lub danych niestandardowych, przed nazwą wymiaru lub danych niestandardowych zostanie dodany prefiks zakresu. Więcej informacji o prefiksach zakresów lub wymiarach/danych niestandardowych znajdziesz w dokumentacji interfejsu Google Analytics Data API.
atAnyPointInTime

boolean

Opcjonalnie: Wskazuje, czy filtr wymaga oceny dynamicznej. Jeśli ma wartość Prawda, użytkownicy mogą dołączać do listy odbiorców, jeśli kiedykolwiek spełnili warunek (ocena statyczna). Jeśli zasada jest nieskonfigurowana 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, a potem usuwani, gdy już ich nie spełniają.

To ustawienie można ustawić tylko wtedy, gdy zakres odbiorców to ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opcjonalnie: Jeśli jest ustawione, określa przedział czasu, dla którego mają być sprawdzane dane w liczbie dni. Jeśli zasada nie jest skonfigurowana, dane o odbiorcach są oceniane na podstawie danych od początku śledzenia (np. nieskończonego przedziału czasu).

Jeśli np. ustawisz wartość 1 dzień, sprawdzane będą tylko dane z bieżącego dnia. Punktem odniesienia jest bieżący dzień, w którym parametr atAnyPointInTime ma wartość false (fałsz).

Tę wartość można ustawić tylko wtedy, gdy zakres odbiorców to ACROSS_ALL_SESSIONS i nie może być dłuższy niż 60 dni.
Pole sumy 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 ciągu znaków, który pasuje do konkretnej listy opcji.
numericFilter

object (NumericFilter)

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

object (BetweenFilter)

Filtr umożliwiający filtrowanie wartości liczbowych lub dat między określonymi wartościami w wymiarze lub rodzaju 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, która ma zostać dopasowana do dopasowania.
caseSensitive

boolean

Opcjonalnie: Jeśli parametr ma wartość prawda, dopasowanie uwzględnia wielkość liter. W przypadku wartości false (fałsz) 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 wartości ciągu znaków.
BEGINS_WITH Zaczyna się od wartości ciągu znaków.
ENDS_WITH Kończy się wartością ciągu znaków.
CONTAINS Zawiera wartość ciągu znaków.
FULL_REGEXP Pełne wyrażenie regularne pasuje do wartości ciągu znaków.

InListFilter

Filtr wymiaru ciągu znaków, który pasuje do konkretnej listy opcji.

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

string

Wymagane. Lista możliwych wartości ciągu znaków do porównania. Pole nie może być puste.
caseSensitive

boolean

Opcjonalnie: Jeśli parametr ma wartość prawda, dopasowanie uwzględnia wielkość liter. W przypadku wartości false (fałsz) wielkość liter nie jest rozróżniana.

NumericFilter

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

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

enum (Operation)

Wymagane. Operacja zastosowana do filtra liczbowego.
value

object (NumericValue)

Wymagane. Wartość liczbowa lub data na potrzeby dopasowania.

Operacja

Operacja zastosowana do filtra liczbowego.

Wartości w polu enum
OPERATION_UNSPECIFIED Nie określono.
EQUAL Równość.
LESS_THAN Mniejsze niż.
GREATER_THAN Większe niż.

NumericValue

Służy do reprezentowania liczby.

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 sumy one_value. Jedna z wartości liczbowych. one_value może mieć tylko jedną z tych wartości:
int64Value

string (int64 format)

Liczba całkowita.
doubleValue

number

Podwójna wartość.

BetweenFilter

Filtr umożliwiający filtrowanie wartości liczbowych lub dat między określonymi wartościami w wymiarze lub rodzaju 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ę tą liczbą włącznie.

AudienceEventFilter

Filtr, który pasuje do zdarzeń o pojedynczej nazwie zdarzenia. Jeśli parametr zdarzenia jest określony, do tego filtra zdarzeń pasuje tylko podzbiór zdarzeń, które pasują zarówno do nazwy pojedynczego zdarzenia, jak i wyrażeń filtra parametrów.

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

string

Wymagane. Stały. Nazwa zdarzenia, które ma być dopasowywane.
eventParameterFilterExpression

object (AudienceFilterExpression)

Opcjonalnie: Jeśli ten filtr zostanie określony, będzie dopasowywać zdarzenia, które pasują zarówno do nazwy pojedynczego zdarzenia, jak i wyrażeń filtra parametrów. Nie można ustawić parametru AudienceEventFilter w wyrażeniu filtra parametrów (np. zagnieżdżone filtry zdarzeń nie są obsługiwane). Powinien to być pojedyncza wartość parametru andGroup obiektu dimensionsOrMetricFilter lub notExpression; Operatory I i LUB nie są obsługiwane. Poza tym jeśli zawiera on filtr „eventCount”, tylko on zostanie wzięty pod uwagę. wszystkie pozostałe filtry są ignorowane.

AudienceSequenceFilter

Określa filtry, które muszą wystąpić w określonej kolejności, aby użytkownik znalazł się na liście odbiorców.

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

enum (AudienceFilterScope)

Wymagane. Stały. 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 składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

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

AudienceSequenceStep

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

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

enum (AudienceFilterScope)

Wymagane. Stały. Określa zakres tego kroku.
immediatelyFollows

boolean

Opcjonalnie: Jeśli wartość to prawda, zdarzenie, które spełnia warunki do tego kroku, musi być kolejnym zdarzeniem po zdarzeniu spełniającym ostatni krok. Jeśli zasada jest nieskonfigurowana lub ma wartość Fałsz, ten krok pośrednio następuje bezpośrednio po poprzednim kroku. np. między poprzednim a tym krokiem mogą wystąpić zdarzenia. Jest ona ignorowana w pierwszym kroku.
constraintDuration

string (Duration format)

Opcjonalnie: Jeśli ten krok jest ustawiony, musi zostać określony w elemencie constraintDuration poprzedniego kroku (na przykład t[i] – t[i-1] <= constraintDuration). Jeśli jej nie skonfigurujesz, nie będzie wymagania dotyczące czasu trwania (jest on w rzeczywistości nieograniczony). Jest ona ignorowana w pierwszym kroku.

Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".
filterExpression

object (AudienceFilterExpression)

Wymagane. Stały. Wyrażenie logiczne filtrów wymiarów, danych lub zdarzeń w każdym kroku.

AudienceClauseType

Określa, czy jest to klauzula filtra uwzględniania czy wykluczania.

Wartości w polu enum
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Nieokreślony typ klauzuli.
INCLUDE Jeśli zostanie spełniony warunek filtra, użytkownicy będą uwzględniani na liście odbiorców.
EXCLUDE Jeśli zostanie spełniony warunek filtra, użytkownicy zostaną wykluczeni z listy odbiorców.

Metody

archive

 Archiwizuje listę odbiorców w usłudze.

create

 Tworzy listę odbiorców.

get

 Wyszukiwanie jednej listy odbiorców.

list

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

patch

 Aktualizuje listę odbiorców w usłudze.