REST Resource: firstAndThirdPartyAudiences

Zasób: FirstAndPartyAudience

Opisuje listę odbiorców (własną lub dostarczoną przez inną firmę) używaną do kierowania. Własne listy odbiorców są tworzone na podstawie danych klienta. Listy odbiorców pochodzące od innych firm są dostarczane przez zewnętrznych dostawców danych i można w ich przypadku udzielać licencji 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 własnej listy odbiorców 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 własnej listy odbiorców i listy odbiorców dostarczonej przez firmę zewnętrzną.
description

string

Podany przez użytkownika opis listy odbiorców.

Dotyczy tylko własnych list odbiorców.
firstAndThirdPartyAudienceType

enum (FirstAndThirdPartyAudienceType)

Określa, czy są to odbiorcy własne czy dostarczone przez firmę zewnętrzną.
audienceType

enum (AudienceType)

Typ listy odbiorców.
audienceSource

enum (AudienceSource)

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

string (int64 format)

Okres (w dniach), przez jaki zgłoszenie pozostaje na liście odbiorców po wydarzeniu kwalifikującym się do otrzymania nagrody. Jeśli lista odbiorców nie ma daty ważności, ustaw w tym polu wartość 10 000. W pozostałych przypadkach ustawiana wartość musi być większa niż 0 i mniejsza niż lub równa 540.

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

Dotyczy tylko własnych list odbiorców.

Zwracane tylko w żądaniu GET.
appId

string

Wartość appId odpowiada typowi przesyłanych urządzeń mobileDeviceId.

Dotyczy tylko audienceType CUSTOMER_MATCH_DEVICE_ID
Pole sumy members. Początkowa grupa odbiorców z kierowania na listę klientów. members może być tylko jedną z tych wartości:
contactInfoList

object (ContactInfoList)

Tylko wejście. Lista informacji kontaktowych wyznaczających początkowych członków grupy odbiorców.

Dotyczy tylko audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Tylko wejście. Lista identyfikatorów urządzeń mobilnych służących do określenia początkowych członków grupy odbiorców.

Dotyczy tylko audienceType CUSTOMER_MATCH_DEVICE_ID

FirstAndThirdPartyAudienceType

Możliwe typy własnych zasobów odbiorców i tych pochodzących od innej firmy.

Wartości w polu enum
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED Wartość domyślna, gdy typ nie został określony lub jest 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 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 został 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

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

Lista odbiorców została utworzona na podstawie liczby zrealizowanych wyświetleń.
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 w YouTube lub kanałem YouTube.
LICENSED Podtyp typu listy odbiorców dostarczonej przez inną firmę.

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 Pochodzą z YouTube.
ADS_DATA_HUB Pochodzą z Centrum danych reklam.

ContactInfoList

Wiadomość o pakiecie z listą informacji kontaktowych definiujących 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ść członków po podzieleniu informacji contactInfo nie może przekraczać 500 000.
consent

object (Consent)

Tylko wejście. Ustawienie dotyczące uzyskiwania zgody dla użytkowników z organizacji contactInfos.

Jeśli to pole jest nieskonfigurowane, oznacza to, ż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 definiujące członka grupy 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 użytkownika zaszyfrowanych za pomocą algorytmu SHA256. Przed haszowaniem usuń wszystkie odstępy i upewnij się, że ciąg znaków zawiera tylko małe litery.
hashedPhoneNumbers[]

string

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

string

Lista kodów pocztowych użytkownika.

Musi też zawierać następujące pola:
hashedFirstName

string

Imię użytkownika szyfrowane za pomocą SHA256. Przed haszowaniem usuń wszystkie odstępy i upewnij się, że ciąg znaków zawiera tylko małe litery.

Musi też zawierać następujące pola:
hashedLastName

string

Nazwisko użytkownika zaszyfrowane za pomocą SHA256. Przed haszowaniem usuń wszystkie odstępy i upewnij się, że ciąg znaków zawiera tylko małe litery.

Musi też zawierać następujące pola:
countryCode

string

Kod kraju użytkownika.

Musi też zawierać następujące 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 odrzucona.

MobileDeviceIdList

Wiadomość o pakiecie z listą identyfikatorów urządzeń mobilnych definiujących członków list 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 list 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 wejście. Ustawienie dotyczące uzyskiwania zgody dla użytkowników z organizacji mobileDeviceIds.

Jeśli to pole jest nieskonfigurowane, oznacza to, że zgoda nie została określona.

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

Metody

create

 Tworzy własną listę 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 firmę zewnętrzną.

list

 Zawiera listę własnych list odbiorców i list odbiorców dostarczonych przez firmę zewnętrzną.

patch

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