Ta strona została przetłumaczona przez Cloud Translation API.

Migracja z interfejsu Bid Manager API w wersji 1.1 do wersji 2

W marcu 2022 roku udostępniliśmy interfejs API Bid Managera w wersji 2. Planujemy wkrótce opublikować datę wycofania wersji 1.1 w związku z jej wprowadzeniem. Zalecamy jak najszybsze rozpoczęcie migracji z wersji 1.1 do 2.

Migracja aplikacji

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

Aktualizowanie wywołań interfejsu API z wersji 1.1 do wersji 2

Aby używać wersji 2 zamiast 1.1, musisz zaktualizować żądania w taki sposób, aby korzystały z nowych punktów końcowych w wersji 2.

Zidentyfikuj równoważne metody

Aby zaktualizować wywołania interfejsu API z wersji 1.1 do v2, musisz najpierw określić odpowiednie metody w wersji 1.1 w wersji 2.

Nazwy wszystkich usług i metod różnią się nieco między wersjami 1.1 i 2.

Usługi Queries i Reports w wersji 1.1 są znane jako queries i queries.reports w wersji 2.

W wersji 2 nazwy metod zostały zmienione w ten sposób:

Nazwa metody w wersji 1.1	Metoda w wersji v2
`Queries.createquery`	`queries.create`
`Queries.deletequery`	`queries.delete`
`Queries.getquery`	`queries.get`
`Queries.listqueries`	`queries.list`
`Queries.runquery`	`queries.run`
`Reports.listreports`	`queries.reports.list`

Zaktualizuj do nowych punktów końcowych

Gdy określisz równoważne metody, musisz zaktualizować żądania. Aby np. wywołać metodę queries.getquery z wersją 1.1, użyj tego adresu URL:

https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId

Aby wywołać odpowiedni sposób w wersji 2, nazywany queries.get, zaktualizuj ten adres URL:

GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId

Jeśli do przesył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 zmiany powodujące niezgodność w wersji 2. Zapoznaj się z podanymi niżej instrukcjami i wprowadź niezbędne zmiany, które będą dotyczyć Twojego korzystania z interfejsu Bid Manager API.

Zaktualizuj połączenia z usługą `queries`

Poniższe pola w zasobie Query reprezentowane przez ogólne obiekty zagnieżdżone zostały zmienione w taki sposób:

Pole v1.1	Odpowiednik typu obiektu w wersji 2
`metadata`	`QueryMetadata`
`params`	`Parameters`
`params.options`	`Options`
`params.options.pathQueryOptions`	`PathQueryOptions`
`params.options.pathQueryOptions.channelGrouping`	`ChannelGrouping`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`
`schedule`	`QuerySchedule`

Poniższe pola w zasobie Query reprezentowane przez obiekty ogólne listy zostały zmienione na listy tych nowych typów obiektów:

Pole listy w wersji 1.1	Typ obiektu w wersji 2
`params.filters[]`	`FilterPair`
`params.options.pathQueryOptions.channelGrouping.rules[]`	`Rule`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]`	`DisjunctiveMatchStatement`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]`	`EventFilter`
`params.options.pathQueryOptions.pathFilters[]`	`PathFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[]`	`EventFilter`

Poniższe pola zasobu Query, pierwotnie reprezentowane przez ciągi, są reprezentowane przez typy wyliczeniowe w wersji 2 i obejmują te zmiany:

Odpowiednik metadata.dataRange w wersji 2 używa teraz wyliczenia Range. Podczas konwertowania na tę wartość typu enum wartość PREVIOUS_HALF_MONTH została usunięta, a wartość TYPE_NOT_SUPPORTED została zmieniona na RANGE_UNSPECIFIED.
metadata.format używa teraz wyliczenia Format. W konwersjach na tę wartość wyliczono EXCEL_CSV, a wartość FORMAT_UNSPECIFIED została dodana.
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match i params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match używają teraz wyliczenia Match.
params.options.pathQueryOptions.pathFilters[].pathMatchPosition używa teraz wyliczenia PathMatchPosition. W konwersjach na tę wartość wyliczeniową dodano wartość PATH_MATCH_POSITION_UNSPECIFIED.
schedule.frequency używa teraz wyliczenia Frequency. W konwersjach na tę wartość wyliczeniową dodano wartość FREQUENCY_UNSPECIFIED.
params.type używa teraz wyliczenia ReportType. W wyniku konwersji na tę wartość typu enum wprowadzono te zmiany:
Te wartości zostały wycofane:
- TYPE_ACTIVE_GRP
- TYPE_AUDIENCE_PERFORMANCE
- TYPE_CLIENT_SAFE
- TYPE_COMSCORE_VCE
- TYPE_CROSS_FEE
- TYPE_CROSS_PARTNER
- TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
- TYPE_ESTIMATED_CONVERSION
- TYPE_FEE
- TYPE_KEYWORD
- TYPE_LINEAR_TV_SEARCH_LIFT
- TYPE_NIELSEN_AUDIENCE_PROFILE
- TYPE_NIELSEN_DAILY_REACH_BUILD
- TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
- TYPE_PAGE_CATEGORY
- TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
- TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
- TYPE_PIXEL_LOAD
- TYPE_THIRD_PARTY_DATA_PROVIDER
- TYPE_TRUEVIEW_IAR
- TYPE_VERIFICATION
- TYPE_YOUTUBE_VERTICAL

Pozostałe wartości zostały zaktualizowane tak, aby lepiej odzwierciedlały ich wartości w interfejsie użytkownika:

Wartości w wersji 1.1	Odpowiednik w formacie `ReportType`
`TYPE_NOT_SUPPORTED`	`REPORT_TYPE_UNSPECIFIED`
`TYPE_GENERAL`	`STANDARD`
`TYPE_INVENTORY_AVAILABILITY`	`INVENTORY_AVAILABILITY`
`TYPE_AUDIENCE_COMPOSITION`	`AUDIENCE_COMPOSITION`
`TYPE_ORDER_ID`	`FLOODLIGHT`
`TYPE_TRUEVIEW`	`YOUTUBE`
`TYPE_NIELSEN_SITE`	`GRP`
`TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE`	`YOUTUBE_PROGRAMMATIC_GUARANTEED`
`TYPE_REACH_AND_FREQUENCY`	`REACH`
`TYPE_REACH_AUDIENCE`	`UNIQUE_REACH_AUDIENCE`
`TYPE_PATH`	`FULL_PATH`
`TYPE_PATH_ATTRIBUTION`	`PATH_ATTRIBUTION`

Pola metadata.dataRange, reportDataStartTimeMs i reportDataEndTimeMs zostały zastąpione polami range, customStartDate i customEndDate. Nowe pola daty używają obiektów Date zamiast milisekund od Unix Epoch. Te pola zastępcze zostały przeniesione do obiektu DataRange przypisanego do pola dataRange w obiekcie QueryMetadata.
Pola schedule.startTimeMs i schedule.endTimeMs zostały zastąpione polami startDate i endDate w obiekcie QuerySchedule. Nowe pola daty używają obiektów Date zamiast milisekund od Unix Epoch.
Pola metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport i metadata.latestReportRunTimeMs zostały usunięte. Zamiast tego informacje o najnowszych raportach danego zapytania należy pobierać za pomocą metody queries.reports.list z parametrem zapytania orderBy „key.reportId desc”, który gwarantuje, że żądanie wyświetla najnowsze raporty.
Pola kind, timezoneCode, metadata.locale, params.includeInviteData i schedule.nextRunMinuteOfDay zostały usunięte.
queries.create nie tworzy już automatycznie zapytań po usunięciu, a parametr zapytania asynchronous został usunięty. Wywołaj queries.run po queries.create, aby wygenerować raporty dla nowych zapytań.
Metoda queries.run została zaktualizowana w następujący sposób:
- Parametr zapytania asynchronous został zastąpiony parametrem zapytania synchronous. Nowy parametr zapytania obsługuje logikę odwrotną. Jeśli nie zostanie podany, ma wartość Fałsz. Z tego względu queries.run domyślnie generuje raporty asynchronicznie w wersji 2 (a nie synchronicznie – w wersji 1.1).
- Treść żądania została zaktualizowana, aby usunąć pole timezoneCode i zastąpić pola dataRange, reportDataStartTimeMs, reportDataEndTimeMs obiektem DataRange przypisanym do pola dataRange.
- Metoda zwraca wynikowy obiekt Report zamiast pustej treści odpowiedzi.
Pole kind w treści odpowiedzi queries.list zostało usunięte.

Zaktualizuj połączenia z usługą `reports`

Poniższe pola w zasobie Report reprezentowane przez ogólne obiekty zagnieżdżone zostały zmienione tak, aby korzystały z tych typów obiektów:

Pole v1.1	Odpowiednik typu obiektu w wersji 2
`key`	`ReportKey`
`metadata`	`ReportMetadata`
`metadata.status`	`ReportStatus`
`params`	`Parameters`
`params.options`	`Options`
`params.options.pathQueryOptions`	`PathQueryOptions`
`params.options.pathQueryOptions.channelGrouping`	`ChannelGrouping`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`

Te pola w zasobie Report reprezentowane przez ogólne obiekty na liście zostały zmienione na listy tych nowych typów obiektów:

Pole listy w wersji 1.1	Typ obiektu w wersji 2
`params.filters[]`	`FilterPair`
`params.options.pathQueryOptions.channelGrouping.rules[]`	`Rule`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]`	`DisjunctiveMatchStatement`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]`	`EventFilter`
`params.options.pathQueryOptions.pathFilters[]`	`PathFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[]`	`EventFilter`

Poniższe pola zasobu Report pierwotnie reprezentowane przez ciągi znaków zostały zmienione, więc ich pola w wersji 2 są reprezentowane przez nowe typy wyliczeń i zawierają zmiany dotyczące dopuszczalnych wartości:
- metadata.status.format używa teraz wyliczenia Format. W konwersjach na tę wartość wyliczono EXCEL_CSV, a potem dodano wartość FORMAT_UNSPECIFIED.
- metadata.status.state używa teraz wyliczenia State. Podczas konwertowania na tę wartość wyliczeniową dodano wartości QUEUED i STATE_UNSPECIFIED.
- params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match i params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match używają teraz wyliczenia Match.
- params.options.pathQueryOptions.pathFilters[].pathMatchPosition używa teraz wyliczenia PathMatchPosition. W konwersjach na tę wartość wyliczeniową dodano wartość PATH_MATCH_POSITION_UNSPECIFIED.
- params.type używa teraz wyliczenia ReportType. W kontekście tej wartości wprowadzono wiele zmian, które znajdziesz w poprzedniej sekcji dotyczącej aktualizowania wywołań usług zapytań.
Pola metadata.reportDataStartTimeMs i metadata.reportDataEndTimeMs zostały zastąpione polami reportDataStartDate i reportDataEndDate w obiekcie ReportMetadata. Nowe pola używają obiektów Date zamiast milisekund od czasu uniksowego.
Ciąg metadata.status.finishTimeMs został zastąpiony polem finishTime w obiekcie ReportStatus. To nowe pole czasu zawiera sygnaturę czasową w formacie RFC3339 UTC "Zulu, a nie w milisekundach od czasu Unix Epoch.
Pola metadata.status.failure i params.includeInviteData zostały usunięte.
Pole kind w treści odpowiedzi reports.list zostało usunięte.

Aktualizacja logiki obsługi błędów

Komunikaty o błędach w interfejsie API zostały zaktualizowane w wersji 2. Te nowe komunikaty o błędach są bardziej szczegółowe. W niektórych przypadkach zawierają też informacje o wartościach w żądaniu API, które powodują wystąpienie błędu. Jeśli dotychczasowa logika obsługi błędów wymaga konkretnego tekstu komunikatu o błędzie, uogólnij obsługę błędów przed przejściem na wersję 2.