REST Resource: customers.userLists

Ressource: UID

Definiert eine von Ads Data Hub verwaltete Nutzerliste.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Nur Ausgabe. Der Name dient zur eindeutigen Identifizierung einer Ads Data Hub-Nutzerliste. Es hat das Format „customers/[customerId]/userLists/[userListId]“.
userListId

string (int64 format)

Nur Ausgabe. ID der Nutzerliste. Dieses Feld wird vom Dienst generiert und dient zum Ausfüllen der UID.
adsDataCustomerId

string (int64 format)

Nicht veränderbar. Verknüpfte Ads Data Hub-Kundennummer, die dieser Nutzerliste zugeordnet ist. Diese ID muss als adsDataCustomerId angegeben werden, wenn Jobs in der Anzeigengruppe mit dieser Nutzerliste ausgeführt werden. Falls nicht vorhanden, wird der übergeordnete Kunde verwendet. Diese Einstellung kann nach dem Erstellen der Liste nicht mehr geändert werden.
title

string

Erforderlich. Titel der Nutzerliste, der für die angegebene adsDataCustomerId eindeutig ist.
description

string

Erforderlich. Beschreibung der Nutzerliste.
type

enum (UserListType)

Nur Ausgabe. Die Werte für den Typ der Anzeigengruppe müssen mit der Nutzerliste übereinstimmen. Dieser Wert ist schreibgeschützt und kann über Get/List-Anfragen aufgerufen werden.
createEmail

string

Nur Ausgabe. E-Mail-Adresse des Nutzers, der diese Nutzerliste erstellt hat.
listSize

string (int64 format)

Nur Ausgabe. Die Anzahl der Nutzer in der Nutzerliste. Die Aktualisierung der Listengröße kann sich verzögern.
populateTime

string (Timestamp format)

Nur Ausgabe. Zeit, zu der die Liste zuletzt ausgefüllt wurde.

Ein Zeitstempel im Format RFC3339 UTC mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Nur Ausgabe. Status der Nutzerliste (aktiv/gelöscht). Dieser Wert ist schreibgeschützt und kann über Get/List-Anfragen aufgerufen werden.

Union-Feld user_list. Weitere Konfiguration abhängig vom Typ der Nutzerliste.

Genau eins muss festgelegt werden. Für user_list ist nur einer der folgenden Werte zulässig:
frequencyList

object (FrequencyBasedListInfo)

Nutzerliste für Frequency Capping
remarketingList

object (RemarketingListInfo)

Remarketing-Liste

UID-Typ

Art der Nutzerliste. Die Erstellung und Verwendung der Nutzerliste zum Targeting-Zeitpunkt hängt von dieser Aufzählung ab. Der Typ der Liste kann nach dem Erstellen nicht mehr geändert werden.

Enums
USER_LIST_TYPE_UNSPECIFIED Standardwert: sollte nicht verwendet werden.
REMARKETING Mit SQL-Abfragen in ADH erstellte Remarketing-Zielgruppen. Remarketing-Listen können für positives und negatives Targeting verwendet werden.
FREQUENCY_BASED Begrenzte Zielgruppen für Frequency Capping. Zielgruppen dieser Art sind auf ausschließendes Targeting beschränkt.

Häufigkeitsbasierte Listeninformationen

Metadaten für häufigkeitsbasierte Nutzerliste.

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

string (int64 format)

IDs für DV360-Werbebuchungen, die zur Häufigkeit beitragen
cmCampaignIds[]
(deprecated)

string (int64 format)

IDs für CM-Kampagnen, die zur Häufigkeit beitragen.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

IDs für Google Ads-Kampagnen, die zur Häufigkeit beitragen
eventMatchers[]

object (EventMatcher)

Welche Ereignisse zur Häufigkeit beitragen. Beim Erstellen von häufigkeitsbasierten Nutzerlisten werden „eventMatchers“ bevorzugt, um Ereignisse anzugeben, die zur Häufigkeit beitragen. Wenn „eventMatchers“ leer ist, werden dv360LineitemIds, cmCampaignIds und googleAdsCampaignIds verwendet.
frequencyConstraint

object (FrequencyConstraint)

Beschreibt, wann ein Nutzer der Liste hinzugefügt wird.
slidingWindowDays

integer

Erforderlich. Die bei der Berechnung der Häufigkeit der einzelnen Ereignisse verwendete Zeitfenstergröße. In Tagen gemessen

EventMatcher

Allgemeines Ereignis, das zur Häufigkeit beiträgt.

JSON-Darstellung 
{
  "matchType": enum (MatchType),
  "value": string
}
Felder
matchType

enum (MatchType)

Der Typ der Einschränkung, die in der Häufigkeitsanzahl enthalten ist.
value

string

Wert der Einschränkung. Wenn Sie beispielsweise die ID einer Google Ads-Kampagne auf 1234 festlegen, lautet der „matchType“ „GOOGLE_ADS_CAMPAIGN_ID“ und der Wert „'1234'“. Ereignisse, die diesen Wert für den jeweiligen Übereinstimmungstyp haben, werden bei der Häufigkeit berücksichtigt.

MatchType

Unterstützte Einschränkungstypen für die Häufigkeit. Dieser Aufzählung werden möglicherweise weitere Typen hinzugefügt, um zusätzliche Einschränkungen zu unterstützen. Sie können einen Filter für „MatchType“ in „describeValidFrequencyLimitingEventMatchersRequest“ angeben, um die in den Ergebnissen zurückgegebenen Ereignis-Matcher auf diejenigen zu beschränken, die von Ihrer API unterstützt werden. Wenn Sie beispielsweise den Filter "eventMatcher.match_type= CM_CAMPAIGN_ID ODER eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" festlegen, werden nur die EventMatcher-Typen dieser beiden Typen zurückgegeben.

Enums
MATCH_TYPE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
CM_CAMPAIGN_ID Einschränkungstyp für die Campaign Manager-Kampagnen-ID.
DV360_INSERTION_ORDER_ID Einschränkungstyp für die DV360-Anzeigenauftrags-ID.
DV360_LINE_ITEM_ID Der Einschränkungstyp für die DV360-Werbebuchungs-ID.
GOOGLE_ADS_CAMPAIGN_ID Einschränkungstyp für die Google Ads-Kampagnen-ID.

Frequency Capping

Geben Sie die Mindestanzahl von Ereignissen für die Begrenzung an.

JSON-Darstellung 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Felder
eventType

enum (EventType)

Nicht veränderbar. Die Art des Ereignisses, das als Grenzwert für Ereignisanzahl gezählt wird. Derzeit stellen wir die Einschränkungen für den Vergleich nicht explizit dar, wenn alle GREATER_OR_EQUAL sind.
thresholdEventCount

string (int64 format)

Erforderlich. Jeder Nutzer sollte in mindestens K-Ereignissen angezeigt werden.

EventType

Ereignistypen, mit denen die Häufigkeit gezählt werden kann.

Enums
EVENT_TYPE_UNSPECIFIED Standardwert: sollte nicht verwendet werden.
IMPRESSIONS Alle Impressionen werden gezählt.

Remarketing-Listeninformationen

Metadaten für Remarketing-Listen.

JSON-Darstellung 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Felder
userListQuery

string

Nicht veränderbar. Die Abfragedatenressource der Ads Data Hub-Nutzerliste, die angibt, wie Nutzer dieser Zielgruppe hinzugefügt werden. Hat die Form „customers/[customerId]/userListQuery/[query_resource_id]“.
populatingUserListQueries[]

string

Nur Ausgabe. Die Ads Data Hub-Nutzerliste enthält Abfrageressourcen, die für diese Zielgruppe ausgefüllt wurden. Dieses Feld dient als Legacy-Feld zur Unterstützung von Nutzerlisten, die vor dem Inkrafttreten der 1:1-Einschränkungen für „userlist:query“ von mehreren Abfragen ausgefüllt wurden. Hat die Form „customers/[customerId]/userListQuery/[query_resource_id]“.

Status

Status der Nutzerliste.

Enums
STATE_UNSPECIFIED Der Standardwert bzw. der nicht festgelegte Wert.
STATE_ACTIVE Die Nutzerliste ist noch aktiv.
STATE_DELETED Nutzerliste ist als gelöscht markiert und sollte nicht mehr für die Ausrichtung verwendet werden

Methoden

addEventMatchers

 Fügt Event-Matcher einer häufigkeitsbasierten Nutzerliste hinzu.

addRecipients

 Fügen Sie den Empfängern einer von Ads Data Hub verwalteten Nutzerliste Entitäten hinzu.

create

 Erstellt eine von Ads Data Hub verwaltete Nutzerliste.

delete

 Löschen Sie die angeforderte, in Ads Data Hub verwaltete Nutzerliste.

generateFrequencyListMemberships

 Generieren Sie Mitgliedschaften für die UID.

get

 Ruft die angeforderte, in Ads Data Hub verwaltete Nutzerliste ab.

list

 Listet die vom angegebenen Ads Data Hub-Kunden verwalteten Nutzerlisten auf.

patch

 Aktualisiert die angeforderte, in Ads Data Hub verwaltete Nutzerliste.

removeRecipients

 Entfernt Entitäten aus den in Ads Data Hub verwalteten Nutzerlisten