Эта страница переведена с помощью Cloud Translation API.

Переход с Bid Manager API версии 1.1 на версию 2.

В марте 2022 года мы выпустили вторую версию Bid Manager API. Учитывая выпуск этой новой версии, мы планируем вскоре объявить дату прекращения поддержки версии 1.1. Мы рекомендуем вам начать миграцию с версии 1.1 на версию 2 как можно скорее.

Перенесите свое приложение

Для перехода с версии 1.1 на версию 2 необходимо обновить URL-адреса конечных точек для вызова версии 2 и обновить приложение для учета критических изменений.

Обновите вызовы API с версии 1.1 до версии 2.

Чтобы использовать версию 2 вместо версии 1.1, вам необходимо обновить свои запросы для использования новых конечных точек версии 2.

Определите эквивалентные методы

Чтобы обновить вызовы API с версии 1.1 на версию 2, сначала необходимо определить эквивалентные методы версии 1.1 в версии 2.

Следующие имена всех служб и методов немного изменились между версией 1.1 и версией 2:

Queries и Reports служб в версии 1.1 известны как queries и queries.reports в версии 2.

В версии 2 методы были переименованы следующим образом:

имя метода v1.1	Эквивалентный метод 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`

Обновление до новых конечных точек

После того как вы определили эквивалентные методы, вам необходимо обновить свои запросы. Например, чтобы вызвать метод queries.getquery в версии 1.1, вы должны использовать следующий URL-адрес:

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

Чтобы вызвать эквивалентный метод в версии 2, известный как queries.get , обновите URL-адрес следующим образом:

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

Если вы используете клиентскую библиотеку для отправки запросов к API, используйте самую последнюю версию клиентской библиотеки и обновите свою конфигурацию, чтобы использовать v2.

Внесите необходимые изменения

Мы вносим ряд серьезных изменений в v2. Прочтите следующие инструкции и внесите необходимые изменения, соответствующие вашему текущему использованию Bid Manager API.

Обновление вызовов в службу `queries`

Следующие поля в ресурсе Query , первоначально представленные общими вложенными объектами, были изменены и теперь используют следующие типы объектов:

поле v1.1	Эквивалентный тип объекта v2
`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`

Следующие поля в ресурсе Query , первоначально представленные объектами общего списка, изменились и стали списками следующих новых типов объектов:

поле списка v1.1	тип объекта v2
`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`

Следующие поля в ресурсе Query , первоначально представленные строками, в версии 2 представлены перечислимыми типами и включают следующие изменения:

Эквивалент metadata.dataRange версии 2 теперь использует перечисление Range . При преобразовании в это перечисление значение PREVIOUS_HALF_MONTH было удалено, а значение TYPE_NOT_SUPPORTED было изменено на RANGE_UNSPECIFIED .
metadata.format теперь использует перечисление Format . При преобразовании в это перечисление значение EXCEL_CSV было удалено и добавлено значение FORMAT_UNSPECIFIED .
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match и params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match теперь используют перечисление Match .
params.options.pathQueryOptions.pathFilters[].pathMatchPosition теперь использует перечисление PathMatchPosition . При преобразовании в это перечисление было добавлено значение PATH_MATCH_POSITION_UNSPECIFIED .
schedule.frequency теперь использует перечисление Frequency . При преобразовании в это перечисление было добавлено значение FREQUENCY_UNSPECIFIED .
params.type теперь использует перечисление ReportType . При преобразовании в это перечисление были внесены следующие изменения:
Следующие значения устарели:
- 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

Остальные значения были обновлены, чтобы лучше отражать их эквивалентные значения в пользовательском интерфейсе:

значения версии 1.1	Эквивалентное значение `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`

Поля metadata.dataRange , reportDataStartTimeMs и reportDataEndTimeMs были заменены полями range , customStartDate и customEndDate . В новых полях даты используются объекты Date вместо миллисекунд, начиная с эпохи Unix. Эти поля замены были перемещены в объект DataRange , назначенный полю dataRange в объекте QueryMetadata .
Поля schedule.startTimeMs и schedule.endTimeMs заменены полями startDate и endDate в объекте QuerySchedule . В новых полях даты используются объекты Date вместо миллисекунд, начиная с эпохи Unix.
Поля metadata.running , metadata.reportCount , metadata.googleCloudStoragePathForLatestReport , metadata.googleDrivePathForLatestReport и metadata.latestReportRunTimeMs были удалены. Вместо этого информацию о последних созданных отчетах запроса следует получать с помощью метода queries.reports.list с параметром запроса orderBy «key.reportId desc», чтобы гарантировать, что в запросе сначала будут перечислены самые последние отчеты.
Поля kind , timezoneCode , metadata.locale , params.includeInviteData и schedule.nextRunMinuteOfDay были удалены.
queries.create больше не запускает автоматически запросы после создания, а параметр asynchronous запроса был удален. Вызовите queries.run после queries.create , чтобы создать отчеты для новых запросов.
Метод queries.run был обновлен следующим образом:
- Параметр asynchronous запроса был заменен параметром synchronous запроса. Новый параметр запроса работает с обратной логикой и считается ложным, если не указан. Учитывая это, queries.run по умолчанию генерирует отчеты асинхронно в версии 2, а не синхронно, что используется по умолчанию в версии 1.1.
- Тело запроса было обновлено: было удалено поле timezoneCode и заменены поля dataRange , reportDataStartTimeMs , reportDataEndTimeMs объектом DataRange , назначенным полю dataRange .
- Метод возвращает результирующий объект Report вместо пустого тела ответа.
kind в теле ответа queries.list было удалено.

Обновление обращений в службу `reports`

Следующие поля в ресурсе Report , первоначально представленные общими вложенными объектами, были изменены и теперь используют следующие типы объектов:

поле v1.1	Эквивалентный тип объекта v2
`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`

Следующие поля в ресурсе Report , первоначально представленные объектами общего списка, изменились и теперь представляют собой списки следующих новых типов объектов:

поле списка v1.1	тип объекта v2
`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`

Следующие поля в ресурсе Report , первоначально представленные строками, были изменены, поэтому их эквивалентные поля в версии 2 представлены новыми типами перечислений и включают изменения допустимых значений:
- metadata.status.format теперь использует перечисление Format . При преобразовании в это перечисление значение EXCEL_CSV было удалено и добавлено FORMAT_UNSPECIFIED .
- metadata.status.state теперь использует перечисление State . При преобразовании в это перечисление были добавлены значения QUEUED и STATE_UNSPECIFIED .
- params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match и params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match теперь используют перечисление Match .
- params.options.pathQueryOptions.pathFilters[].pathMatchPosition теперь использует перечисление PathMatchPosition . При преобразовании в это перечисление было добавлено значение PATH_MATCH_POSITION_UNSPECIFIED .
- params.type теперь использует перечисление ReportType . При преобразовании в это перечисление были внесены многочисленные изменения, которые подробно перечислены в предыдущем разделе, посвященном обновлению вызовов службы запросов.
Поля metadata.reportDataStartTimeMs и metadata.reportDataEndTimeMs были заменены полями reportDataStartDate и reportDataEndDate в объекте ReportMetadata . В новых полях используются объекты Date вместо миллисекунд, начиная с эпохи Unix.
metadata.status.finishTimeMs заменено полем finishTime в объекте ReportStatus . Это новое поле времени представляет дату и время в виде метки времени в формате RFC3339 UTC «Zulu», а не в миллисекундах, как в эпоху Unix.
Поля metadata.status.failure и params.includeInviteData были удалены.
kind вида в теле ответа reports.list было удалено.

Обновить логику обработки ошибок

Сообщения об ошибках в API были обновлены в версии 2. Эти новые сообщения об ошибках более конкретны и в некоторых случаях предоставляют информацию о значениях в запросе API, из-за которых возвращается ошибка. Если существующая логика обработки ошибок основана на конкретном тексте сообщения об ошибке, обобщите обработку ошибок перед переходом на версию 2.