REST Resource: firstPartyAndPartnerAudiences

Zasób: FirstPartyAndPartnerAudience

Opisuje własną listę odbiorców lub listę odbiorców partnera używaną do kierowania. Własne listy odbiorców są tworzone na podstawie danych klientów. Listy odbiorców partnerów są dostarczane przez zewnętrznych dostawców danych i mogą być licencjonowane tylko klientom.

Zapis JSON
{
  "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
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu własnej listy odbiorców i listy odbiorców partnera.

firstPartyAndPartnerAudienceId

string (int64 format)

Identyfikator. Unikalny identyfikator własnej listy odbiorców i listy odbiorców partnera. Przypisany przez system.

displayName

string

Opcjonalnie: Wyświetlana nazwa własnej listy odbiorców i listy odbiorców partnera.

description

string

Opcjonalnie: Podany przez użytkownika opis listy odbiorców.

Dotyczy tylko własnych list odbiorców.

firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

Tylko dane wyjściowe. Czy lista odbiorców jest własną listą odbiorców i listą odbiorców partnera.

audienceType

enum (AudienceType)

Wartość niezmienna. Typ odbiorców.

audienceSource

enum (AudienceSource)

Tylko dane wyjściowe. Źródło odbiorców.

membershipDurationDays

string (int64 format)

Opcjonalnie: Liczba dni, przez które wpis pozostaje na liście odbiorców po zdarzeniu kwalifikującym. Ustawiona wartość musi być większa niż 0 i mniejsza niż 540 lub równa 540.

Dotyczy tylko własnych list odbiorców.

To pole jest wymagane, jeśli używany jest jeden z tych parametrów audienceType:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacunkowa wielkość grupy odbiorców w sieci reklamowej.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i ze względu na ochronę prywatności zostanie zwrócona wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Zwracane tylko w żądaniu GET.

activeDisplayAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacunkowa wielkość grupy odbiorców w sieci reklamowej w ostatnim miesiącu.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i ze względu na ochronę prywatności zostanie zwrócona wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Zwracane tylko w żądaniu GET.

youtubeAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacunkowa wielkość grupy odbiorców w sieci YouTube.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i ze względu na ochronę prywatności zostanie zwrócona wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracane tylko w żądaniu GET.

gmailAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacunkowa wielkość grupy odbiorców w sieci Gmail.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i ze względu na ochronę prywatności zostanie zwrócona wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracane tylko w żądaniu GET.

displayMobileAppAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacunkowa wielkość grupy odbiorców aplikacji mobilnych w sieci reklamowej.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i ze względu na ochronę prywatności zostanie zwrócona wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracane tylko w żądaniu GET.

displayMobileWebAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacunkowa wielkość grupy odbiorców w internecie mobilnym w sieci reklamowej.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i ze względu na ochronę prywatności zostanie zwrócona wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracane tylko w żądaniu GET.

displayDesktopAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacowana wielkość grupy odbiorców na komputerach w sieci reklamowej.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta, a ze względu na ochronę prywatności zostanie zwrócona wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracane tylko w żądaniu GET.

appId

string

Opcjonalnie: Parametr appId odpowiada typowi przesyłanych identyfikatorów mobileDeviceIds.

Dotyczy tylko: audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Możliwe typy zasobu własnych list odbiorców i list odbiorców partnera.

Wartości w polu enum
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Wartość domyślna, gdy typ nie jest określony lub jest nieznany.
TYPE_FIRST_PARTY Grupa odbiorców utworzona na podstawie danych klienta.
TYPE_PARTNER Odbiorcy dostarczani przez zewnętrznych dostawców danych.

AudienceType

Możliwe typy odbiorców.

Wartości w polu enum
AUDIENCE_TYPE_UNSPECIFIED Wartość domyślna, gdy typ nie jest określony lub jest nieznany.
CUSTOMER_MATCH_CONTACT_INFO Lista odbiorców została wygenerowana przez dopasowanie klientów do znanych informacji kontaktowych.
CUSTOMER_MATCH_DEVICE_ID Lista odbiorców została wygenerowana przez dopasowanie klientów do znanych identyfikatorów urządzeń mobilnych.
CUSTOMER_MATCH_USER_ID Lista odbiorców została wygenerowana przez dopasowanie klientów do znanych identyfikatorów użytkowników.
ACTIVITY_BASED

Wycofane: lista odbiorców została utworzona na podstawie aktywności w kampanii.

FREQUENCY_CAP

Wycofane: lista odbiorców została utworzona na podstawie wykluczenia liczby wyświetleń, które zostały zrealizowane w ich przypadku.

TAG_BASED Lista odbiorców została utworzona na podstawie zmiennych niestandardowych dołączonych do piksela.
YOUTUBE_USERS Lista odbiorców została utworzona na podstawie wcześniejszych interakcji z filmami, reklamami na YouTube lub kanałem na YouTube.
THIRD_PARTY Lista odbiorców została licencjonowana do użytku przez inną firmę.
COMMERCE Listy odbiorców udostępniane przez partnerów handlowych za opłatą.
LINEAR Odbiorcy treści w telewizji linearnej.
AGENCY Odbiorcy dostarczani przez agencję.

AudienceSource

Możliwe źródła danych o odbiorcach.

Wartości w polu enum
AUDIENCE_SOURCE_UNSPECIFIED Wartość domyślna, gdy źródło danych o odbiorcach nie jest określone lub jest nieznane.
DISPLAY_VIDEO_360 pochodzi z Display & Video 360,
CAMPAIGN_MANAGER pochodzi z Campaign Managera 360,
AD_MANAGER Pochodzi z Google Ad Managera.
SEARCH_ADS_360 pochodzić z Search Ads 360,
YOUTUBE pochodzi z YouTube,
ADS_DATA_HUB pochodzi z Centrum danych reklam,

Metody

get

Pobiera własną listę odbiorców lub listę odbiorców partnera.

list

Zawiera własne listy odbiorców i listy odbiorców partnera.