REST Resource: accountTypes.accounts.userLists

Kaynak: UserList

Kullanıcı listesi kaynağı.

JSON gösterimi 
{
  "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),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of mutually exclusive fields.
}
Alanlar
name

string

Tanımlayıcı. Kullanıcı listesinin kaynak adı. Biçim: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

Yalnızca çıkış. Kullanıcı listesinin benzersiz kimliği.
readOnly

boolean

Yalnızca çıkış. Kullanıcının listeyi düzenleyip düzenleyemeyeceğini belirten bir seçenek.
membershipDuration

string (Duration format)

İsteğe bağlı. Bir kullanıcının kullanıcı listesinde kalma süresi. Geçerli süreler, 24 saatin (86.400 saniye) tam katlarıdır. 24 saatin tam katı olmayan bir değer girilmesi INVALID_ARGUMENT hatasına neden olur.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".
accessReason

enum (AccessReason)

Yalnızca çıkış. Bu hesaba listeye erişim verilmesinin nedeni.
sizeInfo

object (SizeInfo)

Yalnızca çıkış. Bu kullanıcı listesindeki üyelerin farklı hedef ağlardaki tahmini sayısı.
targetNetworkInfo

object (TargetNetworkInfo)

İsteğe bağlı. Farklı hedef ağlar için uygunluk bilgileri.
displayName

string

Zorunlu. Kullanıcı listesinin görünen adı.
description

string

İsteğe bağlı. Kullanıcı listesinin açıklaması.
membershipStatus

enum (MembershipStatus)

İsteğe bağlı. Bu kullanıcı listesinin üyelik durumu.
integrationCode

string

İsteğe bağlı. Harici sistemden alınan bir kimlik. Kullanıcı listesi satıcıları, sistemlerindeki kimlikleri ilişkilendirmek için bu parametreyi kullanır.
closingReason

enum (ClosingReason)

Yalnızca çıkış. Bu kullanıcı listesi üyelik durumunun kapatılma nedeni.
accountAccessStatus

enum (AccessStatus)

İsteğe bağlı. Bu paylaşımın hâlâ etkin olup olmadığını gösterir. Bir kullanıcı listesi hesapla paylaşıldığında bu alan ENABLED olarak ayarlanır. Daha sonra kullanıcı listesi sahibi, paylaşımı iptal etmeye ve listeyi DISABLED yapmaya karar verebilir.
Kullanıcı listesi hakkında ek bilgiler. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
ingestedUserListInfo

object (IngestedUserListInfo)

İsteğe bağlı. Kullanıcı tarafından alınan verilerle doldurulan bir kullanıcı listesini temsil eder.
Karşılıklı olarak hariç tutulan alanların sonu.

MembershipStatus

Kullanıcı listesinin durumu.

Sıralamalar
MEMBERSHIP_STATUS_UNSPECIFIED Belirtilmedi.
OPEN Açık durum: Kullanıcı listesine üye eklenmeye devam ediliyor ve liste hedeflenebiliyor.
CLOSED Kapalı durumu: Yeni üye eklenmez.

ClosingReason

Kullanıcı listesinin neden kapatıldığını gösterir. Bu enum yalnızca bir liste sistem tarafından otomatik olarak kapatıldığında kullanılır.

Sıralamalar
CLOSING_REASON_UNSPECIFIED Belirtilmedi.
UNUSED Kullanıcı listesi, son zamanlarda hedeflemede kullanılmadığı için kapatıldı. Ayrıntılı bilgi için https://support.google.com/google-ads/answer/2472738 adresine göz atın.

AccessReason

Olası erişim nedenlerini açıklayan enum veri türü.

Sıralamalar
ACCESS_REASON_UNSPECIFIED Belirtilmedi.
OWNED Kaynak, kullanıcının mülkiyetindedir.
SHARED Kaynak, kullanıcıyla paylaşılır.
LICENSED Kaynak, kullanıcıya lisanslanmıştır.
SUBSCRIBED Kullanıcı, kaynağa abone oldu.
AFFILIATED Kaynak, kullanıcı tarafından erişilebilir.

AccessStatus

Bu istemcinin listeye erişimi olup olmadığını gösterir.

Sıralamalar
ACCESS_STATUS_UNSPECIFIED Belirtilmedi.
ENABLED Erişim etkinleştirilmiş olmalıdır.
DISABLED Erişim devre dışı bırakıldı.

SizeInfo

Bu kullanıcı listesindeki üyelerin farklı hedef ağlardaki tahmini sayısı.

JSON gösterimi 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
Alanlar
displayNetworkMembersCount

string (int64 format)

Yalnızca çıkış. Google Görüntülü Reklam Ağı'ndaki bu kullanıcı listesinde tahmini üye sayısı.
searchNetworkMembersCount

string (int64 format)

Yalnızca çıkış. google.com alanında bu kullanıcı listesindeki tahmini üye sayısı. Bunlar, Arama Ağı kampanyalarında hedefleme için kullanılabilen üyelerdir.
youtubeMembersCount

string (int64 format)

Yalnızca çıkış. YouTube'daki bu kullanıcı listesinde bulunan tahmini üye sayısı.
gmailMembersCount

string (int64 format)

Yalnızca çıkış. Gmail'deki bu kullanıcı listesinde bulunan tahmini üye sayısı.

TargetNetworkInfo

Farklı hedef ağlar için uygunluk bilgileri.

JSON gösterimi 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Alanlar
eligibleForDisplay

boolean

Yalnızca çıkış. Bu kullanıcı listesinin Google Görüntülü Reklam Ağı için uygun olduğunu gösterir.

IngestedUserListInfo

Kullanıcı tarafından sağlanan verilerle doldurulmuş bir kullanıcı listesini temsil eder.

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

enum (UploadKeyType)

Zorunlu. Değişmez. Bu kullanıcı listesinin yükleme anahtarı türleri.
contactIdInfo

object (ContactIdInfo)

İsteğe bağlı. CONTACT_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.
mobileIdInfo

object (MobileIdInfo)

İsteğe bağlı. MOBILE_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.
userIdInfo

object (UserIdInfo)

İsteğe bağlı. USER_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.
pairIdInfo

object (PairIdInfo)

İsteğe bağlı. PAIR_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.

Bu özellik yalnızca veri iş ortakları tarafından kullanılabilir.
pseudonymousIdInfo

object (PseudonymousIdInfo)

İsteğe bağlı. PSEUDONYMOUS_ID için ek bilgiler uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

İsteğe bağlı. İş ortağı kitleleri için ek bilgiler.

Bu özellik yalnızca veri iş ortakları tarafından kullanılabilir.

UploadKeyType

Bir kullanıcı listesinin olası yükleme anahtarı türlerini içeren sıralama.

Sıralamalar
UPLOAD_KEY_TYPE_UNSPECIFIED Belirtilmedi.
CONTACT_ID E-posta adresi, telefon numarası veya fiziksel adres gibi müşteri bilgileri
MOBILE_ID Mobil reklam kimlikleri.
USER_ID Üçüncü taraf tarafından sağlanan kullanıcı kimlikleri.
PAIR_ID Yayıncı-reklamveren kimlik eşleşmesi kimlikleri.
PSEUDONYMOUS_ID

Veri Yönetimi Platformu kimlikleri:

  • Google Kullanıcı Kimliği
  • İş ortağı tarafından sağlanan kimlik
  • Yayıncı Tarafından Sağlanan Kimlik
  • iOS IDFA
  • Android reklam kimliği
  • Roku kimliği
  • Amazon Fire TV kimliği
  • Xbox veya Microsoft Kimliği
  • Genel Cihaz Kimliği

ContactIdInfo

CONTACT_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.

JSON gösterimi 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Alanlar
matchRatePercentage

integer

Yalnızca çıkış. Müşteri Eşleştirme kullanıcı listeleri için eşleşme oranı.
dataSourceType

enum (DataSourceType)

İsteğe bağlı. Değişmez. Yüklenen verilerin kaynağı

DataSourceType

Yüklenen verilerin kaynağını gösterir.

Sıralamalar
DATA_SOURCE_TYPE_UNSPECIFIED Belirtilmedi.
DATA_SOURCE_TYPE_FIRST_PARTY Yüklenen veriler birinci taraf verileridir.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Yüklenen veriler, üçüncü taraf bir kredi bürosuna aittir.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Yüklenen veriler, üçüncü taraf seçmen dosyasından alınmıştır.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Yüklenen veriler, üçüncü taraf iş ortağı verileridir.

MobileIdInfo

MOBILE_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.

JSON gösterimi 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Alanlar
dataSourceType

enum (DataSourceType)

İsteğe bağlı. Değişmez. Yüklenen verilerin kaynağı.
keySpace

enum (KeySpace)

Zorunlu. Değişmez. Mobil kimliklerin anahtar alanı.
appId

string

Zorunlu. Değişmez. Verilerin toplandığı mobil uygulamayı benzersiz şekilde tanımlayan dize.

KeySpace

Mobil kimlik için anahtar alanı.

Sıralamalar
KEY_SPACE_UNSPECIFIED Belirtilmedi.
IOS iOS anahtar alanı.
ANDROID Android anahtar alanı.

UserIdInfo

USER_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.

JSON gösterimi 
{
  "dataSourceType": enum (DataSourceType)
}
Alanlar
dataSourceType

enum (DataSourceType)

İsteğe bağlı. Değişmez. Yüklenen verilerin kaynağı.

PairIdInfo

PAIR_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.

Bu özellik yalnızca veri iş ortakları tarafından kullanılabilir.

JSON gösterimi 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Alanlar
publisherId

string (int64 format)

Zorunlu. Değişmez. Yayıncı-Reklamveren Kimlik Eşleşmesi kullanıcı listesinin eşleştirildiği yayıncıyı tanımlar. Bu alan, temiz oda sağlayıcı tarafından sağlanır ve yalnızca söz konusu temiz oda kapsamında benzersizdir. Bu, birden fazla temiz oda arasında genel tanımlayıcı olarak kullanılamaz.
publisherName

string

Zorunlu. Daha iyi bir hedefleme deneyimi için kullanıcı arayüzünde gösterilecek yayıncının açıklayıcı adı.
matchRatePercentage

integer

Zorunlu. Bu alan, bu kullanıcı listesinin ilgili yayıncının birinci taraf verileriyle eşleşen üyelik yüzdesini gösterir. 0 ile 100 arasında olmalıdır (bu değerler dahil).
advertiserIdentifierCount

string (int64 format)

İsteğe bağlı. Bir temiz oda sağlayıcısına yüklenen reklamverenin birinci taraf veri kayıtlarının sayısı. Bu, bir PAIR kullanıcı listesinin boyutunu göstermez.
cleanRoomIdentifier

string

Zorunlu. Değişmez. Bir temiz oda sağlayıcısı ile veya birden çok temiz oda sağlayıcısı arasında benzersiz bir reklamveren-yayıncı ilişkisini tanımlar.

PseudonymousIdInfo

PSEUDONYMOUS_ID, uploadKeyTypes öğelerinden biri olduğunda ek bilgiler.

JSON gösterimi 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Alanlar
syncStatus

enum (SyncStatus)

Yalnızca çıkış. Kullanıcı listesinin senkronizasyon durumu.
billableRecordCount

string (int64 format)

İsteğe bağlı. Değişmez. Faturalandırılabilir kayıtların sayısı (ör. yüklenen veya eşleşen).

SyncStatus

Kullanıcı listesinin senkronizasyon durumu.

Sıralamalar
SYNC_STATUS_UNSPECIFIED Belirtilmedi.
CREATED Kullanıcı listesi yer tutucu olarak oluşturuldu. Liste içerikleri ve/veya meta veriler hâlâ senkronize ediliyor. Kullanıcı listesi kullanıma hazır değil.
READY_FOR_USE Kullanıcı listesi kullanıma hazır. İçerikler ve çerezler doğru şekilde senkronize edildi.
FAILED Kullanıcı listesi içerikleri ve/veya meta verileri senkronize edilirken bir hata oluştu. Kullanıcı listesi kullanılamaz.

PartnerAudienceInfo

İş ortağı kitleleri için ek bilgiler.

Bu özellik yalnızca veri iş ortakları tarafından kullanılabilir.

JSON gösterimi 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Alanlar
partnerAudienceSource

enum (PartnerAudienceSource)

Zorunlu. Değişmez. İş ortağı kitlesinin kaynağı.
commercePartner

string

İsteğe bağlı. Ticaret iş ortağının adı. Yalnızca partnerAudienceSource COMMERCE_AUDIENCE ise izin verilir.

PartnerAudienceSource

İş ortağı kitle kaynağı.

Sıralamalar
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Belirtilmedi.
COMMERCE_AUDIENCE İş ortağı kitle kaynağı, ticari kitlelerdir.
LINEAR_TV_AUDIENCE İş ortağı kitle kaynağı, geleneksel TV kitlesidir.
AGENCY_PROVIDER_AUDIENCE İş ortağı kitle kaynağı, ajans/sağlayıcı kitlesidir.

Yöntemler

create

 UserList oluşturur.

delete

 Bir UserList'i siler.

get

 Bir UserList alır.

list

 UserLists'i listeler.

patch

 Bir UserList'i günceller.