REST Resource: firstPartyAndPartnerAudiences

Ressource: FirstPartyAndPartnerAudience

Beschreibt eine eigene oder Partner-Zielgruppenliste, die für das Targeting verwendet wird. Eigene Zielgruppen werden durch die Verwendung von Kundendaten erstellt. Partnerzielgruppen werden von Drittanbietern von Daten bereitgestellt und können nur an Kunden lizenziert werden.

JSON-Darstellung 
{
  "name": string,
  "firstPartyAndPartnerAudienceId": string,
  "displayName": string,
  "description": string,
  "firstPartyAndPartnerAudienceType": enum (FirstPartyAndPartnerAudienceType),
  "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 Zielgruppe mit selbst erhobenen Daten und der Partner-Zielgruppe.
firstPartyAndPartnerAudienceId

string (int64 format)

ID. Die eindeutige ID der Zielgruppe mit selbst erhobenen Daten und der Partner-Zielgruppe. Vom System zugewiesen.
displayName

string

Optional. Der Anzeigename der Zielgruppe mit selbst erhobenen Daten und der Partner-Zielgruppe.
description

string

Optional. Die vom Nutzer angegebene Beschreibung der Zielgruppe.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

Nur Ausgabe. Gibt an, ob es sich bei der Zielgruppe um eine Zielgruppe mit selbst erhobenen Daten oder eine Partner-Zielgruppe handelt.
audienceType

enum (AudienceType)

Nicht veränderbar. Der Typ der Zielgruppe.
audienceSource

enum (AudienceSource)

Nur Ausgabe. Die Quelle der Zielgruppe.
membershipDurationDays

string (int64 format)

Optional. Die Anzahl der Tage, die ein Eintrag nach dem entsprechenden Ereignis in der Zielgruppe verbleibt. Der festgelegte Wert muss 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 kleiner als 1.000 ist, wird die Zahl aus Datenschutzgründen verborgen und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

Wird nur bei GET-Anfragen 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 aus Datenschutzgründen verborgen und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

Wird nur bei GET-Anfragen zurückgegeben.
youtubeAudienceSize

string (int64 format)

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

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

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur bei 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 kleiner als 1.000 ist, wird die Zahl aus Datenschutzgründen verborgen und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur bei GET-Anfragen zurückgegeben.
displayMobileAppAudienceSize

string (int64 format)

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

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

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur bei GET-Anfragen zurückgegeben.
displayMobileWebAudienceSize

string (int64 format)

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

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

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur bei GET-Anfragen zurückgegeben.
displayDesktopAudienceSize

string (int64 format)

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

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

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

Wird nur bei GET-Anfragen zurückgegeben.
appId

string

Optional. Die App-ID stimmt mit dem Typ der hochgeladenen „mobileDeviceIds“ überein.

Gilt nur für audienceType CUSTOMER_MATCH_DEVICE_ID
Union-Feld members. Die ursprünglichen 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, um die ersten Zielgruppenmitglieder zu definieren.

Gilt nur für audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Nur Eingabe. Eine Liste mit IDs für Mobilgeräte, mit denen die ersten Zielgruppenmitglieder definiert werden.

Gilt nur für audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Mögliche Typen einer Ressource für Zielgruppen mit selbst erhobenen Daten und Partner-Zielgruppen.

Enums
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Standardwert, wenn der Typ nicht angegeben oder unbekannt ist.
TYPE_FIRST_PARTY Zielgruppe, die durch die Verwendung von Kundendaten erstellt wird.
TYPE_PARTNER Zielgruppe, die von Datendrittanbietern 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 durch Abgleich von Kunden mit bekannten Kontaktdaten generiert.
CUSTOMER_MATCH_DEVICE_ID Die Zielgruppe wurde durch den Abgleich von Kunden mit bekannten Mobilgeräte-IDs generiert.
CUSTOMER_MATCH_USER_ID Die Zielgruppe wurde durch Abgleich von Kunden mit bekannten Nutzer-IDs generiert.
ACTIVITY_BASED

Eingestellt: Die Zielgruppe wurde auf Grundlage von Kampagnenaktivitäten erstellt.
FREQUENCY_CAP

Eingestellt: Die Zielgruppe wurde durch Ausschluss von Nutzern erstellt, für die bereits eine bestimmte Menge an Impressionen ausgeliefert wurde.
TAG_BASED Die Zielgruppe wurde auf Grundlage benutzerdefinierter Variablen erstellt, die dem Pixel zugeordnet sind.
YOUTUBE_USERS Die Zielgruppe wurde auf Grundlage früherer Interaktionen mit Videos, YouTube-Anzeigen oder dem YouTube-Kanal erstellt.
THIRD_PARTY Die Zielgruppe wurde von einem Dritten lizenziert.
COMMERCE Zielgruppe, die von Handelspartnern gegen Gebühr bereitgestellt wird.
LINEAR Zielgruppe für lineares Fernsehen.
AGENCY Von einer Agentur bereitgestellte Zielgruppe.

AudienceSource

Mögliche Zielgruppenquellen.

Enums
AUDIENCE_SOURCE_UNSPECIFIED Standardwert, wenn die Zielgruppenquelle nicht angegeben oder unbekannt ist.
DISPLAY_VIDEO_360 Der Traffic stammt aus Display & Video 360.
CAMPAIGN_MANAGER Sie stammen aus Campaign Manager 360.
AD_MANAGER Sie stammen aus Google Ad Manager.
SEARCH_ADS_360 Sie stammen aus Search Ads 360.
YOUTUBE Sie stammen von YouTube.
ADS_DATA_HUB Sie stammen aus Ads Data Hub.

ContactInfoList

Wrapper-Nachricht für eine Liste mit Kontaktdaten, die Zielgruppenmitglieder für den Kundenabgleich definiert.

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

object (ContactInfo)

Optional. Eine Liste von ContactInfo-Objekten, die Zielgruppenmitglieder für den Kundenabgleich definieren. Die Größe der Mitglieder nach dem Aufteilen der contactInfos darf nicht größer als 500.000 sein.
consent

object (Consent)

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

Wenn dieses Feld nicht festgelegt ist, bedeutet das, dass keine Einwilligung angegeben ist.

Wenn die Felder adUserData oder adPersonalization auf CONSENT_STATUS_DENIED gesetzt sind, wird bei der Anfrage ein Fehler zurückgegeben.

ContactInfo

Kontaktdaten, die ein Mitglied einer Zielgruppe zum Kundenabgleich definieren.

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

string

Optional. Eine Liste mit 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

Optional. Eine Liste der SHA256-gehashten Telefonnummern des Mitglieds. Vor dem Hashen müssen alle Telefonnummern im E.164-Format formatiert werden und die Ländervorwahl enthalten.
zipCodes[]

string

Optional. Eine Liste der Postleitzahlen des Mitglieds.

Muss auch mit den folgenden Feldern festgelegt werden:
hashedFirstName

string

Optional. SHA256-gehashter Vorname des Mitglieds. Entfernen Sie vor dem Hashing alle Leerzeichen und achten Sie darauf, dass der String nur Kleinbuchstaben enthält.

Muss auch mit den folgenden Feldern festgelegt werden:
hashedLastName

string

Optional. SHA256-gehashter Nachname des Mitglieds. Entfernen Sie vor dem Hashing alle Leerzeichen und achten Sie darauf, dass der String nur Kleinbuchstaben enthält.

Muss auch mit den folgenden Feldern festgelegt werden:
countryCode

string

Optional. Ländercode des Mitglieds.

Muss auch mit den folgenden Feldern festgelegt werden:

ConsentStatus

Einwilligungsstatus

Enums
CONSENT_STATUS_UNSPECIFIED Der Typwert ist in dieser Version nicht angegeben oder unbekannt.
CONSENT_STATUS_GRANTED Die Einwilligung wird erteilt.
CONSENT_STATUS_DENIED Die Einwilligung wird verweigert.

MobileDeviceIdList

Wrapper-Nachricht für eine Liste von Mobilgeräte-IDs, die Mitglieder von Zielgruppen zum Kundenabgleich definieren.

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

string

Optional. Eine Liste von Mobilgeräte-IDs, die Mitglieder der Zielgruppe zum Kundenabgleich definieren. Die Größe von „mobileDeviceIds“ darf nicht größer als 500.000 sein.
consent

object (Consent)

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

Wenn dieses Feld nicht festgelegt ist, bedeutet das, dass keine Einwilligung angegeben ist.

Wenn die Felder adUserData oder adPersonalization auf CONSENT_STATUS_DENIED gesetzt sind, wird bei der Anfrage ein Fehler zurückgegeben.

Methoden

create

 Erstellt eine FirstPartyAndPartnerAudience.

editCustomerMatchMembers

 Aktualisiert die Mitgliederliste einer Zielgruppe zum Kundenabgleich.

get

 Er erhält eine Zielgruppe mit selbst erhobenen Daten oder eine Partner-Zielgruppe.

list

 Hier werden eigene und Partner-Zielgruppen aufgeführt.

patch

 Aktualisiert eine vorhandene FirstPartyAndPartnerAudience.