Migracja z wersji 1 do wersji 2

Ostatnia aktualizacja: 6.12.2022

Migracja aplikacji

Migracja z wersji 1 na wersję 2 wymaga zaktualizowania adresów URL punktów końcowych, aby wywoływać wersję 2, oraz zaktualizowania aplikacji w celu uwzględnienia zmian powodujących przerwanie działania.

Zaktualizuj wywołania interfejsu API z wersji 1 na wersję 2

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

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

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

W przypadku wersji 2 zaktualizuj adres URL do tego:

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

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

Wprowadzanie wymaganych zmian

Wprowadziliśmy w wersji 2 kilka zmian powodujących niezgodność. Zapoznaj się z tymi instrukcjami i wprowadź wymagane zmiany w sposobie, w jaki obecnie używasz interfejsu Display & Video 360 API.

Aktualizowanie wywołań metod kierowania

• Niektóre typy kierowania są teraz przypisywane za pomocą wartości z ujednoliconego zbioru wartości zamiast identyfikatorów opcji kierowania. Na przykład urządzenia typu tablet są teraz kierowane bezpośrednio za pomocą typu zbiorczego DEVICE_TYPE_TABLET DeviceType, a nie identyfikatora opcji kierowania z usługi targetingTypes.targetingOptions. Wersje ciągów znaków tych typów danych są reprezentowane w nowym polu assignedTargetingOptionIdAlias w tych zasobach AssignedTargetingOption i można ich używać podczas pobierania lub usuwania dotychczasowego kierowania. Wartość assignedTargetingOptionId tych zasobów AssignedTargetingOption się nie zmieniła.

  Zaktualizuj wywołania, które zarządzają tymi typami kierowania:

  • 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 TARGETING_TYPE_PROXIMITY_LOCATION_LIST, aby używać zdefiniowanego rozmiaru promienia i jednostki odległości zamiast wartości wyliczenia ProximityRadiusRange.

• Zmieniono nazwy metod kierowania, które pobierają lub edytują opcje kierowania w różnych typach kierowania w ramach jednego zasobu nadrzędnego.

  Zaktualizuj wywołania tych metod, aby używać ich nowych nazw:

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

Aktualizacja połączeń z usługą advertisers.lineItems

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

• Te 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

• Z obiektu LineItemFlight zostało usunięte pole triggerId, a z typu zbioru LineItemFlightDateType – wartość LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER. Wersja 2 nie obsługuje ustawiania wydatków na elementy zamówienia na podstawie aktywacji ręcznych inicjatorów.

Aktualizacja połączeń z usługą customBiddingAlgorithms

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

Dodatkowe zmiany

Oprócz wymienionych wyżej zmian wprowadzających nowe funkcje, wersja 2 zawiera też nowe funkcje.

Funkcje dodane do wersji 2 po jej pierwszym udostępnieniu znajdziesz w informacjach o wersjach.

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

W wersji 2 elementy zamówienia typu YouTube i ich ustawienia kierowania można pobrać za pomocą usług advertisers.lineItems i advertisers.lineItems.targetingTypes.assignedTargetingOptions. Interfejs API zapewnia dostęp tylko do odczytu, co oznacza, że próby zapisu żądań do tych elementów zamówienia zwrócą błąd. Elementy w linii dotyczące YouTube będą miały 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ększania skuteczności

W wersji 2 usługa advertisers.lineItems udostępnia nowe metody, które można stosować zamiast żądań zbiorczych, aby uzyskać lepszą wydajność i zmniejszyć zużycie limitu:

• Aby ustawić te same wartości pól dla wielu elementów zamówienia, możesz użyć advertisers.lineItems.bulkUpdate. Obecnie obsługiwane są tylko zmiany w polu entityStatus.
• Możesz użyć funkcji advertisers.lineItems.bulkEditAssignedTargetingOptions, aby dodawać i usuwać te same przypisane opcje kierowania w różnych elementach zamówienia.
• Możesz użyć kolumny advertisers.lineItems.bulkListAssignedTargetingOptions, aby wyświetlić przypisane opcje kierowania w różnych elementach zamówienia.
• Możesz użyć advertisers.lineItems.duplicate, aby utworzyć kopię dotychczasowego elementu zamówienia w ramach tego samego zamówienia reklamowego, kopiując wszystkie konfiguracje i ustawienia kierowania.

Dostęp do zapisu w ograniczonym zakresie w przypadku kierowania zamówienia reklamowego

W wersji 2 możesz edytować ustawienia kierowania podzbioru zasobów InsertionOrder za pomocą nowych metod create i delete w usłudze advertisers.insertionOrders.targetingTypes.assignedTargetingOptions. Na poziomie zamówienia reklamowego możesz 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