Package google.ads.datamanager.v1

Index

IngestionService

Dienst zum Senden von Zielgruppendaten an unterstützte Ziele.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Lädt eine Liste von AudienceMember-Ressourcen in die bereitgestellte Destination hoch.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/datamanager
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Lädt eine Liste mit Event-Ressourcen aus dem bereitgestellten Destination hoch.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/datamanager
RemoveAudienceMembers

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Entfernt eine Liste von AudienceMember-Ressourcen aus dem bereitgestellten Destination.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/datamanager

AdIdentifiers

Kennungen und andere Informationen, die verwendet werden, um das Conversion-Ereignis mit anderen Onlineaktivitäten (z. B. Anzeigenklicks) abzugleichen.

Felder
session_attributes

string

Optional. Sitzungsattribute für die Ereignisattribution und -modellierung.
gclid

string

Optional. Die GCLID (Google Click ID), die diesem Ereignis zugeordnet ist.
gbraid

string

Optional. Die Klick-ID für Klicks, die App-Ereignissen zugeordnet sind und von iOS-Geräten mit mindestens iOS 14 stammen.
wbraid

string

Optional. Die Klick-ID für Klicks, die Web-Events zugeordnet sind und von iOS-Geräten mit mindestens iOS 14 stammen.
landing_page_device_info

DeviceInfo

Optional. Informationen zum verwendeten Gerät (falls vorhanden), wenn der Nutzer nach der Interaktion mit der Anzeige auf der Website des Werbetreibenden landet.

AddressInfo

Adressinformationen für den Nutzer.

Felder
given_name

string

Erforderlich. Vorname des Nutzers, nur Kleinbuchstaben, ohne Satzzeichen, ohne führende oder nachfolgende Leerzeichen und mit SHA-256 gehasht.
family_name

string

Erforderlich. Nachname des Nutzers, alles in Kleinbuchstaben, ohne Satzzeichen, ohne führende oder nachfolgende Leerzeichen und mit SHA-256 gehasht.
region_code

string

Erforderlich. Der aus zwei Buchstaben bestehende Regionscode nach ISO 3166-1 Alpha 2 der Adresse des Nutzers.
postal_code

string

Erforderlich. Die Postleitzahl der Adresse des Nutzers.

AudienceMember

Die Person, die operiert werden soll.

Felder
consent

Consent

Optional. Die Einwilligungseinstellung für den Nutzer.
Union-Feld data. Der Typ der zu verarbeitenden identifizierenden Daten. Für data ist nur einer der folgenden Werte zulässig:
user_data

UserData

Von Nutzern bereitgestellte Daten, die den Nutzer identifizieren.
pair_data

PairData

PAIR-IDs (Publisher Advertiser Identity Reconciliation).
mobile_data

MobileData

Daten zur Identifizierung der Mobilgeräte des Nutzers.

CartData

Die mit dem Ereignis verknüpften Warenkorbdaten.

Felder
merchant_id

string

Optional. Die Merchant Center-ID, die den Artikeln zugeordnet ist.
merchant_feed_label

string

Optional. Das Merchant Center-Feedlabel, das mit dem Feed der Artikel verknüpft ist.
merchant_feed_language_code

string

Optional. Der Sprachcode in ISO 639-1, der mit dem Merchant Center-Feed der Artikel verknüpft ist, in den Ihre Artikel hochgeladen werden.
transaction_discount

double

Optional. Die Summe aller Rabatte, die der Transaktion zugeordnet sind.
items[]

Item

Optional. Die Liste der mit dem Ereignis verknüpften Elemente.

Einstellungen für die Einwilligung gemäß dem Gesetz über digitale Märkte (Digital Markets Act, DMA) für den Nutzer.

Felder
ad_user_data

ConsentStatus

Optional. Gibt an, ob der Nutzer der Verwendung von werbebezogenen Nutzerdaten zustimmt.
ad_personalization

ConsentStatus

Optional. Gibt an, ob der Nutzer der personalisierten Werbung zustimmt.

ConsentStatus

Gibt an, ob der Nutzer die Einwilligung erteilt, verweigert oder nicht angegeben hat.

Enums
CONSENT_STATUS_UNSPECIFIED Nicht angegeben.
CONSENT_GRANTED Gewährt.
CONSENT_DENIED Abgelehnt.

CustomVariable

Benutzerdefinierte Variable für Anzeigen-Conversions.

Felder
variable

string

Optional. Der Name der benutzerdefinierten Variable, die festgelegt werden soll. Wenn die Variable für das angegebene Ziel nicht gefunden wird, wird sie ignoriert.
value

string

Optional. Der Wert, der für die benutzerdefinierte Variable gespeichert werden soll.
destination_references[]

string

Optional. Referenzstring, mit dem bestimmt wird, an welche der Event.destination_references die benutzerdefinierte Variable gesendet werden soll. Wenn leer, wird Event.destination_references verwendet.

CustomerType

Typ des Kunden, der dem Ereignis zugeordnet ist.

Enums
CUSTOMER_TYPE_UNSPECIFIED Nicht angegebener CustomerType. Sollte nicht verwendet werden.
NEW Der Kunde ist neu für den Werbetreibenden.
RETURNING Der Kunde kehrt zum Werbetreibenden zurück.
REENGAGED Der Kunde hat sich wieder mit dem Werbetreibenden in Verbindung gesetzt.

CustomerValueBucket

Der vom Werbetreibenden geschätzte Wert des Kunden.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Nicht angegebener CustomerValueBucket. Sollte nicht verwendet werden.
LOW Der Kunde hat ein niedriges Umsatzpotenzial.
MEDIUM Der Kunde hat ein mittleres Umsatzpotenzial.
HIGH Der Kunde hat ein hohes Umsatzpotenzial.

Ziel

Das Google-Produkt, an das Sie Daten senden. Zum Beispiel ein Google Ads-Konto.

Felder
reference

string

Optional. ID für diese Destination-Ressource, die innerhalb der Anfrage eindeutig ist. Wird verwendet, um in der IngestEventsRequest auf diese Destination zu verweisen.
login_account

ProductAccount

Optional. Das Konto, das zum Ausführen dieses API-Aufrufs verwendet wurde. Wenn Sie Daten in die operating_account einfügen oder daraus entfernen möchten, muss diese login_account Schreibzugriff auf die operating_account haben. Das kann beispielsweise ein Verwaltungskonto von operating_account oder ein Konto mit einer bestehenden Verknüpfung zu operating_account sein.
linked_account

ProductAccount

Optional. Ein Konto, auf das das login_account des aufrufenden Nutzers über eine eingerichtete Kontoverknüpfung zugreifen kann. Beispiel: Der login_account eines Datenpartners hat möglicherweise Zugriff auf den linked_account eines Kunden. Der Partner kann dieses Feld verwenden, um Daten aus dem linked_account an ein anderes operating_account zu senden.
operating_account

ProductAccount

Erforderlich. Das Konto, an das die Daten gesendet oder aus dem die Daten entfernt werden sollen.
product_destination_id

string

Erforderlich. Das Objekt im Produktkonto, in das die Daten aufgenommen werden sollen. Das kann beispielsweise eine Google Ads- oder Display & Video 360-Zielgruppen-ID sein.

DeviceInfo

Informationen zum Gerät, das bei Eintreten des Ereignisses verwendet wurde (falls zutreffend).

Felder
user_agent

string

Optional. Der User-Agent-String des Geräts für den angegebenen Kontext.
ip_address

string

Optional. Die IP-Adresse des Geräts für den angegebenen Kontext.

Hinweis:Google Ads unterstützt keinen IP-Adressenabgleich für Endnutzer im Europäischen Wirtschaftsraum (EWR), im Vereinigten Königreich (VK) oder in der Schweiz (CH). Fügen Sie Logik hinzu, um die Weitergabe von IP-Adressen von Nutzern aus diesen Regionen bedingt auszuschließen. Stellen Sie außerdem sicher, dass Sie Nutzer verständlich und umfassend über die Daten informieren, die Sie auf Ihren Websites, in Ihren Apps und in anderen Properties erheben, und holen Sie die Einwilligung ein, sofern dies gesetzlich oder gemäß den anwendbaren Google-Richtlinien erforderlich ist. Weitere Informationen zu Offline-Conversion-Importen

Codierung

Der Codierungstyp der gehashten identifizierenden Informationen.

Enums
ENCODING_UNSPECIFIED Nicht angegebener Codierungstyp. Sollte nicht verwendet werden.
HEX Hexadezimale Codierung.
BASE64 Base64-Codierung.

EncryptionInfo

Informationen zur Verschlüsselung der aufgenommenen Daten.

Felder
Union-Feld wrapped_key. Der verpackte Schlüssel, der zum Verschlüsseln der Daten verwendet wird. Für wrapped_key ist nur einer der folgenden Werte zulässig:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Informationen zu umhüllten Schlüsseln für die Google Cloud Platform.

Ereignis

Ein Ereignis, das eine Nutzerinteraktion mit der Website oder App eines Werbetreibenden darstellt.

Felder
destination_references[]

string

Optional. Referenzstring zur Bestimmung des Ziels. Wenn leer, wird das Ereignis an alle destinations in der Anfrage gesendet.
transaction_id

string

Erforderlich. Die eindeutige Kennung für dieses Ereignis.
event_timestamp

Timestamp

Erforderlich. Zeit, zu der das Ereignis aufgetreten ist.
last_updated_timestamp

Timestamp

Optional. Der Zeitpunkt, zu dem das Ereignis zuletzt aktualisiert wurde.
user_data

UserData

Optional. Von Nutzern bereitgestellte Daten, die den Nutzer darstellen, mit dem das Ereignis verknüpft ist.
consent

Consent

Optional. Informationen dazu, ob der zugehörige Nutzer verschiedene Arten von Einwilligungen erteilt hat.
ad_identifiers

AdIdentifiers

Optional. Kennungen und andere Informationen, die verwendet werden, um das Conversion-Ereignis mit anderen Onlineaktivitäten (z. B. Anzeigenklicks) abzugleichen.
currency

string

Optional. Der Währungscode, der allen Geldwerten in diesem Ereignis zugeordnet ist.
conversion_value

double

Optional. Der mit dem Ereignis verknüpfte Conversion-Wert für wertbezogene Conversions.
event_source

EventSource

Optional. Signal dafür, wo das Ereignis stattgefunden hat (Web, App, Geschäft usw.).
event_device_info

DeviceInfo

Optional. Informationen zum Gerät, das zum Zeitpunkt des Ereignisses verwendet wurde (falls zutreffend).
cart_data

CartData

Optional. Informationen zur Transaktion und zu den mit dem Ereignis verknüpften Artikeln.
custom_variables[]

CustomVariable

Optional. Zusätzliche Schlüssel/Wert-Paare, die an die Conversion-Container (Conversion-Aktion oder Floodlight-Aktivität) gesendet werden sollen.
experimental_fields[]

ExperimentalField

Optional. Eine Liste von Schlüssel/Wert-Paaren für experimentelle Felder, die möglicherweise in die API aufgenommen werden.
user_properties

UserProperties

Optional. Vom Werbetreibenden erhobene Informationen zum Nutzer zum Zeitpunkt des Ereignisses.

EventSource

Die Quelle des Ereignisses.

Enums
EVENT_SOURCE_UNSPECIFIED Nicht angegebene EventSource. Sollte nicht verwendet werden.
WEB Das Ereignis wurde von einem Webbrowser generiert.
APP Der Termin wurde aus einer App generiert.
IN_STORE Das Ereignis wurde aus einer Transaktion im Geschäft generiert.
PHONE Das Ereignis wurde aus einem Telefonanruf generiert.
OTHER Das Ereignis wurde aus anderen Quellen generiert.

ExperimentalField

Experimentelles Feld für inoffizielle Felder.

Felder
field

string

Optional. Der Name des zu verwendenden Felds.
value

string

Optional. Der Wert, auf den das Feld festgelegt werden soll.

GcpWrappedKeyInfo

Informationen zum umschlossenen Schlüssel der Google Cloud Platform.

Felder
key_type

KeyType

Erforderlich. Der Algorithmus, der zum Verschlüsseln der Daten verwendet wird.
wip_provider

string

Erforderlich. Der Workload Identity-Poolanbieter, der für die Verwendung von KEK erforderlich ist.
kek_uri

string

Erforderlich. Ressourcen-ID des Google Cloud Platform Cloud Key Management Service.
encrypted_dek

string

Erforderlich. Der base64-codierte verschlüsselte Datenverschlüsselungsschlüssel.

KeyType

Der Algorithmus, der zum Verschlüsseln der Daten verwendet wird.

Enums
KEY_TYPE_UNSPECIFIED Nicht angegebener Schlüsseltyp. Sollte nicht verwendet werden.
XCHACHA20_POLY1305 Algorithmus XChaCha20-Poly1305

IngestAudienceMembersRequest

Anfrage zum Hochladen von Zielgruppenmitgliedern in die angegebenen Ziele. Gibt ein IngestAudienceMembersResponse zurück.

Felder
destinations[]

Destination

Erforderlich. Die Liste der Ziele, an die die Zielgruppenmitglieder gesendet werden sollen.
audience_members[]

AudienceMember

Erforderlich. Die Liste der Nutzer, an die die angegebenen Ziele gesendet werden sollen. In einer einzelnen Anfrage können maximal 10.000 AudienceMember-Ressourcen gesendet werden.
consent

Consent

Optional. Einwilligung auf Anfrageebene, die für alle Nutzer in der Anfrage gilt. Die Einwilligung auf Nutzerebene überschreibt die Einwilligung auf Anfrageebene und kann in jedem AudienceMember angegeben werden.
validate_only

bool

Optional. Zu Testzwecken. Wenn true, wird die Anfrage validiert, aber nicht ausgeführt. Es werden nur Fehler zurückgegeben, keine Ergebnisse.
encoding

Encoding

Optional. Erforderlich für UserData-Uploads. Der Codierungstyp der Nutzerkennungen. Bei gehashten Nutzer-IDs ist dies der Codierungstyp des gehashten Strings. Bei verschlüsselten gehashten Nutzer-IDs ist dies der Codierungstyp des äußeren verschlüsselten Strings, aber nicht unbedingt des inneren gehashten Strings. Der innere gehashte String kann also anders codiert sein als der äußere verschlüsselte String. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.
encryption_info

EncryptionInfo

Optional. Informationen zur Verschlüsselung für UserData-Uploads. Wenn nicht festgelegt, wird davon ausgegangen, dass hochgeladene personenbezogene Daten gehasht, aber nicht verschlüsselt sind. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.
terms_of_service

TermsOfService

Optional. Die Nutzungsbedingungen, die der Nutzer akzeptiert oder abgelehnt hat.

IngestAudienceMembersResponse

Antwort von IngestAudienceMembersRequest.

Felder
request_id

string

Die automatisch generierte ID der Anfrage.

IngestEventsRequest

Anfrage zum Hochladen von Zielgruppenmitgliedern in die angegebenen Ziele. Gibt ein IngestEventsResponse zurück.

Felder
destinations[]

Destination

Erforderlich. Die Liste der Ziele, an die die Ereignisse gesendet werden sollen.
events[]

Event

Erforderlich. Die Liste der Ereignisse, die an die angegebenen Ziele gesendet werden sollen. In einer einzelnen Anfrage können maximal 2.000 Event-Ressourcen gesendet werden.
consent

Consent

Optional. Einwilligung auf Anfrageebene, die für alle Nutzer in der Anfrage gilt. Die Einwilligung auf Nutzerebene überschreibt die Einwilligung auf Anfrageebene und kann in jedem Event angegeben werden.
validate_only

bool

Optional. Zu Testzwecken. Wenn true, wird die Anfrage validiert, aber nicht ausgeführt. Es werden nur Fehler zurückgegeben, keine Ergebnisse.
encoding

Encoding

Optional. Erforderlich für UserData-Uploads. Der Codierungstyp der Nutzerkennungen. Bei gehashten Nutzer-IDs ist dies der Codierungstyp des gehashten Strings. Bei verschlüsselten gehashten Nutzer-IDs ist dies der Codierungstyp des äußeren verschlüsselten Strings, aber nicht unbedingt des inneren gehashten Strings. Der innere gehashte String kann also anders codiert sein als der äußere verschlüsselte String. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.
encryption_info

EncryptionInfo

Optional. Informationen zur Verschlüsselung für UserData-Uploads. Wenn nicht festgelegt, wird davon ausgegangen, dass hochgeladene personenbezogene Daten gehasht, aber nicht verschlüsselt sind. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.

IngestEventsResponse

Antwort von IngestEventsRequest.

Felder
request_id

string

Die automatisch generierte ID der Anfrage.

Element

Stellt einen Artikel im Einkaufswagen dar, der mit dem Ereignis verknüpft ist.

Felder
merchant_product_id

string

Optional. Die Produkt-ID im Merchant Center-Konto.
quantity

int64

Optional. Die Anzahl dieses Artikels, die mit dem Ereignis verknüpft ist.
unit_price

double

Optional. Der Artikelpreis ohne Steuern, Versand und etwaige Rabatte auf Transaktionsebene.

MobileData

Mobile IDs für die Zielgruppe. Es ist mindestens eine mobile ID erforderlich.

Felder
mobile_ids[]

string

Erforderlich. Die Liste der IDs für Mobilgeräte (Werbe-ID/IDFA). In einem einzelnen AudienceMember können maximal 10 mobileIds angegeben werden.

PairData

PAIR-IDs für die Zielgruppe. Mindestens eine PAIR-ID ist erforderlich.

Felder
pair_ids[]

string

Erforderlich. Von Cleanroom-Anbietern bereitgestellte personenbezogene Daten, die mit SHA256 gehasht und mit einer kommutativen EC-Verschlüsselung mit dem Publisher-Schlüssel für die PAIR-Nutzerliste verschlüsselt wurden. In einem einzelnen AudienceMember können maximal 10 pairIds angegeben werden.

Produkt

Stellt ein bestimmtes Google-Produkt dar. Wird verwendet, um Konten und Ziele zu finden.

Enums
PRODUCT_UNSPECIFIED Nicht angegebenes Produkt. Sollte nicht verwendet werden.
GOOGLE_ADS Google Ads
DISPLAY_VIDEO_PARTNER Display & Video 360-Partner.
DISPLAY_VIDEO_ADVERTISER Display & Video 360-Werbetreibender
DATA_PARTNER Datenpartner

ProductAccount

Stellt ein bestimmtes Konto dar.

Felder
product

Product

Erforderlich. Das Produkt, zu dem das Konto gehört. Beispiel: GOOGLE_ADS.
account_id

string

Erforderlich. Die ID des Kontos. Beispiel: Ihre Google Ads-Konto-ID.

RemoveAudienceMembersRequest

Anfrage zum Entfernen von Nutzern aus einer Zielgruppe an den angegebenen Zielen. Gibt RemoveAudienceMembersResponse zurück.

Felder
destinations[]

Destination

Erforderlich. Die Liste der Ziele, aus denen die Nutzer entfernt werden sollen.
audience_members[]

AudienceMember

Erforderlich. Die Liste der zu entfernenden Nutzer.
validate_only

bool

Optional. Zu Testzwecken. Wenn true, wird die Anfrage validiert, aber nicht ausgeführt. Es werden nur Fehler zurückgegeben, keine Ergebnisse.
encoding

Encoding

Optional. Erforderlich für UserData-Uploads. Der Codierungstyp der Nutzerkennungen. Gilt nur für die äußere Codierung verschlüsselter Nutzer-IDs. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.
encryption_info

EncryptionInfo

Optional. Informationen zur Verschlüsselung für UserData-Uploads. Wenn nicht festgelegt, wird davon ausgegangen, dass hochgeladene personenbezogene Daten gehasht, aber nicht verschlüsselt sind. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.

RemoveAudienceMembersResponse

Antwort von RemoveAudienceMembersRequest.

Felder
request_id

string

Die automatisch generierte ID der Anfrage.

TermsOfService

Die Nutzungsbedingungen, die der Nutzer akzeptiert oder abgelehnt hat.

Felder
customer_match_terms_of_service_status

TermsOfServiceStatus

Optional. Die Nutzungsbedingungen für den Kundenabgleich: https://support.google.com/adspolicy/answer/6299717. Diese muss für alle Uploads in Nutzerlisten zum Kundenabgleich akzeptiert werden.

TermsOfServiceStatus

Gibt an, ob der Anrufer die Nutzungsbedingungen akzeptiert oder abgelehnt hat.

Enums
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Nicht angegeben.
ACCEPTED Status, der angibt, dass der Anrufer die Nutzungsbedingungen akzeptiert hat.
REJECTED Status, der angibt, dass der Anrufer die Nutzungsbedingungen abgelehnt hat.

UserData

Daten, die den Nutzer identifizieren. Mindestens eine Kennung ist erforderlich.

Felder
user_identifiers[]

UserIdentifier

Erforderlich. Die Kennungen für den Nutzer. Es ist möglich, mehrere Instanzen desselben Datentyps anzugeben, z. B. mehrere E-Mail-Adressen. Geben Sie so viele Kennungen wie möglich an, um die Wahrscheinlichkeit einer Übereinstimmung zu erhöhen. In einem einzelnen AudienceMember oder Event können maximal 10 userIdentifiers angegeben werden.

UserIdentifier

Eine einzelne Kennung für den Nutzer.

Felder
Union-Feld identifier. Es muss genau eine angegeben werden. Für identifier ist nur einer der folgenden Werte zulässig:
email_address

string

Gehashte E-Mail-Adresse mit der SHA-256-Hash-Funktion nach der Normalisierung.
phone_number

string

Gehashte Telefonnummer mit der SHA-256-Hash-Funktion nach der Normalisierung (E164-Standard).
address

AddressInfo

Die bekannten Komponenten der Adresse eines Nutzers. Enthält eine Gruppierung von Kennungen, die alle gleichzeitig abgeglichen werden.

UserProperties

Vom Werbetreibenden erhobene Informationen zum Nutzer zum Zeitpunkt des Ereignisses. Weitere Informationen finden Sie unter https://support.google.com/google-ads/answer/14007601.

Felder
customer_type

CustomerType

Optional. Typ des Kunden, der dem Ereignis zugeordnet ist.
customer_value_bucket

CustomerValueBucket

Optional. Der vom Werbetreibenden geschätzte Wert des Kunden.