Użyj mapowań w tabelach, aby zmapować metody i pola zarządzania odbiorcami kierowania na listę klientów w interfejsie Display & Video 360 API na ich odpowiedniki w interfejsie Data Manager API.
Uwierzytelnianie
Interfejs Data Manager API wymaga danych logowania o innym zakresie niż interfejs Display & Video 360 API. Aby wygenerować nowe dane logowania, które obejmują zakres interfejsu Data Manager API, wykonaj czynności opisane w artykule Konfigurowanie dostępu do interfejsu API.
Mapowanie metod
W tabeli poniżej znajdziesz metody interfejsu Display & Video 360 API i odpowiadające im metody interfejsu Data Manager API:
| Metody interfejsu Display & Video 360 API | Metody interfejsu Data Manager API | Uwagi |
|---|---|---|
firstPartyAndPartnerAudiences.get |
userLists.get |
Interfejs Data Manager API może pobierać tylko listy odbiorców kierowania na listę klientów. |
firstPartyAndPartnerAudiences.list |
userLists.list |
Interfejs Data Manager API będzie zwracać tylko odbiorców kierowania na listę klientów. |
firstPartyAndPartnerAudiences.create |
userLists.create |
Dane użytkownika muszą zostać przesłane w kolejnym żądaniu w interfejsie Data Manager API. |
| Brak odpowiednika | userLists.delete |
Niedostępne w interfejsie Display & Video 360 API. |
firstPartyAndPartnerAudiences.patch |
userLists.patch |
|
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.ingest |
Do dodawania i usuwania użytkowników z list odbiorców kierowania na listę klientów służą osobne metody interfejsu Data Manager API. |
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.remove |
Do dodawania i usuwania użytkowników z odbiorców kierowania na listę klientów służą osobne metody interfejsu Data Manager API. |
| Brak odpowiednika. | audienceMembers.removeAll |
Interfejs Data Manager API umożliwia usunięcie wszystkich członków listy odbiorców za pomocą jednego żądania. |
Mapowanie żądań
W poniższych tabelach pola żądań metod interfejsu Display & Video 360 API są mapowane na ich odpowiedniki w interfejsie Data Manager API.
userLists.get
firstPartyAndPartnerAudiences.get (Display & Video 360 API) |
userLists.get (Data Manager API) |
Uwagi |
|---|---|---|
|
name |
Nazwa UserList zawiera zarówno identyfikator reklamodawcy nadrzędnego lub partnera, jak i identyfikator listy odbiorców. Więcej informacji znajdziesz w sekcji Nazwy zasobów. |
userLists.list
firstPartyAndPartnerAudiences.list (Display & Video 360 API) |
userLists.list (Data Manager API) |
Uwagi |
|---|---|---|
|
parent |
parent zawiera identyfikator reklamodawcy nadrzędnego lub partnera. |
pageSize |
pageSize |
Maksymalny rozmiar strony w interfejsie Data Manager API to 1000. |
pageToken |
pageToken |
|
filter |
filter |
|
orderBy |
Brak odpowiednika |
userLists.create
firstPartyAndPartnerAudiences.create (Display & Video 360 API) |
userLists.create (Data Manager API) |
Uwagi |
|---|---|---|
|
parent |
parent zawiera identyfikator reklamodawcy nadrzędnego lub partnera nowej listy odbiorców. |
| Brak odpowiednika | validateOnly |
|
FirstPartyAndPartnerAudience treść żądania |
UserList treść żądania |
Mapowanie treści żądania znajdziesz w sekcji UserList. |
userLists.update
firstPartyAndPartnerAudiences.patch (Display & Video 360 API) |
userLists.patch (Data Manager API) |
Uwagi |
|---|---|---|
|
Parametr userList.name |
Nazwa zasobu UserList, który chcesz zaktualizować. |
updateMask |
updateMask |
To pole jest zalecane, ale nie jest wymagane w interfejsie Data Manager API. Jeśli pozostanie puste, wszystkie uwzględnione pola zostaną zastąpione. |
| Brak odpowiednika | validateOnly |
|
FirstPartyAndPartnerAudience treść żądania |
UserList treść żądania |
Mapowanie treści żądania znajdziesz w sekcji UserList. |
audienceMembers.ingest
firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) |
audienceMembers.ingest (Data Manager API) |
Uwagi |
|---|---|---|
|
destinations |
Więcej informacji znajdziesz w artykule Konfigurowanie miejsc docelowych. |
addedContactInfoList.contactInfos |
audienceMembers |
Poszczególne identyfikatory użytkowników można ustawić w polu compositeData.userData w obiektach AudienceMember. Więcej informacji znajdziesz w sekcji Identyfikatory użytkowników. |
addedContactInfoList.consent |
consent |
Zgodę można też ustawić w poszczególnych obiektach AudienceMember. |
addedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Identyfikatory poszczególnych urządzeń mobilnych są ustawiane w polu mobileData w obiektach AudienceMember. |
addedMobileDeviceIdList.consent |
consent |
Zgodę można też ustawić w poszczególnych obiektach AudienceMember. |
| Brak odpowiednika | validateOnly |
|
| Brak odpowiednika | encoding |
Parametr wymagany. Ustaw Encoding używany dla wartości UserIdentifier. |
| Brak odpowiednika | encryptionInfo |
Ustaw, jeśli żądanie zawiera zaszyfrowane wartości. Szczegółowe informacje znajdziesz w artykule Szyfrowanie. |
| Brak odpowiednika | termsOfService |
Wymagany. Ustaw, aby wskazać, że użytkownik zaakceptował lub odrzucił warunki korzystania z usługi kierowania na listę klientów. |
audienceMembers.remove
firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) |
audienceMembers.remove (Data Manager API) |
Uwagi |
|---|---|---|
|
destinations |
|
removedContactInfoList.contactInfos |
audienceMembers |
Poszczególne identyfikatory użytkowników można ustawić w polu compositeData.userData w obiektach AudienceMember. Więcej informacji znajdziesz w sekcji Identyfikatory użytkowników. |
removedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Identyfikatory poszczególnych urządzeń mobilnych są ustawiane w polu mobileData w obiektach AudienceMember. |
| Brak odpowiednika | validateOnly |
|
| Brak odpowiednika | encoding |
Wymagany. Ustaw Encoding używany dla wartości UserIdentifier. |
| Brak odpowiednika | encryptionInfo |
Ustaw, jeśli żądanie zawiera zaszyfrowane wartości. Szczegółowe informacje znajdziesz w artykule Szyfrowanie. |
Mapowania pól obiektów
Oto mapowanie obiektów interfejsu Display & Video 360 API na odpowiednie obiekty w interfejsie Data Manager API.
UserList
FirstPartyAndPartnerAudience (Display & Video 360 API) |
UserList (Data Manager API) |
Uwagi |
|---|---|---|
name |
name |
używa innego formatu nazwy zasobu; Więcej informacji znajdziesz w sekcji Nazwy zasobów. |
firstPartyAndPartnerAudienceId |
id |
|
| Brak odpowiednika | readOnly |
|
displayName |
displayName |
|
description |
description |
|
| Brak odpowiednika | membershipStatus |
|
| Brak odpowiednika | integrationCode |
|
membershipDurationDays |
membershipDuration |
|
| Brak odpowiednika | closingReason |
|
| Brak odpowiednika | accessReason |
|
| Brak odpowiednika | accountAccessStatus |
|
displayAudienceSize |
sizeInfo.displayNetworkMembersCount |
|
| Brak odpowiednika | sizeInfo.searchNetworkMembersCount |
|
| Brak odpowiednika | targetNetworkInfo |
|
| Brak odpowiednika | ingestedUserListInfo |
|
firstPartyAndPartnerAudienceType |
Brak odpowiednika | |
audienceType |
Brak odpowiednika | |
audienceSource |
Brak odpowiednika | |
activeDisplayAudienceSize |
Brak odpowiednika | |
youtubeAudienceSize |
Brak odpowiednika | |
gmailAudienceSize |
Brak odpowiednika | |
displayMobileAppAudienceSize |
Brak odpowiednika | |
displayMobileWebAudienceSize |
Brak odpowiednika | |
displayDesktopAudienceSize |
Brak odpowiednika | |
appId |
ingestedUserListInfo.mobileIdInfo.appId |
|
contactInfoList |
Metody audienceMembers |
W interfejsie Data Manager API możesz dodawać i usuwać użytkowników za pomocą metod ingest, remove i removeAll zasobu audienceMembers.
|
mobileDeviceIdList |
Metody audienceMembers |
W interfejsie Data Manager API możesz dodawać i usuwać użytkowników za pomocą metod ingest, remove i removeAll zasobu audienceMembers.
|
Nazwy zasobów
Interfejs Data Manager API używa innego formatu nazwy zasobu niż interfejs Display & Video 360 API.
- Display & Video 360 API
W interfejsie Display & Video 360 API nazwa zasobu
UserListma format, który zawiera tylko identyfikator listy odbiorców:firstAndThirdPartyAudiences/{first_and_third_party_audience_id}- Data Manager API
W interfejsie Data Manager API nazwa zasobu
UserListma format, który zawiera identyfikator listy odbiorców orazAccountTypei identyfikator konta partnera lub reklamodawcy, który jest właścicielem listy odbiorców:accountTypes/{accountType}/accounts/{account}/userLists/{userList}
Identyfikatory użytkowników
Chociaż userData jest nadal obsługiwany, zalecamy używanie compositeData, aby integracja była przygotowana na przyszłe ulepszenia. Więcej informacji znajdziesz w sekcji Dane złożone.
ContactInfo (Display & Video 360 API) |
CompositeData (Data Manager API) |
Uwagi |
|---|---|---|
hashedEmails |
userData.userIdentifiers.emailAddress |
Ustaw sformatowany i zaszyfrowany adres e-mail. Możesz też zaszyfrować zaszyfrowany adres e-mail. Możesz dopasować wiele adresów e-mail do jednego użytkownika, używając wielu obiektów UserIdentifier. |
hashedPhoneNumbers |
userData.userIdentifiers.phoneNumber |
Ustaw sformatowany i zahaszowany numer telefonu. Możesz też zaszyfrować zahaszowany numer telefonu. Możesz dopasować wiele numerów telefonu do jednego użytkownika, używając wielu obiektów UserIdentifier. |
hashedFirstName |
userData.userIdentifiers.address.givenName |
Ustaw sformatowane i zaszyfrowane imię. Możesz też zaszyfrować zaszyfrowane imię. |
hashedLastName |
userData.userIdentifiers.address.familyName |
Ustaw sformatowane i zaszyfrowane nazwisko. Możesz też zaszyfrować zaszyfrowane nazwisko. |
countryCode |
userData.userIdentifiers.address.regionCode |
|
zipCodes |
userData.userIdentifiers.address.postalCode |
Możesz dopasować wiele kodów pocztowych do jednego użytkownika, używając wielu obiektów UserIdentifier. |
Miejsce docelowe
| Display & Video 360 API | Destination (Data Manager API) |
Uwagi |
|---|---|---|
| Identyfikator reklamodawcy lub partnera, do którego użytkownik Display & Video 360 ma dostęp. | loginAccount |
To ustawienie jest wymagane tylko w scenariuszu dostępu partnera Display & Video 360, w którym lista odbiorców jest przypisana do reklamodawcy, ale użytkownik Display & Video 360 ma dostęp do partnera nadrzędnego reklamodawcy. W przeciwnym razie możesz pozostawić to pole puste. |
| Identyfikator reklamodawcy nadrzędnego lub partnera listy odbiorców. | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| Brak odpowiednika | reference |