REST Resource: firstAndThirdPartyAudiences

Zasób: FirstAndthirdPartyAudience

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

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 listy odbiorców własnej i listy odbiorców dostarczonej przez firmę zewnętrzną.
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 listy odbiorców własnej i listy odbiorców dostarczonej przez firmę zewnętrzną.
description

string

Opis listy odbiorców podany przez użytkownika.

Dotyczy tylko własnych list odbiorców.
firstAndThirdPartyAudienceType

enum (FirstAndThirdPartyAudienceType)

Czy są to odbiorcy własne czy dostarczone przez inną firmę.
audienceType

enum (AudienceType)

Typ listy odbiorców.
audienceSource

enum (AudienceSource)

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

string (int64 format)

Okres (w dniach), przez jaki wpis pozostaje na liście odbiorców po wydarzeniu kwalifikującym się do udziału w nim. Jeśli lista odbiorców nie ma daty ważności, ustaw wartość w tym polu na 10 000. W innych przypadkach ustawiona wartość musi być większa niż 0, ale mniejsza lub równa 540.

Dotyczy tylko własnych list odbiorców.

To pole jest wymagane, jeśli używany jest jeden z tych elementó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, ze względu na ochronę prywatności liczba zostanie ukryta, a wartość 0 zwracana. W przeciwnym razie liczba zostanie zaokrąglona do dwóch znaczących cyfr.

Zwrócone 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, ze względu na ochronę prywatności liczba zostanie ukryta, a wartość 0 zwracana. W przeciwnym razie liczba zostanie zaokrąglona do dwóch znaczących cyfr.

Zwrócone 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, ze względu na ochronę prywatności liczba zostanie ukryta, a wartość 0 zwracana. W przeciwnym razie liczba zostanie zaokrąglona do dwóch znaczących cyfr.

Dotyczy tylko własnych list odbiorców.

Zwrócone 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, ze względu na ochronę prywatności liczba zostanie ukryta, a wartość 0 zwracana. W przeciwnym razie liczba zostanie zaokrąglona do dwóch znaczących cyfr.

Dotyczy tylko własnych list odbiorców.

Zwrócone 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, ze względu na ochronę prywatności liczba zostanie ukryta, a wartość 0 zwracana. W przeciwnym razie liczba zostanie zaokrąglona do dwóch znaczących cyfr.

Dotyczy tylko własnych list odbiorców.

Zwrócone 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, ze względu na ochronę prywatności liczba zostanie ukryta, a wartość 0 zwracana. W przeciwnym razie liczba zostanie zaokrąglona do dwóch znaczących cyfr.

Dotyczy tylko własnych list odbiorców.

Zwrócone 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, ze względu na ochronę prywatności liczba zostanie ukryta, a wartość 0 zwracana. W przeciwnym razie liczba zostanie zaokrąglona do dwóch znaczących cyfr.

Dotyczy tylko własnych list odbiorców.

Zwrócone tylko w żądaniu GET.
appId

string

Wartość appId pasuje do typu przesyłanych identyfikatorów urządzeń mobilnych.

Dotyczy tylko: audienceType CUSTOMER_MATCH_DEVICE_ID
Pole sumy members. Początkowa grupa 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 informacji kontaktowych określających 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 służących do zdefiniowania początkowych członków grupy odbiorców.

Dotyczy tylko: audienceType CUSTOMER_MATCH_DEVICE_ID

FirstAndThirdPartyAudienceType

Możliwe typy własnych i zewnętrznych list odbiorców.

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 Grupa odbiorców utworzona na podstawie danych klienta.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY Lista odbiorców dostarczana 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 dopasowywanie klientów do znanych informacji kontaktowych.
CUSTOMER_MATCH_DEVICE_ID Lista odbiorców została wygenerowana przez dopasowywanie klientów do znanych identyfikatorów urządzeń mobilnych.
CUSTOMER_MATCH_USER_ID Lista odbiorców została wygenerowana przez dopasowywanie 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 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 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 zostało 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 towarzyszący z listą danych kontaktowych określających członków odbiorców z kierowania na listę klientów.

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

object (ContactInfo)

Lista obiektów ContactInfo definiujących członków odbiorców z kierowania na listę klientów. Rozmiar członków po podzieleniu informacji kontaktowych nie może przekraczać 500 000.

ContactInfo

Dane kontaktowe definiujące członka grupy 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 użytkownika zaszyfrowanych za pomocą SHA256. Przed haszowaniem usuń wszystkie spacje i sprawdź, czy ciąg znaków jest w nim zapisany małymi literami.
hashedPhoneNumbers[]

string

Lista numerów telefonów użytkownika zaszyfrowanych za pomocą SHA256. Przed zaszyfrowaniem wszystkie numery telefonów muszą zostać sformatowane w formacie E.164 i zawierać kod kierunkowy kraju.
zipCodes[]

string

Lista kodów pocztowych członka grupy.

Musi też zawierać te pola:
hashedFirstName

string

Imię członka grupy zaszyfrowane za pomocą SHA256. Przed haszowaniem usuń wszystkie spacje i sprawdź, czy ciąg znaków jest w nim zapisany małymi literami.

Musi też zawierać te pola:
hashedLastName

string

Nazwisko członka grupy zaszyfrowane za pomocą SHA256. Przed haszowaniem usuń wszystkie spacje i sprawdź, czy ciąg znaków jest w nim zapisany małymi literami.

Musi też zawierać te pola:
countryCode

string

Kod kraju członka społeczności.

Musi też zawierać te pola:

MobileDeviceIdList

Komunikat towarzyszący z listą identyfikatorów urządzeń mobilnych definiujących członków odbiorców z kierowania na listę klientów.

Zapis JSON 
{
  "mobileDeviceIds": [
    string
  ]
}
Pola
mobileDeviceIds[]

string

Lista identyfikatorów urządzeń mobilnych definiujących członków odbiorców z kierowania na listę klientów. Rozmiar parametru mobileDeviceId nie może być większy niż 500 000.

Metody

create

 Tworzy własną grupę odbiorców z firmy zewnętrznej.

editCustomerMatchMembers

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

get

 Pozyskuje odbiorców własnych i dostarczanych przez inną firmę.

list

 Wyświetla listę własnych list odbiorców i list odbiorców dostarczonych przez firmę zewnętrzną.

patch

 Aktualizuje istniejącą listę odbiorców własnych i zewnętrznych.