API 呼び出しを行う

このガイドでは、前の手順で構成したいくつかの前提条件の設定が必要です。まだ確認していない場合は、概要から始めてください。

このガイドでは、更新トークンも使用します。このワークフローでは、Google 広告アカウントへの十分なアクセス権を持つユーザーが、アプリを 1 回限りの設定で承認すると、ユーザーが介入することなく、アカウントに対してオフライン API 呼び出しを行うことができます。更新トークンを使用すると、cron ジョブやデータ パイプラインなどのオフライン ワークフローと、ウェブアプリやモバイルアプリなどのインタラクティブ ワークフローの両方を構築できます。

更新トークンを取得する

Google Ads API では、認可メカニズムとして OAuth 2.0 が使用されます。デフォルトでは、OAuth 2.0 認証では、一定期間後に有効期限が切れるアクセス トークンが発行されます。アクセス トークンを自動的に更新するには、代わりに更新トークンを発行します。

oauth2l

  1. oauth2l ツールを実行して更新トークンを生成します。

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

    credentials.json ファイルは前の手順で作成したものです。

  2. oauth2l コマンドを実行すると、新しいブラウザ ウィンドウに Google アカウントのログイン ウィンドウが開き、OAuth 2.0 認証の手順が開始されます。

    ログイン用お客様 ID を確認した手順のメールアドレスを使用してログインしてください。

    アプリが未確認の場合は、警告画面が表示されることがあります。このような場合は、[詳細を表示] リンクをクリックし、[PROJECT_NAME（未確認）に移動] オプションをクリックしても安全です。

  3. スコープを確認したら、[続行] ボタンをクリックして権限を付与します。

    ブラウザに次のようなメッセージが記載されたプロンプトが表示されます。

    Authorization code granted. Close this tab.

    oauth2l コマンドは、次の JSON スニペットを出力します。

    {
  "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. 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>

    credentials.json ファイルは前の手順で作成したものです。

  2. gcloud コマンドを実行すると、新しいブラウザ ウィンドウに Google アカウントのログイン ウィンドウが開き、OAuth 2.0 認証の手順が開始されます。

    ログイン用お客様 ID を確認した手順のメールアドレスを使用してログインしてください。

    アプリが未確認の場合は、警告画面が表示されることがあります。このような場合は、[詳細を表示] リンクをクリックし、[PROJECT_NAME（未確認）に移動] オプションをクリックしても安全です。

  3. スコープを確認したら、[続行] ボタンをクリックして権限を付与します。

    ブラウザが https://cloud.google.com/sdk/auth_success に移動し、認証が成功したことを示します。

    Authorization code granted. Close this tab.

    gcloud コマンドは次のような出力を出力します。

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

    application_default_credentials.json ファイルを開きます。内容は次のようになります。

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

その他

代わりに curl または独自の HTTP クライアントを使用する場合は、モバイルアプリとデスクトップ アプリ向けの OAuth 2.0 ガイドで例をご覧ください。

API 呼び出しを行う

ご希望のクライアントを選択して、API 呼び出しの手順を確認してください。

Java

クライアント ライブラリ アーティファクトは Maven 中央リポジトリに公開されます。次のように、クライアント ライブラリを依存関係としてプロジェクトに追加します。

Maven 依存関係は次のとおりです。

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

Gradle の依存関係は次のとおりです。

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

次の内容の ~/ads.properties ファイルを作成します。

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

GoogleAdsClient オブジェクトは、次のように作成します。

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

次に、GoogleAdsService.SearchStream メソッドを使用してキャンペーン レポートを実行し、アカウント内のキャンペーンを取得します。このガイドでは、レポート作成の詳細については説明しません。

    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#

クライアント ライブラリ パッケージは Nuget.org リポジトリに公開されています。まず、Google.Ads.GoogleAds パッケージに nuget 参照を追加します。

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

関連する設定を使用して GoogleAdsConfig オブジェクトを作成し、それを GoogleAdsClient オブジェクトの作成に使用します。

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

次に、GoogleAdsService.SearchStream メソッドを使用してキャンペーン レポートを実行し、アカウント内のキャンペーンを取得します。このガイドでは、レポート作成の詳細については説明しません。

    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

クライアント ライブラリ パッケージは Packagist リポジトリに公開されます。プロジェクトのルート ディレクトリに移動し、次のコマンドを実行して、ライブラリとそのすべての依存関係をプロジェクトのルート ディレクトリの vendor/ ディレクトリにインストールします。

composer require googleads/google-ads-php:25.0.0

GitHub リポジトリの google_ads_php.ini ファイルのコピーを作成し、認証情報を含めるように変更します。

[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"

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

次に、GoogleAdsService.SearchStream メソッドを使用してキャンペーン レポートを実行し、アカウント内のキャンペーンを取得します。このガイドでは、レポート作成の詳細については説明しません。

    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

クライアント ライブラリは PyPI で配布されており、次のように pip コマンドを使用してインストールできます。

python -m pip install google-ads==21.3.0

GitHub リポジトリから google-ads.yaml ファイルのコピーを作成し、認証情報を含めるように変更します。

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

GoogleAdsClient.load_from_storage メソッドを呼び出して GoogleAdsClient インスタンスを作成します。google-ads.yaml へのパスを文字列としてメソッドに渡して呼び出します。

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

次に、GoogleAdsService.SearchStream メソッドを使用してキャンペーン レポートを実行し、アカウント内のキャンペーンを取得します。このガイドでは、レポート作成の詳細については説明しません。

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

クライアント ライブラリの Ruby gem は、Rubygems gem ホスティング サイトに公開されています。インストールに推奨される方法は、Bundler を使用する方法です。Gemfile に次の行を追加します。

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

次のコマンドを実行します。

bundle install

GitHub リポジトリの google_ads_config.rb ファイルのコピーを作成し、認証情報を含めるように変更します。

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

このファイルを保存する場所のパスを渡して、GoogleAdsClient インスタンスを作成します。

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

次に、GoogleAdsService.SearchStream メソッドを使用してキャンペーン レポートを実行し、アカウント内のキャンペーンを取得します。このガイドでは、レポート作成の詳細については説明しません。

    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

このライブラリは CPAN で配布されています。まず、任意のディレクトリに google-ads-perl リポジトリのクローンを作成します。

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

google-ads-perl ディレクトリに移動し、コマンド プロンプトで次のコマンドを実行して、ライブラリの使用に必要なすべての依存関係をインストールします。

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

GitHub リポジトリの googleads.properties ファイルのコピーを作成し、認証情報を含めるように変更します。

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

このファイルを保存する場所のパスを渡して、Client インスタンスを作成します。

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

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

次に、GoogleAdsService.SearchStream メソッドを使用してキャンペーン レポートを実行し、アカウント内のキャンペーンを取得します。このガイドでは、レポート作成の詳細については説明しません。

    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

まず、HTTP クライアントを使用して OAuth 2.0 アクセス トークンを取得します。このガイドでは、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

次に、GoogleAdsService.SearchStream メソッドを使用してキャンペーン レポートを実行し、アカウント内のキャンペーンを取得します。このガイドでは、レポート作成の詳細については説明しません。

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"

query.json の内容は次のとおりです。

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}
前へ
ツールとライブラリのダウンロード
次へ
よくある間違い