Memulai Search Ads 360 Reporting API

Bagian berikut menjelaskan cara memulai Search Ads 360 Reporting API.

Menyiapkan project di Google Cloud

Untuk menggunakan Search Ads 360 Reporting API, Anda perlu membuat project untuk aplikasi di Google Cloud.

Membuat project Google

Project Google berfungsi sebagai penampung resource untuk resource Google Cloud Anda.

1. Go to the Google API Console.
2. Klik Buat proyek .
3. Masukkan nama atau terima saran yang dihasilkan.
4. Konfirmasikan atau edit bidang yang tersisa.
5. Klik Buat .

Membuat kredensial OAuth2

Search Ads 360 Reporting API menggunakan OAuth 2.0 untuk autentikasi dan otorisasi. Kredensial OAuth mengidentifikasi aplikasi Anda kepada Google, dan memungkinkan Anda membuat token OAuth untuk mengelola pengguna Search Ads 360.

Untuk membuat kredensial OAuth 2.0 di Google API Console , lakukan hal berikut:

1. Go to the Credentials page.
2. Klik Buat kredensial> ID klien OAuth
3. Pilih jenis aplikasi Anda.
4. Isi formulir dan klik Buat .

Mengaktifkan Search Ads 360 Reporting API

Untuk menggunakan API, Anda harus mengaktifkan Search Ads 360 Reporting API untuk project Anda di Konsol Google API.

Untuk mengaktifkan API untuk proyek Anda:

1. Open the API Library di Google API Console .
2. If prompted, select a project, or create a new one. The API Library daftar semua API yang tersedia, dikelompokkan berdasarkan keluarga produk dan popularitas.
3. Jika API yang ingin Anda aktifkan tidak terlihat dalam daftar, gunakan pencarian untuk menemukannya, atau klik Lihat Semua dalam keluarga produk yang dimilikinya.
4. Pilih API yang ingin Anda aktifkan, lalu klik tombol Aktifkan .
5. If prompted, enable billing.
6. If prompted, read and accept the API's Terms of Service.

Secara opsional, aktifkan penagihan untuk project Anda

Penggunaan Search Ads 360 Reporting API di Google Cloud tidak dikenai biaya. Namun, ada kuota untuk jumlah total project Cloud gratis untuk setiap akun. Jika telah mencapai batas, Anda dapat mendaftar ke akun Google baru yang akan menyertakan kuota project gratis.

Untuk mengaktifkan penagihan untuk proyek Anda:

1. Kunjungi Billing page .
2. Jika Anda tidak memiliki akun penagihan aktif, buat akun dengan mengklik Tambah akun penagihan dan ikuti instruksi.

Mengaktifkan layar izin project Anda

Untuk mengaktifkan layar persetujuan proyek Anda:

1. Buka Consent Screen page di Google API Console .
2. If prompted, select a project, or create a new one.
3. Isi formulir dan klik Simpan .

Membuat, mengedit, atau melihat URI pengalihan

Untuk membuat, melihat, atau mengedit URI redirect untuk kredensial OAuth 2.0 yang diberikan, lakukan hal berikut:

1. Go to the Credentials page.
2. Di bagian OAuth 2.0 klien ID halaman, klik kredensial.
3. Lihat atau edit URI pengalihan.

Jika tidak ada bagian ID klien OAuth 2.0 di halaman Kredensial, maka proyek Anda tidak memiliki kredensial OAuth. Untuk membuatnya, klik Buat kredensial .

Mendownload library klien

Menggunakan library klien Search Ads 360 Reporting API adalah cara yang direkomendasikan untuk terhubung ke Search Ads 360 Reporting API.

Download library klien Search Ads 360 Reporting API untuk lingkungan pengembangan Anda. Ikuti petunjuk khusus bahasa tentang cara menyiapkan file konfigurasi library klien. Pada umumnya, Anda dapat menggunakan kembali konfigurasi yang ada saat bermigrasi ke library klien Search Ads 360 Reporting API versi baru.

Salah satu perubahan penting adalah header login-customer-id baru. Lihat Header ID pelanggan login untuk mengetahui detail tentang kapan Anda perlu menambahkannya ke konfigurasi.

Melakukan panggilan pertama

Setelah mengonfigurasi library klien, Anda dapat melakukan panggilan pertama.

Mendapatkan Kampanye

Di IDE Anda, jalankan kode berikut:

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

#!/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()

Konsol akan mencetak listingan kampanye di akun Anda.

Menggunakan REST

Jika memutuskan untuk tidak menggunakan library klien, Anda perlu memahami cara menggunakan REST.

Jika Anda menggunakan REST dengan Search Ads 360 API lama, kredensial Anda akan tetap berfungsi dengan Search Ads 360 Reporting API versi baru. Temukan endpoint baru dan detail lainnya di bagian referensi REST.

Pelajari lebih lanjut

Pelajari Search Ads 360 Reporting API lebih lanjut

• Kueri:

  • Bahasa Kueri Search Ads 360
  • Membuat laporan penelusuran
  • Mengambil metadata

• Konsep:

  • Struktur Search Ads 360 Reporting API
  • Struktur panggilan Search Ads 360 Reporting API
  • Pembuatan versi di Search Ads 360 Reporting API
  • Library klien untuk Search Ads 360 Reporting API