スタートガイド

Apache Maven(または Gradle)でクライアント ライブラリを使用することをおすすめします。

新しい Maven/Gradle プロジェクトを作成する

任意の IDE で新しい Maven/Gradle プロジェクトを作成します。Google のアーティファクトは Maven セントラル リポジトリで公開されています。

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

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

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

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

ソースからビルドすることもできます。このガイドでは、必要な依存関係が使用可能なプロジェクトが設定されていることを前提としています。

API で認証するための認証情報を取得する

Google Ads API にアクセスするには、OAuth 認証情報と Google Ads API デベロッパー トークンが必要です。このセクションでは、各プロパティの概要、使用方法、取得方法について説明します。

開発者トークン(API へのアクセス用)

開発者トークンは MCC アカウントにリンクされており、Google 広告の管理画面で確認できます。

開発者トークンはクライアント センター(MCC)アカウントにリンクされていますが、MCC アカウントにはアクセスできません。通常、開発者トークンは API へのアクセスを許可します。アカウント レベルのアクセス権は OAuth によって構成されます。

OAuth 認証情報(Google 広告アカウントへのアクセス用)

Google 広告アカウントへのアクセス権を持つ Google アカウント ユーザーとして承認するには、一連の OAuth 認証情報を提供する必要があります。

一般的に使用される OAuth フローには、デスクトップ(インストール済み)アプリとウェブアプリの 2 つがあります。この 2 つの主な違いは、デスクトップ アプリはシステム ブラウザを開き、Google の承認サーバーからのレスポンスを処理するためにローカル リダイレクト URI を提供する必要があるのに対し、ウェブアプリは任意のサードパーティ ブラウザをリダイレクトして認証を完了し、認証情報をサーバーに返すことができることです。このライブラリは、あまり使用されないサービス アカウント フローもサポートしています。

独自の認証情報を使用して承認する場合(デスクトップ アプリのフロー)
OAuth デスクトップ アプリのフローをご覧ください。これには、自身の認証情報による承認に必要なすべての詳細情報が含まれます。
サードパーティの Google ユーザーとして承認する場合(ウェブフロー)
OAuth ウェブアプリ フローをご覧ください。任意のサードパーティ ユーザーの OAuth 認証を設定する方法の例を以下に示します。
Google Apps ドメイン ユーザーとして承認する場合(サービス アカウント フロー)
OAuth サービス アカウントのフローをご覧ください。ここでは、Google Apps ドメイン ユーザーの OAuth 認証を設定する方法の例を示します。

Google 広告クライアント センター(MCC)アカウントから Google 広告のお客様アカウントにアクセスしている場合は、ログインのお客様 ID も指定する必要があります(後述)。

ログインのお客様 ID(MCC アカウントから Google 広告アカウントにアクセスする場合)

必要に応じて、広告配信中アカウントへのアクセス権を付与する MCC アカウントのお客様 ID を指定します。クライアント センター(MCC)アカウントを介してお客様のアカウントにアクセスする場合は、指定する必要があります。お客様 ID へのパスにすべての MCC アカウントを指定する必要はありません。アクセス権限に使用する最上位の MCC アカウントのみを指定します。詳細については、関連ドキュメントをご覧ください。

認証情報を使用してクライアント ライブラリを構成する

クライアント ライブラリは、構成ファイル、環境変数、またはプログラムによって構成できます。このガイドでは構成ファイルのアプローチを使用し、デスクトップとウェブのフローに焦点を当てます。認証情報セットが 1 つしかない場合(たとえば、1 人のマネージャーの下でアカウントを管理している場合など)は、構成ファイルを使用することをおすすめします。

次の内容の ~/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

プレースホルダを、前の手順で取得した認証情報に置き換えます。

また、更新トークンが MCC アカウント用の場合は、ログイン顧客としてこのアカウントのお客様 ID を指定する必要があります。

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

認証情報を検証する

ここでは、すべてが正しく設定されていることを確認するために、GetCampaigns のサンプルを実行します。

まず、google-ads-examples ディレクトリに移動します。

$ cd google-ads-examples

この例では、Google 広告アカウントのお客様 ID をダッシュなしで指定した --customerId パラメータが必要です。

Gradle で実行するには:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"

その他の例を見る

google-ads-examplesexamples パッケージには、有用な例がいくつか含まれています。ほとんどの例にはパラメータが必要です。パラメータを引数として渡すか(推奨)、ソースコードで INSERT_XXXXX_HERE 値を編集します。特定の使用法の説明を表示するには、--help を唯一の引数として渡します。

Gradle を使用する場合:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

Gradle の listExamples タスクを使用して、すべての例(サブディレクトリの例や、説明に検索キーワードが含まれている例)を一覧表示することもできます。

# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'