REST Resource: customers.userLists

Resource: UserList

Menentukan daftar pengguna yang dikelola Ads Data Hub.

Representasi JSON 
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
Kolom
name

string

Hanya output. Nama yang secara unik mengidentifikasi daftar pengguna Ads Data Hub. Aturan ini memiliki format customer/[customerId]/userLists/[userListId]
userListId

string (int64 format)

Hanya output. ID daftar pengguna. Kolom ini dihasilkan oleh layanan dan digunakan untuk mengisi UserList.
adsDataCustomerId

string (int64 format)

Tidak dapat diubah. ID pelanggan Ads Data Hub tertaut yang terkait dengan daftar pengguna ini. ID ini harus ditetapkan sebagai adsDataCustomerId saat menjalankan tugas UserListQuery menggunakan daftar pengguna ini. Jika tidak ada, pelanggan induk akan digunakan. Setelan ini tidak dapat diubah setelah daftar dibuat.
title

string

Wajib diisi. Judul daftar pengguna, yang unik untuk adsDataCustomerId yang ditentukan.
description

string

Wajib diisi. Deskripsi daftar pengguna.
type

enum (UserListType)

Hanya output. Nilai jenis UserList harus konsisten dengan userList. Nilai ini adalah Hanya Baca dan akan dapat diakses pada permintaan daftar/dapatkan.
createEmail

string

Hanya output. Alamat email pengguna yang membuat daftar pengguna ini.
listSize

string (int64 format)

Hanya output. Jumlah pengguna dalam daftar pengguna. Pembaruan ukuran daftar mungkin tertunda.
populateTime

string (Timestamp format)

Hanya output. Waktu daftar terakhir diisi.

Stempel waktu dalam format RFC3339 UTC "Zulu" dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Hanya output. Status daftar pengguna (Aktif/Dihapus). Nilai ini adalah Hanya Baca dan akan dapat diakses pada permintaan daftar/dapatkan.

Kolom union user_list. Konfigurasi lebih lanjut bergantung pada jenis daftar pengguna.

Hanya satu yang harus ditetapkan. user_list hanya dapat berupa salah satu dari berikut:
frequencyList

object (FrequencyBasedListInfo)

Daftar pengguna untuk pembatasan frekuensi.
remarketingList

object (RemarketingListInfo)

Daftar pemasaran ulang.

JenisDaftarPengguna

Jenis Daftar Pengguna. Pembuatan dan penggunaan daftar pengguna pada waktu penargetan bergantung pada enum ini. Jenis daftar tidak dapat diganti setelah dibuat.

Enumerasi
USER_LIST_TYPE_UNSPECIFIED Nilai default: tidak boleh digunakan.
REMARKETING Audiens Pemasaran Ulang yang dibuat dengan kueri SQL di ADH. Daftar pemasaran ulang dapat digunakan untuk penargetan positif dan negatif.
FREQUENCY_BASED Audiens frekuensi terbatas. Audiens semacam ini dibatasi untuk penargetan negatif.

InfoDaftarBerbasisFrekuensi

Metadata untuk Daftar Pengguna berbasis frekuensi.

Representasi JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Kolom
dv360LineitemIds[]
(deprecated)

string (int64 format)

ID untuk item baris DV360 yang berkontribusi pada frekuensi.
cmCampaignIds[]
(deprecated)

string (int64 format)

ID untuk kampanye CM yang berkontribusi pada frekuensi.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

ID untuk kampanye Google Ads yang berkontribusi pada frekuensi.
eventMatchers[]

object (EventMatcher)

Peristiwa mana yang berkontribusi pada frekuensi. Saat membuat daftar pengguna berbasis frekuensi, eventMatchers lebih disukai untuk menentukan peristiwa yang berkontribusi pada frekuensi. dv360LineitemIds, cmCampaignIds, dan googleAdsCampaignIds digunakan jika eventMatchers kosong.
frequencyConstraint

object (FrequencyConstraint)

Menjelaskan kapan pengguna ditambahkan ke daftar.
slidingWindowDays

integer

Wajib diisi. Ukuran periode waktu yang digunakan saat menghitung frekuensi setiap peristiwa. Ini diukur dalam hari

PeristiwaMatcher

Peristiwa umum yang berkontribusi pada frekuensi.

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

enum (MatchType)

Jenis batasan yang akan disertakan dalam jumlah frekuensi.
value

string

Nilai batasan. Misalnya, untuk menentukan ID kampanye Google Ads = 1234, matchType akan menjadi GOOGLE_ADS_CAMPAIGN_ID dan nilainya akan menjadi '1234'. Peristiwa yang memiliki nilai ini untuk MatchType yang bersangkutan akan disertakan dalam jumlah frekuensi.

Jenis Kecocokan

Jenis batasan yang didukung untuk jumlah frekuensi. Jenis lainnya mungkin ditambahkan ke enum ini di masa mendatang untuk mendukung batasan tambahan. Anda dapat menentukan filter pada MatchType di ExplainValidFrequencyLimitingEventMatchersRequest untuk membatasi matcher peristiwa yang ditampilkan dalam hasil hanya untuk yang didukung oleh API Anda. Misalnya, menetapkan filter sebagai "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" akan menampilkan EventMatchers hanya dari kedua jenis tersebut.

Enumerasi
MATCH_TYPE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
CM_CAMPAIGN_ID Jenis batasan yang merepresentasikan ID Kampanye Campaign Manager.
DV360_INSERTION_ORDER_ID Jenis batasan yang mewakili ID Perjanjian Pemasangan Iklan DV360.
DV360_LINE_ITEM_ID Jenis batasan yang mewakili ID Item Baris DV360.
GOOGLE_ADS_CAMPAIGN_ID Jenis batasan yang mewakili ID Kampanye Google Ads.

FrequencyConstraint

Tentukan jumlah peristiwa minimum untuk batas tersebut.

Representasi JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Kolom
eventType

enum (EventType)

Tidak dapat diubah. Jenis peristiwa yang akan dihitung nilai minimumEventEventCount. Untuk saat ini, kami tidak secara eksplisit mewakili batasan perbandingan dengan asumsi bahwa semua GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

Wajib diisi. Setiap pengguna harus muncul setidaknya dalam peristiwa K.

Jenis Peristiwa

Jenis peristiwa yang dapat digunakan untuk menghitung frekuensi.

Enumerasi
EVENT_TYPE_UNSPECIFIED Nilai default: tidak boleh digunakan.
IMPRESSIONS Hitung semua tayangan.

InfoDaftar Pemasaran Ulang

Metadata untuk daftar pemasaran ulang.

Representasi JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Kolom
userListQuery

string

Tidak dapat diubah. Resource kueri daftar pengguna Ads Data Hub yang menentukan cara pengguna ditambahkan ke audiens ini. Memiliki bentuk: customer/[customerId]/userListQuery/[query_resource_id]
populatingUserListQueries[]

string

Hanya output. Referensi kueri daftar pengguna Ads Data Hub yang telah mengisi audiens ini. Hal ini dimaksudkan sebagai kolom lama untuk mendukung daftar pengguna yang diisi oleh beberapa kueri sebelum batasan pengguna 1:1 diterapkan. Memiliki bentuk: customer/[customerId]/userListQuery/[query_resource_id]

Negara bagian

Status daftar pengguna.

Enumerasi
STATE_UNSPECIFIED Nilai default / tidak ditetapkan.
STATE_ACTIVE Daftar pengguna masih terbuka dan aktif.
STATE_DELETED Daftar pengguna ditandai sebagai dihapus dan tidak boleh digunakan untuk penargetan lagi

Metode

addEventMatchers

 Menambahkan pencocok peristiwa ke daftar pengguna berbasis frekuensi.

addRecipients

 Menambahkan entitas ke penerima daftar pengguna yang dikelola Ads Data Hub.

create

 Membuat daftar pengguna yang dikelola Ads Data Hub.

delete

 Hapus daftar pengguna yang dikelola Ads Data Hub yang diminta.

generateFrequencyListMemberships

 Buat keanggotaan untuk UserList.

get

 Mengambil daftar pengguna yang dikelola Ads Data Hub yang diminta.

list

 Mencantumkan daftar pengguna yang dikelola oleh pelanggan Ads Data Hub yang ditentukan.

patch

 Memperbarui daftar pengguna yang dikelola Ads Data Hub yang diminta.

removeRecipients

 Menghapus entitas dari penerima daftar pengguna yang dikelola Ads Data Hub.