認証

DFP API のすべての呼び出しは、OAuth 2.0 を使って認証する必要があります。

オープン スタンダードである OAuth 2.0 を使用すると、第三者アプリケーションに対し、ユーザーに代わってウェブサービスとやり取りする権限を付与することができます。これにより、DFP API クライアント アプリケーションからユーザーの DFP アカウントへ、ユーザー名やパスワードの処理や保存を行うことなくアクセスできるようになります。

OAuth 2.0 と DFP API の使用を開始する

DFP のクライアント ライブラリで OAuth 2.0 を使用する方法は次のとおりです。

  • クライアント ID とクライアント シークレットを作成する。
  • クライアント ライブラリを設定する。

クライアント ID とクライアント シークレットを作成する

OAuth 2.0 を使って DFP API を認証するには、まず次の方法でクライアント ID とクライアント シークレットを作成します。

  1. Google Developers Console にアクセスします。

  2. [プロジェクトの作成] をクリックして新しいプロジェクトを作成します。

    新しいプロジェクトのスクリーンショットを作成する

  3. プロジェクト名を入力し、必要であればプロジェクト ID も編集して、[作成] をクリックします。

    新しいプロジェクト ダイアログのスクリーンショット

  4. 左上のギャラリー メニュー ギャラリー メニュー から [API Manager] を選択します。

    API Manager を選択する

  5. API Manager ページが表示されます。左パネルで [認証情報] をクリックします。

    API Manager を選択する

  6. [同意画面] で、必要な情報がすべて登録されていることを確認します。

    同意画面の設定のスクリーンショット

  7. [認証情報] タブの下で [新しい認証情報] をクリックし、プルダウンから [OAuth クライアント ID] を選択します。

    認証情報ページ

  8. インストール済みアプリケーションには [その他] を選択します。[作成] をクリックすると登録完了です。

    クライアント ID のスクリーンショットを作成する

  9. クライアント ID とクライアント シークレットが作成され、表示されます。

    クライアント ID とクライアント シークレットのスクリーンショット

クライアント ライブラリを設定して使用する

OAuth 2.0 を使ったインストール済みアプリケーションのフローを設定する手順は次のとおりです。

  1. クライアント ライブラリの設定ファイルに、対応するクライアント ID とクライアント シークレットを追加します。

  2. クライアント ライブラリ ユーティリティを実行します。

  3. このユーティリティを実行すると、Google の承諾ページが表示され、アプリケーションに権限を付与するよう求められます。

  4. [同意する] をクリックして、アプリケーションに権限を与えます。

  5. Google からウェブページの認証コードが提供されます。

    OAuth 2.0 認証コードのスクリーンショット

  6. この認証コードをコピーして、クライアント ライブラリ ユーティリティに貼り付けます。

  7. クライアント ライブラリ ユーティリティに認証コードを入力すると、リフレッシュ トークンが出力されます。

  8. このオフライン リフレッシュ トークンをクライアント ライブラリの設定ファイルに保存します。

各種クライアント ライブラリで OAuth 2.0 を使用する詳しい手順については、以下のリンクからご覧ください。

OAuth 2.0 ご利用ガイド OAuth 2.0 ユーティリティ
Java Java
PHP PHP
.NET .NET
Python Python
Ruby Ruby

具体的な仕組み

クライアント ライブラリでは、背後でいくつかの処理が自動的に行われます。参考までに、具体的な内容を以下に記載しておきます。なおこのセクションは、既に OAuth 2.0 の仕様を熟知していて、Google API で OAuth 2.0 を使用する方法に精通している上級ユーザーの方を対象としています。

スコープ

1 つのアクセス トークンで、複数の API にさまざまなレベルのアクセス権を付与できます。scope という変数パラメータを使って、アクセス トークンで許可するリソースと操作を制御することが可能です。アクセス トークンのリクエストを行う中で、アプリケーションから scope パラメータの値が送信されます。

DFP API のスコープは次のとおりです。

スコープ 意味
https://www.googleapis.com/auth/dfp DFP API への読み取りと書き込みのアクセス。

オフライン アクセス

DFP API クライアント アプリケーションからオフライン アクセスをリクエストすることはよくあります。たとえば、ユーザーがウェブサイトをオンラインで閲覧していないときに、DFP API クライアント アプリケーションで一括ジョブを実行することが考えられます。

タイプがウェブ アプリケーションの場合、オフライン アクセスをリクエストするには、access_type パラメータを必ず offline に設定してください。詳しくは、Google の OAuth 2.0 ガイドをご覧ください。

タイプがインストール済みアプリケーションの場合、オフライン アクセスはデフォルトで有効になっているため、改めてリクエストする必要はありません。

HTTP リクエスト ヘッダー

DFP API サーバーに送信するリクエストの HTTP ヘッダーには、次の形式でアクセス トークンを含める必要があります。

Authorization: Bearer THE_ACCESS_TOKEN

たとえば次のようになります。

POST … HTTP/1.1
Host: …
Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg
Content-Type: text/xml;charset=UTF-8
Content-Length: …

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope">
  …
</soap:Envelope>

アクセス トークンとリフレッシュ トークン

DFP API を使用するほとんどのケースでは、リフレッシュ トークンを安全に保管して再利用できるようにしておく必要があります。アクセス トークンとリフレッシュ トークンをリクエストする方法について詳しくは、使用するアプリケーション タイプに関連するガイドをご覧ください。

アクセス トークンの期限切れ

アクセス トークンには、expires_in の値に基づいて有効期限が設定され、期限を過ぎるとトークンは無効になります。リフレッシュ トークンを使って、期限切れとなったアクセス トークンを更新できます。クライアント ライブラリでは、期限切れのアクセス トークンがデフォルトで自動更新されます。

フィードバックを送信...

Doubleclick for Publishers
Doubleclick for Publishers
ご不明な点がありましたら、Google のサポートページをご覧ください。