이전 체크리스트

  1. 이전 Search Ads 360 API에서 새 Search Ads 360 Reporting API로의 매핑을 검토합니다.

  2. Google Cloud 프로젝트에서 Search Ads Reporting 360 API를 사용 설정합니다.

    • Google API 콘솔에서 API 라이브러리를 엽니다. 메시지가 표시되면 프로젝트를 선택하거나 새 프로젝트를 만듭니다. API 라이브러리에는 사용 가능한 모든 API가 제품군과 인기도를 기준으로 분류되어 있습니다.
    • 목록에 표시되지 않는 경우 검색을 사용하여 Search Ads 360 Reporting API를 찾습니다.
    • Search Ads 360 Reporting API를 선택하고 사용 설정을 클릭합니다.

  3. 클라이언트 라이브러리를 선택합니다.

  4. 첫 번째 통화를 합니다.

클라이언트 라이브러리 사용

Search Ads 360 Reporting API 클라이언트 라이브러리를 사용하는 것이 Search Ads 360 Reporting API에 연결하는 권장 방법입니다.

개발 환경에 맞는 Search Ads 360 Reporting API 클라이언트 라이브러리를 다운로드합니다. 클라이언트 라이브러리 구성 파일을 설정하는 방법에 관한 언어별 안내를 따릅니다. 대부분의 경우 새 Search Ads 360 Reporting API 클라이언트 라이브러리로 이전할 때 기존 구성을 재사용할 수 있습니다.

중요한 변경사항 중 하나는 새 login-customer-id 헤더입니다. 구성에 이 헤더를 추가해야 하는 경우는 로그인 고객 ID 헤더를 참고하세요.

Java 구성 예

이 예에서는 인증 속성의 doubleclicksearch를 searchads360로 대체하여 Java 클라이언트 라이브러리의 searchads360.properties 파일을 업데이트하는 방법을 보여줍니다.

api.doubleclicksearch.clientId       -> api.searchads360.clientId
api.doubleclicksearch.clientSecret   -> api.searchads360.clientSecret
api.doubleclicksearch.refreshToken   -> api.searchads360.refreshToken

첫 통화하기

구성 파일을 업데이트한 후에는 첫 번째 호출을 실행할 수 있습니다.

캠페인 가져오기

IDE에서 다음 코드를 실행합니다.

자바

// 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 사용 방법을 알아야 합니다.

이전 Search Ads 360 API에서 REST를 사용했다면 새 Search Ads 360 Reporting API에서도 사용자 인증 정보가 계속 작동합니다. REST 참조 섹션에서 새 엔드포인트 및 기타 세부정보를 확인하세요.

자세히 알아보기

Search Ads 360 Reporting API에 대해 자세히 알아보세요.