REST Resource: customers.userLists

Kaynak: UserList

Ads Data Hub tarafından yönetilen bir kullanıcı listesi tanımlar.

JSON gösterimi 
{
  "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.
}
Alanlar
name

string

Yalnızca çıkış. Ads Data Hub kullanıcı listesini benzersiz şekilde tanımlayan ad. Şu biçimdedir: müşteriler/[musteri]/kullaniciListeleri/[kullaniciListeId]
userListId

string (int64 format)

Yalnızca çıkış. Kullanıcı listesi kimliği. Bu alan, hizmet tarafından oluşturulur ve Kullanıcı Listesini doldurmak için kullanılır.
adsDataCustomerId

string (int64 format)

Sabit. Bu kullanıcı listesiyle ilişkilendirilmiş bağlı Ads Data Hub müşteri kimliği. Bu kullanıcı listesi kullanılarak UserListQuery işleri çalıştırılırken bu kimlik, adsDataCustomerId olarak belirtilmelidir. Mevcut değilse ana müşteri kullanılır. Bu ayar, liste oluşturulduktan sonra değiştirilemez.
title

string

Zorunlu. Belirtilen adsDataCustomerId için benzersiz kullanıcı listesi başlığı.
description

string

Zorunlu. Kullanıcı listesi açıklaması.
type

enum (UserListType)

Yalnızca çıkış. UserList türü değerleri, UserList ile tutarlı olmalıdır. Bu değer Salt Okunur ve alma/listeleme isteklerine erişilebilir.
createEmail

string

Yalnızca çıkış. Bu kullanıcı listesini oluşturan kullanıcının e-posta adresi.
listSize

string (int64 format)

Yalnızca çıkış. Kullanıcı listesindeki kullanıcı sayısı. Liste boyutu güncellemesi gecikebilir.
populateTime

string (Timestamp format)

Yalnızca çıkış. Listenin son doldurulduğu saat.

RFC3339 UTC "Zulu&quot" biçiminde nanosaniye çözünürlüğe ve dokuz adede kadar kesir basamağına sahip zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Yalnızca çıkış. Kullanıcı listesinin durumu (Etkin/Silinmiş). Bu değer Salt Okunur ve alma/listeleme isteklerine erişilebilir.

Birlik alanı user_list. Kullanıcı listesinin türüne bağlı olarak daha fazla yapılandırma.

Tam olarak bir tane ayarlanmalıdır. user_list aşağıdakilerden yalnızca biri olabilir:
frequencyList

object (FrequencyBasedListInfo)

Sıklık sınırı için kullanıcı listesi.
remarketingList

object (RemarketingListInfo)

Yeniden pazarlama listesi.

Kullanıcı ListesiTürü

Kullanıcı Listesi türü. Hedefleme sırasında kullanıcı listesinin oluşturulması ve kullanılması bu sıralamaya bağlıdır. Listenin türü, oluşturulduktan sonra değiştirilemez.

Sıralamalar
USER_LIST_TYPE_UNSPECIFIED Varsayılan değer: Kullanılmamalıdır.
REMARKETING ADH'de SQL sorgularıyla oluşturulan Yeniden Pazarlama Kitleleri. Yeniden pazarlama listesi, pozitif ve negatif hedefleme için kullanılabilir.
FREQUENCY_BASED Sıklık sınırlı kitleler. Bu türdeki kitleler negatif hedeflemeyle sınırlıdır.

Sıklık Tabanlı Liste Bilgileri

Sıklık tabanlı Kullanıcı Listesi için meta veriler.

JSON gösterimi 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Alanlar
dv360LineitemIds[]
(deprecated)

string (int64 format)

Sıklığa katkıda bulunan DV360 satır öğeleri için kimlikler.
cmCampaignIds[]
(deprecated)

string (int64 format)

Sıklığa katkıda bulunan CM kampanyalarının kimlikleri.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

Sıklığa katkıda bulunan Google Ads kampanyalarının kimlikleri.
eventMatchers[]

object (EventMatcher)

Sıklığa hangi etkinliklerin katkıda bulunduğu. Sıklıka dayalı kullanıcı listeleri oluştururken eventMatchers, sıklığa katkıda bulunan etkinlikleri belirtmek için tercih edilir. eventMatchers boşsa dv360LineitemIds, cmCampaignIds ve googleAdsCampaignIds kullanılır.
frequencyConstraint

object (FrequencyConstraint)

Bir kullanıcının listeye ne zaman eklendiğini açıklar.
slidingWindowDays

integer

Zorunlu. Her bir etkinliğin sıklığı hesaplanırken kullanılan zaman aralığı boyutu. Gün olarak ölçülür

Etkinlik Eşleştirme

Sıklığa katkıda bulunan genel etkinlik.

JSON gösterimi 
{
  "matchType": enum (MatchType),
  "value": string
}
Alanlar
matchType

enum (MatchType)

Sıklık sayısına dahil edilecek kısıtlamanın türü.
value

string

Kısıtlamanın değeri. Örneğin, 1134 Google Ads kampanya kimliğini belirtmek için matchType GOOGLE_ADS_CAMPAIGN_ID ve değeri '1234' olur. İlgili MatchType için bu değere sahip etkinlikler sıklık sayısına dahil edilir.

Eşleme Türü

Sıklık sayısı için desteklenen kısıtlama türleri. Ek kısıtlamaları desteklemek üzere bu sıralamaya gelecekte daha fazla tür eklenebilir. Sonuçlarda döndürülen etkinlik eşleştiricileri yalnızca API'niz tarafından desteklenenlerle sınırlamak için ExplainGeçerliSıklıkLimitingEventMatchersRequest içindeki Eşleme Türü için bir filtre belirtebilirsiniz. Örneğin, filtreyi "eventMatcher.match_type= CM_CAMPAIGN_ID VEYA eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" olarak ayarlamak, yalnızca bu iki türden EventMatchers değerini döndürür.

Sıralamalar
MATCH_TYPE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmaz.
CM_CAMPAIGN_ID Campaign Manager Kampanya Kimliğini temsil eden kısıtlama türü.
DV360_INSERTION_ORDER_ID DV360 Kampanya Siparişi Kimliğini temsil eden kısıtlama türü.
DV360_LINE_ITEM_ID DV360 Satır Öğesi Kimliğini temsil eden kısıtlama türü.
GOOGLE_ADS_CAMPAIGN_ID Google Ads Kampanya Kimliğini temsil eden kısıtlama türü.

Sıklık Sınırı

Sınır için minimum etkinlik sayısını belirtin.

JSON gösterimi 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Alanlar
eventType

enum (EventType)

Sabit. eşiğiEventCount'ta sayılacak etkinliğin türü. Şu anda, yalnızca GREATER_OR_EQUAL olduğu varsayılarak karşılaştırma kısıtlamalarını açık bir şekilde temsil etmiyoruz.
thresholdEventCount

string (int64 format)

Zorunlu. Her kullanıcı en az K etkinliğinde görünmelidir.

EtkinlikTürü

Sıklığı saymak için kullanılabilecek etkinlik türleri.

Sıralamalar
EVENT_TYPE_UNSPECIFIED Varsayılan değer: Kullanılmamalıdır.
IMPRESSIONS Tüm gösterimleri sayın.

Yeniden Pazarlama Listesi Bilgileri

Yeniden pazarlama listeleri için meta veriler.

JSON gösterimi 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Alanlar
userListQuery

string

Sabit. Kullanıcıların bu kitleye nasıl eklendiğini gösteren Ads Data Hub kullanıcı listesi sorgu kaynağı. Şu biçimdedir: customer/[müşterikimliği]/userListSorgular/[sorgu_kaynak_kimliği]
populatingUserListQueries[]

string

Yalnızca çıkış. Ads Data Hub kullanıcı listesi bu kitleyi dolduran sorgu kaynaklarını görüntüler. Bu, 1:1 kullanıcı listesi:sorgu kısıtlamaları yürürlüğe girmeden önce birden fazla sorgu tarafından doldurulan kullanıcı listelerini desteklemek için eski bir alan olarak tasarlanmıştır. Şu biçimdedir: customer/[müşterikimliği]/userListSorgular/[sorgu_kaynak_kimliği]

Eyalet

Kullanıcı listesinin durumu.

Sıralamalar
STATE_UNSPECIFIED Varsayılan / ayarlanmamış değer.
STATE_ACTIVE Kullanıcı listesi hâlâ açık ve etkin.
STATE_DELETED Kullanıcı listesi silindi olarak işaretlendi ve artık hedefleme için kullanılmamalıdır

Yöntemler

addEventMatchers

 Sıklık tabanlı bir kullanıcı listesine etkinlik eşleştiriciler ekler.

addRecipients

 Ads Data Hub tarafından yönetilen kullanıcı listesinin alıcılarına varlık ekleyin.

create

 Ads Data Hub tarafından yönetilen bir kullanıcı listesi oluşturur.

delete

 İstenen Ads Data Hub tarafından yönetilen kullanıcı listesini silin.

generateFrequencyListMemberships

 Kullanıcı Listesi için üyelikler oluşturun.

get

 İstenen Ads Data Hub tarafından yönetilen kullanıcı listesini alır.

list

 Belirtilen Ads Data Hub müşterisi tarafından yönetilen kullanıcı listelerini listeler.

patch

 İstenen Ads Data Hub tarafından yönetilen kullanıcı listesini günceller.

removeRecipients

 Ads Data Hub tarafından yönetilen kullanıcı listesinin alıcılarından varlıkları kaldırır.