REST Resource: properties.audiences

Zasób: Odbiorcy

Komunikat zasobu reprezentujący listę 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ązanego z odbiorcami. Format: usługi/{identyfikator_usługi}/{identyfikator_listy_odbiorców}
displayName

string

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

string

Wymagane. Opis grupy odbiorców.
membershipDurationDays

integer

Wymagane. Niezmienna. Czas, przez który użytkownik powinien pozostawać na liście odbiorców. Nie może ona przekraczać 540 dni.
adsPersonalizationEnabled

boolean

Tylko dane wyjściowe. Jest ona automatycznie ustawiana przez GA na wartość false, jeśli jest to lista odbiorców NPA i jest wykluczona z personalizacji reklam.
eventTrigger

object (AudienceEventTrigger)

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

enum (AudienceExclusionDurationMode)

Niezmienna. Określa, jak długo wykluczenie ma obowiązywać w przypadku użytkowników, którzy spełniają kryteria filtra wykluczeń. Jest ona stosowana do wszystkich klauzul filtra EXCLUDE i ignorowana, gdy w grupie odbiorców nie ma klauzuli filtra EXCLUDE.
filterClauses[]

object (AudienceFilterClause)

Wymagane. Niezmienna. Lista nieuporządkowana. Klauzule filtra określające listę odbiorców. Wszystkie klauzule zostaną połączone za pomocą operatora AND.
createTime

string (Timestamp format)

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

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. 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łączy do listy odbiorców.

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

string

Wymagane. Nazwa zdarzenia, które zostanie zapisane w rejestrze.
logCondition

enum (LogCondition)

Wymagane. Kiedy rejestrować zdarzenie.

LogCondition

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

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

AudienceExclusionDurationMode

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

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

AudienceFilterClause

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

Pole unii filter.

filter może być tylko jednym z tych elementów:
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ępować w określonej kolejności, aby użytkownik mógł być członkiem listy odbiorców.

AudienceSimpleFilter

Określa prosty filtr, który użytkownik musi spełnić, aby należał 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 wymiaru listy odbiorców, danych lub filtrów 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 Nie podano zakresu.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Użytkownik dołącza do listy odbiorców, jeśli warunek filtra jest spełniony w ramach jednego zdarzenia.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Użytkownik dołącza do listy odbiorców, jeśli warunek filtra jest spełniony w ramach 1 sesji.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Użytkownik dołącza do listy odbiorców, jeśli warunek filtra jest spełniony przez dowolne zdarzenie w dowolnej sesji.

AudienceFilterExpression

Wyrażenie logiczne wymiaru listy odbiorców, danych lub filtrów 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 unii expr. Wyrażenie zastosowane do filtra. expr może być tylko jednym z tych elementów:
andGroup

object (AudienceFilterExpressionList)

Lista wyrażeń, które mają być połączone za pomocą operatora „AND”. Może zawierać tylko wyrażenia AudienceFilterExpressions z elementem orGroup. Musisz go ustawić na najwyższym poziomie wyrażenia AudienceFilterExpression.
orGroup

object (AudienceFilterExpressionList)

Lista wyrażeń do połączenia za pomocą operatora logicznego „LUB”. Nie może zawierać wyrażeń AudienceFilterExpressions z andGroup ani orGroup.
notExpression

object (AudienceFilterExpression)

Wyrażenie filtra, które ma być zanegowane (np. odwrócone lub uzupełnione). Może zawierać tylko element dimensionOrMetricFilter. Nie można go ustawić na najwyższym poziomie wyrażenia AudienceFilterExpression.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Filtr według jednego wymiaru lub rodzaju danych. Nie można go ustawić na najwyższym poziomie wyrażenia AudienceFilterExpression.
eventFilter

object (AudienceEventFilter)

Tworzy filtr pasujący do określonego zdarzenia. Nie można go ustawić na najwyższym poziomie wyrażenia AudienceFilterExpression.

AudienceFilterExpressionList

Lista wyrażeń filtra odbiorców.

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

object (AudienceFilterExpression)

Lista wyrażeń filtra odbiorców.

AudienceDimensionOrMetricFilter

Określony filtr dla pojedynczego wymiaru lub 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, według której chcesz filtrować. Jeśli nazwa pola odnosi się do wymiaru niestandardowego lub danych niestandardowych, przed nazwą wymiaru niestandardowego lub danych niestandardowych zostanie dodany prefiks zakresu. Więcej informacji o prefiksach zakresu lub wymiarach/danych niestandardowych znajdziesz w dokumentacji interfejsu Google Analytics Data API.
atAnyPointInTime

boolean

Opcjonalnie: Wskazuje, czy ten filtr wymaga oceny dynamicznej. Jeśli ta opcja jest ustawiona na „Prawda”, użytkownicy dołączają do listy odbiorców, jeśli kiedykolwiek spełnili dany warunek (ocena statyczna). Jeśli ta opcja nie jest ustawiona lub ma wartość Fałsz, ocena użytkownika na potrzeby listy odbiorców jest dynamiczna, co oznacza, że 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 danych Audience to ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opcjonalnie: W razie ustawienia określa okno czasowe, w którym mają być oceniane dane, w liczbie dni. Jeśli nie jest ustawiona, dane dotyczące odbiorców są oceniane na podstawie danych z całego okresu (np. nieskończonego okna czasowego).

Jeśli np. ustawisz 1 dzień, uwzględnione zostaną tylko dane z dzisiejszego dnia. Punkt odniesienia to bieżący dzień, gdy parametr atAnyPointInTime jest nieustawiony lub ma wartość false.

Można go ustawić tylko wtedy, gdy zakres danych na potrzeby kierowania na odbiorców to ACROSS_ALL_SESSIONS, a czas nie może przekraczać 60 dni.
Pole unii one_filter. Jeden z wymienionych powyżej filtrów. one_filter może być tylko jednym z tych elementów:
stringFilter

object (StringFilter)

Filtr wymiaru typu ciąg znaków pasujący do określonego wzorca.
inListFilter

object (InListFilter)

Filtr wymiaru ciągu znaków pasującego do określonej listy opcji.
numericFilter

object (NumericFilter)

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

object (BetweenFilter)

Filtr wartości liczbowych lub datowych między określonymi wartościami wymiaru lub wskaźnika.

StringFilter

Filtr wymiaru typu ciąg znaków pasujący 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, z którą ma być przeprowadzane dopasowanie.
caseSensitive

boolean

Opcjonalnie: Jeśli ma wartość true, wielkość liter ma znaczenie. Jeśli wartość to fałsz, wielkość liter nie ma znaczenia.

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 znaków.
BEGINS_WITH zaczyna się od ciągu znaków;
ENDS_WITH Kończy się wartością ciągu znaków.
CONTAINS Zawiera wartość ciągu znaków.
FULL_REGEXP Całkowite wyrażenie regularne pasuje do wartości ciągu znaków.

InListFilter

Filtr wymiaru ciągu znaków pasującego do określonej listy opcji.

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

string

Wymagane. Lista możliwych wartości ciągu znaków, które mają być dopasowywane. nie może być puste.
caseSensitive

boolean

Opcjonalnie: Jeśli ma wartość true, wielkość liter ma znaczenie. Jeśli wartość to fałsz, wielkość liter nie ma znaczenia.

NumericFilter

Filtr według 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, do której ma być dopasowywana wartość.

Operacja

Operacja zastosowana do filtra liczbowego.

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

NumericValue

Reprezentowanie 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 unii one_value. Wartość liczbowa. one_value może być tylko jednym z tych elementów:
int64Value

string (int64 format)

Wartość liczby całkowitej.
doubleValue

number

Wartość typu double.

BetweenFilter

Filtr wartości liczbowych lub datowych między określonymi wartościami wymiaru lub wskaźnika.

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

object (NumericValue)

Wymagane. zaczyna się od tej liczby, w tym tej liczby;
toValue

object (NumericValue)

Wymagane. Kończy się tym numerem włącznie.

AudienceEventFilter

Filtr, który pasuje do zdarzeń o tej samej nazwie. Jeśli podany jest parametr zdarzenia, do tego filtra pasuje tylko podzbiór zdarzeń, które odpowiadają zarówno nazwie pojedynczego zdarzenia, jak i wyrazom filtra parametru.

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

string

Wymagane. Niezmienna. Nazwa zdarzenia, z którym ma być dopasowywane.
eventParameterFilterExpression

object (AudienceFilterExpression)

Opcjonalnie: Jeśli jest określony, filtr ten pasuje do zdarzeń, które pasują zarówno do nazwy pojedynczego zdarzenia, jak i do wyrażeń filtra parametrów. Nie można ustawić wyrażenia filtra parametrów AudienceEventFilter (np. zagnieżchnia filtrów zdarzeń nie są obsługiwane). Powinien to być pojedynczy element andGroup z wymiaruOrMetricFilter lub notExpression; operatory AND z OR nie są obsługiwane. Jeśli zawiera on filtr „eventCount”, zostanie uwzględniony tylko on, a pozostałe filtry zostaną zignorowane.

AudienceSequenceFilter

Określa filtry, które muszą występować w określonej kolejności, aby użytkownik mógł należeć do listy 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 w sekundach z maksymalnie 9 miejscami po przecinku, zakończony literą „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 to ustawienie ma wartość Prawda, 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, oznacza to, że ten krok pośrednio następuje po poprzednim kroku. Może to oznaczać, że między tymi krokami występują inne zdarzenia. Jest on ignorowany w pierwszym kroku.
constraintDuration

string (Duration format)

Opcjonalnie: Gdy jest ustawiony, ten krok musi być spełniony w ramach czasu określonego przez parametr constraintDuration poprzedniego kroku (np. t[i] – t[i-1] <= constraintDuration). Jeśli nie jest ustawiony, nie ma wymogu dotyczącego czasu trwania (czas trwania jest w zasadzie nieograniczony). Jest on ignorowany w pierwszym kroku.

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

object (AudienceFilterExpression)

Wymagane. Niezmienna. Wyrażenie logiczne określające wymiar Odbiorcy, dane lub filtry zdarzeń na 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 Użytkownicy zostaną dodani do listy odbiorców, jeśli zostanie spełniona klauzula filtra.
EXCLUDE Użytkownicy zostaną wykluczeni z listy odbiorców, jeśli zostanie spełniony warunek 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

 Zaktualizuje listę odbiorców w usłudze.