REST Resource: accountTypes.accounts.userLists

Resource: UserList

Resource daftar pengguna.

Representasi JSON 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
Kolom
name

string

ID. Nama resource daftar pengguna. Format: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

Hanya output. ID unik daftar pengguna.
readOnly

boolean

Hanya output. Opsi yang menunjukkan apakah pengguna dapat mengedit daftar.
membershipDuration

string (Duration format)

Opsional. Durasi pengguna tetap berada dalam daftar pengguna. Durasi yang valid adalah kelipatan 24 jam (86400 detik). Memberikan nilai yang bukan kelipatan 24 jam akan menghasilkan error INVALID_ARGUMENT.

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

enum (AccessReason)

Hanya output. Alasan akun ini diberi akses ke daftar.
sizeInfo

object (SizeInfo)

Hanya output. Estimasi jumlah anggota dalam daftar pengguna ini di berbagai jaringan target.
targetNetworkInfo

object (TargetNetworkInfo)

Opsional. Informasi kelayakan untuk berbagai jaringan target.
displayName

string

Wajib. Nama tampilan daftar pengguna.
description

string

Opsional. Deskripsi daftar pengguna.
membershipStatus

enum (MembershipStatus)

Opsional. Status keanggotaan daftar pengguna ini.
integrationCode

string

Opsional. ID dari sistem eksternal. ID ini digunakan oleh penjual daftar pengguna untuk mengorelasikan ID di sistem mereka.
closingReason

enum (ClosingReason)

Hanya output. Alasan status keanggotaan daftar pengguna ini ditutup.
accountAccessStatus

enum (AccessStatus)

Opsional. Menunjukkan apakah berbagi ini masih diaktifkan. Jika daftar pengguna dibagikan ke akun, kolom ini akan ditetapkan ke ENABLED. Kemudian, pemilik daftar pengguna dapat memutuskan untuk mencabut pembagian dan menjadikannya DISABLED.
Kolom union user_list_info. Informasi tambahan tentang daftar pengguna. user_list_info hanya dapat berupa salah satu dari berikut:
ingestedUserListInfo

object (IngestedUserListInfo)

Opsional. Merepresentasikan daftar pengguna yang diisi dengan data yang dimasukkan pengguna.

MembershipStatus

Status daftar pengguna.

Enum
MEMBERSHIP_STATUS_UNSPECIFIED Tidak ditentukan.
OPEN Status terbuka - Daftar pengguna mengakumulasi anggota dan dapat ditargetkan.
CLOSED Status tertutup - Tidak ada anggota baru yang ditambahkan.

ClosingReason

Menunjukkan alasan daftar pengguna ditutup. Enum ini hanya digunakan saat daftar ditutup secara otomatis oleh sistem.

Enum
CLOSING_REASON_UNSPECIFIED Tidak ditentukan.
UNUSED Daftar pengguna ditutup karena tidak digunakan dalam penargetan baru-baru ini. Lihat https://support.google.com/google-ads/answer/2472738 untuk mengetahui detailnya.

AccessReason

Enum yang mendeskripsikan kemungkinan alasan akses.

Enum
ACCESS_REASON_UNSPECIFIED Tidak ditentukan.
OWNED Resource dimiliki oleh pengguna.
SHARED Resource dibagikan kepada pengguna.
LICENSED Resource dilisensikan kepada pengguna.
SUBSCRIBED Pengguna berlangganan resource.
AFFILIATED Resource dapat diakses oleh pengguna.

AccessStatus

Menunjukkan apakah klien ini masih memiliki akses ke daftar.

Enum
ACCESS_STATUS_UNSPECIFIED Tidak ditentukan.
ENABLED Akses diaktifkan.
DISABLED Akses dinonaktifkan.

SizeInfo

Estimasi jumlah anggota dalam daftar pengguna ini di berbagai jaringan target.

Representasi JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
Kolom
displayNetworkMembersCount

string (int64 format)

Hanya output. Perkiraan jumlah anggota dalam daftar pengguna ini, di Jaringan Display Google.
searchNetworkMembersCount

string (int64 format)

Hanya output. Perkiraan jumlah anggota dalam daftar pengguna ini di domain google.com. Ini adalah anggota yang tersedia untuk penargetan di kampanye Penelusuran.
youtubeMembersCount

string (int64 format)

Hanya output. Estimasi jumlah anggota dalam daftar pengguna ini di YouTube.
gmailMembersCount

string (int64 format)

Hanya output. Perkiraan jumlah anggota dalam daftar pengguna ini di Gmail.

TargetNetworkInfo

Informasi kelayakan untuk berbagai jaringan target.

Representasi JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Kolom
eligibleForDisplay

boolean

Hanya output. Menunjukkan bahwa daftar pengguna ini memenuhi syarat untuk Jaringan Display Google.

IngestedUserListInfo

Merepresentasikan daftar pengguna yang diisi dengan data yang disediakan pengguna.

Representasi JSON 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
Kolom
uploadKeyTypes[]

enum (UploadKeyType)

Wajib. Tidak dapat diubah. Jenis kunci upload daftar pengguna ini.
contactIdInfo

object (ContactIdInfo)

Opsional. Informasi tambahan jika CONTACT_ID adalah salah satu uploadKeyTypes.
mobileIdInfo

object (MobileIdInfo)

Opsional. Informasi tambahan jika MOBILE_ID adalah salah satu uploadKeyTypes.
userIdInfo

object (UserIdInfo)

Opsional. Informasi tambahan jika USER_ID adalah salah satu uploadKeyTypes.
pairIdInfo

object (PairIdInfo)

Opsional. Informasi tambahan jika PAIR_ID adalah salah satu uploadKeyTypes.

Fitur ini hanya tersedia untuk partner data.
pseudonymousIdInfo

object (PseudonymousIdInfo)

Opsional. Informasi tambahan untuk PSEUDONYMOUS_ID adalah salah satu uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

Opsional. Informasi tambahan untuk audiens partner.

Fitur ini hanya tersedia untuk partner data.

UploadKeyType

Enum yang berisi kemungkinan jenis kunci upload daftar pengguna.

Enum
UPLOAD_KEY_TYPE_UNSPECIFIED Tidak ditentukan.
CONTACT_ID Info pelanggan seperti alamat email, nomor telepon, atau alamat fisik.
MOBILE_ID ID iklan seluler.
USER_ID ID pengguna yang disediakan pihak ketiga.
PAIR_ID ID rekonsiliasi identitas pengiklan penayang.
PSEUDONYMOUS_ID ID Platform Pengelolaan Data: - ID Pengguna Google - ID yang Disediakan Partner - ID yang Disediakan Penayang - IDFA iOS - ID iklan Android - ID Roku - ID Amazon Fire TV - ID Xbox atau Microsoft

ContactIdInfo

Informasi tambahan jika CONTACT_ID adalah salah satu uploadKeyTypes.

Representasi JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Kolom
matchRatePercentage

integer

Hanya output. Tingkat kecocokan untuk daftar pengguna Customer Match.
dataSourceType

enum (DataSourceType)

Opsional. Tidak dapat diubah. Sumber data upload

DataSourceType

Menunjukkan sumber data upload.

Enum
DATA_SOURCE_TYPE_UNSPECIFIED Tidak ditentukan.
DATA_SOURCE_TYPE_FIRST_PARTY Data yang diupload adalah data pihak pertama.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Data yang diupload berasal dari biro kredit pihak ketiga.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Data yang diupload berasal dari file pemilih pihak ketiga.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Data yang diupload adalah data partner pihak ketiga.

MobileIdInfo

Informasi tambahan jika MOBILE_ID adalah salah satu uploadKeyTypes.

Representasi JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Kolom
dataSourceType

enum (DataSourceType)

Opsional. Tidak dapat diubah. Sumber data upload.
keySpace

enum (KeySpace)

Wajib. Tidak dapat diubah. Ruang utama ID seluler.
appId

string

Wajib. Tidak dapat diubah. String yang secara unik mengidentifikasi aplikasi seluler tempat data dikumpulkan.

KeySpace

Ruang kunci untuk ID seluler.

Enum
KEY_SPACE_UNSPECIFIED Tidak ditentukan.
IOS Ruang kunci iOS.
ANDROID Keyspace Android.

UserIdInfo

Informasi tambahan jika USER_ID adalah salah satu uploadKeyTypes.

Representasi JSON 
{
  "dataSourceType": enum (DataSourceType)
}
Kolom
dataSourceType

enum (DataSourceType)

Opsional. Tidak dapat diubah. Sumber data upload.

PairIdInfo

Informasi tambahan jika PAIR_ID adalah salah satu uploadKeyTypes.

Fitur ini hanya tersedia untuk partner data.

Representasi JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Kolom
publisherId

string (int64 format)

Wajib. Tidak dapat diubah. Mengidentifikasi penayang yang daftar pengguna Rekonsiliasi Identitas Pengiklan Penayang direkonsiliasi. Kolom ini disediakan oleh penyedia cleanroom dan hanya unik dalam cakupan cleanroom tersebut. ID ini tidak dapat digunakan sebagai ID global di beberapa ruang bersih.
publisherName

string

Wajib. Nama deskriptif penayang yang akan ditampilkan di UI untuk pengalaman penargetan yang lebih baik.
matchRatePercentage

integer

Wajib. Kolom ini menunjukkan persentase kecocokan keanggotaan daftar pengguna ini dengan data pihak pertama penayang yang sesuai. Harus antara 0 dan 100 inklusif.
advertiserIdentifierCount

string (int64 format)

Opsional. Jumlah catatan data pihak pertama pengiklan yang telah diupload ke penyedia ruang bersih. Hal ini tidak menunjukkan ukuran daftar pengguna PAIR.
cleanRoomIdentifier

string

Wajib. Tidak dapat diubah. Mengidentifikasi hubungan unik pengiklan dengan penayang dengan satu penyedia ruang bersih atau di beberapa penyedia ruang bersih.

PseudonymousIdInfo

Informasi tambahan jika PSEUDONYMOUS_ID adalah salah satu uploadKeyTypes.

Representasi JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Kolom
syncStatus

enum (SyncStatus)

Hanya output. Status sinkronisasi daftar pengguna.
billableRecordCount

string (int64 format)

Opsional. Tidak dapat diubah. Jumlah catatan yang dapat ditagih (misalnya, diupload atau dicocokkan).

SyncStatus

Status sinkronisasi daftar pengguna.

Enum
SYNC_STATUS_UNSPECIFIED Tidak ditentukan.
CREATED Daftar pengguna telah dibuat sebagai placeholder. Isi dan/atau metadata daftar masih disinkronkan. Daftar pengguna belum siap digunakan.
READY_FOR_USE Daftar pengguna siap digunakan. Konten dan cookie telah disinkronkan dengan benar.
FAILED Terjadi error saat menyinkronkan konten dan/atau metadata daftar pengguna. Daftar pengguna tidak dapat digunakan.

PartnerAudienceInfo

Informasi tambahan untuk audiens partner.

Fitur ini hanya tersedia untuk partner data.

Representasi JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Kolom
partnerAudienceSource

enum (PartnerAudienceSource)

Wajib. Tidak dapat diubah. Sumber audiens partner.
commercePartner

string

Opsional. Nama partner e-commerce. Hanya diizinkan jika partnerAudienceSource adalah COMMERCE_AUDIENCE.

PartnerAudienceSource

Sumber audiens partner.

Enum
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Tidak ditentukan.
COMMERCE_AUDIENCE Sumber Audiens partner adalah audiens commerce.
LINEAR_TV_AUDIENCE Sumber Audiens Partner adalah audiens TV linear.
AGENCY_PROVIDER_AUDIENCE Sumber Audiens partner adalah audiens agensi/penyedia.

Metode

create

 Membuat UserList.

delete

 Menghapus UserList.

get

 Mendapatkan UserList.

list

 Mencantumkan UserList.

patch

 Memperbarui UserList.