Migracja z wersji 1 do wersji 2

Ostatnia aktualizacja: 6.12.2022 r.

Migracja aplikacji

Migracja z wersji 1 do wersji 2 wymaga zaktualizowania adresów URL punktów końcowych tak, aby wywoływały wersję 2, oraz zaktualizowania aplikacji pod kątem zmian powodujących niezgodność.

Zaktualizuj wywołania interfejsu API z wersji 1 do 2

Aby używać wersji 2 zamiast 1, musisz zaktualizować żądania, tak aby używały nowych punktów końcowych wersji 2.

Aby na przykład wywołać metodę advertisers.get za pomocą wersji 1, użyj tego adresu URL:

GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId

W przypadku wersji 2 zaktualizuj adres URL do takiego adresu:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

Jeśli do wysyłania żądań do interfejsu API używasz biblioteki klienta, użyj najnowszej wersji biblioteki klienta i zaktualizuj konfigurację tak, aby używała wersji 2.

Wprowadzanie wymaganych zmian

Wprowadzamy w wersji 2 pewne zmiany powodujące niezgodność. Zapoznaj się z podanymi niżej instrukcjami i wprowadź wymagane zmiany związane z dotychczasowym korzystaniem z interfejsu Display & Video 360 API.

Aktualizowanie wywołań metod kierowania

• Niektóre typy kierowania są teraz przypisywane za pomocą wartości wyliczeniowych zamiast identyfikatorów opcji kierowania. Na przykład na tablety są teraz kierowane bezpośrednio wyliczenia DEVICE_TYPE_TABLET DeviceType, a nie identyfikator opcji kierowania z usługi targetingTypes.targetingOptions. Wersje z ciągami znaków tych wyliczeniowych są reprezentowane w nowym polu assignedTargetingOptionIdAlias w tych zasobach AssignedTargetingOption i można ich używać przy pobieraniu lub usuwaniu dotychczasowych ustawień kierowania. Wartość assignedTargetingOptionId tych zasobów AssignedTargetingOption nie zmieniła się.

  Zaktualizuj wywołania zarządzające tymi typami kierowania tak, by używały wartości wyliczeniowych:

  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_VIEWABILITY

• Metoda advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions została zastąpiona metodą advertisers.lineItems.bulkEditAssignedTargetingOptions.

• Metoda advertisers.lineItems.bulkListLineItemAssignedTargetingOptions została zastąpiona metodą advertisers.lineItems.bulkListAssignedTargetingOptions.

• Zaktualizuj wywołania zarządzające obszarem TARGETING_TYPE_PROXIMITY_LOCATION_LIST tak, aby używały ustawionego rozmiaru promienia i jednostki odległości zamiast wartości wyliczeniowej ProximityRadiusRange.

• Zmieniliśmy nazwy metod kierowania, które pobierają lub edytują opcje kierowania w wielu typach kierowania w ramach 1 zasobu nadrzędnego.

  Zaktualizuj wywołania następujących metod, aby używały ich nowych nazw:

  • advertisers.bulkEditAdvertiserAssignedTargetingOptions do advertisers.editAssignedTargetingOptions
  • advertisers.bulkListAdvertiserAssignedTargetingOptions do advertisers.listAssignedTargetingOptions
  • advertisers.campaigns.bulkListCampaignAssignedTargetingOptions do advertisers.campaigns.listAssignedTargetingOptions
  • advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions do advertisers.insertionOrders.listAssignedTargetingOptions
  • partners.bulkEditPartnerAssignedTargetingOptions do partners.editAssignedTargetingOptions

Zaktualizuj połączenia z usługą advertisers.lineItems

• Pole inventorySourceIds zostało usunięte. Zarządzanie przypisaniem źródła zasobów reklamowych za pomocą zasobów AssignedTargetingOption TARGETING_TYPE_INVENTORY_SOURCE.

• Poniższe wartości wyliczenia LineItemWarningMessage zostały wycofane w wersji 2 i nie będą już wyświetlane w LineItem.warningMessages:

  • NO_POSITIVE_AUDIENCE_LIST_TARGETED
  • APP_INSTALL_NO_CONVERSION_PIXEL
  • TARGETING_REVOKED_OR_CLOSED_USER_LIST
  • APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
  • CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
  • NO_CREATIVE_FOR_TARGETED_DEALS
  • TARGETING_DEPRECATED_GEO_TARGET

• Pole triggerId zostało usunięte z obiektu LineItemFlight, a wartość LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER została usunięta z typu wyliczenia LineItemFlightDateType. Wersja 2 nie umożliwia ustawiania wydatków w elementach zamówienia na podstawie aktywacji reguł ręcznych.

Zaktualizuj połączenia z usługą customBiddingAlgorithms

Pola customBiddingAlgorithmState i modelReadiness zostały zastąpione polem modelDetails , które podaje stany gotowości i zawieszenia obecnego modelu algorytmu w przypadku każdego reklamodawcy, który ma dostęp za pomocą listy obiektów CustomBiddingModelDetails.

Dodatkowe zmiany

Oprócz wymienionych powyżej zmian powodujących niezgodność wersja 2 wprowadza też nowe funkcje.

Funkcje dodane do wersji 2 po jej opublikowaniu znajdziesz w informacjach o wersji.

Dostęp tylko do odczytu do elementów zamówienia YouTube

W wersji 2 elementy zamówienia YouTube i ich ustawienia kierowania można pobierać odpowiednio za pomocą usług advertisers.lineItems i advertisers.lineItems.targetingTypes.assignedTargetingOptions. Interfejs API zapewnia dostęp tylko do odczytu, co oznacza, że wszystkie próby zapisu wysyłane do tych elementów zamówienia zwracają błąd. Elementy zamówienia YouTube będą mieć jedną z tych wartości LineItemType:

• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

Nowe metody zwiększające skuteczność

W wersji 2 usługa advertisers.lineItems udostępnia nowe metody zamiast żądań zbiorczych, które pozwalają zwiększyć wydajność i zmniejszyć wykorzystanie limitu:

• Aby ustawić te same wartości pól w wielu elementach zamówienia, możesz użyć funkcji advertisers.lineItems.bulkUpdate. Obecnie obsługiwane są tylko zmiany pola entityStatus.
• Aby dodać lub usunąć te same przypisane opcje kierowania w wielu elementach zamówienia, możesz użyć advertisers.lineItems.bulkEditAssignedTargetingOptions.
• Aby wyświetlić listę opcji kierowania przypisanych w wielu elementach zamówienia, możesz użyć właściwości advertisers.lineItems.bulkListAssignedTargetingOptions.
• Za pomocą advertisers.lineItems.duplicate możesz utworzyć duplikat istniejącego elementu zamówienia w ramach tego samego zamówienia reklamowego, kopiując wszystkie konfiguracje i ustawienia kierowania.

Częściowy dostęp do zapisu w przypadku kierowania zamówienia reklamowego

Wersja 2 umożliwia edytowanie ustawień kierowania na podzbiór zasobów InsertionOrder za pomocą nowych metod create i delete w usłudze advertisers.insertionOrders.targetingTypes.assignedTargetingOptions. Na poziomie zamówienia reklamowego można w pełni zarządzać tymi typami kierowania:

• TARGETING_TYPE_AGE_RANGE
• TARGETING_TYPE_BROWSER
• TARGETING_TYPE_CATEGORY
• TARGETING_TYPE_CHANNEL
• TARGETING_TYPE_DEVICE_MAKE_MODEL
• TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
• TARGETING_TYPE_ENVIRONMENT
• TARGETING_TYPE_GENDER
• TARGETING_TYPE_KEYWORD
• TARGETING_TYPE_LANGUAGE
• TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
• TARGETING_TYPE_OPERATING_SYSTEM
• TARGETING_TYPE_PARENTAL_STATUS
• TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
• TARGETING_TYPE_VIEWABILITY