REST Resource: firstAndThirdPartyAudiences

Zasób: FirstAndThirdPartyAudience

Opisuje listę odbiorców (własną lub innej firmy) używaną do kierowania. Własne listy odbiorców są tworzone na podstawie danych klientów. Listy odbiorców pochodzące od innych firm są dostarczane przez zewnętrznych dostawców danych i można na nie licencjonowane korzystać tylko dla klientów.

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

string

Tylko dane wyjściowe. Nazwa zasobu dla własnej listy odbiorców i listy odbiorców dostarczonej przez inną firmę.
firstAndThirdPartyAudienceId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator własnej listy odbiorców i listy odbiorców dostarczonej przez firmę zewnętrzną. Przypisana przez system.
displayName

string

Wyświetlana nazwa własnej listy odbiorców i listy odbiorców dostarczonej przez inną firmę.
description

string

Podany przez użytkownika opis listy odbiorców.

Dotyczy tylko własnych list odbiorców.
firstAndThirdPartyAudienceType

enum (FirstAndThirdPartyAudienceType)

tego, czy jest to własna lista odbiorców czy lista odbiorców dostarczona przez inną firmę;
audienceType

enum (AudienceType)

Typ odbiorców.
audienceSource

enum (AudienceSource)

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

string (int64 format)

Czas (w dniach), przez jaki film pozostaje na liście odbiorców po zakończeniu kwalifikującego się wydarzenia. Jeśli lista odbiorców nie ma daty ważności, ustaw w tym polu wartość 10 000. W przeciwnym razie ustawiona wartość musi być większa niż 0 i mniejsza lub równa 540.

Dotyczy tylko własnych list odbiorców.

To pole jest wymagane, jeśli używana jest jedna z tych właściwości audienceType:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

Tylko dane wyjściowe. Szacowana 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 zwrócona zostanie 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. Szacowana 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 zwrócona zostanie 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. Szacowana 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 zwrócona zostanie 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. Szacowana 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 zwrócona zostanie 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 mobilnej w sieci reklamowej.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i 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.

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 zwrócona zostanie 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. Szacunkowa wielkość grupy odbiorców na komputerach w sieci reklamowej.

Jeśli rozmiar jest mniejszy niż 1000, liczba zostanie ukryta i 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.

Zwracane tylko w żądaniu GET.
appId

string

Wartość appId pasuje do typu przesyłanych identyfikatorów mobileDeviceId.

Ma zastosowanie tylko do: audienceType CUSTOMER_MATCH_DEVICE_ID
Pole sumy members. Początkowi członkowie grupy odbiorców z kierowania na listę klientów. members może mieć tylko jedną z tych wartości:
contactInfoList

object (ContactInfoList)

Tylko dane wejściowe. Lista danych kontaktowych pozwalających określić początkowych członków grupy odbiorców.

Ma zastosowanie tylko do: audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Tylko dane wejściowe. Lista identyfikatorów urządzeń mobilnych definiujących początkowych członków grupy odbiorców.

Ma zastosowanie tylko do: audienceType CUSTOMER_MATCH_DEVICE_ID

FirstAndThirdPartyAudienceType

Możliwe typy zasobów własnych i dostarczonych przez firmę zewnętrzną.

Wartości w polu enum
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED Wartość domyślna, gdy typ nie jest określony lub nieznany.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY Lista odbiorców tworzona na podstawie danych klienta.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY Lista odbiorców dostarczona 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 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

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

Lista odbiorców została utworzona na podstawie wykluczenia liczby zrealizowanych wyświetleń.
TAG_BASED Lista odbiorców została utworzona na podstawie zmiennych niestandardowych przypisanych do piksela.
YOUTUBE_USERS Grupa odbiorców została utworzona na podstawie wcześniejszych interakcji z filmami, reklamami w YouTube lub kanałem w YouTube.
LICENSED Podtyp typu listy odbiorców dostarczonej przez firmę zewnętrzną.

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 nieznane.
DISPLAY_VIDEO_360 Źródło: Display & Film 360.
CAMPAIGN_MANAGER Usługa pochodzi z Campaign Managera 360.
AD_MANAGER Usługa pochodzi z Google Ad Managera.
SEARCH_ADS_360 Pochodzi z Search Ads 360.
YOUTUBE Film pochodzi z YouTube.
ADS_DATA_HUB Pochodzi z Centrum danych reklam.

ContactInfoList

Podsumowanie wiadomości z informacjami kontaktowymi określającymi odbiorców z kierowania na listę klientów.

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

object (ContactInfo)

Lista obiektów ContactInfo definiujących członków odbiorców z kierowania na listę klientów. Wielkość użytkowników po podzieleniu informacji kontaktowych nie może być większa niż 500 000.
consent

object (Consent)

Tylko dane wejściowe. Ustawienie dotyczące zgody użytkowników w organizacji contactInfos.

Jeśli to pole nie jest skonfigurowane, oznacza to, że nie określono zgody.

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

ContactInfo

Dane kontaktowe służące do określenia odbiorców z 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 grupy zaszyfrowanych przy użyciu algorytmu SHA256. Przed zaszyfrowaniem usuń wszystkie odstępy i upewnij się, że ciąg znaków jest zapisany małymi literami.
hashedPhoneNumbers[]

string

Lista zahaszowanych za pomocą algorytmu SHA256 numerów telefonów członka grupy. Przed zaszyfrowaniem wszystkie numery telefonów muszą zostać sformatowane w formacie E.164 i zawierać numer kierunkowy kraju.
zipCodes[]

string

Lista kodów pocztowych uczestnika.

Musi też zawierać te pola:
hashedFirstName

string

Imię członka zahaszowane za pomocą algorytmu SHA256. Przed zaszyfrowaniem usuń wszystkie odstępy i upewnij się, że ciąg znaków jest zapisany małymi literami.

Musi też zawierać te pola:
hashedLastName

string

Nazwisko osoby zahaszowane za pomocą algorytmu SHA256. Przed zaszyfrowaniem usuń wszystkie odstępy i upewnij się, że ciąg znaków jest zapisany małymi literami.

Musi też zawierać te pola:
countryCode

string

Kod kraju użytkownika.

Musi też zawierać te pola:

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 Zgoda nie została wyrażona.

MobileDeviceIdList

Podsumowanie wiadomości z listą identyfikatorów urządzeń mobilnych definiujących członków odbiorców z 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 odbiorców z kierowania na listę klientów. Rozmiar identyfikatorów mobileDeviceId nie może być większy niż 500 000.
consent

object (Consent)

Tylko dane wejściowe. Ustawienie dotyczące zgody użytkowników w organizacji mobileDeviceIds.

Jeśli to pole nie jest skonfigurowane, oznacza to, że nie określono zgody.

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

Metody

create

 Tworzy grupę odbiorców FirstAndThirdPartyAudience.

editCustomerMatchMembers

 Aktualizuje listę członków odbiorców z kierowania na listę klientów.

get

 Pobiera własną listę odbiorców i listę odbiorców dostarczoną przez inną firmę.

list

 Wyświetla listy odbiorców własne i dostarczone przez firmę zewnętrzną.

patch

 Aktualizuje istniejącą grupę odbiorców FirstAndThirdPartyAudience.