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 dla klientów.

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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of mutually exclusive fields.
}
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: Opis odbiorców podany przez użytkownika.

Dotyczy tylko własnych list odbiorców.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

Tylko dane wyjściowe. Określa, czy lista odbiorców jest własną listą odbiorców czy listą odbiorców partnera.
audienceType

enum (AudienceType)

Niezmienne. Typ odbiorców.
audienceSource

enum (AudienceSource)

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

string (int64 format)

Opcjonalnie: Okres w dniach, przez który wpis pozostaje na liście odbiorców po wystąpieniu kwalifikującego się zdarzenia. Ustawiona wartość musi być większa od 0 i nie większa niż 540.

Dotyczy tylko własnych list odbiorców.

To pole jest wymagane, jeśli używasz jednego z tych 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, a ze względu na ochronę prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Zwracany tylko w przypadku żądania 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, a ze względu na ochronę prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Zwracany tylko w przypadku żądania 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, a ze względu na ochronę prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracany tylko w przypadku żądania 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, a ze względu na ochronę prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracany tylko w przypadku żądania 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, a ze względu na ochronę prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracany tylko w przypadku żądania 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, a ze względu na ochronę prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracany tylko w przypadku żądania GET.
displayDesktopAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacunkowa 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 zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy tylko własnych list odbiorców.

Zwracany tylko w przypadku żądania GET.
appId

string

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

Dotyczy tylko audienceType CUSTOMER_MATCH_DEVICE_ID
Początkowi użytkownicy listy odbiorców kierowania na listę klientów. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
contactInfoList

object (ContactInfoList)

Tylko dane wejściowe. Lista informacji kontaktowych, która określa początkowych członków grupy odbiorców.

Dotyczy tylko audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Tylko dane wejściowe. Lista identyfikatorów urządzeń mobilnych, która określa początkowych członków listy odbiorców.

Dotyczy tylko audienceType CUSTOMER_MATCH_DEVICE_ID
Koniec pól wykluczających się nawzajem.

ContactInfoList

Wiadomość opakowująca listę informacji kontaktowych określających użytkowników na liście odbiorców z kierowania na listę klientów.

Zapis JSON 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
Pola
contactInfos[]

object (ContactInfo)

Opcjonalnie: Lista obiektów ContactInfo określających odbiorców kierowania na listę klientów. Rozmiar elementów po podzieleniu contactInfos nie może być większy niż 500 tys.
consent

object (Consent)

Tylko dane wejściowe. Ustawienie zgody użytkowników w contactInfos.

Pozostawienie tego pola bez ustawienia oznacza, że zgoda nie została określona.

Jeśli pola adUserData lub adPersonalization mają wartość CONSENT_STATUS_DENIED, żądanie zwróci błąd.

ContactInfo

Dane kontaktowe określające członka listy odbiorców kierowania na listę klientów.

Zapis JSON 
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
Pola
hashedEmails[]

string

Opcjonalnie: Lista adresów e-mail użytkownika zaszyfrowanych algorytmem SHA256. Przed haszowaniem usuń wszystkie białe znaki i upewnij się, że ciąg znaków zawiera tylko małe litery.
hashedPhoneNumbers[]

string

Opcjonalnie: Lista numerów telefonów członka zaszyfrowanych za pomocą algorytmu SHA256. Przed zaszyfrowaniem wszystkie numery telefonów muszą być sformatowane w formacie E.164 i zawierać kod kraju.
zipCodes[]

string

Opcjonalnie: Lista kodów pocztowych członka.

Musi być też ustawiony w tych polach:
hashedFirstName

string

Opcjonalnie: Zahaszowane z użyciem SHA256 imię członka. Przed haszowaniem usuń wszystkie białe znaki i upewnij się, że ciąg znaków zawiera tylko małe litery.

Musi być też ustawiony w tych polach:
hashedLastName

string

Opcjonalnie: Zahaszowane za pomocą SHA256 nazwisko uczestnika. Przed haszowaniem usuń wszystkie białe znaki i upewnij się, że ciąg znaków zawiera tylko małe litery.

Musi być też ustawiony w tych polach:
countryCode

string

Opcjonalnie: Kod kraju członka.

Musi być też ustawiony w tych polach:

ConsentStatus

Stan zgody.

Wartości w polu enum
CONSENT_STATUS_UNSPECIFIED Wartość typu nie jest określona lub jest nieznana w tej wersji.
CONSENT_STATUS_GRANTED Zgoda została udzielona.
CONSENT_STATUS_DENIED Odmowa zgody.

MobileDeviceIdList

Wiadomość opakowująca listę identyfikatorów urządzeń mobilnych określających członków listy odbiorców z kierowania na listę klientów.

Zapis JSON 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
Pola
mobileDeviceIds[]

string

Opcjonalnie: Lista identyfikatorów urządzeń mobilnych określająca członków listy odbiorców z kierowania na listę klientów. Rozmiar listy mobileDeviceIds nie może przekraczać 500 tys.
consent

object (Consent)

Tylko dane wejściowe. Ustawienie zgody użytkowników w mobileDeviceIds.

Pozostawienie tego pola bez ustawienia oznacza, że zgoda nie została określona.

Jeśli pola adUserData lub adPersonalization mają wartość CONSENT_STATUS_DENIED, żądanie zwróci błąd.

FirstPartyAndPartnerAudienceType

Możliwe typy zasobu własnej listy odbiorców i listy 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 Lista 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 Odbiorcy zostali wygenerowani 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 na podstawie dopasowania klientów do znanych identyfikatorów użytkowników.
ACTIVITY_BASED

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

Wycofano: grupa 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 Odbiorcy zostali utworzeni na podstawie wcześniejszych interakcji z filmami, reklamami w YouTube lub kanałem w YouTube.
THIRD_PARTY Lista odbiorców została licencjonowana do użytku przez osobę trzecią.
COMMERCE Lista odbiorców udostępniana przez partnerów handlowych za opłatą.
LINEAR Odbiorcy treści w telewizji linearnej.
AGENCY Lista odbiorców dostarczona 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 usługi Campaign Manager 360.
AD_MANAGER Pochodzi z usługi Google Ad Manager.
SEARCH_ADS_360 Pochodzą z Search Ads 360.
YOUTUBE Pochodzi z YouTube.
ADS_DATA_HUB Pochodzą z Centrum danych reklam.

Metody

create

 Tworzy obiekt FirstPartyAndPartnerAudience.

editCustomerMatchMembers

 Aktualizuje listę użytkowników na liście odbiorców z kierowania na listę klientów.

get

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

list

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

patch

 Aktualizuje istniejącą listę FirstPartyAndPartnerAudience.