Pierwsze kroki z interfejsem Search Ads 360 Reporting API

W następnych sekcjach znajdziesz informacje o tym, jak zacząć korzystać z Search Ads 360 Reporting API.

Konfigurowanie projektu w Google Cloud

Aby korzystać z interfejsu Search Ads 360 Reporting API, musisz utworzyć projekt aplikacji w Google Cloud.

Tworzenie projektu Google

Projekt Google pełni funkcję kontenera zasobów dla Twoich zasobów Google Cloud.

  1. Go to the Google API Console.
  2. Kliknij Utwórz projekt .
  3. Wpisz nazwę lub zaakceptuj wygenerowaną sugestię.
  4. Potwierdź lub edytuj pozostałe pola.
  5. Kliknij Utwórz .

Tworzenie danych logowania OAuth2

Interfejs Search Ads 360 Reporting API używa protokołu OAuth 2.0 do uwierzytelniania i autoryzacji. Dane uwierzytelniające OAuth umożliwiają Google identyfikację Twojej aplikacji i generowanie tokenów OAuth na potrzeby zarządzania użytkownikami Search Ads 360.

Aby utworzyć poświadczenie OAuth 2.0 w Google API Console , wykonaj następujące czynności:

  1. Go to the Credentials page.
  2. Kliknij Utwórz dane logowania> Identyfikator klienta OAuth
  3. Wybierz typ aplikacji.
  4. Wypełnij formularz i kliknij Utwórz .

Włączanie interfejsu Search Ads 360 Reporting API

Aby korzystać z interfejsu API, musisz włączyć Search Ads 360 Reporting API w projekcie w Konsoli interfejsów API Google.

Aby włączyć interfejs API dla swojego projektu:

  1. Open the API Library w Google API Console .
  2. If prompted, select a project, or create a new one. API Library zawiera listę wszystkich dostępnych interfejsów API, pogrupowanych według rodziny produktów i popularności.
  3. Jeśli API, które chcesz włączyć, nie jest widoczne na liście, użyj funkcji wyszukiwania, aby go znaleźć, lub kliknij opcję Wyświetl wszystko w rodzinie produktów, do której należy.
  4. Wybierz interfejs API, który chcesz włączyć, a następnie kliknij przycisk Włącz .
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

Opcjonalnie włącz płatności w projekcie

Korzystanie z interfejsu Search Ads 360 Reporting API w Google Cloud jest bezpłatne. W przypadku każdego konta obowiązuje jednak limit dotyczący łącznej liczby bezpłatnych projektów Cloud. Jeśli limit został osiągnięty, możesz utworzyć nowe konto Google, które będzie zawierać limit bezpłatnych projektów.

Aby włączyć płatności za swój projekt:

  1. Odwiedź Billing page .
  2. Jeśli nie masz aktywnego konta rozliczeniowego, utwórz je, klikając Dodaj konto rozliczeniowe i postępując zgodnie z instrukcjami.

Aby włączyć ekran akceptacji projektu:

  1. Otwórz Consent Screen page w Google API Console .
  2. If prompted, select a project, or create a new one.
  3. Wypełnij formularz i kliknij Zapisz .

Tworzenie, edytowanie i wyświetlanie identyfikatorów URI przekierowania

Aby utworzyć, wyświetlić lub edytować identyfikatory URI przekierowania dla danego poświadczenia OAuth 2.0, wykonaj następujące czynności:

  1. Go to the Credentials page.
  2. W sekcji identyfikatorów klientów OAuth 2.0 na stronie kliknij poświadczenie.
  3. Wyświetl lub edytuj identyfikatory URI przekierowania.

Jeśli na stronie Poświadczenia nie ma sekcji identyfikatorów klientów OAuth 2.0 , Twój projekt nie ma poświadczeń OAuth. Aby je utworzyć, kliknij Utwórz dane logowania .

Pobieranie biblioteki klienta

Zalecane jest używanie biblioteki klienta Search Ads 360 Reporting API do nawiązywania połączenia z tym interfejsem.

Pobierz bibliotekę klienta Search Ads 360 Reporting API do środowiska programistycznego. Postępuj zgodnie z instrukcjami dotyczącymi danego języka, aby skonfigurować plik konfiguracji biblioteki klienta. W większości przypadków podczas przechodzenia na nową bibliotekę klienta Search Ads 360 Reporting API możesz ponownie użyć dotychczasowej konfiguracji.

Jedną z ważnych zmian jest nowy nagłówek login-customer-id. Szczegółowe informacje o tym, kiedy należy dodać ten nagłówek do konfiguracji, znajdziesz w sekcji Nagłówek Login customer ID.

Pierwsze połączenie

Po skonfigurowaniu biblioteki klienta możesz wykonać pierwsze wywołanie.

Pobieranie kampanii

W swoim środowisku IDE uruchom ten kod:

Java

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package sample;

import com.beust.jcommander.Parameter;
import com.google.ads.searchads360.v0.lib.SearchAds360Client;
import com.google.ads.searchads360.v0.services.SearchAds360Row;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;
import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;

/** Get campaign details. */
public class GetCampaigns {
  private static final int PAGE_SIZE = 200;

  private static class GetCampaignsParams extends CodeSampleParams {

    @Parameter(names = "--customerId", required = true)
    private String customerId;

    @Parameter(names = "--loginCustomerId")
    private String loginCustomerId;
  }

  public static void main(String[] args) {
    GetCampaignsParams params = new GetCampaignsParams();
    if (!params.parseArguments(args)) {
      // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
      // here (10 digits, no dashes). If neither are set, customerId will be used as
      // loginCustomerId.
      // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
    }
    final String loginCustomerId = params.loginCustomerId;
    final String customerId = params.customerId;

    try {
      // Creates a SearchAds360Client with the specified loginCustomerId. If there's
      // no loginCustomerId, customerId will be used instead.
      final SearchAds360Client searchAds360Client =
          SearchAds360Client.newBuilder()
              .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
              .fromPropertiesFile()
              .build();
      // Creates the Search Ads 360 Service client.
      SearchAds360ServiceClient client = searchAds360Client.create();
      new GetCampaigns().runExample(client, customerId);
    } catch (Exception exception) {
      System.err.printf("Failed with exception: %s%n", exception);
      exception.printStackTrace();
      System.exit(1);
    }
  }

  private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
    // Creates a query that retrieves all campaigns under the customerId.
    String query = "SELECT campaign.name, campaign.id, campaign.status FROM campaign";
    SearchSearchAds360Request request =
        SearchSearchAds360Request.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .setPageSize(PAGE_SIZE)
            .build();

    // Issues a search request.
    final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
    for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
      System.out.printf(
          "Campaign found with name '%s', ID %d, and status: %s.%n",
          element.getCampaign().getName(),
          element.getCampaign().getId(),
          element.getCampaign().getStatus());
    }
  }
}

Pobierz GetCampaigns.java

Python

#!/usr/bin/env python
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Retrieves campaigns for a customer using a pagination search request."""

import argparse
import traceback
from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360Request
from util_searchads360 import SearchAds360Client

_DEFAULT_PAGE_SIZE = 10000


def main(client, customer_id, page_size) -> None:
  search_ads_360_service = client.get_service()

  query = """
      SELECT
        campaign.name,
        campaign.id,
        campaign.status
      FROM campaign"""

  request = SearchSearchAds360Request()
  request.customer_id = customer_id
  request.query = query
  request.page_size = page_size

  # Issues a search request.
  results = search_ads_360_service.search(request=request)

  for row in results:
    campaign = row.campaign
    print(
        f'campaign "{campaign.name}" has id {campaign.id} and status {campaign.status.name}'
    )


if __name__ == "__main__":
  # SearchAds360Client will read the search-ads-360.yaml configuration file in
  # the home directory if none is specified.
  search_ads_360_client = SearchAds360Client.load_from_file()

  parser = argparse.ArgumentParser(
      description=("Retrieves campaigns for a customer."))
  # Arguments to provide to run the example.
  parser.add_argument(
      "-c",
      "--customer_id",
      type=str,
      required=True,
      help="The Search Ads 360 customer ID (10 digits, no dashes).",
  )

  parser.add_argument(
      "-l",
      "--login_customer_id",
      type=str,
      required=False,
      help="The Search Ads 360 login customer ID (10 digits, no dashes).",
  )

  args = parser.parse_args()

  search_ads_360_client.set_ids(args.customer_id, args.login_customer_id)

  try:
    main(search_ads_360_client, args.customer_id, _DEFAULT_PAGE_SIZE)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

Pobierz get_campaigns.py

Konsola powinna wydrukować listę kampanii na Twoim koncie.

Używanie interfejsu REST

Jeśli zdecydujesz się nie używać biblioteki klienta, musisz wiedzieć, jak korzystać z protokołu REST.

Jeśli używasz interfejsu REST w starej wersji Search Ads 360 API, Twoje dane logowania będą nadal działać z nowym interfejsem Search Ads 360 Reporting API. Nowy punkt końcowy i inne informacje znajdziesz w sekcji dotyczącej interfejsu REST.

Więcej informacji

Więcej informacji o interfejsie Search Ads 360 Reporting API