На этой странице представлены примечания к выпуску API Google Bid Manager.
Версия 2
Внесены структурные изменения в API, включая обновление конечной точки службы и переименование служб и методов.
Значительно обновлены ресурсы запросов и отчетов за счет удаления ненужных полей, реорганизации существующих полей и изменения типов полей. Это включает в себя изменение типов полей для использования именованных объектов вместо общего определения «вложенного объекта».
Требуется выполнять специальные запросы с использованием метода queries.run
вместо их автоматического запуска после создания.
Параметр запроса queries.run
asynchronous
на synchronous
.
Упрощен поиск отчетов за счет следующих изменений:
- Добавление метода
queries.reports.get
. - Добавление параметра запроса
orderBy
вqueries.reports.list
. - Обновление тела ответа
queries.run
с пустого объекта на экземпляр созданного ресурсаReport
.
Обновлены сообщения об ошибках, возвращаемые API, чтобы сделать их более конкретными и предоставить более предписывающие решения.
Следуйте инструкциям, представленным в Руководстве по миграции версии 2 , для перехода с версии 1.1 на версию 2.
Новые возможности
Конечная точка службы была изменена:
конечная точка службы v1 конечная точка службы v2 https://www.googleapis.com/doubleclickbidmanager
https://doubleclickbidmanager.googleapis.com
Службы переименованы следующим образом:
v1 сервис служба v2 Запросы запросы Отчеты запросы.отчеты Методы были переименованы следующим образом:
Добавлены следующие методы:
Услуга Метод(ы) запросы.отчеты получать Следующие методы имеют новое тело ответа:
Метод Новый объект тела ответа запросы.run Отчет Следующие поля были удалены:
Ресурс Поле(а) queries.list
Тело ответадобрый
queries.reports.list
Тело ответадобрый
Запрос добрый
отчетдатаендтимемс
отчетдатастарттимемс
часовой поясКод
Запустить запросрекуест отчетдатаендтимемс
отчетдатастарттимемс
часовой поясКод
Тип объекта следующих полей был изменен на следующий:
Ресурс Поле(а) Тип объекта Запрос Отчет Запустить запросрекуест Были добавлены следующие параметры запроса метода:
Метод Параметры запроса запросы.список Сортировать по запросы.reports.list Сортировать по запросы.run синхронный Следующие параметры запроса метода были удалены:
Метод Параметры запроса запросы.создать асинхронный запросы.run асинхронный Были добавлены следующие значения фильтра:
Значение фильтра FILTER_INVENTORY_MEDIA_COST_TYPE FILTER_TARGETING_EXPANSION Следующие значения фильтра были удалены:
Значение фильтра FILTER_TRUEVIEW_IAR_REGION Были добавлены следующие значения Метрики:
Значение показателя METRIC_STORE_VISIT_VIEW_THROUGH_CONVERSIONS METRIC_UNIQUE_REACH_AVERAGE_VIEWABLE_IMPRESSION_FREQUENCY METRIC_UNIQUE_REACH_IMPRESSION_REACH_ADDED_WITH_CROSS_STACK_FCAP METRIC_UNIQUE_REACH_IMPRESSION_REACH_ADDED_WITH_PG_FMGMT METRIC_UNIQUE_REACH_INCREMENTAL_CLICK_REACH METRIC_UNIQUE_REACH_INCREMENTAL_IMPRESSION_REACH METRIC_UNIQUE_REACH_INCREMENTAL_TOTAL_REACH METRIC_UNIQUE_REACH_INCREMENTAL_VIEWABLE_IMPRESSION_REACH METRIC_UNIQUE_REACH_VIEWABLE_IMPRESSION_REACH
Известные вопросы
Никто.
Версия 1.1
Фильтр «один к одному» для отображения сопоставления столбцов отчета
Фильтры, сопоставленные с несколькими столбцами отчета, теперь сопоставляются с отдельными столбцами.
Например, в версии 1 включение фильтра FILTER_ADVERTISER
дает отчет со столбцами «Рекламодатель» в дополнение к «Идентификатор рекламодателя». В версии 1.1 все столбцы отчета имеют собственные фильтры. Например, новый фильтр FILTER_ADVERTISER_NAME
соответствует «Рекламодателю». Чтобы получить в отчетах столбцы «Идентификатор рекламодателя» и «Рекламодатель», в запросы Queries.createquery
необходимо включить оба фильтра FILTER_ADVERTISER
и FILTER_ADVERTISER_NAME
соответственно.
Более конкретно, запрос createquery
:
{
...
"params": {
...
"groupBys": ["FILTER_ADVERTISER"],
"metrics": ["METRIC_IMPRESSIONS"],
...
}
...
}
генерирует файл отчета со следующими заголовками в версии 1:
Advertiser,Advertiser ID,Advertiser Status,Advertiser Integration Code,Impressions
и следующие заголовки в версии 1.1:
Advertiser,Impressions
Следующий код версии 1 используется для получения столбцов отчета в приведенном выше примере:
List<String> groupBys = new ArrayList<>();
groupBys.add("FILTER_ADVERTISER");
List<String> metrics = new ArrayList<>();
metrics.add("METRIC_IMPRESSIONS");
com.google.api.services.doubleclickbidmanager.model.Parameters createQueryParameters =
new com.google.api.services.doubleclickbidmanager.model.Parameters()
.setGroupBys(groupBys)
.setMetrics(metrics);
необходимо будет изменить аналогично следующему в версии 1.1 (примечание о порядке фильтров):
List<String> groupBys = new ArrayList<>();
groupBys.add("FILTER_ADVERTISER_NAME");
groupBys.add("FILTER_ADVERTISER");
groupBys.add("FILTER_ADVERTISER_INTEGRATION_STATUS");
groupBys.add("FILTER_ADVERTISER_INTEGRATION_CODE");
List<String> metrics = new ArrayList<>();
metrics.add("METRIC_IMPRESSIONS");
com.google.api.services.doubleclickbidmanager.model.Parameters createQueryParameters =
new com.google.api.services.doubleclickbidmanager.model.Parameters()
.setGroupBys(groupBys)
.setMetrics(metrics);
Оригинальный фильтр | Добавлены фильтры |
---|---|
FILTER_ADVERTISER | FILTER_ADVERTISER_NAME FILTER_ADVERTISER_INTEGRATION_CODE FILTER_ADVERTISER_INTEGRATION_STATUS |
FILTER_AD_POSITION | FILTER_AD_POSITION_NAME |
FILTER_CARRIER | FILTER_CARRIER_NAME |
FILTER_CHANNEL_ID | FILTER_CHANNEL_NAME |
FILTER_CITY | FILTER_CITY_NAME |
FILTER_COMPANION_CREATIVE_ID | FILTER_COMPANION_CREATIVE_NAME |
FILTER_DMA | FILTER_DMA_NAME |
FILTER_INSERTION_ORDER | FILTER_INSERTION_ORDER_NAME |
FILTER_PARTNER | FILTER_PARTNER_NAME FILTER_PARTNER_STATUS |
FILTER_REGION | FILTER_REGION_NAME |
FILTER_TRUEVIEW_DMA | FILTER_TRUEVIEW_DMA_NAME |
FILTER_TRUEVIEW_IAR_REGION | FILTER_TRUEVIEW_IAR_REGION_NAME |
FILTER_USER_LIST_FIRST_PARTY | FILTER_USER_LIST_FIRST_PARTY_NAME |
FILTER_USER_LIST_THIRD_PARTY | FILTER_USER_LIST_THIRD_PARTY_NAME |
Пагинация
Версия 1.1 добавляет нумерацию страниц в методы Queries.listqueries
и Reports.listreports
.
В версии 1.1 количество результатов, возвращаемых этими методами, равно недавно добавленному параметру pageSize
(по умолчанию оно равно 100
, если не указано иное). Ответы содержат недавно добавленное поле nextPageToken
, которое можно использовать для получения следующего набора результатов. Это поле пустое, если результаты исчерпаны.
Следующий код версии 1 для получения всех отчетов, принадлежащих определенному запросу:
public class GetReports {
public List<Report> getReports(DoubleClickBidManager service, long queryId) throws IOException {
ListReportsResponse reportListResponse = service.reports().listreports(queryId).execute();
return reportListResponse.getReports();
}
}
необходимо будет изменить аналогично следующему в версии 1.1, чтобы продолжить получение всех отчетов:
public class GetReports {
public List<Report> getReports(DoubleClickBidManager service, long queryId) throws IOException {
ListReportsResponse reportListResponse = service.reports().listreports(queryId).execute();
List<Report> reports = new ArrayList<>(reportListResponse.getReports());
while (reportListResponse.getNextPageToken() != null
&& reportListResponse.getNextPageToken().length() > 0) {
// Get next set of results, aka page.
reportListResponse =
service
.reports()
.listreports(queryId)
.setPageToken(reportListResponse.getNextPageToken())
.execute();
reports.addAll(reportListResponse.getReports());
}
return reports;
}
}
Дополнительные сведения см. в документации по методам Queries.listqueries
и Reports.listreports
.
Известные вопросы
Никто.
Версия 1
Это начальная версия API.
Известные вопросы
Никто.