Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

認証と認可

他の Google API と同様に、Google Ads API では、認証および承認に OAuth 2.0 プロトコルを使用しています。OAuth 2.0 を使うことで、Google Ads API クライアントアプリケーションは、ユーザーのログイン情報を保存したり処理したりしなくてもユーザーの Google 広告アカウントにアクセスできるようになります。

このガイドでは、最も一般的な 3 つの OAuth 2.0 フローを使用して Google Ads API 認証用に Java クライアントライブラリを構成する方法と、必要な認証情報について説明します。

Google Ads API アクセスモデルの詳細については、Google 広告アクセスモデルのガイドをご覧ください。

認証情報

Google Ads API にアクセスするには、開発者トークン、OAuth 2.0 認証情報、場合によってはログイン用お客様 ID が必要です。

開発者トークン

開発者トークンはクライアントセンター（MCC）アカウントにリンクされており、Google 広告のウェブインターフェースで確認できます。

開発者トークンは MCC アカウントにリンクされていますが、そのアカウントへのアクセス権は付与されません。開発者トークンは API へのアクセス権を付与するもので、アカウントレベルのアクセス権は OAuth 2.0 を使用して構成します。

クライアントライブラリでは、開発者トークンは ads.properties ファイルの api.googleads.developerToken キーで指定します。

OAuth 2.0 認証情報

Google 広告アカウントにアクセスできる Google アカウントユーザーとして承認するには、OAuth 2.0 認証情報を提供する必要があります。必要な認証情報の種類は、使用する OAuth 2.0 フローによって異なります。

ライブラリは次の 3 つのフローをサポートしています。

サービスアカウントフロー
シングルユーザー認証フロー
マルチユーザー認証フロー

Google Ads API の OAuth の概要で OAuth フローの詳細を確認し、ニーズに最も適したフローの手順に沿って必要な認証情報を取得してください。

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

クライアントライブラリでは、ログイン用お客様 ID は ads.properties ファイルの api.googleads.loginCustomerId キーで指定します。

構成

クライアントライブラリは、ads.properties ファイル、環境変数、またはプログラムで構成できます。このガイドでは、ads.properties ファイルを使用する方法について説明します。すべてのオプションの詳細については、構成ガイドをご覧ください。

ads.properties ファイルを使用する場合は、ホームディレクトリ: ~/ads.properties に配置します。

OAuth ワークフロー

Google Ads API を使用する際に使用される一般的なワークフローは 3 つあります。

サービスアカウントフロー

ワークフローでユーザー操作が必要ない場合は、このワークフローをおすすめします。このワークフローでは、ユーザーがサービスアカウントを Google 広告アカウントに追加する構成手順が必要です。アプリは、サービスアカウントの認証情報を使用して、ユーザーの Google 広告アカウントを管理できます。

秘密鍵 JSON ファイルを取得したら、ads.properties ファイルに次のコードを追加します。

api.googleads.serviceAccountSecretsPath=PRIVATE_KEY_JSON_FILE_PATH
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
# Only add this key if you are using impersonation to access an account
# other than the service account itself.
# api.googleads.serviceAccountUser=USER_EMAIL_TO_IMPERSONATE

詳しくは、サービスアカウントのワークフローガイドをご覧ください。

シングルユーザー認証フロー

サービスアカウントを使用できない場合は、このワークフローを使用できます。このワークフローには、次の 2 つの構成手順が必要です。

Google Ads API を使用して管理するすべてのアカウントへのアクセス権を 1 人のユーザーに付与します。一般的な方法としては、Google Ads API の MCC アカウントへのアクセス権をユーザーに付与し、その MCC アカウントの下にあるすべての Google 広告アカウントをリンクします。
ユーザーは、gcloud などのコマンドラインツールまたは GenerateUserCredentials コードサンプルを実行して、アプリがユーザーに代わってすべての Google 広告アカウントを管理できるようにします。

これらの認証情報を取得したら、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

詳しくは、シングルユーザー認証のワークフローガイドをご覧ください。

マルチユーザー認証フロー

アプリでユーザーがログインし、アプリがユーザーに代わって Google 広告アカウントを管理できるようにする場合は、このワークフローをおすすめします。 GenerateUserCredentials は、ユーザーに代わって Google 広告アカウントを管理するために、実行時にユーザー認証を取得する方法を示すコマンドラインコードサンプルです。このコードサンプルは、ユーザー認証を必要とするデスクトップアプリを構築する際の参考として使用できます。

次のコードを 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

詳しくは、マルチユーザー認証のワークフローガイドをご覧ください。

ユーザーが複数のアカウントを管理している場合はどうすればよいですか？

ユーザーが複数の Google 広告アカウントを管理していることはよくあります。アカウントに直接アクセスする場合と、Google 広告の MCC アカウントを使用する場合があります。Java クライアントライブラリには、このようなケースを処理する方法を示す次のコードサンプルが用意されています。

GetAccountHierarchy コードサンプルは、Google 広告の MCC アカウントの下にあるすべてのアカウントのリストを取得する方法を示しています。
ListAccessibleCustomers コードサンプルは、ユーザーが直接アクセスできるすべてのアカウントのリストを取得する方法を示しています。これらのアカウントは、LoginCustomerId 設定の有効な値として使用できます。

アプリケーションのデフォルト認証情報

Java クライアントライブラリは、アプリケーションのデフォルト認証情報を使用した認証もサポートしています。

これは、ローカル開発や、さまざまな Google API に対する開発に特に便利です。正しい OAuth 2.0 スコープにアクセスできる場合は、同じ認証情報を再利用できます。

Google Ads API の場合、アプリケーションのデフォルト認証情報が https://www.googleapis.com/auth/adwords OAuth 2.0 スコープにアクセスできることを確認してください。

アプリケーションのデフォルト認証情報を使用するには、ads.properties ファイルで api.googleads.useApplicationDefaultCredentials オプションを true に設定します。アプリケーションのデフォルト認証情報を使用する場合、クライアント ID、クライアントシークレット、更新トークンは設定しないでください。

認証と認可 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。