Interfejs Search Ads 360 Reporting API zawiera 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 tworzenie 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ą metod Search lub SearchStream.
Obie metody obsługują te same zapytania i zwracają te same wyniki. Metoda Search zwraca dane w spersonalizowanych rozmiarach stron, co umożliwia iterowanie nad zbiorem wyników za pomocą podziału na strony. Może to być przydatne w przypadku niskiej przepustowości lub niestabilnego połączenia sieciowego, np. gdy chcesz podzielić duży zbiór wyników na mniejsze odpowiedzi, które można pobrać ponownie w przypadku utraty połączenia. Z kolei metoda SearchStream przesyła cały zbiór wyników w jednej odpowiedzi, co może być bardziej wydajne w przypadku pobierania dużej 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 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 element nextPageToken:
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
Powtórzenie tego samego zapytania z dodaną wartością pageToken spowoduje wyświetlenie 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 pojedynczej odpowiedzi przesyłanej strumieniowo, wystarczy zmienić metodę usługi w adresie URL na searchStream (pageSize i pageToken nie są wymagane przez 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'" }