API Google Ads предоставляет унифицированный механизм получения атрибутов и отчётности по метрикам , позволяющий создавать запросы на языке запросов Google Ads . Это позволяет создавать сложные запросы, возвращающие большие объёмы данных об отдельных аккаунтах Google Ads.
Вы можете создавать запросы, используя методы Search
и SearchStream
. Оба метода поддерживают одни и те же запросы и возвращают эквивалентные результаты. Метод Search
возвращает данные страницами фиксированного размера по 10 000 строк, что позволяет итерировать набор результатов с помощью пагинации. Это может быть полезно в условиях низкой пропускной способности или ненадежной сети, например, для сегментации большого набора результатов на более мелкие ответы, которые можно повторно загрузить в случае потери соединения. Метод SearchStream
, с другой стороны, возвращает весь набор результатов в виде одного ответа, что может быть более эффективно при массовом извлечении данных.
Search
и SearchStream
используют один и тот же базовый URL:
https://googleads.googleapis.com/v21/customers/CUSTOMER_ID/googleAds
POST /v21/customers/CUSTOMER_ID/googleAds:search HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_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'" }
Если в результатах содержится более 10 000 строк, в ответе возвращается nextPageToken
:
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
Повтор того же запроса с pageToken
, добавленным со значениями из предыдущего запроса, извлекает следующую страницу результатов:
POST /v21/customers/CUSTOMER_ID/googleAds:search HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_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'", "pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B" }
Чтобы использовать метод SearchStream
, который возвращает все результаты в одном потоковом ответе, измените метод службы в URL-адресе на searchStream
( pageToken
не требуется для SearchStream
):
POST /v21/customers/CUSTOMER_ID/googleAds:searchStream HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_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'" }