Search Ads 360 Reporting API 시작하기

다음 섹션에서는 Search Ads 360 Reporting API를 시작하는 방법을 설명합니다.

Google Cloud에서 프로젝트 설정

Search Ads 360 Reporting API를 사용하려면 Google Cloud에서 애플리케이션의 프로젝트를 만들어야 합니다.

Google 프로젝트 만들기

Google 프로젝트는 Google Cloud 리소스의 리소스 컨테이너 역할을 합니다.

1. Go to the Google API Console.
2. 프로젝트 생성을 클릭 하십시오 .
3. 이름을 입력하거나 생성 된 제안을 수락하십시오.
4. 나머지 필드를 확인하거나 편집하십시오.
5. 작성을 클릭 하십시오 .

OAuth2 사용자 인증 정보 만들기

Search Ads 360 Reporting API는 인증 및 승인에 OAuth 2.0을 사용합니다. OAuth 사용자 인증 정보는 Google에 앱을 식별하고 Search Ads 360 사용자를 관리하기 위한 OAuth 토큰을 생성할 수 있도록 허용합니다.

Google API Console 에서 OAuth 2.0 자격 증명을 만들려면 다음을 수행하십시오.

1. Go to the Credentials page.
2. 신임 정보 작성> OAuth 클라이언트 ID를 클릭 하십시오.
3. 응용 프로그램 유형을 선택하십시오.
4. 양식을 작성 하고 작성을 클릭 하십시오 .

경고: Search Ads 360 보고 범위의 사용자 인증 정보를 가져오는 데 사용되는 모든 Google Cloud 앱에는 Google OAuth 확인이 필요합니다. 인증을 하면 로그인 시 사용자에게 확인되지 않은 UI 화면이 표시되지 않습니다.

Search Ads 360 Reporting API 사용 설정

이 API를 사용하려면 Google API 콘솔에서 프로젝트에 Search Ads 360 Reporting API를 사용 설정해야 합니다.

프로젝트에 API를 사용하려면 다음을 수행하십시오.

1. Open the API Library 의 Google API Console .
2. If prompted, select a project, or create a new one. API Library 는 제품군 및 인기도별로 그룹화 된 사용 가능한 모든 API를 나열합니다.
3. 사용하려는 API가 목록에 표시되지 않으면 검색을 사용하여 찾거나 해당 제품군에서 모두보기를 클릭하십시오.
4. 사용하려는 API를 선택한 다음 사용 버튼을 클릭하십시오.
5. If prompted, enable billing.
6. If prompted, read and accept the API's Terms of Service.

원하는 경우 프로젝트에 결제를 사용 설정

Google Cloud에서 Search Ads 360 Reporting API를 사용하는 경우 요금이 부과되지 않습니다. 하지만 각 계정의 총 무료 Cloud 프로젝트 수에는 할당량이 있습니다. 한도에 도달한 경우 무료 프로젝트 할당량이 포함된 새 Google 계정을 가입할 수 있습니다.

참고: 이미 결제가 사용 설정된 경우 (예: Google Cloud) 프로젝트의 결제 계정을 선택해야 합니다.

프로젝트에서 결제를 활성화하려면 :

1. Billing page 방문하십시오.
2. 결제 계정이없는 경우 결제 계정 추가 를 클릭하고 안내에 따라 계정을 만드 십시오 .

프로젝트의 동의 화면 사용 설정

프로젝트의 동의 화면을 활성화하려면 :

1. 열기 Consent Screen page 에서 Google API Console .
2. If prompted, select a project, or create a new one.
3. 양식을 작성하고 저장을 클릭 하십시오 .

리디렉션 URI 만들기, 수정 또는 보기

지정된 OAuth 2.0 자격 증명에 대한 리디렉션 URI를 만들거나 보거나 편집하려면 다음을 수행하십시오.

1. Go to the Credentials page.
2. 페이지의 OAuth 2.0 클라이언트 ID 섹션에서 신임 정보를 클릭하십시오.
3. 리디렉션 URI를 보거나 편집하십시오.

자격 증명 페이지에 OAuth 2.0 클라이언트 ID 섹션이 없으면 프로젝트에 OAuth 자격 증명이없는 것입니다. 자격 증명 을 만들려면 자격 증명 만들기를 클릭합니다.

클라이언트 라이브러리 다운로드

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

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

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

첫 통화하기

클라이언트 라이브러리를 구성한 후에는 첫 번째 호출을 실행할 수 있습니다.

캠페인 가져오기

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에 대해 자세히 알아보기

• 검색어:

  • Search Ads 360 쿼리 언어
  • 검색 보고서 만들기
  • 메타데이터 가져오기

• 개념:

  • Search Ads 360 Reporting API 구조
  • Search Ads 360 Reporting API 호출 구조
  • Search Ads 360 Reporting API의 버전 관리
  • Search Ads 360 Reporting API용 클라이언트 라이브러리