Melakukan panggilan API

Panduan ini memerlukan beberapa setelan prasyarat yang dikonfigurasi di langkah sebelumnya. Mulai dengan Pengantar jika Anda belum melakukannya.

Panduan ini juga menggunakan token refresh, yaitu alur kerja saat pengguna dengan akses yang memadai ke akun Google Ads dapat memberikan otorisasi ke aplikasi Anda, dalam penyiapan satu kali, untuk melakukan panggilan API offline ke akun tanpa intervensi pengguna lebih lanjut. Anda dapat menggunakan token refresh untuk membuat alur kerja offline, seperti tugas cron atau pipeline data, dan alur kerja interaktif, seperti aplikasi web atau seluler.

Mengambil token refresh

Google Ads API menggunakan OAuth 2.0 sebagai mekanisme otorisasi. Secara default, autentikasi OAuth 2.0 menerbitkan token akses yang masa berlakunya habis setelah waktu terbatas. Untuk memperpanjang token akses secara otomatis, berikan token refresh.

oauth2l

1. Buat token refresh dengan menjalankan alat oauth2l:

   oauth2l fetch --credentials credentials.json --scope adwords \
       --output_format refresh_token

   File credentials.json berasal dari langkah sebelumnya.

2. Perintah oauth2l akan membuka jendela login Akun Google di jendela browser baru dan memandu Anda melalui langkah-langkah autentikasi OAuth 2.0.

   Pastikan Anda login menggunakan alamat email dari langkah saat Anda mengidentifikasi ID pelanggan login.

   Jika aplikasi Anda tidak diverifikasi, Anda mungkin melihat layar peringatan. Dalam kasus tersebut, Anda dapat mengklik link Tampilkan Lanjutan dan mengklik opsi Buka PROJECT_NAME (belum diverifikasi).

   

3. Setelah Anda memverifikasi cakupan, berikan izin dengan mengklik tombol Lanjutkan.

   Perintah ditampilkan di browser dengan teks berikut:

   Authorization code granted. Close this tab.
   

   Perintah oauth2l menghasilkan cuplikan JSON berikut:

   {
     "client_id": "******.apps.googleusercontent.com",
     "client_secret": "******",
     "token_uri": "https://oauth2.googleapis.com/token",
     "auth_uri": "https://accounts.google.com/o/oauth2/auth",
     "refresh_token": "******",
     "type": "authorized_user"
   }
   

gcloud CLI

1. Buat token refresh dengan menjalankan alat gcloud CLI:

   gcloud auth application-default \
     login --scopes=https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform \
     --client-id-file=<path_to_credentials.json>

   File credentials.json berasal dari langkah sebelumnya.

2. Perintah gcloud akan membuka jendela login Akun Google di jendela browser baru dan memandu Anda melalui langkah-langkah autentikasi OAuth 2.0.

   Pastikan Anda login menggunakan alamat email dari langkah saat Anda mengidentifikasi ID pelanggan login.

   Jika aplikasi Anda tidak diverifikasi, Anda mungkin melihat layar peringatan. Dalam kasus tersebut, Anda dapat mengklik link Tampilkan Lanjutan dan mengklik opsi Buka PROJECT_NAME (belum diverifikasi).

   

3. Setelah memverifikasi cakupan, klik tombol Lanjutkan untuk memberikan izin.

   Browser akan membuka https://cloud.google.com/sdk/auth_success, yang menunjukkan bahwa autentikasi berhasil.

   Authorization code granted. Close this tab.
   

   Perintah gcloud akan mencetak output seperti berikut:

   Credentials saved to file: [/****/.config/gcloud/application_default_credentials.json]
   

   Sekarang buka file application_default_credentials.json. Kontennya harus mirip dengan berikut:

   {
     "account": "",
     "client_id": "******.apps.googleusercontent.com",
     "client_secret": "******",
     "refresh_token": "******",
     "type": "authorized_user",
     "universe_domain": "googleapis.com"
   }
   

Lainnya

Jika Anda lebih suka menggunakan curl atau klien HTTP Anda sendiri, lihat panduan OAuth 2.0 untuk Aplikasi Seluler dan Desktop untuk mengetahui contohnya.

Melakukan panggilan API

Pilih klien pilihan Anda untuk mendapatkan petunjuk tentang cara melakukan panggilan API:

Java

Artefak library klien dipublikasikan ke repositori pusat Maven. Tambahkan library klien sebagai dependensi ke project Anda sebagai berikut:

Dependensi Maven adalah:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>34.0.0</version>
</dependency>

Dependensi Gradle adalah:

implementation 'com.google.api-ads:google-ads:34.0.0'

Buat file ~/ads.properties dengan konten berikut:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Buat objek GoogleAdsClient seperti berikut:

GoogleAdsClient googleAdsClient = null;
try {
  googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
  System.err.printf(
      "Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
      fnfe);
  System.exit(1);
} catch (IOException ioe) {
  System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
  System.exit(1);
}

Selanjutnya, jalankan laporan kampanye menggunakan metode GoogleAdsService.SearchStream untuk mengambil kampanye di akun Anda. Panduan ini tidak membahas detail pelaporan.

    private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java

C#

Paket library klien dipublikasikan ke repositori Nuget.org. Mulai dengan menambahkan referensi nuget ke paket Google.Ads.GoogleAds.

dotnet add package Google.Ads.GoogleAds --version 18.1.0

Buat objek GoogleAdsConfig dengan setelan yang relevan, dan gunakan untuk membuat objek GoogleAdsClient.

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "APPLICATION",
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******",
    LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);

Selanjutnya, jalankan laporan kampanye menggunakan metode GoogleAdsService.SearchStream untuk mengambil kampanye di akun Anda. Panduan ini tidak membahas detail pelaporan.

    public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V18.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs

PHP

Paket library klien dipublikasikan ke repositori Packagist. Beralih ke direktori utama project Anda dan jalankan perintah berikut untuk menginstal library dan semua dependensinya di direktori vendor/ dari direktori utama project Anda.

composer require googleads/google-ads-php:25.0.0

Buat salinan file google_ads_php.ini dari repositori GitHub dan ubah untuk menyertakan kredensial Anda.

[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"

[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"

Buat instance objek GoogleAdsClient.

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

Selanjutnya, jalankan laporan kampanye menggunakan metode GoogleAdsService.SearchStream untuk mengambil kampanye di akun Anda. Panduan ini tidak membahas detail pelaporan.

    public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php

Python

Library klien yang didistribusikan di PyPI dapat diinstal menggunakan perintah pip sebagai berikut:

python -m pip install google-ads==21.3.0

Buat salinan file google-ads.yaml dari repositori GitHub dan ubah untuk menyertakan kredensial Anda.

client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE

Buat instance GoogleAdsClient dengan memanggil metode GoogleAdsClient.load_from_storage. Teruskan jalur ke google-ads.yaml sebagai string ke metode saat memanggilnya:

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

Selanjutnya, jalankan laporan kampanye menggunakan metode GoogleAdsService.SearchStream untuk mengambil kampanye di akun Anda. Panduan ini tidak membahas detail pelaporan.

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

    query = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py

Ruby

Gem Ruby untuk library klien dipublikasikan ke situs hosting gem Rubygems. Cara yang direkomendasikan untuk menginstal adalah menggunakan bundler. Tambahkan baris ke Gemfile Anda:

gem 'google-ads-googleads', '~> 30.0.0'

Kemudian, jalankan:

bundle install

Buat salinan file google_ads_config.rb dari repositori GitHub dan ubah untuk menyertakan kredensial Anda.

Google::Ads::GoogleAds::Config.new do |c|
  c.client_id = 'INSERT_CLIENT_ID_HERE'
  c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
  c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
  c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end

Buat instance GoogleAdsClient dengan meneruskan jalur ke tempat Anda menyimpan file ini.

client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')

Selanjutnya, jalankan laporan kampanye menggunakan metode GoogleAdsService.SearchStream untuk mengambil kampanye di akun Anda. Panduan ini tidak membahas detail pelaporan.

    def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb

Perl

Library ini didistribusikan di CPAN. Mulai dengan meng-clone repositori google-ads-perl di direktori pilihan Anda.

git clone https://github.com/googleads/google-ads-perl.git

Beralihlah ke direktori google-ads-perl dan jalankan perintah berikut di command prompt untuk menginstal semua dependensi yang diperlukan untuk menggunakan library.

cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps

Buat salinan file googleads.properties dari repositori GitHub dan ubah untuk menyertakan kredensial Anda.

clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Buat instance Client dengan meneruskan jalur ke tempat Anda menyimpan file ini.

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

Selanjutnya, jalankan laporan kampanye menggunakan metode GoogleAdsService.SearchStream untuk mengambil kampanye di akun Anda. Panduan ini tidak membahas detail pelaporan.

    sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V18::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}
get_campaigns.pl

REST

Mulailah dengan menggunakan klien HTTP untuk mengambil token akses OAuth 2.0. Panduan ini menggunakan perintah curl.

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Selanjutnya, jalankan laporan kampanye menggunakan metode GoogleAdsService.SearchStream untuk mengambil kampanye di akun Anda. Panduan ini tidak membahas detail pelaporan.

curl -i -X POST https://googleads.googleapis.com/v18/customers/CUSTOMER_ID/googleAds:searchStream \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer ACCESS_TOKEN" \
   -H "developer-token: DEVELOPER_TOKEN" \
   -H "login-customer-id: LOGIN_CUSTOMER_ID" \
   --data-binary "@query.json"

Isi query.json adalah sebagai berikut:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}