Interfejs Search Ads 360 Reporting API ma ujednolicony mechanizm pobierania atrybutów i raportowania danych, który umożliwia tworzenie zapytań za pomocą języka zapytań Search Ads 360. Umożliwia to obsługę złożonych zapytań, które mogą zwracać duże ilości danych o poszczególnych kontach Search Ads 360.
Zapytania możesz tworzyć, korzystając z jednej z metod Search
lub SearchStream
.
Obie metody obsługują te same zapytania i zwracają równoważne wyniki. Metoda Search
zwraca dane w niestandardowych rozmiarach stron, co umożliwia powtórzenie zbioru wyników z wykorzystaniem podziału na strony. Może to być przydatne przy niskiej przepustowości lub niestabilnych warunkach sieciowych, np. gdy chcesz podzielić duży wynik na mniejsze odpowiedzi, które mogą być ponownie pobrane w przypadku utraty połączenia. Z kolei metoda SearchStream
przesyła strumieniowo cały zestaw wyników w jednej odpowiedzi, co może być skuteczniejsze w przypadku zbiorczego pobierania danych.
Zarówno Search
, jak i SearchStream
używają tego samego podstawowego adresu URL:
https://searchAds360.googleapis.com/v0/customers/CUSTOMER_ID/searchAds360
Metoda wyszukiwania na podstawie stron przyjmuje opcjonalny parametr pageSize
, który ogranicza liczbę wyników zwracanych w pojedynczej odpowiedzi interfejsu 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'" }
Jeśli w wynikach jest więcej wierszy niż pageSize
, w odpowiedzi zwracany jest błąd nextPageToken
:
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
Powtórzenie tego samego zapytania z dodanym parametrem pageToken
o wartości powyżej spowoduje pobranie następnej strony z wynikami:
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" }
Aby użyć metody SearchStream
, która zwraca wszystkie wyniki w pojedynczej, strumieniowej odpowiedzi, zmień metodę usługi w adresie URL na searchStream
(SearchStream
nie wymagają pageSize
i 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'" }