Wyszukiwarka i SearchStream

Film: raportowanie

Interfejs Google Ads API ma ujednolicony mechanizm pobierania atrybutów i raportowania danych, który umożliwia tworzenie zapytań za pomocą języka zapytań Google Ads. Umożliwia to wykonywanie złożonych zapytań, które mogą zwracać duże ilości danych o poszczególnych kontach Google Ads.

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 na stronach o stałym rozmiarze (10 tys. wierszy), co umożliwia iterację po zbiorze wyników za pomocą paginacji. Może to być korzystne w przypadku małej 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://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'"
}

Jeśli wyniki zawierają więcej niż 10 tys. wierszy,w odpowiedzi zwracany jest znak nextPageToken:

{
  "results": [
    // ...
    // ...
    // ...
  ],
  "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B",
  "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status"
}

Powtórzenie tego samego zapytania z parametrem pageToken dodanym z wartościami z poprzedniego żądania spowoduje pobranie następnej strony wyników:

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"
}

Aby użyć metody SearchStream, która zwraca wszystkie wyniki w jednej przesyłanej strumieniowo odpowiedzi, zmień metodę usługi w adresie URL na searchStream (pageToken nie jest wymagane przez 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'"
}