REST Resource: accountTypes.accounts.userLists

Ressource: UserList

Eine Nutzerlistenressource.

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

string

ID. Der Ressourcenname der Nutzerliste. Format: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

Nur Ausgabe. Die eindeutige ID der Nutzerliste.
readOnly

boolean

Nur Ausgabe. Eine Option, die angibt, ob ein Nutzer eine Liste bearbeiten darf.
membershipDuration

string (Duration format)

Optional. Die Dauer, die ein Nutzer in der Nutzerliste verbleibt. Gültige Zeiträume sind genaue Vielfache von 24 Stunden (86.400 Sekunden). Wenn Sie einen Wert angeben, der kein genaues Vielfaches von 24 Stunden ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
accessReason

enum (AccessReason)

Nur Ausgabe. Der Grund, warum diesem Konto Zugriff auf die Liste gewährt wurde.
sizeInfo

object (SizeInfo)

Nur Ausgabe. Geschätzte Anzahl der Mitglieder in dieser Nutzerliste in verschiedenen Zielnetzwerken.
targetNetworkInfo

object (TargetNetworkInfo)

Optional. Informationen zu den Voraussetzungen für verschiedene Zielnetzwerke.
displayName

string

Erforderlich. Der Anzeigename der Nutzerliste.
description

string

Optional. Eine Beschreibung der Nutzerliste.
membershipStatus

enum (MembershipStatus)

Optional. Mitgliedschaftsstatus dieser Nutzerliste.
integrationCode

string

Optional. Eine ID aus einem externen System. Sie wird von Verkäufern von Nutzerlisten verwendet, um IDs in ihren Systemen abzugleichen.
closingReason

enum (ClosingReason)

Nur Ausgabe. Der Grund, warum der Mitgliedschaftsstatus dieser Nutzerliste geschlossen ist.
accountAccessStatus

enum (AccessStatus)

Optional. Gibt an, ob diese Freigabe noch aktiviert ist. Wenn eine Nutzerliste für das Konto freigegeben wird, für das dieses Feld festgelegt ist, wird ENABLED verwendet. Später kann der Inhaber der Nutzerliste die Freigabe widerrufen und die Liste auf DISABLED setzen.
Union-Feld user_list_info. Zusätzliche Informationen zur Nutzerliste. Für user_list_info ist nur einer der folgenden Werte zulässig:
ingestedUserListInfo

object (IngestedUserListInfo)

Optional. Stellt eine Nutzerliste dar, die mit von Nutzern erfassten Daten gefüllt wird.

MembershipStatus

Status der Nutzerliste.

Enums
MEMBERSHIP_STATUS_UNSPECIFIED Nicht angegeben.
OPEN Offen: Der Nutzerliste werden Mitglieder hinzugefügt und sie kann für das Targeting verwendet werden.
CLOSED Status „Geschlossen“: Es werden keine neuen Mitglieder hinzugefügt.

ClosingReason

Gibt den Grund an, warum die Nutzerliste geschlossen wurde. Diese Enumeration wird nur verwendet, wenn eine Liste automatisch vom System geschlossen wird.

Enums
CLOSING_REASON_UNSPECIFIED Nicht angegeben.
UNUSED Die Nutzerliste wurde geschlossen, weil sie in letzter Zeit nicht für das Targeting verwendet wurde. Weitere Informationen finden Sie unter https://support.google.com/google-ads/answer/2472738.

AccessReason

Aufzählung zur Beschreibung möglicher Zugriffsgründe.

Enums
ACCESS_REASON_UNSPECIFIED Nicht angegeben.
OWNED Die Ressource gehört dem Nutzer.
SHARED Die Ressource wird für den Nutzer freigegeben.
LICENSED Die Ressource ist für den Nutzer lizenziert.
SUBSCRIBED Der Nutzer hat die Ressource abonniert.
AFFILIATED Der Nutzer kann auf die Ressource zugreifen.

AccessStatus

Gibt an, ob dieser Client noch Zugriff auf die Liste hat.

Enums
ACCESS_STATUS_UNSPECIFIED Nicht angegeben.
ENABLED Der Zugriff ist aktiviert.
DISABLED Der Zugriff ist deaktiviert.

SizeInfo

Geschätzte Anzahl der Mitglieder in dieser Nutzerliste in verschiedenen Zielnetzwerken.

JSON-Darstellung 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string
}
Felder
displayNetworkMembersCount

string (int64 format)

Nur Ausgabe. Geschätzte Anzahl der Mitglieder in dieser Nutzerliste im Google Displaynetzwerk.
searchNetworkMembersCount

string (int64 format)

Nur Ausgabe. Geschätzte Anzahl der Mitglieder in dieser Nutzerliste in der Domain „google.com“. Diese Mitglieder können für das Targeting in Suchkampagnen verwendet werden.

TargetNetworkInfo

Informationen zu den Voraussetzungen für verschiedene Zielnetzwerke.

JSON-Darstellung 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Felder
eligibleForDisplay

boolean

Nur Ausgabe. Gibt an, ob diese Nutzerliste für das Google Displaynetzwerk infrage kommt.

IngestedUserListInfo

Stellt eine Nutzerliste dar, die mit von Nutzern bereitgestellten Daten gefüllt wird.

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

enum (UploadKeyType)

Erforderlich. Nicht veränderbar. Uploadschlüsseltypen dieser Nutzerliste.
contactIdInfo

object (ContactIdInfo)

Optional. Zusätzliche Informationen, wenn CONTACT_ID eine der uploadKeyTypes ist.
mobileIdInfo

object (MobileIdInfo)

Optional. Zusätzliche Informationen, wenn MOBILE_ID eine der uploadKeyTypes ist.
userIdInfo

object (UserIdInfo)

Optional. Zusätzliche Informationen, wenn USER_ID eine der uploadKeyTypes ist.
pairIdInfo

object (PairIdInfo)

Optional. Zusätzliche Informationen, wenn PAIR_ID eine der uploadKeyTypes ist.

Diese Funktion ist nur für Datenpartner verfügbar.
pseudonymousIdInfo

object (PseudonymousIdInfo)

Optional. Zusätzliche Informationen für PSEUDONYMOUS_ID sind eine der uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

Optional. Zusätzliche Informationen zu Partnerzielgruppen

Diese Funktion ist nur für Datenpartner verfügbar.

UploadKeyType

Enumeration mit den möglichen Uploadschlüsseltypen einer Nutzerliste.

Enums
UPLOAD_KEY_TYPE_UNSPECIFIED Nicht angegeben.
CONTACT_ID Kundeninformationen wie E‑Mail-Adresse, Telefonnummer oder Postanschrift.
MOBILE_ID IDs für mobile Werbung.
USER_ID Nutzer-IDs von Drittanbietern.
PAIR_ID IDs für den Identitätsabgleich zwischen Publishern und Werbetreibenden.
PSEUDONYMOUS_ID Datenverwaltungsplattform-IDs: - Google-Nutzer-ID - Vom Partner bereitgestellte ID - Vom Publisher bereitgestellte ID - iOS-IDFA - Android-Werbe-ID - Roku-ID - Amazon Fire TV-ID - Xbox- oder Microsoft-ID

ContactIdInfo

Zusätzliche Informationen, wenn CONTACT_ID eine der uploadKeyTypes ist.

JSON-Darstellung 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Felder
matchRatePercentage

integer

Nur Ausgabe. Abgleichsrate für Nutzerlisten zum Kundenabgleich.
dataSourceType

enum (DataSourceType)

Optional. Nicht veränderbar. Quelle der Upload-Daten

DataSourceType

Gibt die Quelle der Upload-Daten an.

Enums
DATA_SOURCE_TYPE_UNSPECIFIED Nicht angegeben.
DATA_SOURCE_TYPE_FIRST_PARTY Die hochgeladenen Daten sind selbst erhobene Daten.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Die hochgeladenen Daten stammen von einem Drittanbieter-Kreditbüro.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Die hochgeladenen Daten stammen aus einer Wählerdatei eines Drittanbieters.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Die hochgeladenen Daten sind Daten von Drittanbieter-Partnern.

MobileIdInfo

Zusätzliche Informationen, wenn MOBILE_ID eine der uploadKeyTypes ist.

JSON-Darstellung 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Felder
dataSourceType

enum (DataSourceType)

Optional. Nicht veränderbar. Quelle der Upload-Daten.
keySpace

enum (KeySpace)

Erforderlich. Nicht veränderbar. Der Schlüsselbereich von mobilen IDs.
appId

string

Erforderlich. Nicht veränderbar. Ein String, der eine mobile App, aus der die Daten erhoben wurden, eindeutig identifiziert.

KeySpace

Schlüsselbereich für mobile ID.

Enums
KEY_SPACE_UNSPECIFIED Nicht angegeben.
IOS Der iOS-Schlüsselbereich.
ANDROID Der Android-Schlüsselbereich.

UserIdInfo

Zusätzliche Informationen, wenn USER_ID eine der uploadKeyTypes ist.

JSON-Darstellung 
{
  "dataSourceType": enum (DataSourceType)
}
Felder
dataSourceType

enum (DataSourceType)

Optional. Nicht veränderbar. Quelle der Upload-Daten.

PairIdInfo

Zusätzliche Informationen, wenn PAIR_ID eine der uploadKeyTypes ist.

Diese Funktion ist nur für Datenpartner verfügbar.

JSON-Darstellung 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Felder
publisherId

string (int64 format)

Erforderlich. Nicht veränderbar. Gibt den Publisher an, mit dem die Nutzerliste für den Identitätsabgleich zwischen Publishern und Werbetreibenden abgeglichen wird. Dieses Feld wird vom Clean-Room-Anbieter bereitgestellt und ist nur im Rahmen dieses Clean Rooms eindeutig. Sie kann nicht als globale Kennung in mehreren Cleanrooms verwendet werden.
publisherName

string

Erforderlich. Ein beschreibender Name des Publishers, der in der Benutzeroberfläche angezeigt wird, um das Targeting zu verbessern.
matchRatePercentage

integer

Erforderlich. In diesem Feld wird der Prozentsatz der Mitgliedschaftsübereinstimmung dieser Nutzerliste mit den entsprechenden selbst erhobenen Daten des Publishers angegeben. Muss zwischen 0 und 100 (einschließlich) liegen.
advertiserIdentifierCount

string (int64 format)

Optional. Die Anzahl der Datensätze mit selbst erhobenen Daten des Werbetreibenden, die in einen Data-Clean-Room-Anbieter hochgeladen wurden. Das bedeutet nicht, dass die Nutzerliste für PAIR so groß ist.
cleanRoomIdentifier

string

Erforderlich. Nicht veränderbar. Gibt eine eindeutige Beziehung zwischen Werbetreibenden und Publishern mit einem oder mehreren Data-Clean-Room-Anbietern an.

PseudonymousIdInfo

Zusätzliche Informationen, wenn PSEUDONYMOUS_ID eine der uploadKeyTypes ist.

JSON-Darstellung 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Felder
syncStatus

enum (SyncStatus)

Nur Ausgabe. Synchronisierungsstatus der Nutzerliste.
billableRecordCount

string (int64 format)

Optional. Nicht veränderbar. Die Anzahl der abrechenbaren Datensätze (z.B. hochgeladen oder abgeglichen).

SyncStatus

Synchronisierungsstatus der Nutzerliste.

Enums
SYNC_STATUS_UNSPECIFIED Nicht angegeben.
CREATED Die Nutzerliste wurde als Platzhalter erstellt. Listeninhalte und/oder Metadaten werden noch synchronisiert. Die Nutzerliste ist noch nicht einsatzbereit.
READY_FOR_USE Die Nutzerliste ist einsatzbereit. Inhalte und Cookies wurden richtig synchronisiert.
FAILED Beim Synchronisieren von Inhalten und/oder Metadaten der Nutzerliste ist ein Fehler aufgetreten. Die Nutzerliste kann nicht verwendet werden.

PartnerAudienceInfo

Zusätzliche Informationen zu Partnerzielgruppen

Diese Funktion ist nur für Datenpartner verfügbar.

JSON-Darstellung 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Felder
partnerAudienceSource

enum (PartnerAudienceSource)

Erforderlich. Nicht veränderbar. Die Quelle der Partnerzielgruppe.
commercePartner

string

Optional. Der Name des Commerce-Partners. Nur zulässig, wenn partnerAudienceSource COMMERCE_AUDIENCE ist.

PartnerAudienceSource

Partnerzielgruppenquelle.

Enums
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Nicht angegeben.
COMMERCE_AUDIENCE Die Partnerzielgruppenquelle ist eine Commerce-Zielgruppe.
LINEAR_TV_AUDIENCE Die Zielgruppenquelle des Partners ist die Zielgruppe für lineares Fernsehen.
AGENCY_PROVIDER_AUDIENCE Die Partnerzielgruppenquelle ist eine von einer Agentur/einem Dienstleister zusammengestellte Zielgruppe.

Methoden

create

 Erstellt eine UserList.

delete

 Löscht eine UserList.

get

 Ruft eine UserList ab.

list

 Listet UserLists auf.

patch

 Aktualisiert eine UserList.