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 wykonywanie złożonych zapytań, które mogą zwracać duże ilości danych o poszczególnych kontach Search Ads 360.
Zapytania możesz tworzyć za pomocą metody Search lub SearchStream.
Obie metody obsługują te same zapytania i zwracają równoważne wyniki. Metoda
Search zwraca dane w postaci stron o rozmiarach, które można dostosowywać, co umożliwia iterowanie po zbiorze wyników za pomocą paginacji. Może to być korzystne w przypadku niskiej przepustowości lub niestabilnej sieci, np. do dzielenia dużego zbioru wyników na mniejsze odpowiedzi, które można ponownie pobrać w razie utraty połączenia. Metoda
SearchStream przesyła z kolei cały zestaw wyników w jednej odpowiedzi, co może być bardziej wydajne w przypadku pobierania dużych ilości 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 strony przyjmuje opcjonalny parametr pageSize, który ogranicza liczbę wyników zwracanych w jednej 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 wyników jest więcej niż pageSize, w odpowiedzi zwracana jest wartość nextPageToken:
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
Powtórzenie tego samego zapytania z dodanym parametrem pageToken o wartości podanej powyżej spowoduje pobranie następnej strony wyników:
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 jednej przesyłanej strumieniowo odpowiedzi, po prostu zmień metodę usługi w adresie URL na searchStream (parametry pageSize i pageToken nie są wymagane przez metodę 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'" }