REST Resource: customers.userLists

Zasób: lista użytkowników

Określa listę użytkowników zarządzaną przez Centrum danych reklam.

Zapis 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.
}
Pola
name

string

Tylko dane wyjściowe. Nazwa, która jednoznacznie identyfikuje listę użytkowników Centrum danych reklam. Ma ona format klienci/[identyfikator_klienta]/listy_użytkowników/[identyfikator_użytkownika]
userListId

string (int64 format)

Tylko dane wyjściowe. Identyfikator na liście użytkowników. To pole jest generowane przez usługę i służy do wypełniania listy użytkowników.
adsDataCustomerId

string (int64 format)

Stały Powiązany identyfikator klienta Centrum danych reklam powiązany z tą listą użytkowników. Identyfikator ten musi być określony jako adsDataCustomerId podczas uruchamiania zadań UserListQuery korzystających z tej listy użytkowników. Jeśli go nie ma, używany jest klient nadrzędny. Po utworzeniu listy nie będzie można tego zmienić.
title

string

Wymagany. Nazwa listy użytkowników unikalna dla określonego identyfikatora adsDataCustomerId.
description

string

Wymagany. Opis listy użytkowników.
type

enum (UserListType)

Tylko dane wyjściowe. Wartości typu UserList powinny być spójne z wartością userList. Ta wartość jest tylko do odczytu i będzie dostępna w przypadku żądań get/list.
createEmail

string

Tylko dane wyjściowe. Adres e-mail użytkownika, który utworzył tę listę użytkowników.
listSize

string (int64 format)

Tylko dane wyjściowe. Liczba użytkowników na liście użytkowników. Aktualizacja rozmiaru listy może być opóźniona.
populateTime

string (Timestamp format)

Tylko dane wyjściowe. Lista została uzupełniona po ostatnim czasie.

Sygnatura czasowa w formacie RFC3339 UTC &Zulu" z rozdzielczością nanosekundy i do 9 cyfr po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Tylko dane wyjściowe. Stan listy użytkowników (Aktywne/Usunięte). Ta wartość jest tylko do odczytu i będzie dostępna w przypadku żądań get/list.

Pole związkowe user_list. Dalsza konfiguracja w zależności od typu listy użytkowników.

Należy ustawić dokładnie jedną wartość. user_list może mieć tylko jedną z tych wartości:
frequencyList

object (FrequencyBasedListInfo)

Lista użytkowników z ograniczeniem liczby wyświetleń.
remarketingList

object (RemarketingListInfo)

Lista remarketingowa.

Typ listy użytkowników

Rodzaj listy użytkowników. Tworzenie i wykorzystywanie listy użytkowników w momencie kierowania zależy od tego wyliczenia. Po utworzeniu listy nie można zmienić jej typu.

Wartości w polu enum
USER_LIST_TYPE_UNSPECIFIED Wartość domyślna: nie należy używać.
REMARKETING Grupy odbiorców remarketingu utworzone za pomocą zapytań SQL w CDR. List remarketingowych można używać do kierowania uwzględniającego i negatywnego.
FREQUENCY_BASED Odbiorcy z ograniczoną częstotliwością. Tego rodzaju listy odbiorców są ograniczone do kierowania wykluczającego.

Informacje o częstotliwości

Metadane listy opartej na częstotliwości.

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

string (int64 format)

Identyfikatory elementów zamówienia DV360, które przyczyniają się do częstotliwości wyświetleń.
cmCampaignIds[]
(deprecated)

string (int64 format)

Identyfikatory kampanii CM, które przyczyniają się do częstotliwości wyświetleń.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

Identyfikatory kampanii Google Ads, które przyczyniają się do zwiększenia częstotliwości wyświetlania reklam.
eventMatchers[]

object (EventMatcher)

Które zdarzenia mają wpływ na częstotliwość. Podczas tworzenia list użytkowników z częstotliwością parametr eventMatchers jest preferowany do określania zdarzeń przyczyniających się do częstotliwości. W przypadku zdarzeń eventMatchers puste są wartości dv360LineitemIds, cmCampaignIds i googleAdsCampaignIds.
frequencyConstraint

object (FrequencyConstraint)

Opisuje, kiedy użytkownik został dodany do listy.
slidingWindowDays

integer

Wymagany. Rozmiar okna czasu używanego do obliczania częstotliwości każdego zdarzenia. Jest mierzona w dniach

Dopasowanie zdarzenia

Ogólne zdarzenie, które wpływa na częstotliwość.

Zapis JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
Pola
matchType

enum (MatchType)

Typ ograniczenia, który zostanie uwzględniony w liczbie wyświetleń.
value

string

Wartość ograniczenia. Na przykład w przypadku identyfikatora kampanii Google Ads = 1234 pasującym typem będzie GOOGLE_ADS_CAMPAIGN_ID, a wartość to '1234'. Zdarzenia, które mają tę wartość dla danego typu dopasowania, będą uwzględniane w częstotliwości.

Typ dopasowania

Typy ograniczeń obsługiwanych przy częstotliwości. W przyszłości możemy dodać do tej listy więcej typów, by uwzględnić dodatkowe ograniczenia. W elemencie MatchType w polu DescriptionValidCzęstotliwośćLimitingEventMatchersRequest możesz określić filtr, aby w wynikach wyszukiwania pojawiały się tylko te dopasowania, które są obsługiwane przez interfejs API. Na przykład ustawienie filtra jako „"eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID"” spowoduje zwrócenie tylko tych typów zdarzeń.

Wartości w polu enum
MATCH_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
CM_CAMPAIGN_ID Typ ograniczenia reprezentujący identyfikator kampanii w usłudze Campaign Manager.
DV360_INSERTION_ORDER_ID Typ ograniczenia reprezentujący identyfikator zamówienia reklamowego DV360.
DV360_LINE_ITEM_ID Typ ograniczenia reprezentujący identyfikator elementu zamówienia DV360.
GOOGLE_ADS_CAMPAIGN_ID Typ ograniczenia reprezentujący identyfikator kampanii Google Ads.

Ograniczenie liczby wyświetleń

Określ minimalną liczbę zdarzeń dla limitu.

Zapis JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Pola
eventType

enum (EventType)

Stały Typ zdarzenia, które będzie uwzględniane przy progu. Obecnie nie podajemy jednoznacznie ograniczeń porównania, zakładając, że wszystkie obowiązują wartości GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

Wymagany. Każdy użytkownik powinien być co najmniej K.

Typ zdarzenia

Typy zdarzeń, które mogą służyć do zliczania wyświetleń na użytkownika.

Wartości w polu enum
EVENT_TYPE_UNSPECIFIED Wartość domyślna: nie należy używać.
IMPRESSIONS Zliczaj wszystkie wyświetlenia.

Informacje o liście remarketingowej

Metadane z list remarketingowych.

Zapis JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Pola
userListQuery

string

Stały Zasób zapytania o listę użytkowników w Centrum danych reklam, który określa sposób dodawania użytkowników do tej grupy odbiorców. Ma postać: klienci/[identyfikator_klienta]/userListQuery/[identyfikator_zasobu_zapytania]
populatingUserListQueries[]

string

Tylko dane wyjściowe. Zasoby zapytań dotyczących listy użytkowników Centrum danych reklam, które wypełniły tę listę odbiorców. Jest to starsze pole do obsługi list użytkowników, które były uzupełniane przez wiele zapytań przed wejściem w życie ograniczeń dotyczących użytkowników 1:1. Ma postać: klienci/[identyfikator_klienta]/userListQuery/[identyfikator_zasobu_zapytania]

Stan

Stan listy użytkowników.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna / nieskonfigurowana.
STATE_ACTIVE Lista użytkowników jest nadal otwarta i aktywna.
STATE_DELETED Lista użytkowników jest oznaczona jako usunięta i nie należy jej już używać do kierowania

Metody

addEventMatchers

 Dodaje dopasowania zdarzeń do listy użytkowników na podstawie częstotliwości.

addRecipients

 Dodaj elementy do odbiorców na liście użytkowników zarządzanych przez Centrum danych reklam.

create

 Tworzy listę użytkowników zarządzaną przez Centrum danych reklam.

delete

 Usuń wybraną listę użytkowników zarządzaną przez Centrum danych reklam.

generateFrequencyListMemberships

 Wygeneruj członkostwo dla listy użytkowników.

get

 Pobiera listę użytkowników zarządzaną przez Centrum danych reklam.

list

 Wyświetla listy użytkowników zarządzane przez określonego klienta Centrum danych reklam.

patch

 Aktualizuje wybraną listę użytkowników zarządzanych przez Centrum danych reklam.

removeRecipients

 Usuwa encje z adresatów listy użytkowników zarządzanej przez Centrum danych reklam.