REST Resource: properties.audiences

Zasób: Odbiorcy

Komunikat dotyczący 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)
    }
  ]
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu tego 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łe. Czas, przez jaki użytkownik powinien pozostawać na liście odbiorców. Nie może on przekraczać 540 dni.
adsPersonalizationEnabled

boolean

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

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

Stałe. Określa, jak długo trwa wykluczenie użytkowników spełniających kryteria filtra wykluczeń. Jest ona stosowana do wszystkich klauzul filtra WYKLUCZ i jest ignorowana, jeśli na liście odbiorców nie ma klauzuli WYKLUCZ.
filterClauses[]

object (AudienceFilterClause)

Wymagane. Stałe. Lista nieuporządkowana. Filtruj klauzule, które definiują odbiorców. Wszystkie klauzule będą połączone operatorem ORAZ.

AudienceEventTrigger

Określa zdarzenie do zarejestrowania, gdy użytkownik dołączy do listy 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 zarejestrować zdarzenie.

Wartości w polu enum
LOG_CONDITION_UNSPECIFIED Nie określono warunku logu.
AUDIENCE_JOINED Zdarzenie należy rejestrować tylko w przypadku dołączenia użytkownika.
AUDIENCE_MEMBERSHIP_RENEWED Zdarzenie powinno być rejestrowane za każdym razem, gdy zostanie spełniony warunek listy odbiorców, nawet jeśli użytkownik należy już do tej listy.

AudienceExclusionDurationMode

Określa, jak długo trwa wykluczenie użytkowników spełniających kryteria filtra wykluczeń.

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ą warunki klauzuli filtra.
EXCLUDE_PERMANENTLY Wyklucza użytkowników z listy odbiorców, jeśli kiedykolwiek spełnili klauzulę filtra.

AudienceFilterClause

Klauzula do określenia filtra prostego lub sekwencyjnego. Filtr może być włączany (np. użytkownicy spełniający klauzulę filtra są uwzględniani w sekcji Odbiorcy) lub wykluczający (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 być tylko jedną z tych wartości:
simpleFilter

object (AudienceSimpleFilter)

Prosty filtr, który musi wykonać użytkownik, aby zostać na liście odbiorców.
sequenceFilter

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

Definiuje prosty filtr, który musi wykonać użytkownik, aby zostać na liście odbiorców.

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

enum (AudienceFilterScope)

Wymagane. Stałe. Określa zakres filtra.
filterExpression

object (AudienceFilterExpression)

Wymagane. Stałe. Logiczne wyrażenie filtrów wymiaru Odbiorcy, danych lub zdarzeń.

AudienceFilterScope

Określa, jak oceniać użytkowników, którzy chcą dołączyć 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 jednym zdarzeniu.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Użytkownik dołącza do listy odbiorców, jeśli warunek filtra zostanie spełniony w ciągu jednej sesji.
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

Logiczne wyrażenie filtrów wymiaru Odbiorcy, 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 być tylko jedną z tych wartości:
andGroup

object (AudienceFilterExpressionList)

Lista wyrażeń połączonych operatorem ORAZ. Może zawierać tylko argumenty AudienceFilter Expressions zawierające parametr orGroup. To ustawienie należy ustawić dla parametru AudienceFilterExpression (najwyższego poziomu).
orGroup

object (AudienceFilterExpressionList)

Lista wyrażeń połączonych operatorem LUB. Nie może zawierać wyrażeń filtra AudienceFilter Express z wartością „&Group” lub „orGroup”.
notExpression

object (AudienceFilterExpression)

Wyrażenie filtra, które ma być NIE, (np. odwrócone, uzupełnione). Może zawierać tylko wymiarOrMetricFilter. Tego ustawienia nie można ustawić na najwyższym poziomie AudienceFilterExpression.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Filtr pojedynczego wymiaru lub rodzaju danych. Tego ustawienia nie można ustawić na najwyższym poziomie AudienceFilterExpression.
eventFilter

object (AudienceEventFilter)

Tworzy filtr pasujący do konkretnego zdarzenia. Tego ustawienia nie można ustawić na najwyższym poziomie 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łe. Nazwa wymiaru lub danych do filtrowania. Jeśli nazwa pola odnosi się do wymiaru niestandardowego lub danych niestandardowych, na początku nazwy takiego wymiaru zostanie dodany prefiks zakresu. Więcej informacji o prefiksach zakresów oraz niestandardowych wymiarach/danych znajdziesz w dokumentacji interfejsu Google Analytics Data API.
atAnyPointInTime

boolean

Opcjonalnie. Wskazuje, czy filtr wymaga dynamicznej oceny. Jeśli ma wartość Prawda, użytkownicy dołączają 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 na potrzeby 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ą.

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

integer

Opcjonalnie. Jeśli jest ustawiony, określa przedział czasu, dla którego są sprawdzane dane (w dniach). Jeśli zasada jest nieskonfigurowana, dane o odbiorcach są oceniane na podstawie danych od początku śledzenia (np. nieskończonego przedziału czasu).

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

Można go 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. jednego z powyższych filtrów. one_filter może być tylko jedną z tych wartości:
stringFilter

object (StringFilter)

Filtr wymiaru typu ciągu 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 danych.
betweenFilter

object (BetweenFilter)

Filtr wartości liczbowych lub dat między określonymi wartościami w wymiarze lub danych.

StringFilter

Filtr wymiaru typu ciągu 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 dla filtra ciągu znaków.
value

string

Wymagane. Wartość ciągu znaków do dopasowania.
caseSensitive

boolean

Opcjonalnie. Jeśli ma wartość prawda, przy dopasowaniu rozróżniana jest wielkość liter. Jeśli ma wartość Fałsz, przy dopasowaniu nie jest rozróżniana wielkość liter.

MatchType

Typ dopasowania dla filtra ciągu znaków.

Wartości w polu enum
MATCH_TYPE_UNSPECIFIED Brak informacji
EXACT Dokładne dopasowanie wartości ciągu.
BEGINS_WITH Zaczyna się od wartości ciągu znaków.
ENDS_WITH Kończy się wartością ciągu.
CONTAINS Zawiera wartość ciągu znaków.
FULL_REGEXP Pełne dopasowanie wyrażenia regularnego 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 których ma być dopasowywana funkcja. Pole nie może być puste.
caseSensitive

boolean

Opcjonalnie. Jeśli ma wartość prawda, przy dopasowaniu rozróżniana jest wielkość liter. Jeśli ma wartość Fałsz, przy dopasowaniu nie jest rozróżniana wielkość liter.

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 liczbowego.
value

object (NumericValue)

Wymagane. Wartość liczbowa lub data 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

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 być tylko jedną z tych wartości:
int64Value

string (int64 format)

Wartość całkowita.
doubleValue

number

Podwójna wartość.

BetweenFilter

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

AudienceEventFilter

Filtr pasujący do zdarzeń o jednej nazwie. Jeśli określisz parametr zdarzenia, do tego filtra zdarzeń pasują tylko podzbiory zdarzeń, które pasują zarówno do nazwy pojedynczej nazwy zdarzenia, jak i do wyrażeń filtra parametrów.

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

string

Wymagane. Stałe. Nazwa zdarzenia, które ma być sprawdzane.
eventParameterFilterExpression

object (AudienceFilterExpression)

Opcjonalnie. Jeśli zostanie określony, filtr będzie pasować do zdarzeń, które pasują zarówno do nazwy pojedynczego zdarzenia, jak i do wyrażeń filtra parametrów. Nie można ustawić parametru AudienceEventFilter w wyrażeniu filtra parametrów (np. nie są obsługiwane zagnieżdżone filtry zdarzeń). Powinien to być pojedynczy parametr „&Group” lub element „parameterOrMetricFilter” lub „notExpression” (nie jest obsługiwany). Jeśli zawiera filtr „eventCount”, tylko jeden z nich zostanie uwzględniony, a pozostałe zostaną zignorowane.

AudienceSequenceFilter

Umożliwiają określenie filtrów, które muszą występować w określonej kolejności, aby użytkownik został na liście odbiorców.

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

enum (AudienceFilterScope)

Wymagane. Stałe. Określa zakres 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 cyframi po przecinku, kończącym się cyframi „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 mógł dopasować sekwencję.

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

enum (AudienceFilterScope)

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

boolean

Opcjonalnie. Jeśli ma wartość true (prawda), zdarzenie spełniające ten krok musi być kolejnym zdarzeniem po zdarzeniu, które zakończyło się ostatnim krokiem. Jeśli zasada jest nieskonfigurowana lub ma wartość fałsz, ten krok pośrednio wykonuje czynności z poprzedniego kroku. Na przykład między poprzednim a tym krokiem mogą wystąpić zdarzenia. W pierwszym kroku jest ona ignorowana.
constraintDuration

string (Duration format)

Opcjonalnie. Gdy ten krok jest ustawiony, ten krok musi być spełniony w ramach ograniczenia czasu trwania poprzedniego kroku (np. t[i] – t[i-1] <= constraintDuration). Jeśli zasada jest nieskonfigurowana, czas trwania nie jest wymagany (w zasadzie czas trwania jest nieograniczony). W pierwszym kroku jest ona ignorowana.

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

object (AudienceFilterExpression)

Wymagane. Stałe. Logiczne wyrażenie filtrów wymiarów, danych lub zdarzeń w poszczególnych krokach.

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 klauzula filtra zostanie spełniona, użytkownicy zostaną dodani do listy odbiorców.
EXCLUDE Jeśli klauzula filtra zostanie spełniona, użytkownicy będą 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 listę odbiorców w usłudze.

patch

 Aktualizuje listę odbiorców w usłudze.