REST Resource: properties.audiences

Kaynak: Kitle

Bir kitleyi 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: 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 kitle içinde 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ıdır. Kullanıcı kitleye katıldığında günlüğe kaydedilecek bir etkinlik belirtir. Ayarlanmamışsa kullanıcı kitleye katıldığında hiçbir etkinlik günlüğe kaydedilmez.

exclusionDurationMode

enum (AudienceExclusionDurationMode)

Değişmez. Hariç tutma filtresini karşılayan kullanıcılar için hariç tutma süresini belirtir. Tüm EXCLUDE filtre yan tümcelerine uygulanır ve Kitlede EXCLUDE filtre yan tümcesi olmadığında yoksayılır.

filterClauses[]

object (AudienceFilterClause)

Zorunlu. Değişmez. Sırasız liste. Kitleyi tanımlayan filtre yan tümceleri. Tüm yan tümceler birlikte VE bağlamında birleştirilir.

createTime

string (Timestamp format)

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

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de 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 günlüğe 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 günlüğe 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 bir kullanıcı katıldığında günlüğe kaydedilmelidir.
AUDIENCE_MEMBERSHIP_RENEWED Kullanıcı halihazırda 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 süresini belirtir.

Sıralamalar
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Belirtilmedi.
EXCLUDE_TEMPORARILY Kullanıcıları, filtre yan tümcesini karşıladıkları dönemlerde kitlenin dışında tutun.
EXCLUDE_PERMANENTLY Filtre yan tümcesini daha önce karşılamış olan kullanıcıları kitlenin dışında tutun.

AudienceFilterClause

Basit veya sıra filtresi tanımlamak için kullanılan bir koşul. Filtreler kapsayıcı (ör. filtre ifadesini karşılayan kullanıcılar Kitleye dahil edilir) veya hariç tutucu (ör. 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 mi yoksa hariç tutma filtresi mi olduğunu belirtir.

Birlik alanı filter.

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

simpleFilter

object (AudienceSimpleFilter)

Kullanıcının kitleye üye olmak için karşılaması gereken basit bir filtre.

sequenceFilter

object (AudienceSequenceFilter)

Kullanıcının kitleye üye olabilmesi için belirli bir sırada gerçekleşmesi gereken filtreler.

AudienceSimpleFilter

Kullanıcının Kitle'nin ü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 oturumda 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
Birlik alanı expr. Bir filtreye uygulanan ifade. expr yalnızca aşağıdakilerden biri olabilir:
andGroup

object (AudienceFilterExpressionList)

Birlikte VE operatörüyle birleştirilecek ifadelerin listesi. Yalnızca orGroup içeren 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 AudienceFilterExpressions içeremez.

notExpression

object (AudienceFilterExpression)

DEĞİL operatörünün uygulanacağı bir filtre ifadesi (ör. ters çevrilmiş, tamamlanmış). Yalnızca bir dimensionOrMetricFilter içerebilir. Bu, üst düzey AudienceFilterExpression'de ayarlanamaz.

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Tek bir boyut veya metriğe uygulanan filtre. Bu, üst düzey AudienceFilterExpression'de ayarlanamaz.

eventFilter

object (AudienceEventFilter)

Belirli bir etkinlikle eşleşen bir filtre oluşturur. Bu, üst düzey AudienceFilterExpression'de 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. Filtre uygulanacak boyut adı veya metrik adı. Alan adı bir özel boyutu veya metriği ifade ediyorsa özel boyutun ya da metrik adının önüne bir kapsam ön eki eklenir. Kapsam ön ekleri veya özel boyutlar/metrikler hakkında daha fazla bilgi için Google Analytics Data API belgelerine bakın.

atAnyPointInTime

boolean

İsteğe bağlıdır. Bu filtrenin dinamik değerlendirmeye ihtiyaç duyup duymadığını belirtir. Doğru olarak ayarlanırsa kullanıcılar koşulu daha önce karşılamışsa kitleye katılır (statik değerlendirme). Ayarlanmazsa veya yanlış olarak ayarlanırsa 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ıdır. Ayarlanırsa verilerin değerlendirileceği zaman aralığını gün sayısı olarak belirtir. Ayarlanmazsa kitle verileri yaşam boyu verilere göre değerlendirilir (ör. sonsuz zaman aralığı).

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

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

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

object (StringFilter)

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

inListFilter

object (InListFilter)

Belirli bir seçenek listesiyle eşleşen bir dize boyutu filtresi.

numericFilter

object (NumericFilter)

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

betweenFilter

object (BetweenFilter)

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

StringFilter

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

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

enum (MatchType)

Zorunlu. Dize filtresinin eşleme türü.

value

string

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

caseSensitive

boolean

İsteğe bağlıdır. Doğru ise 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ş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 bir dize boyutu filtresi.

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

string

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

caseSensitive

boolean

İsteğe bağlıdır. Doğru ise 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 boyut 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 uygulanır.

value

object (NumericValue)

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

İşlem

İşlem, sayısal bir filtreye uygulanır.

Sıralamalar
OPERATION_UNSPECIFIED Belirtilmedi.
EQUAL Eşit.
LESS_THAN Küçüktür.
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
Birlik alanı one_value. Sayısal değerlerden biri. one_value yalnızca aşağıdakilerden biri olabilir:
int64Value

string (int64 format)

Tam sayı değeri.

doubleValue

number

Çift değer.

BetweenFilter

Bir boyut veya metrikteki belirli değerler arasındaki sayısal 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 (dahil).

toValue

object (NumericValue)

Zorunlu. Bu sayıyla biter (bu sayı dahil).

AudienceEventFilter

Tek bir etkinlik adıyla eşleşen etkinlikleri içeren bir filtre. Bir etkinlik parametresi belirtilirse yalnızca hem tek etkinlik adıyla 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. Değişmez. Eşleştirilecek etkinliğin adı.

eventParameterFilterExpression

object (AudienceFilterExpression)

İsteğe bağlıdır. Belirtilen bu filtre, hem tek etkinlik adıyla hem de parametre filtresi ifadeleriyle eşleşen etkinlikleri eşleştirir. Parametre filtresi ifadesi içindeki AudienceEventFilter ayarlanamaz (ör. iç içe yerleştirilmiş etkinlik filtreleri desteklenmez). Bu, tek bir andGroup of dimensionOrMetricFilter veya notExpression olmalıdır; VE'lerin VE'leri 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 kitleye üye 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ıdır. Tüm adım sırasının ne kadar sürede gerçekleşmesi gerektiğini 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. Kullanıcıların, sıra filtresine katılmak 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ına göre 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ıdır. Doğru ise 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ıdır. Ayarlandığında bu adım, önceki adımın constraintDuration süresi içinde karşılanmalıdır (örneğin, t[i] - t[i-1] <= constraintDuration). Ayarlanmazsa süre koşulu 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 mi yoksa hariç tutma filtresi mi olduğunu belirtir.

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

Yöntemler

archive

Bir mülkte kitle arşivler.

create

Bir 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.