REST Resource: properties.audiences

Referensi: Audiens

Pesan resource yang mewakili Audiens GA4.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ]
}
Kolom
name

string

Hanya output. Nama resource untuk resource Audiens ini. Format: properties/{propertyId}/audiences/{audienceId}
displayName

string

Wajib. Nama tampilan Audiens.
description

string

Wajib. Deskripsi Audiens.
membershipDurationDays

integer

Wajib. Tidak dapat diubah. Durasi pengguna harus tetap berada di Audiens. Tidak boleh ditetapkan ke lebih dari 540 hari.
adsPersonalizationEnabled

boolean

Hanya output. Kolom ini otomatis ditetapkan oleh GA ke salah (false) jika ini adalah Audiens NPA dan dikecualikan dari personalisasi iklan.
eventTrigger

object (AudienceEventTrigger)

Opsional. Menentukan peristiwa yang akan dicatat saat pengguna bergabung dengan Audiens. Jika tidak ditetapkan, tidak ada peristiwa yang akan dicatat saat pengguna bergabung dengan Audiens.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Tidak dapat diubah. Menentukan durasi pengecualian untuk pengguna yang memenuhi filter pengecualian. Filter ini diterapkan ke semua klausa filter KECUALIKAN dan diabaikan jika tidak ada klausa filter KECUALIKAN dalam Audiens.
filterClauses[]

object (AudienceFilterClause)

Wajib. Tidak dapat diubah. Daftar yang tidak diurutkan. Klausa filter yang menentukan Audiens. Semua klausa akan digabungkan dengan AND.

AudienceEventTrigger

Menentukan peristiwa yang akan dicatat saat pengguna bergabung dengan Audiens.

Representasi JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Kolom
eventName

string

Wajib. Nama peristiwa yang akan dicatat.
logCondition

enum (LogCondition)

Wajib. Kapan peristiwa dicatat ke dalam log.

LogCondition

Menentukan waktu untuk mencatat peristiwa ke dalam log.

Enum
LOG_CONDITION_UNSPECIFIED Kondisi log tidak ditentukan.
AUDIENCE_JOINED Peristiwa hanya boleh dicatat jika pengguna bergabung.
AUDIENCE_MEMBERSHIP_RENEWED Peristiwa harus dicatat setiap kali kondisi Audiens terpenuhi, meskipun pengguna sudah menjadi anggota Audiens.

AudienceExclusionDurationMode

Menentukan durasi pengecualian untuk pengguna yang memenuhi filter pengecualian.

Enum
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Tidak ditentukan.
EXCLUDE_TEMPORARILY Mengecualikan pengguna dari Audiens selama periode saat mereka memenuhi klausul filter.
EXCLUDE_PERMANENTLY Mengecualikan pengguna dari Audiens jika mereka pernah memenuhi klausul filter.

AudienceFilterClause

Klausa untuk menentukan filter sederhana atau urutan. Filter dapat bersifat inklusif (Misalnya, pengguna yang memenuhi klausa filter akan disertakan dalam Audiens) atau eksklusif (Misalnya, pengguna yang memenuhi klausa filter akan dikecualikan dari Audiens).

Representasi 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.
}
Kolom
clauseType

enum (AudienceClauseType)

Wajib. Menentukan apakah ini merupakan klausa filter sertakan atau kecualikan.

Kolom union filter.

filter hanya dapat berupa salah satu dari yang berikut:
simpleFilter

object (AudienceSimpleFilter)

Filter sederhana yang harus dipenuhi pengguna untuk menjadi anggota Audiens.
sequenceFilter

object (AudienceSequenceFilter)

Filter yang harus muncul dalam urutan tertentu agar pengguna menjadi anggota Audiens.

AudienceSimpleFilter

Menentukan filter sederhana yang harus dipenuhi pengguna untuk menjadi anggota Audiens.

Representasi JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Kolom
scope

enum (AudienceFilterScope)

Wajib. Tidak dapat diubah. Menentukan cakupan untuk filter ini.
filterExpression

object (AudienceFilterExpression)

Wajib. Tidak dapat diubah. Ekspresi logis dari filter peristiwa, metrik, atau dimensi Audiens.

AudienceFilterScope

Menentukan cara mengevaluasi pengguna untuk bergabung dengan Audiens.

Enum
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Cakupan tidak ditentukan.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Pengguna bergabung dengan Audiens jika kondisi filter terpenuhi dalam satu peristiwa.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Pengguna bergabung dengan Audiens jika kondisi filter terpenuhi dalam satu sesi.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Pengguna akan bergabung dengan Audiens jika kondisi filter terpenuhi oleh peristiwa apa pun di seluruh sesi.

AudienceFilterExpression

Ekspresi logis dari filter peristiwa, metrik, atau dimensi Audiens.

Representasi 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.
}
Kolom
Kolom union expr. Ekspresi yang diterapkan ke filter. expr hanya ada berupa salah satu diantara berikut:
andGroup

object (AudienceFilterExpressionList)

Daftar ekspresi yang akan digabungkan dengan AND. Ini hanya dapat berisi AudienceFilterExpressions dengan atauGroup. Ini harus ditetapkan untuk AudienceFilterExpression tingkat teratas.
orGroup

object (AudienceFilterExpressionList)

Daftar ekspresi untuk OR yang digabungkan. Elemen ini tidak boleh berisi AudienceFilterExpressions dengan danGroup atau atauGroup.
notExpression

object (AudienceFilterExpression)

Ekspresi filter yang akan TIDAK diolah (Misalnya, dibalik, dilengkapi). Dimensi ini hanya dapat menyertakan dimensionOrMetricFilter. Ini tidak dapat ditetapkan pada AudienceFilterExpression tingkat teratas.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Filter pada satu dimensi atau metrik. Ini tidak dapat ditetapkan pada AudienceFilterExpression tingkat teratas.
eventFilter

object (AudienceEventFilter)

Membuat filter yang cocok dengan peristiwa tertentu. Ini tidak dapat ditetapkan pada AudienceFilterExpression tingkat teratas.

AudienceFilterExpressionList

Daftar ekspresi filter Audiens.

Representasi JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Kolom
filterExpressions[]

object (AudienceFilterExpression)

Daftar ekspresi filter Audiens.

AudienceDimensionOrMetricFilter

Filter tertentu untuk satu dimensi atau metrik.

Representasi 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.
}
Kolom
fieldName

string

Wajib. Tidak dapat diubah. Nama dimensi atau nama metrik yang akan difilter. Jika nama kolom merujuk ke dimensi atau metrik kustom, awalan cakupan akan ditambahkan ke bagian depan nama metrik atau dimensi kustom. Untuk informasi lebih lanjut tentang awalan cakupan atau dimensi/metrik kustom, lihat dokumentasi Google Analytics Data API.
atAnyPointInTime

boolean

Opsional. Menunjukkan apakah filter ini memerlukan evaluasi dinamis atau tidak. Jika ditetapkan ke benar (true), pengguna akan bergabung dengan Audiens jika mereka pernah memenuhi kondisi (evaluasi statis). Jika tidak disetel atau disetel ke salah (false), evaluasi pengguna untuk Audiens bersifat dinamis; pengguna ditambahkan ke Audiens saat memenuhi kondisi, lalu dihapus saat tidak lagi memenuhinya.

Ini hanya dapat ditetapkan jika Cakupan audiens adalah ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Opsional. Jika ditetapkan, menentukan periode waktu untuk mengevaluasi data dalam jumlah hari. Jika tidak ditetapkan, data audiens akan dievaluasi terhadap data sepanjang waktu (Misalnya, periode waktu tak terbatas).

Misalnya, jika ditetapkan ke 1 hari, hanya data hari ini yang akan dievaluasi. Titik referensinya adalah hari ini saat atAnyPointInTime tidak disetel atau salah (false).

Ini hanya dapat ditetapkan jika Cakupan audiens adalah ACROSS_ALL_SESSIONS dan tidak boleh lebih dari 60 hari.
Kolom union one_filter. Salah satu filter di atas. one_filter hanya ada berupa salah satu diantara berikut:
stringFilter

object (StringFilter)

Filter untuk dimensi jenis string yang cocok dengan pola tertentu.
inListFilter

object (InListFilter)

Filter untuk dimensi string yang cocok dengan daftar opsi tertentu.
numericFilter

object (NumericFilter)

Filter untuk nilai numerik atau tanggal pada dimensi atau metrik.
betweenFilter

object (BetweenFilter)

Filter untuk nilai numerik atau tanggal di antara nilai-nilai tertentu pada dimensi atau metrik.

StringFilter

Filter untuk dimensi jenis string yang cocok dengan pola tertentu.

Representasi JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Kolom
matchType

enum (MatchType)

Wajib. Jenis pencocokan untuk filter string.
value

string

Wajib. Nilai string yang akan dicocokkan.
caseSensitive

boolean

Opsional. Jika true (benar), pencocokan peka huruf besar/kecil. Jika false, kecocokan tidak peka huruf besar/kecil.

MatchType

Jenis pencocokan untuk filter string.

Enum
MATCH_TYPE_UNSPECIFIED Tidak ditentukan
EXACT Pencocokan persis dari nilai string.
BEGINS_WITH Diawali dengan nilai string.
ENDS_WITH Berakhir dengan nilai string.
CONTAINS Berisi nilai string.
FULL_REGEXP Ekspresi reguler penuh cocok dengan nilai string.

InListFilter

Filter untuk dimensi string yang cocok dengan daftar opsi tertentu.

Representasi JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Kolom
values[]

string

Wajib. Daftar kemungkinan nilai string untuk dicocokkan. Tidak boleh kosong.
caseSensitive

boolean

Opsional. Jika true (benar), pencocokan peka huruf besar/kecil. Jika false, kecocokan tidak peka huruf besar/kecil.

NumericFilter

Filter untuk nilai numerik atau tanggal pada dimensi atau metrik.

Representasi JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Kolom
operation

enum (Operation)

Wajib. Operasi yang diterapkan ke filter numerik.
value

object (NumericValue)

Wajib. Nilai numerik atau tanggal untuk dicocokkan.

Operasi

Operasi yang diterapkan ke filter numerik.

Enum
OPERATION_UNSPECIFIED Tidak ditentukan.
EQUAL Sama.
LESS_THAN Kurang dari.
GREATER_THAN Lebih dari.

NumericValue

Untuk mewakili angka.

Representasi 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.
}
Kolom
Kolom union one_value. Salah satu dari nilai numerik. one_value hanya ada berupa salah satu diantara berikut:
int64Value

string (int64 format)

Nilai bilangan bulat.
doubleValue

number

Nilai ganda.

BetweenFilter

Filter untuk nilai numerik atau tanggal di antara nilai-nilai tertentu pada dimensi atau metrik.

Representasi JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Kolom
fromValue

object (NumericValue)

Wajib. Diawali dengan angka ini, inklusif.
toValue

object (NumericValue)

Wajib. Berakhir dengan angka ini, inklusif.

AudienceEventFilter

Filter yang mencocokkan peristiwa dari satu nama peristiwa. Jika parameter peristiwa ditentukan, hanya subkumpulan peristiwa yang cocok dengan satu nama peristiwa dan ekspresi filter parameter yang cocok dengan filter peristiwa ini.

Representasi JSON 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Kolom
eventName

string

Wajib. Tidak dapat diubah. Nama peristiwa yang akan dicocokkan.
eventParameterFilterExpression

object (AudienceFilterExpression)

Opsional. Jika ditentukan, filter ini akan mencocokkan peristiwa yang cocok dengan satu nama peristiwa dan ekspresi filter parameter. AudienceEventFilter di dalam ekspresi filter parameter tidak dapat ditetapkan (Misalnya, filter peristiwa bertingkat tidak didukung). Nilai ini harus berupa satu andGroup dimensiOrMetricFilter atau notExpression; DAN dari OR tidak didukung. Selain itu, jika filter menyertakan filter untuk "eventCount", hanya filter tersebut yang akan dipertimbangkan; semua filter lainnya akan diabaikan.

AudienceSequenceFilter

Menentukan filter yang harus muncul dalam urutan tertentu agar pengguna menjadi anggota Audiens.

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

enum (AudienceFilterScope)

Wajib. Tidak dapat diubah. Menentukan cakupan untuk filter ini.
sequenceMaximumDuration

string (Duration format)

Opsional. Menentukan jangka waktu saat seluruh urutan harus terjadi.

Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan 's'. Contoh: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Wajib. Urutan langkah yang berurutan. Pengguna harus menyelesaikan setiap langkah untuk bergabung dengan filter urutan.

AudienceSequenceStep

Kondisi yang harus terjadi dalam urutan langkah yang ditentukan agar pengguna ini cocok dengan urutan.

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

enum (AudienceFilterScope)

Wajib. Tidak dapat diubah. Menentukan cakupan untuk langkah ini.
immediatelyFollows

boolean

Opsional. Jika benar, peristiwa yang memenuhi langkah ini harus merupakan peristiwa berikutnya setelah peristiwa yang memenuhi langkah terakhir. Jika tidak disetel atau disetel ke salah (false), langkah ini akan mengikuti langkah sebelumnya secara tidak langsung. Misalnya, mungkin ada peristiwa antara langkah sebelumnya dan langkah ini. Elemen ini diabaikan untuk langkah pertama.
constraintDuration

string (Duration format)

Opsional. Jika ditetapkan, langkah ini harus dipenuhi dalam constraintDuration pada langkah sebelumnya (Misalnya, t[i] - t[i-1] <= constraintDuration). Jika tidak disetel, tidak ada persyaratan durasi (durasi sebenarnya tidak terbatas). Elemen ini diabaikan untuk langkah pertama.

Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan 's'. Contoh: "3.5s".
filterExpression

object (AudienceFilterExpression)

Wajib. Tidak dapat diubah. Ekspresi logis dari filter peristiwa, metrik, atau dimensi Audiens di setiap langkah.

AudienceClauseType

Menentukan apakah ini merupakan klausa filter sertakan atau kecualikan.

Enum
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Jenis klausa tidak ditentukan.
INCLUDE Pengguna akan disertakan dalam Audiens jika klausa filter terpenuhi.
EXCLUDE Pengguna akan dikecualikan dari Audiens jika klausa filter terpenuhi.

Metode

archive

 Mengarsipkan Audiens di properti.

create

 Membuat Audiens.

get

 Cari untuk satu Audiens.

list

 Mencantumkan Audiens di properti.

patch

 Memperbarui Audiens di properti.