В Search Ads 360 Reporting API есть единый механизм получения атрибутов и создания отчетов по показателям, который позволяет создавать запросы с помощью языка запросов Поисковой рекламы 360. Это позволяет выполнять сложные запросы, которые могут возвращать большие объемы данных об отдельных аккаунтах Поисковой рекламы 360.
Запросы можно создавать с помощью методов Search или SearchStream.
Оба метода поддерживают одни и те же запросы и возвращают одинаковые результаты. Метод Search возвращает данные в настраиваемых размерах страниц, что позволяет выполнять итерацию по набору результатов с помощью разбивки на страницы. Это может быть полезно при низкой пропускной способности или ненадежном сетевом подключении, например, для сегментирования большого набора результатов на более мелкие ответы, которые можно повторно получить в случае потери соединения. Метод SearchStream, напротив, передает весь набор результатов в одном ответе, что может быть более эффективным для массового извлечения данных.
У Search и SearchStream один и тот же базовый URL:
https://searchAds360.googleapis.com/v0/customers/CUSTOMER_ID/searchAds360
Метод поиска на основе страниц принимает необязательный параметр pageSize, который ограничивает количество результатов, возвращаемых в одном ответе API.
POST /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1 Host: searchAds360.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN { "pageSize": 10000, "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'" }
Если в результатах больше строк, чем указано в параметре pageSize, в ответе возвращается nextPageToken:
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
Повторение того же запроса с добавлением pageToken со значением выше позволяет получить следующую страницу результатов:
POST /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1 Host: searchads360.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN { "pageSize": 10000, "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'", "pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B" }
Чтобы использовать метод SearchStream, который возвращает все результаты в одном потоковом ответе, просто измените метод сервиса в URL на searchStream (для SearchStream не требуются pageSize и pageToken):
POST /v0/customers/CUSTOMER_ID/searchAds360:searchStream HTTP/1.1 Host: searchads360.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN { "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'" }