API отчётности Search Ads 360 предоставляет унифицированный механизм извлечения атрибутов и отчётности по метрикам , позволяющий создавать запросы с использованием языка запросов Search Ads 360. Это позволяет создавать сложные запросы, которые могут возвращать большие объёмы данных об отдельных аккаунтах Search Ads 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 ( pageSize и pageToken не требуются для SearchStream ):
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'" }