REST Resource: firstAndThirdPartyAudiences

Ressource: FirstAndThirdPartyAudience

Beschreibt eine eigene oder Drittanbieter-Zielgruppenliste, die für das Targeting verwendet wird. Zielgruppen mit selbst erhobenen Daten werden mithilfe von Kundendaten erstellt. Zielgruppen von Drittanbietern werden von Datenanbietern zur Verfügung gestellt und können nur an Kunden lizenziert werden.

JSON-Darstellung
{
  "name": string,
  "firstAndThirdPartyAudienceId": string,
  "displayName": string,
  "description": string,
  "firstAndThirdPartyAudienceType": enum (FirstAndThirdPartyAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string,

  // Union field members can be only one of the following:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field members.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Erstanbieter- und Drittanbieterzielgruppe.

firstAndThirdPartyAudienceId

string (int64 format)

Nur Ausgabe. Die eindeutige ID der Erstanbieter- und Drittanbieterzielgruppe. Vom System zugewiesen.

displayName

string

Der Anzeigename der eigenen und der Drittanbieter-Zielgruppe.

description

string

Die vom Nutzer angegebene Beschreibung der Zielgruppe.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

firstAndThirdPartyAudienceType

enum (FirstAndThirdPartyAudienceType)

Ob es sich um eine Zielgruppe mit selbst erhobenen Daten oder eine Drittanbieterzielgruppe handelt.

audienceType

enum (AudienceType)

Die Art der Zielgruppe.

audienceSource

enum (AudienceSource)

Nur Ausgabe. Die Quelle der Zielgruppe.

membershipDurationDays

string (int64 format)

Die Dauer in Tagen, während der ein Eintrag nach dem auslösenden Ereignis in der Zielgruppe verbleibt. Wenn die Zielgruppe keine Ablaufzeit hat, legen Sie den Wert in diesem Feld auf 10.000 fest. Andernfalls muss der festgelegte Wert größer als 0 und kleiner oder gleich 540 sein.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Dieses Feld ist erforderlich, wenn eine der folgenden audienceType verwendet wird:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

Nur Ausgabe. Die geschätzte Größe der Zielgruppe für das Displaynetzwerk.

Wenn die Größe unter 1.000 liegt, wird die Zahl aus Datenschutzgründen ausgeblendet und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Ziffern gerundet.

Wird nur in einer GET-Anfrage zurückgegeben.

activeDisplayAudienceSize

string (int64 format)

Nur Ausgabe. Die geschätzte Größe der Zielgruppe für das Displaynetzwerk im letzten Monat.

Wenn die Größe kleiner als 1.000 ist, wird die Zahl ausgeblendet und 0 wird aus Datenschutzgründen zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

Wird nur in einer GET-Anfrage zurückgegeben.

youtubeAudienceSize

string (int64 format)

Nur Ausgabe. Die geschätzte Größe der Zielgruppe für das YouTube-Werbenetzwerk.

Wenn die Größe unter 1.000 liegt, wird die Zahl aus Datenschutzgründen ausgeblendet und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Ziffern gerundet.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur in GET-Anfragen zurückgegeben.

gmailAudienceSize

string (int64 format)

Nur Ausgabe. Die geschätzte Größe der Zielgruppe für das Gmail-Werbenetzwerk.

Wenn die Größe unter 1.000 liegt, wird die Zahl aus Datenschutzgründen ausgeblendet und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Ziffern gerundet.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur in GET-Anfragen zurückgegeben.

displayMobileAppAudienceSize

string (int64 format)

Nur Ausgabe. Die geschätzte Größe der Zielgruppe mit mobilen Apps im Displaynetzwerk.

Wenn die Größe kleiner als 1.000 ist, wird die Zahl ausgeblendet und 0 wird aus Datenschutzgründen zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur in GET-Anfragen zurückgegeben.

displayMobileWebAudienceSize

string (int64 format)

Nur Ausgabe. Die geschätzte Größe der Zielgruppe im mobilen Web im Displaynetzwerk.

Wenn die Größe unter 1.000 liegt, wird die Zahl aus Datenschutzgründen ausgeblendet und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur in GET-Anfragen zurückgegeben.

displayDesktopAudienceSize

string (int64 format)

Nur Ausgabe. Die geschätzte Größe der Desktop-Zielgruppe im Displaynetzwerk.

Wenn die Größe unter 1.000 liegt, wird die Zahl aus Datenschutzgründen ausgeblendet und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur in einer GET-Anfrage zurückgegeben.

appId

string

Die appId stimmt mit dem Typ der hochgeladenen mobileDeviceIds überein.

Gilt nur für audienceType CUSTOMER_MATCH_DEVICE_ID

Union-Feld members. Die ersten Mitglieder der Zielgruppe zum Kundenabgleich. Für members ist nur einer der folgenden Werte zulässig:
contactInfoList

object (ContactInfoList)

Nur Eingabe. Eine Liste mit Kontaktdaten zur Definition der anfänglichen Zielgruppenmitglieder.

Gilt nur für audienceType CUSTOMER_MATCH_CONTACT_INFO

mobileDeviceIdList

object (MobileDeviceIdList)

Nur Eingabe. Eine Liste mit Mobilgeräte-IDs, um die ersten Zielgruppenmitglieder zu definieren.

Gilt nur für audienceType CUSTOMER_MATCH_DEVICE_ID

FirstAndThirdPartyAudienceType

Mögliche Typen von Zielgruppenressourcen mit selbst erhobenen Daten und von Drittanbietern.

Enums
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED Standardwert, wenn der Typ nicht angegeben oder unbekannt ist.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY Eine Zielgruppe, die anhand von Kundendaten erstellt wurde.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY Zielgruppe, die von Datenanbietern bereitgestellt wird.

AudienceType

Mögliche Zielgruppentypen.

Enums
AUDIENCE_TYPE_UNSPECIFIED Standardwert, wenn der Typ nicht angegeben oder unbekannt ist.
CUSTOMER_MATCH_CONTACT_INFO Die Zielgruppe wurde generiert, indem Kunden bekannten Kontaktdaten zugeordnet wurden.
CUSTOMER_MATCH_DEVICE_ID Die Zielgruppe wurde durch den Abgleich von Kunden mit bekannten Mobilgeräte-IDs erstellt.
CUSTOMER_MATCH_USER_ID Die Zielgruppe wurde durch den Abgleich von Kunden mit bekannten User-IDs generiert.
ACTIVITY_BASED

Die Zielgruppe wurde basierend auf der Kampagnenaktivität erstellt.

FREQUENCY_CAP

Die Zielgruppe wurde erstellt, weil die Anzahl der Impressionen, die für sie ausgeliefert wurden, ausgeschlossen wurde.

TAG_BASED Die Zielgruppe wurde anhand von benutzerdefinierten Variablen erstellt, die dem Pixel zugeordnet sind.
YOUTUBE_USERS Die Zielgruppe wurde auf der Grundlage früherer Interaktionen mit Videos, YouTube-Anzeigen oder YouTube-Kanälen erstellt.
LICENSED Untertyp des Zielgruppentyps „Drittanbieter“.

AudienceSource

Mögliche Zielgruppenquellen

Enums
AUDIENCE_SOURCE_UNSPECIFIED Standardwert, wenn die Zielgruppenquelle nicht angegeben oder unbekannt ist.
DISPLAY_VIDEO_360 Stammt von Display- und Video 360
CAMPAIGN_MANAGER Sie stammen aus Campaign Manager 360.
AD_MANAGER Sie stammen aus Google Ad Manager.
SEARCH_ADS_360 Aus Search Ads 360 stammend.
YOUTUBE stammen von YouTube.
ADS_DATA_HUB Sie stammen aus Ads Data Hub.

ContactInfoList

Wrapper-Nachricht für eine Liste mit Kontaktdaten, die Mitglieder von Zielgruppen vom Typ „Kundenabgleich“ definieren.

JSON-Darstellung
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
Felder
contactInfos[]

object (ContactInfo)

Eine Liste mit ContactInfo-Objekten, mit denen die Mitglieder der Zielgruppe zum Kundenabgleich definiert werden. Die Größe der Mitglieder nach dem Aufteilen der contactInfos darf 500.000 nicht überschreiten.

consent

object (Consent)

Nur Eingabe. Die Einwilligungseinstellung für die Nutzer in contactInfos.

Wenn dieses Feld nicht konfiguriert ist, ist keine Einwilligung angegeben.

Wenn die Felder adUserData oder adPersonalization auf CONSENT_STATUS_DENIED gesetzt sind, gibt die Anfrage einen Fehler zurück.

ContactInfo

Kontaktdaten, mit denen die Zielgruppe zum Kundenabgleich definiert wird

JSON-Darstellung
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
Felder
hashedEmails[]

string

Eine Liste der SHA256-gehashten E-Mail-Adressen des Mitglieds. Entfernen Sie vor dem Hashing alle Leerzeichen und achten Sie darauf, dass der String nur Kleinbuchstaben enthält.

hashedPhoneNumbers[]

string

Eine Liste mit SHA256-Hash-Telefonnummern des Mitglieds. Vor dem Hashing müssen alle Telefonnummern im E.164-Format formatiert sein und die Ländervorwahl enthalten.

zipCodes[]

string

Eine Liste der Postleitzahlen des Mitglieds.

Muss auch mit den folgenden Feldern festgelegt werden:

hashedFirstName

string

Der mit SHA256 gehashte Vorname des Mitglieds. Entfernen Sie vor dem Hashen alle Leerzeichen und stellen Sie sicher, dass der String ausschließlich aus Kleinbuchstaben besteht.

Muss auch mit den folgenden Feldern festgelegt werden:

hashedLastName

string

SHA256-gehashter Nachname des Mitglieds. Entfernen Sie vor dem Hashen alle Leerzeichen und stellen Sie sicher, dass der String ausschließlich aus Kleinbuchstaben besteht.

Muss auch mit den folgenden Feldern festgelegt werden:

countryCode

string

Ländercode des Mitglieds.

Außerdem müssen die folgenden Felder festgelegt werden:

ConsentStatus

Einwilligungsstatus

Enums
CONSENT_STATUS_UNSPECIFIED Der Typwert ist in dieser Version nicht angegeben oder unbekannt.
CONSENT_STATUS_GRANTED Einwilligung erteilt.
CONSENT_STATUS_DENIED Das Einverständnis wurde verweigert.

MobileDeviceIdList

Wrapper-Nachricht für eine Liste von Mobilgeräte-IDs, die Mitglieder der Zielgruppe für den Kundenabgleich definieren.

JSON-Darstellung
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
Felder
mobileDeviceIds[]

string

Eine Liste von Mobilgeräte-IDs, die Mitglieder der Zielgruppe zum Kundenabgleich definieren. Die Größe von „mobileDeviceIds“ darf 500.000 nicht überschreiten.

consent

object (Consent)

Nur Eingabe. Die Einwilligungseinstellung für die Nutzer in mobileDeviceIds.

Wenn dieses Feld nicht konfiguriert ist, ist keine Einwilligung angegeben.

Wenn das Feld adUserData oder adPersonalization auf CONSENT_STATUS_DENIED gesetzt ist, gibt die Anfrage einen Fehler zurück.

Methoden

create

Erstellt ein FirstAndThirdPartyAudience.

editCustomerMatchMembers

Aktualisiert die Mitgliederliste einer Zielgruppe mit Kundenabgleich.

get

Ruft eine eigene und Drittanbieter-Zielgruppe ab.

list

Hier werden Zielgruppen mit selbst erhobenen Daten und Drittanbieter-Zielgruppen aufgeführt.

patch

Aktualisiert eine vorhandene FirstAndThirdPartyAudience.