REST Resource: properties.audiences

Kaynak: Kitle

GA4 kitlesini temsil eden bir 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: mülkler/{propertyId}/audiences/{audienceId}

displayName

string

Zorunlu. Kitlenin görünen adı.

description

string

Zorunlu. Kitlenin açıklaması.

membershipDurationDays

integer

Zorunlu. Sabit. 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ç tutulduysa GA tarafından otomatik olarak false (yanlış) değerine ayarlanır.

eventTrigger

object (AudienceEventTrigger)

İsteğe bağlı. Bir kullanıcı Kitleye katıldığında günlüğe kaydedilecek bir etkinliği belirtir. Politika ayarlanmadan bırakılırsa bir kullanıcı Kitleye katıldığında hiçbir etkinlik günlüğe kaydedilmez.

exclusionDurationMode

enum (AudienceExclusionDurationMode)

Sabit. Hariç tutma filtresini karşılayan kullanıcılar için hariç tutma işleminin ne kadar süreceğini belirtir. Tüm HARİÇ TUT filtre deyimlerine uygulanır ve Kitlede HARİÇ TUT filtre ifadesi yoksa yoksayılır.

filterClauses[]

object (AudienceFilterClause)

Zorunlu. Sabit. Sırasız liste. Kitleyi tanımlayan ifadeleri filtreleyin. Tüm ifadeler bir arada VE "VE" olacaktır.

createTime

string (Timestamp format)

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

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

AudienceEventTrigger

Bir kullanıcı Kitleye katıldığında günlüğe kaydedilecek bir etkinliği 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 günlüğe 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 belirtilmedi.
AUDIENCE_JOINED Etkinlik yalnızca bir kullanıcı katıldığında günlüğe kaydedilmelidir.
AUDIENCE_MEMBERSHIP_RENEWED Kullanıcı zaten Kitlenin üyesi olsa bile Kitle koşulu her karşılandığında etkinlik günlüğe kaydedilmelidir.

AudienceExclusionDurationMode

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

Sıralamalar
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Belirtilmedi.
EXCLUDE_TEMPORARILY Filtre ifadesini karşıladıkları dönemlerde kullanıcıları Kitleden hariç tutun.
EXCLUDE_PERMANENTLY Filtre ifadesini daha önce karşılamış olan kullanıcıları Kitleden hariç tutun.

AudienceFilterClause

Basit veya sıralı filtreleri tanımlamak için kullanılan ifade. Bir filtre kapsayıcı (Örneğin, filtre ifadesini karşılayan kullanıcılar Kitleye dahil edilir) veya dışlayıcı (Ö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 filtre koşulu olup olmadığını belirtir.

Birleştirme alanı filter.

filter şunlardan yalnızca biri olabilir:

simpleFilter

object (AudienceSimpleFilter)

Bir kullanıcının Kitlenin üyesi olmak için karşılaması gereken basit bir filtre.

sequenceFilter

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

Kullanıcının Kitlenin ü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. Sabit. Bu filtre için kapsamı belirtir.

filterExpression

object (AudienceFilterExpression)

Zorunlu. Sabit. Kitle boyutu, metriği veya etkinlik filtrelerinin mantıksal ifadesi.

AudienceFilterScope

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

Sıralamalar
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Kapsam belirtilmedi.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Filtre koşulu bir etkinlikte karşılanırsa kullanıcı Kitleye katılır.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Filtre koşulu bir oturumda karşılanırsa kullanıcı Kitleye katılır.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Filtre koşulu oturumlardaki herhangi bir etkinlik tarafından karşılanırsa kullanıcı Kitleye katılır.

AudienceFilterExpression

Kitle boyutu, metriği 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
Birleştirme alanı expr. Bir filtreye uygulanan ifade. expr şunlardan yalnızca biri olabilir:
andGroup

object (AudienceFilterExpressionList)

Birlikte VE olacak ifadelerin listesi. Yalnızca orGroup ile AudienceFilterExpressions içerebilir. Bu, üst düzey AudienceFilterExpression için ayarlanmalıdır.

orGroup

object (AudienceFilterExpressionList)

Birlikte VEYA eklenen ifadelerin listesi. andGroup veya orGroup ile AudienceFilterExpressions içeremez.

notExpression

object (AudienceFilterExpression)

DEĞİŞTİRİLMEYECEK filtre ifadesi (ör. ters çevrilmiş, tamamlanan). Yalnızca boyutOrMetricFilter içerebilir. Bu, üst düzey AudienceFilterExpression'da ayarlanamaz.

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Tek bir boyut veya metrik için filtre. Bu, üst düzey AudienceFilterExpression'da ayarlanamaz.

eventFilter

object (AudienceEventFilter)

Belirli bir etkinlikle eşleşen bir filtre oluşturur. Bu, üst düzey AudienceFilterExpression'da 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. Sabit. Filtrelenecek boyut adı veya metrik adı. Alan adı bir özel boyuta veya metriğe işaret 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 Data API belgelerini inceleyin.

atAnyPointInTime

boolean

İsteğe bağlı. Bu filtrenin dinamik değerlendirmeye ihtiyaç duyup duymadığını belirtir. Doğru değerine ayarlanırsa kullanıcılar koşulu daha önce karşılamışlarsa (statik değerlendirme) Kitleye katılır. Politika ayarlanmazsa veya yanlış değerine ayarlanırsa Kitle için kullanıcı değerlendirmesi dinamik olur; Kullanıcılar koşulları karşıladığında Kitleye eklenir ve artık karşılamadığı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 gün sayısı olarak değerlendirileceği zaman aralığını belirtir. Politika ayarlanmazsa kitle verileri yaşam boyu verilere (ör. sonsuz zaman aralığı) göre değerlendirilir.

Örneğin, 1 gün olarak ayarlanırsa yalnızca geçerli günün verileri değerlendirilir. Referans noktası, atAnyPointInTime öğesinin ayarlanmadığı veya false (yanlış) değerine ayarlandığı geçerli gündür.

Yalnızca kitle kapsamı ACROSS_ALL_SESSIONS olduğunda ayarlanabilir ve 60 günden uzun olamaz.

Birleştirme alanı one_filter. Yukarıdaki filtrelerden biri. one_filter şunlardan yalnızca biri olabilir:
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

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

numericFilter

object (NumericFilter)

Bir boyut veya metrikteki sayısal değerler veya tarih değerleri için bir filtre.

betweenFilter

object (BetweenFilter)

Bir boyut veya metrikte belirli değerler arasındaki sayısal değerler veya tarih değerleri için bir filtre.

StringFilter

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

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

enum (MatchType)

Zorunlu. Dize filtresi için eşleme türü.

value

string

Zorunlu. Karşılaştırılacak dize değeri.

caseSensitive

boolean

İsteğe bağlı. True (doğru) ise eşleşme büyük/küçük harfe duyarlıdır. Yanlışsa eşleşme büyük/küçük harfe duyarlı değildir.

MatchType

Dize filtresi için eşleme 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 Tam normal ifade, dize değeriyle eşleşir.

InListFilter

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

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

string

Zorunlu. Eşleştirme yapılacak olası dize değerlerinin listesi. Boş bırakılamaz.

caseSensitive

boolean

İsteğe bağlı. True (doğru) ise eşleşme büyük/küçük harfe duyarlıdır. Yanlışsa eşleşme büyük/küçük harfe duyarlı değildir.

NumericFilter

Bir boyut veya metrikteki sayısal değerler veya tarih değerleri için bir filtre.

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

enum (Operation)

Zorunlu. Sayısal bir filtreye uygulanan işlem.

value

object (NumericValue)

Zorunlu. Eşleştirme yapılacak sayısal veya tarih değeridir.

İşlem

Sayısal bir filtreye uygulanan işlem.

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

NumericValue

Bir sayıyı temsil eder.

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
Birleştirme alanı one_value. Sayısal değerlerden biri. one_value şunlardan yalnızca biri olabilir:
int64Value

string (int64 format)

Tam sayı değeri.

doubleValue

number

Çift değer.

BetweenFilter

Bir boyut veya metrikte belirli değerler arasındaki sayısal değerler veya tarih değerleri için bir 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 sayıyla (bu sayı dahil) biter.

AudienceEventFilter

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

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

string

Zorunlu. Sabit. Eşleştirme yapılacak etkinliğin adı.

eventParameterFilterExpression

object (AudienceFilterExpression)

İsteğe bağlı. Belirtilmesi durumunda bu filtre, hem tek etkinlik adı hem de parametre filtresi ifadeleriyle eşleşen etkinlikleri eşleştirir. Parametre filtresi ifadesinin içindeki AudienceEventFilter ayarlanamıyor (Örneğin, iç içe yerleştirilmiş etkinlik filtreleri desteklenmez). Bu, tek bir boyutOrMetricFilter veya notExpression türünde bir &Group olmalıdır; OR operatörleri desteklenmez. Ayrıca, "eventCount" için bir filtre içeriyorsa yalnızca bu filtre dikkate alınır; diğer tüm filtreler yoksayılır.

AudienceSequenceFilter

Kullanıcının Kitlenin üyesi olması için belirli bir sırada uygulanması gereken filtreleri tanımlar.

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

enum (AudienceFilterScope)

Zorunlu. Sabit. Bu filtre için kapsamı belirtir.

sequenceMaximumDuration

string (Duration format)

İsteğe bağlı. Tüm dizinin gerçekleşmesi gereken dönemi tanımlar.

En fazla dokuz kesir basamağı olan ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

sequenceSteps[]

object (AudienceSequenceStep)

Zorunlu. Sıralı bir adım dizisi. Kullanıcı, sıra filtresine katılabilmek için her adımı tamamlamalıdır.

AudienceSequenceStep

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

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

enum (AudienceFilterScope)

Zorunlu. Sabit. Bu adımın kapsamını belirtir.

immediatelyFollows

boolean

İsteğe bağlı. Doğru değerine ayarlanırsa bu adımı karşılayan etkinlik, son adımı karşılayan etkinlikten sonraki etkinlik olmalıdır. Ayarlanmazsa veya false ise bu adım dolaylı olarak önceki adımın ardından gelir; Örneğin, önceki adımla bu adım arasında etkinlikler olabilir. İlk adım için yoksayılır.

constraintDuration

string (Duration format)

İsteğe bağlı. Ayarlandığında, bu adım önceki adımın restrictedDuration (örneğin, t[i] - t[i-1] <=restrictionDuration) dahilinde gerçekleştirilmelidir. Politika ayarlanmazsa süre şartı yoktur (süre fiilen sınırsızdır). İlk adım için yoksayılır.

En fazla dokuz kesir basamağı olan ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

filterExpression

object (AudienceFilterExpression)

Zorunlu. Sabit. Her adımdaki Kitle boyutu, metriği veya etkinlik filtrelerinin mantıksal ifadesi.

AudienceClauseType

Bunun bir dahil etme veya hariç tutma filtre koşulu olup olmadığını belirtir.

Sıralamalar
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Belirtilmemiş ifade türü.
INCLUDE Filtre koşulu karşılanırsa kullanıcılar Kitleye dahil edilir.
EXCLUDE Filtre koşulu karşılanırsa kullanıcılar Kitleden hariç tutulur.

Yöntemler

archive

Bir mülkteki Kitleyi arşivler.

create

Kitle oluşturur.

get

Tek bir Kitle arayın.

list

Bir mülkteki kitleleri listeler.

patch

Bir mülkteki Kitleyi günceller.