Начните работу с API отчетов Search Ads 360

В следующих разделах описано, как начать работу с API отчетов Search Ads 360.

Разместите свой проект в Google Cloud.

Для использования API отчетов Search Ads 360 необходимо создать проект для вашего приложения в Google Cloud.

Создайте проект Google

Проект Google служит контейнером ресурсов для ваших ресурсов Google Cloud.

  1. Перейдите в консоль Google API .
  2. Нажмите «Создать проект» .
  3. Введите имя или примите предложенное имя.
  4. Подтвердите или отредактируйте оставшиеся поля.
  5. Нажмите «Создать» .

Создание учетных данных OAuth2

API для создания отчетов Search Ads 360 использует OAuth 2.0 для аутентификации и авторизации. Учетные данные OAuth идентифицируют ваше приложение для Google и позволяют генерировать токены OAuth для управления пользователями Search Ads 360.

Для создания учетных данных OAuth 2.0 в консоли Google API выполните следующие действия:

  1. Перейдите на страницу «Клиенты» .
  2. Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth».
  3. Выберите тип приложения.
  4. Заполните форму и нажмите «Создать» .

Включите API отчетов Search Ads 360.

Для использования API необходимо включить API отчетов Search Ads 360 для вашего проекта в консоли Google API.

Чтобы включить API для вашего проекта:

  1. Откройте библиотеку API в консоли Google API.
  2. При появлении запроса выберите проект или создайте новый. В библиотеке API перечислены все доступные API, сгруппированные по семействам продуктов и популярности.
  3. Если нужный вам API отсутствует в списке, воспользуйтесь поиском, чтобы найти его, или нажмите «Показать все» в разделе, к которому он относится.
  4. Выберите API, который хотите включить, затем нажмите кнопку «Включить» .
  5. При появлении запроса включите оплату.
  6. При появлении запроса ознакомьтесь с условиями использования API и примите их.

При желании включите выставление счетов за ваш проект.

Использование API Search Ads 360 Reporting в Google Cloud бесплатно. Однако существует квота на общее количество бесплатных проектов Cloud для каждого аккаунта. Если вы достигли лимита, вы можете зарегистрировать новый аккаунт Google, который будет включать квоту на бесплатные проекты.

Чтобы включить выставление счетов за ваш проект:

  1. Перейдите на страницу «Оплата» .
  2. Если у вас нет активного платежного аккаунта, создайте его, нажав кнопку «Добавить платежный аккаунт» и следуя инструкциям.

Чтобы включить экран согласия для вашего проекта:

  1. Откройте страницу «Брендинг» в консоли Google Cloud.
  2. При появлении запроса выберите проект или создайте новый.
  3. Заполните форму и нажмите «Сохранить» .

Создавайте, редактируйте или просматривайте URI перенаправления.

Чтобы создать, просмотреть или отредактировать URI перенаправления для заданных учетных данных OAuth 2.0, выполните следующие действия:

  1. Перейдите на страницу «Клиенты» .
  2. Нажмите на клиента.
  3. Просмотреть или отредактировать URI перенаправления.

Если на странице «Клиенты» нет указанного клиента, значит, у вашего проекта отсутствуют учетные данные OAuth. Чтобы создать их, нажмите «Создать клиента» .

Загрузите клиентскую библиотеку

Рекомендуемый способ подключения к API отчетов Search Ads 360 — использование клиентской библиотеки.

Загрузите клиентскую библиотеку API для отчетов Search Ads 360 для вашей среды разработки. Следуйте инструкциям для конкретного языка программирования по настройке файла конфигурации клиентской библиотеки . В большинстве случаев вы можете повторно использовать существующую конфигурацию при миграции на новую клиентскую библиотеку API для отчетов Search Ads 360.

Одно из важных изменений — это новый заголовок login-customer-id . Подробнее о том, когда необходимо добавить этот заголовок в конфигурацию, см. в разделе «Заголовок идентификатора клиента при входе в систему» .

Сделайте свой первый звонок

После настройки клиентской библиотеки вы можете совершить свой первый звонок.

Получить кампании

В вашей IDE выполните следующий код:

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());
    }
  }
}

Скачать 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()

Скачайте файл get_campaigns.py

В консоли должен отобразиться список кампаний в вашем аккаунте.

Используйте REST

Если вы решите не использовать клиентскую библиотеку, вам необходимо понимать, как работать с REST.

Если вы использовали REST со старым API Search Ads 360, ваши учетные данные по-прежнему будут работать с новым API отчетов Search Ads 360. Новую конечную точку и другие подробности можно найти в разделе справочника по REST .

Узнать больше

Узнайте больше об API отчетов Search Ads 360.