REST Resource: properties.audiences

Kaynak: Kitle

Bir kitleyi temsil eden kaynak mesaj.

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

string

Yalnızca çıkış. Bu kitle kaynağının kaynak adı. Biçim: properties/{propertyId}/audiences/{audienceId}

displayName

string

Zorunlu. Kitlenin görünen adı.

description

string

Zorunlu. Kitlenin açıklaması.

membershipDurationDays

integer

Zorunlu. Değişmez. Kullanıcının bir kitlede kalması gereken süre. 540 günden uzun bir süreye ayarlanamaz.

adsPersonalizationEnabled

boolean

Yalnızca çıkış. Bu bir NPA kitlesiyse ve reklam kişiselleştirmeden hariç tutuluyorsa GA tarafından otomatik olarak yanlış olarak ayarlanır.

eventTrigger

object (AudienceEventTrigger)

İsteğe bağlı. Kullanıcı kitleye katıldığında kaydedilecek bir etkinlik belirtir. Ayarlanmazsa kullanıcı kitleye katıldığında hiçbir etkinlik kaydedilmez.

exclusionDurationMode

enum (AudienceExclusionDurationMode)

Değişmez. Hariç tutma filtresini karşılayan kullanıcılar için hariç tutmanın ne kadar süreceğini belirtir. Tüm HARIÇ TUT filtresi yan tümcelerine uygulanır ve kitlede HARIÇ TUT filtresi yan tümcesi olmadığında yoksayılır.

filterClauses[]

object (AudienceFilterClause)

Zorunlu. Değişmez. Sırasız liste. Kitleyi tanımlayan filtreleme koşulları. Tüm maddeler "VE" ile bağlanır.

createTime

string (Timestamp format)

Yalnızca çıkış. Kitlenin oluşturulduğu zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

AudienceEventTrigger

Kullanıcı kitleye katıldığında kaydedilecek bir etkinlik belirtir.

JSON gösterimi
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Alanlar
eventName

string

Zorunlu. Günlüğe kaydedilecek etkinlik adı.

logCondition

enum (LogCondition)

Zorunlu. Etkinliğin ne zaman kaydedileceği.

LogCondition

Etkinliğin ne zaman günlüğe kaydedileceğini belirler.

Sıralamalar
LOG_CONDITION_UNSPECIFIED Günlük koşulu belirtilmemiş.
AUDIENCE_JOINED Etkinlik yalnızca kullanıcı katıldığında kaydedilmelidir.
AUDIENCE_MEMBERSHIP_RENEWED Kullanıcı zaten kitlenin üyesi olsa bile kitle koşulu karşılandığında etkinlik kaydedilmelidir.

AudienceExclusionDurationMode

Hariç tutma filtresini karşılayan kullanıcılar için hariç tutmanın ne kadar süreceğini belirtir.

Sıralamalar
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Belirtilmedi.
EXCLUDE_TEMPORARILY Kullanıcıları, filtre koşulunu karşıladıkları dönemlerde kitleden hariç tutun.
EXCLUDE_PERMANENTLY Filtre koşulunu daha önce karşılamış olan kullanıcıları kitlenin dışında tutun.

AudienceFilterClause

Basit veya sıralı filtre tanımlamak için kullanılan bir koşul. Filtreler kapsayıcı (örneğin, filtre ifadesini karşılayan kullanıcılar kitleye dahil edilir) veya hariç tutucu (örneğin, filtre ifadesini karşılayan kullanıcılar kitleden hariç tutulur) olabilir.

JSON gösterimi
{
  "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.
}
Alanlar
clauseType

enum (AudienceClauseType)

Zorunlu. Bunun bir dahil etme veya hariç tutma filtresi ifadesi olup olmadığını belirtir.

filter birleşik alanı.

filter aşağıdakilerden yalnızca biri olabilir:

simpleFilter

object (AudienceSimpleFilter)

Kullanıcının kitle üyesi olabilmesi için karşılaması gereken basit bir filtre.

sequenceFilter

object (AudienceSequenceFilter)

Kullanıcının kitle üyesi olması için belirli bir sırada gerçekleşmesi gereken filtreler.

AudienceSimpleFilter

Kullanıcının kitle üyesi olmak için karşılaması gereken basit bir filtre tanımlar.

JSON gösterimi
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Alanlar
scope

enum (AudienceFilterScope)

Zorunlu. Değişmez. Bu filtrenin kapsamını belirtir.

filterExpression

object (AudienceFilterExpression)

Zorunlu. Değişmez. Kitle boyutu, metrik veya etkinlik filtrelerinin mantıksal ifadesi.

AudienceFilterScope

Kullanıcıların bir kitleye katılmak için nasıl değerlendirileceğini belirtir.

Sıralamalar
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Kapsam belirtilmemiş.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Filtre koşulu bir etkinlik içinde karşılanırsa kullanıcı kitleye katılır.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Filtre koşulu bir oturum içinde karşılanırsa kullanıcı kitleye katılır.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Filtre koşulu herhangi bir oturumdaki herhangi bir etkinlik tarafından karşılanırsa kullanıcı kitleye katılır.

AudienceFilterExpression

Kitle boyutu, metrik veya etkinlik filtrelerinin mantıksal ifadesi.

JSON gösterimi
{

  // 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.
}
Alanlar
expr birleşik alanı. Filtreye uygulanan ifade. expr aşağıdakilerden yalnızca biri olabilir:
andGroup

object (AudienceFilterExpressionList)

Birlikte AND işlemine tabi tutulacak ifadelerin listesi. Yalnızca orGroup ile AudienceFilterExpressions içerebilir. Bu, üst düzey AudienceFilterExpression için ayarlanmalıdır.

orGroup

object (AudienceFilterExpressionList)

Birlikte "VEYA" işlemi uygulanacak ifadelerin listesi. andGroup veya orGroup içeren AudienceFilterExpression'lar içeremez.

notExpression

object (AudienceFilterExpression)

NOT işlemi uygulanacak bir filtre ifadesi (örneğin, ters çevrilmiş, tamamlanmış). Yalnızca bir DimensionOrMetricFilter içerebilir. Bu, üst düzey AudienceFilterExpression üzerinde ayarlanamaz.

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Tek bir boyut veya metrikteki filtre. Bu, üst düzey AudienceFilterExpression üzerinde ayarlanamaz.

eventFilter

object (AudienceEventFilter)

Belirli bir etkinlikle eşleşen bir filtre oluşturur. Bu, üst düzey AudienceFilterExpression üzerinde ayarlanamaz.

AudienceFilterExpressionList

Kitle filtresi ifadelerinin listesi.

JSON gösterimi
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Alanlar
filterExpressions[]

object (AudienceFilterExpression)

Kitle filtresi ifadelerinin listesi.

AudienceDimensionOrMetricFilter

Tek bir boyut veya metrik için belirli bir filtre.

JSON gösterimi
{
  "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.
}
Alanlar
fieldName

string

Zorunlu. Değişmez. Filtrelenecek boyut adı veya metrik adı. Alan adı bir özel boyutu veya metriği ifade ediyorsa özel boyutların veya metrik adının önüne bir kapsam öneki eklenir. Kapsam önekleri veya özel boyutlar/metrikler hakkında daha fazla bilgi için Google Analytics Veri API'si dokümanlarına bakın.

atAnyPointInTime

boolean

İsteğe bağlı. Bu filtrenin dinamik değerlendirmeye ihtiyacı olup olmadığını gösterir. Doğru olarak ayarlanırsa koşulu daha önce karşılayan kullanıcılar kitleye katılır (statik değerlendirme). Ayarlanmamışsa veya yanlış olarak ayarlanmışsa bir kitlenin kullanıcı değerlendirmesi dinamik olur. Bu durumda, kullanıcılar koşulları karşıladığında kitleye eklenir, karşılamayı bıraktıklarında kaldırılır.

Bu yalnızca Kitle kapsamı ACROSS_ALL_SESSIONS olduğunda ayarlanabilir.

inAnyNDayPeriod

integer

İsteğe bağlı. Ayarlanırsa verilerin değerlendirileceği zaman aralığını gün cinsinden belirtir. Ayarlanmazsa kitle verileri yaşam boyu verilerle karşılaştırılarak değerlendirilir (ör. sonsuz zaman aralığı).

Örneğin, 1 gün olarak ayarlanırsa yalnızca geçerli günün verileri değerlendirilir. atAnyPointInTime ayarlanmamışsa veya yanlışsa referans noktası geçerli gündür.

Yalnızca kitle kapsamı ACROSS_ALL_SESSIONS olduğunda ayarlanabilir ve 60 günü aşamaz.

one_filter birleşik alanı. Yukarıdaki filtrelerden biri. one_filter aşağıdakilerden yalnızca biri olabilir:
stringFilter

object (StringFilter)

Belirli bir kalıpla eşleşen dize türü bir boyut için filtre.

inListFilter

object (InListFilter)

Belirli bir seçenek listesiyle eşleşen dize boyutu için filtre.

numericFilter

object (NumericFilter)

Bir boyuttaki veya metrikteki sayısal ya da tarih değerleri için filtre.

betweenFilter

object (BetweenFilter)

Bir boyuttaki veya metrikteki belirli değerler arasındaki sayısal ya da tarih değerleri için filtre.

StringFilter

Belirli bir kalıpla eşleşen dize türü bir boyut için filtre.

JSON gösterimi
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Alanlar
matchType

enum (MatchType)

Zorunlu. Dize filtresinin eşleşme türü.

value

string

Zorunlu. Eşleştirilecek dize değeri.

caseSensitive

boolean

İsteğe bağlı. Doğruysa eşleşme büyük/küçük harfe duyarlıdır. Yanlış ise eşleşme büyük/küçük harfe duyarlı değildir.

MatchType

Dize filtresinin eşleşme türü.

Sıralamalar
MATCH_TYPE_UNSPECIFIED Belirtilmedi
EXACT Dize değerinin tam eşleşmesi.
BEGINS_WITH Dize değeriyle başlar.
ENDS_WITH Dize değeriyle biter.
CONTAINS Dize değerini içerir.
FULL_REGEXP Normal ifadeler, dize değeriyle tam olarak eşleşir.

InListFilter

Belirli bir seçenek listesiyle eşleşen dize boyutu için filtre.

JSON gösterimi
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Alanlar
values[]

string

Zorunlu. Eşleştirilecek olası dize değerlerinin listesi. Boş olmamalıdır.

caseSensitive

boolean

İsteğe bağlı. Doğruysa eşleşme büyük/küçük harfe duyarlıdır. Yanlış ise eşleşme büyük/küçük harfe duyarlı değildir.

NumericFilter

Bir boyuttaki veya metrikteki sayısal ya da tarih değerleri için filtre.

JSON gösterimi
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Alanlar
operation

enum (Operation)

Zorunlu. İşlem, sayısal bir filtreye uygulandı.

value

object (NumericValue)

Zorunlu. Eşleştirilecek sayısal veya tarih değeri.

İşlem

İşlem, sayısal bir filtreye uygulandı.

Sıralamalar
OPERATION_UNSPECIFIED Belirtilmedi.
EQUAL Eşit.
LESS_THAN Şundan küçük:
GREATER_THAN Şundan büyük:

NumericValue

Bir sayıyı temsil etmek için.

JSON gösterimi
{

  // 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.
}
Alanlar
one_value birleşik alanı. Sayısal bir değer. one_value aşağıdakilerden yalnızca biri olabilir:
int64Value

string (int64 format)

Tam sayı değeri.

doubleValue

number

Çift değer.

BetweenFilter

Bir boyuttaki veya metrikteki belirli değerler arasındaki sayısal ya da tarih değerleri için filtre.

JSON gösterimi
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Alanlar
fromValue

object (NumericValue)

Zorunlu. Bu sayıyla başlar (bu sayı dahil).

toValue

object (NumericValue)

Zorunlu. Bu numarayla (bu numara dahil) biter.

AudienceEventFilter

Tek bir etkinlik adının etkinlikleriyle eşleşen filtre. Bir etkinlik parametresi belirtilirse bu etkinlik filtresiyle yalnızca hem tek etkinlik adıyla hem de parametre filtresi ifadeleriyle eşleşen etkinliklerin alt kümesi eşleşir.

JSON gösterimi
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Alanlar
eventName

string

Zorunlu. Değişmez. Karşılaştırılacak etkinliğin adı.

eventParameterFilterExpression

object (AudienceFilterExpression)

İsteğe bağlı. Belirtilirse bu filtre, hem tek etkinlik adıyla hem de parametre filtresi ifadeleriyle eşleşen etkinliklerle eşleşir. Parametre filtresi ifadesindeki AudienceEventFilter ayarlanamaz (örneğin, iç içe yerleştirilmiş etkinlik filtreleri desteklenmez). Bu, tek bir andGroup of dimensionOrMetricFilter veya notExpression olmalıdır. OR'ların AND'leri desteklenmez. Ayrıca, "eventCount" için bir filtre içeriyorsa yalnızca bu filtre dikkate alınır, diğer tüm filtreler yok sayılır.

AudienceSequenceFilter

Kullanıcının kitle üyesi olması için belirli bir sırada gerçekleşmesi gereken filtreleri tanımlar.

JSON gösterimi
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Alanlar
scope

enum (AudienceFilterScope)

Zorunlu. Değişmez. Bu filtrenin kapsamını belirtir.

sequenceMaximumDuration

string (Duration format)

İsteğe bağlı. Tüm adım sırasının tamamlanması için gereken süreyi tanımlar.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

sequenceSteps[]

object (AudienceSequenceStep)

Zorunlu. Sıralı bir adım dizisi. Bir kullanıcının sıra filtresine katılabilmesi için her adımı tamamlaması gerekir.

AudienceSequenceStep

Bu kullanıcının sırayla eşleşmesi için belirtilen adım sırasıyla gerçekleşmesi gereken bir koşul.

JSON gösterimi
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Alanlar
scope

enum (AudienceFilterScope)

Zorunlu. Değişmez. Bu adımın kapsamını belirtir.

immediatelyFollows

boolean

İsteğe bağlı. Doğruysa bu adımı karşılayan etkinlik, son adımı karşılayan etkinlikten hemen sonraki etkinlik olmalıdır. Ayarlanmamışsa veya yanlışsa bu adım, önceki adımı dolaylı olarak takip eder. Örneğin, önceki adım ile bu adım arasında etkinlikler olabilir. İlk adımda yoksayılır.

constraintDuration

string (Duration format)

İsteğe bağlı. Bu adım ayarlandığında önceki adımın constraintDuration'ı içinde karşılanmalıdır (örneğin, t[i] - t[i-1] <= constraintDuration). Ayarlanmazsa süre şartı yoktur (süre etkin bir şekilde sınırsızdır). İlk adımda yoksayılır.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

filterExpression

object (AudienceFilterExpression)

Zorunlu. Değişmez. Her adımda kitle boyutu, metrik veya etkinlik filtrelerinin mantıksal ifadesi.

AudienceClauseType

Bunun bir dahil etme veya hariç tutma filtresi ifadesi olup olmadığını belirtir.

Sıralamalar
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Belirtilmemiş madde türü.
INCLUDE Filtre ifadesi karşılanırsa kullanıcılar kitleye dahil edilir.
EXCLUDE Filtre koşulu karşılanırsa kullanıcılar kitlenin dışında tutulur.

Yöntemler

archive

Bir mülkteki kitleyi arşivler.

create

Kitle oluşturur.

get

Tek bir kitle için arama yapın.

list

Bir mülkteki kitleleri listeler.

patch

Bir mülkteki kitleyi günceller.