REST Resource: firstPartyAndPartnerAudiences

Zasób: FirstPartyAndPartnerAudience

Opisuje listę odbiorców własnych lub partnerskich, która jest używana do kierowania reklam. Listy odbiorców własnych są tworzone na podstawie danych klienta. 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,

  // 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.
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu własnego 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

Tylko dane wyjściowe. Wyświetlana nazwa własnej listy odbiorców i listy odbiorców partnera.
description

string

Tylko dane wyjściowe. Podany przez użytkownika opis listy odbiorców.

Dotyczy to tylko własnych list odbiorców.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

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

enum (AudienceType)

Tylko dane wyjściowe. Typ listy odbiorców.
audienceSource

enum (AudienceSource)

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

string (int64 format)

Tylko dane wyjściowe. Liczba dni, przez którą wpis pozostaje na liście odbiorców po spełnieniu kryterium. Jeśli lista odbiorców nie ma daty wygaśnięcia, ustaw wartość tego pola na 10000. W przeciwnym razie ustawiona wartość musi być większa od 0, ale nie większa niż 540.

Dotyczy to tylko własnych list odbiorców.

To pole jest wymagane, jeśli używana jest jedna z tych wartości 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 z powodu ochrony prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Zwracany tylko w żądaniu GET.
activeDisplayAudienceSize

string (int64 format)

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

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta, a z powodu ochrony prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Zwracany tylko w żądaniu GET.
youtubeAudienceSize

string (int64 format)

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

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta, a z powodu ochrony prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy to tylko własnych list odbiorców.

Zwracany 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, a z powodu ochrony prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy to tylko własnych list odbiorców.

Zwracany tylko w żądaniu GET.
displayMobileAppAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacowana wielkość grupy odbiorców aplikacji mobilnej w sieci reklamowej.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta, a z powodu ochrony prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy to tylko własnych list odbiorców.

Zwracany 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, a z powodu ochrony prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy to tylko własnych list odbiorców.

Zwracany tylko w żądaniu 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 z powodu ochrony prywatności zwrócona zostanie wartość 0. W przeciwnym razie liczba zostanie zaokrąglona do 2 cyfr znaczących.

Dotyczy to tylko własnych list odbiorców.

Zwracany tylko w żądaniu GET.
appId

string

Opcjonalnie: Identyfikator aplikacji musi być zgodny z typem przesyłanych identyfikatorów urządzeń mobilnych.

Dotyczy tylko audienceType CUSTOMER_MATCH_DEVICE_ID
Pole unii members. Pierwsi członkowie listy odbiorców kierowania na listę klientów. members może być tylko jednym z tych elementów:
contactInfoList

object (ContactInfoList)

Tylko dane wejściowe. Lista informacji kontaktowych, która służy do definiowania początkowych członków listy odbiorców.

Dotyczy tylko audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Tylko dane wejściowe. Lista identyfikatorów urządzeń mobilnych, która służy do definiowania początkowych członków listy odbiorców.

Dotyczy tylko audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Możliwe typy własnych i partnerskich zasobów list odbiorców

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 udostępniani 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 utworzona przez dopasowanie klientów do znanych informacji kontaktowych.
CUSTOMER_MATCH_DEVICE_ID Lista odbiorców została utworzona przez dopasowanie klientów do znanych identyfikatorów urządzeń mobilnych.
CUSTOMER_MATCH_USER_ID Lista odbiorców została utworzona przez dopasowanie klientów do znanych identyfikatorów użytkowników.
ACTIVITY_BASED

Lista odbiorców została utworzona na podstawie aktywności w kampanii.
FREQUENCY_CAP

Lista odbiorców została utworzona na podstawie wykluczenia liczby wyświetleń, które zobaczyli.
TAG_BASED Lista odbiorców została utworzona na podstawie zmiennych niestandardowych przypisanych do piksela.
YOUTUBE_USERS Lista odbiorców została utworzona na podstawie wcześniejszych interakcji z filmami, reklamami w YouTube lub kanałem w YouTube.
THIRD_PARTY Lista odbiorców została objęta licencją przez osobę trzecią.
COMMERCE Listy odbiorców udostępniane przez partnerów handlowych za opłatą.
LINEAR Odbiorcy treści linearnych w telewizji.

AudienceSource

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

Wartości w polu enum
AUDIENCE_SOURCE_UNSPECIFIED Wartość domyślna, gdy źródło listy odbiorców 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.

ContactInfoList

Komunikat opakowujący listę informacji kontaktowych definiujących członków listy odbiorców kierowania na listę klientów.

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

object (ContactInfo)

Lista obiektów ContactInfo, które definiują członków listy odbiorców z kierowania na listę klientów. Liczba elementów members po podzieleniu informacji kontaktowych nie może być większa niż 500 tys.
consent

object (Consent)

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

Pozostawienie tego pola pustego oznacza, że nie wyrażono zgody.

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

ContactInfo

Dane kontaktowe określające odbiorcę 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

Lista adresów e-mail członka zaszyfrowanych za pomocą algorytmu SHA256. Przed zaszyfrowaniem usuń wszystkie spacje i upewnij się, że ciąg znaków jest zapisany wyłącznie małymi literami.
hashedPhoneNumbers[]

string

Lista numerów telefonów członka zaszyfrowanych za pomocą algorytmu SHA256. Przed zaszyfrowaniem wszystkie numery telefonów muszą być sformatowane zgodnie z formatem E.164 i mieć kod kraju.
zipCodes[]

string

Lista kodów pocztowych członka.

Musisz też ustawić te pola:
hashedFirstName

string

Imię użytkownika zaszyfrowane za pomocą algorytmu SHA-256. Przed zaszyfrowaniem usuń wszystkie spacje i upewnij się, że ciąg znaków jest zapisany wyłącznie małymi literami.

Musisz też ustawić te pola:
hashedLastName

string

Hasz SHA256 nazwiska użytkownika. Przed zaszyfrowaniem usuń wszystkie spacje i upewnij się, że ciąg znaków jest zapisany wyłącznie małymi literami.

Musisz też ustawić te pola:
countryCode

string

Kod kraju użytkownika.

Musisz też ustawić te pola:

ConsentStatus

Stan zgody.

Wartości w polu enum
CONSENT_STATUS_UNSPECIFIED Wartość typu nie została 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, która określa członków listy odbiorców kierowania na listę klientów.

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

string

Lista identyfikatorów urządzeń mobilnych definiujących członków listy odbiorców kierowania na listę klientów. Rozmiar identyfikatorów mobileDeviceId nie może przekraczać 500 tys.
consent

object (Consent)

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

Pozostawienie tego pola pustego oznacza, że nie wyrażono zgody.

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

Metody

create

 Tworzy listę odbiorców FirstPartyAndPartnerAudience.

editCustomerMatchMembers

 Aktualizuje listę użytkowników odbiorców kierowania na listę klientów.

get

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

list

 Wyświetla własne listy odbiorców i listy odbiorców partnera.

patch

 Aktualizuje dotychczasowy zbiór odbiorców FirstPartyAndPartnerAudience.