REST Resource: firstAndThirdPartyAudiences

Ressource: FirstAndThirdPartyAudience

Beschreibt eine Erst- oder Drittanbieter-Zielgruppenliste, die für das Targeting verwendet wird. Zielgruppen mit selbst erhobenen Daten werden anhand von Kundendaten erstellt. Drittanbieter-Zielgruppen werden von Datendrittanbietern 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 Erst- und Drittanbieter-Zielgruppe.

firstAndThirdPartyAudienceId

string (int64 format)

Nur Ausgabe Eindeutige ID der Erst- und Drittanbieter-Zielgruppe. Vom System zugewiesen.

displayName

string

Der Anzeigename der Erst- und Drittanbieter-Zielgruppe.

description

string

Die vom Nutzer angegebene Beschreibung der Zielgruppe.

Gilt nur für Zielgruppen mit selbst erhobenen Daten.

firstAndThirdPartyAudienceType

enum (FirstAndThirdPartyAudienceType)

Ob die Zielgruppe eine Erst- oder Drittanbieter-Zielgruppe ist.

audienceType

enum (AudienceType)

Die Art der Zielgruppe.

audienceSource

enum (AudienceSource)

Nur Ausgabe Die Quelle der Zielgruppe.

membershipDurationDays

string (int64 format)

Die Dauer in Tagen, die ein Beitrag nach dem entsprechenden Ereignis in der Zielgruppe verbleibt. Wenn die Zielgruppe kein Ablaufdatum 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 kleiner als 1.000 ist, wird die Zahl aus Datenschutzgründen ausgeblendet und 0 zurückgegeben. Andernfalls wird die Zahl auf zwei signifikante Stellen gerundet.

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

Wird nur in 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 kleiner als 1.000 ist, 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-Anfrage zurückgegeben.

gmailAudienceSize

string (int64 format)

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

Wenn die Größe kleiner als 1.000 ist, 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-Anfrage 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 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-Anfrage zurückgegeben.

displayMobileWebAudienceSize

string (int64 format)

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

Wenn die Größe kleiner als 1.000 ist, 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-Anfrage zurückgegeben.

displayDesktopAudienceSize

string (int64 format)

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

Wenn die Größe kleiner als 1.000 ist, 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-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 zur Definition der anfänglichen Zielgruppenmitglieder.

Gilt nur für audienceType CUSTOMER_MATCH_DEVICE_ID

FirstAndThirdPartyAudienceType

Mögliche Typen von Erst- und Drittanbieter-Zielgruppenressourcen.

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 Zielgruppe, die anhand von Kundendaten erstellt wird.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY 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 erstellt, indem Kunden bekannten Kontaktdaten zugeordnet wurden.
CUSTOMER_MATCH_DEVICE_ID Die Zielgruppe wurde generiert, indem Kunden bekannten Mobilgeräte-IDs zugeordnet wurden.
CUSTOMER_MATCH_USER_ID Die Zielgruppe wurde erstellt, indem Kunden bekannten User-IDs zugeordnet wurden.
ACTIVITY_BASED

Die Zielgruppe wurde basierend auf der kampagnenbezogenen Aktivität erstellt.

FREQUENCY_CAP

Die Zielgruppe wurde anhand der Anzahl der erzielten Impressionen erstellt.

TAG_BASED Die Zielgruppe wurde anhand von benutzerdefinierten Variablen erstellt, die an das Pixel angehängt sind.
YOUTUBE_USERS Die Zielgruppe wurde basierend auf früheren Interaktionen mit Videos, YouTube-Anzeigen oder YouTube-Kanälen erstellt.
LICENSED Untertyp des Drittanbieter-Zielgruppentyps.

AudienceSource

Mögliche Zielgruppenquellen.

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

ContactInfoList

Wrapper-Nachricht für eine Liste von Kontaktdaten, mit denen Zielgruppenmitglieder zum Kundenabgleich definiert werden

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

object (ContactInfo)

Eine Liste von ContactInfo-Objekten, in denen Zielgruppenmitglieder zum Kundenabgleich definiert sind. Die Mitgliedergröße 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, bedeutet dies, dass keine Einwilligung angegeben wurde.

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

ContactInfo

Kontaktdaten, mit denen ein Zielgruppenmitglied zum Kundenabgleich definiert wird.

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

string

Eine Liste mit SHA256-Hash-E-Mail-Adressen des Mitglieds. Entfernen Sie vor dem Hashen sämtliche Leerzeichen und achten Sie darauf, dass der String nur aus Kleinbuchstaben besteht.

hashedPhoneNumbers[]

string

Eine Liste mit SHA256-verschlüsselten Telefonnummern des Mitglieds. Vor dem Hashen müssen alle Telefonnummern im E.164-Format formatiert werden und die Landesvorwahl enthalten.

zipCodes[]

string

Eine Liste mit Postleitzahlen des Mitglieds.

Muss auch mit den folgenden Feldern festgelegt werden:

hashedFirstName

string

SHA256-verschlüsselter Vorname des Mitglieds. Entfernen Sie vor dem Hashen sämtliche Leerzeichen und achten Sie darauf, dass der String nur aus Kleinbuchstaben besteht.

Muss auch mit den folgenden Feldern festgelegt werden:

hashedLastName

string

Mit SHA256 gehashter Nachname des Mitglieds. Entfernen Sie vor dem Hashen sämtliche Leerzeichen und achten Sie darauf, dass der String nur aus Kleinbuchstaben besteht.

Muss auch mit den folgenden Feldern festgelegt werden:

countryCode

string

Ländercode des Mitglieds

Muss auch mit den folgenden Feldern festgelegt werden:

ConsentStatus

Einwilligungsstatus

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

MobileDeviceIdList

Wrapper-Nachricht für eine Liste von Mobilgeräte-IDs, mit denen Zielgruppen zum Kundenabgleich definiert werden.

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

string

Eine Liste der Mobilgeräte-IDs, mit denen Zielgruppen zum Kundenabgleich definiert werden. Die 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 konfiguriert ist, bedeutet dies, dass keine Einwilligung angegeben wurde.

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

Methoden

create

Erstellt eine FirstAndThirdPartyAudience.

editCustomerMatchMembers

Aktualisiert die Mitgliederliste einer Zielgruppe zum Kundenabgleich.

get

Ruft eine Erst- und eine Drittanbieter-Zielgruppe ab.

list

Enthält eigene und Drittanbieter-Zielgruppen.

patch

Aktualisiert eine vorhandene FirstAndThirdPartyAudience.