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 diisi. Nama tampilan Audiens.

description

string

Wajib diisi. Deskripsi Audiens.

membershipDurationDays

integer

Wajib diisi. Tidak dapat diubah. Durasi pengguna harus tetap berada di Audiens. Setelan ini tidak dapat ditetapkan ke lebih dari 540 hari.

adsPersonalizationEnabled

boolean

Hanya output. Nilai ini otomatis ditetapkan oleh GA ke 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 dicatat dalam log saat pengguna bergabung dengan Audiens.

exclusionDurationMode

enum (AudienceExclusionDurationMode)

Tidak dapat diubah. Menentukan berapa lama pengecualian berlangsung untuk pengguna yang memenuhi filter pengecualian. Hal ini diterapkan untuk semua klausa filter KECUALIKAN dan diabaikan jika tidak ada klausa filter KECUALIKAN di Audiens.

filterClauses[]

object (AudienceFilterClause)

Wajib diisi. Tidak dapat diubah. Daftar tidak berurutan. Klausa filter yang menentukan Audiens. Semua klausa akan digabungkan DAN.

PemicuPeristiwaAudiens

Menentukan peristiwa yang akan dicatat saat pengguna bergabung dengan Audiens.

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

string

Wajib diisi. Nama peristiwa yang akan dicatat ke dalam log.

logCondition

enum (LogCondition)

Wajib diisi. Kapan harus mencatat peristiwa.

KondisiLog

Menentukan waktu untuk mencatat peristiwa.

Enumerasi
LOG_CONDITION_UNSPECIFIED Kondisi log tidak ditentukan.
AUDIENCE_JOINED Peristiwa harus dicatat ke dalam log hanya saat pengguna bergabung.
AUDIENCE_MEMBERSHIP_RENEWED Peristiwa harus dicatat dalam log setiap kali kondisi Audiens terpenuhi, meskipun pengguna sudah menjadi anggota Audiens.

ModePengecualianAudiens

Menentukan berapa lama pengecualian berlangsung untuk pengguna yang memenuhi filter pengecualian.

Enumerasi
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Tidak ditentukan.
EXCLUDE_TEMPORARILY Kecualikan pengguna dari Audiens selama periode saat mereka memenuhi klausul filter.
EXCLUDE_PERMANENTLY Kecualikan 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 disertakan di Audiens) atau eksklusif (Misalnya, pengguna yang memenuhi klausa filter 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 diisi. Menentukan apakah ini adalah klausa filter sertakan atau kecualikan.

Kolom union filter.

filter hanya dapat berupa salah satu dari berikut:

simpleFilter

object (AudienceSimpleFilter)

Filter sederhana yang harus dipenuhi pengguna agar dapat menjadi anggota Audiens.

sequenceFilter

object (AudienceSequenceFilter)

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

AudienceSimpleFilter

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

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

enum (AudienceFilterScope)

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

filterExpression

object (AudienceFilterExpression)

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

AudienceFilterScope

Menentukan cara mengevaluasi pengguna yang bergabung ke Audiens.

Enumerasi
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 ke Audiens jika kondisi filter terpenuhi dalam satu sesi.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Pengguna bergabung dengan Audiens jika kondisi filter terpenuhi oleh peristiwa apa pun di seluruh sesi.

AudienceFilterExpression

Ekspresi logis dari Filter dimensi, metrik, atau peristiwa 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 dapat berupa salah satu dari berikut:
andGroup

object (AudienceFilterExpressionList)

Daftar ekspresi yang akan digabungkan DAN. Kolom ini hanya dapat berisi AudienceFilterExpressions dengan orGroup. Ini harus ditetapkan untuk AudienceFilterExpression tingkat teratas.

orGroup

object (AudienceFilterExpressionList)

Daftar ekspresi untuk OR bersama-sama. Ini tidak boleh berisi AudienceFilterExpressions dengan andGroup atau orGroup.

notExpression

object (AudienceFilterExpression)

Ekspresi filter yang TIDAK boleh (misalnya, dibalik, dilengkapi). Ini hanya dapat menyertakan sebuah dimensiOrMetricFilter. Ini tidak dapat ditetapkan di AudienceFilterExpression tingkat teratas.

dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

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

eventFilter

object (AudienceEventFilter)

Membuat filter yang cocok dengan peristiwa tertentu. Ini tidak dapat ditetapkan di 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 dimensi atau metrik tunggal.

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 diisi. Tidak dapat diubah. Nama dimensi atau nama metrik yang akan difilter. Jika nama kolom merujuk ke dimensi atau metrik kustom, awalan cakupan akan ditambahkan di depan nama dimensi atau metrik kustom. Untuk informasi selengkapnya 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 kebijakan tidak disetel atau disetel ke salah (false), evaluasi pengguna untuk Audiens bersifat dinamis; pengguna akan 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 jangka waktu evaluasi data dalam jumlah hari. Jika tidak ditetapkan, data audiens akan dievaluasi berdasarkan data sepanjang waktu (misalnya, periode waktu yang tidak terbatas).

Misalnya, jika disetel ke 1 hari, hanya data hari ini yang dievaluasi. Titik referensi adalah hari ini saat atAnyPointInTime tidak ditetapkan atau salah.

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 dapat berupa salah satu dari 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 angka atau tanggal pada dimensi atau metrik.

betweenFilter

object (BetweenFilter)

Filter untuk nilai numerik atau tanggal antara 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 diisi. Jenis pencocokan untuk filter string.

value

string

Wajib diisi. Nilai string yang akan dicocokkan.

caseSensitive

boolean

Opsional. Jika true (benar), kecocokannya peka huruf besar/kecil. Jika salah, kecocokannya tidak peka huruf besar/kecil.

JenisPencocokan

Jenis pencocokan untuk filter string.

Enumerasi
MATCH_TYPE_UNSPECIFIED Tidak ditentukan
EXACT Pencocokan persis untuk nilai string.
BEGINS_WITH Diawali dengan nilai string.
ENDS_WITH Diakhiri dengan nilai string.
CONTAINS Berisi nilai string.
FULL_REGEXP Ekspresi reguler 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 diisi. Daftar kemungkinan nilai string yang akan dicocokkan. Wajib diisi.

caseSensitive

boolean

Opsional. Jika true (benar), kecocokannya peka huruf besar/kecil. Jika salah, kecocokannya tidak peka huruf besar/kecil.

Filter Angka

Filter untuk nilai angka atau tanggal pada dimensi atau metrik.

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

enum (Operation)

Wajib diisi. Operasi yang diterapkan pada filter numerik.

value

object (NumericValue)

Wajib diisi. Nilai numerik atau tanggal untuk dicocokkan.

Operasi

Operasi yang diterapkan pada filter numerik.

Enumerasi
OPERATION_UNSPECIFIED Tidak ditentukan.
EQUAL Sama dengan.
LESS_THAN Kurang dari.
GREATER_THAN Lebih dari.

Nilai Angka

Untuk mewakili sebuah 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 nilai numerik. one_value hanya dapat berupa salah satu dari berikut:
int64Value

string (int64 format)

Nilai bilangan bulat.

doubleValue

number

Nilai ganda.

AntarFilter

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

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

object (NumericValue)

Wajib diisi. Diawali dengan nomor ini, inklusif.

toValue

object (NumericValue)

Wajib diisi. Berakhir dengan angka ini, inklusif.

AudienceEventFilter

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

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

string

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

eventParameterFilterExpression

object (AudienceFilterExpression)

Opsional. Jika ditentukan, filter ini cocok dengan peristiwa yang cocok dengan nama peristiwa tunggal dan ekspresi filter parameter. AudienceEventFilter di dalam ekspresi filter parameter tidak dapat ditetapkan (Misalnya, filter peristiwa bertingkat tidak didukung). Ini harus berupa single andGroup ofdimensionOrMetricFilter atau notExpression; AND dari OR tidak didukung. Selain itu, jika filter disertakan untuk "eventCount", hanya filter tersebut yang akan dipertimbangkan; semua filter lainnya akan diabaikan.

AudienceAudienceFilter

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

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

enum (AudienceFilterScope)

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

sequenceMaximumDuration

string (Duration format)

Opsional. Menentukan periode waktu saat keseluruhan urutan harus terjadi.

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

sequenceSteps[]

object (AudienceSequenceStep)

Wajib diisi. Urutan langkah-langkah secara berurutan. Pengguna harus menyelesaikan setiap langkah untuk bergabung ke filter urutan.

LangkahUrutan Audiens

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 diisi. Tidak dapat diubah. Menentukan cakupan untuk langkah ini.

immediatelyFollows

boolean

Opsional. Jika benar, peristiwa yang memenuhi langkah ini harus berupa peristiwa berikutnya setelah peristiwa yang sesuai dengan langkah terakhir. Jika tidak ditetapkan atau salah, langkah ini secara tidak langsung mengikuti langkah sebelumnya; misalnya, mungkin ada peristiwa antara langkah sebelumnya dan langkah ini. Langkah ini diabaikan untuk langkah pertama.

constraintDuration

string (Duration format)

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

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

filterExpression

object (AudienceFilterExpression)

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

JenisKlausul Audiens

Menentukan apakah ini adalah klausa filter sertakan atau kecualikan.

Enumerasi
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 satu Audiens.

list

Mencantumkan Audiens di properti.

patch

Memperbarui Audiens pada properti.