DFP API のすべての呼び出しは、オープン スタンダードである OAuth 2.0 を使って認証する必要があります。OAuth 2.0 によってユーザーは、第三者アプリケーションに対し、自分に代わってウェブサービスとやり取りする権限を付与することができます。つまり、OAuth 2.0 を使用すると、DFP API クライアント アプリケーションは、ユーザー名やパスワードの処理や保存を行うことなくユーザーの DFP アカウントにアクセスできるようになります。
OAuth 2.0 認証情報を作成する
OAuth 2.0 認証情報を作成する手順は以下のとおりです。
1. 認証の種類を決める
以下の表で、対象の DFP API アプリケーションに最適な認証の種類を確認します。
OAuth 2.0 認証の種類を選択する | |
---|---|
サービス アカウント |
自分の DFP データにアクセスするだけでよい場合に選択します。 詳細 |
ウェブ アプリケーション |
アプリケーションに DFP データへのアクセスを許可する任意のユーザーとして認証を行う場合に選択します。 詳細 |
2. OAuth 2.0 認証情報を作成する
認証の種類を決めたら以下で該当するタブをクリックし、手順に沿って OAuth 2.0 認証情報を作成します。
- Google API Console の認証情報ページを開きます。
- プロジェクトのプルダウン メニューから [プロジェクトを作成] を選択し、プロジェクトの名前を入力します(表示されているプロジェクト ID は任意で編集することもできます)。[作成] をクリックします。
- 認証情報ページで [認証情報を作成] を選択し、[サービス アカウント キー] を選択します。
- [新しいサービス アカウント] を選択し、[JSON] を指定します。
- [作成] をクリックして、秘密鍵を含むファイルをダウンロードします。
- Google API Console の認証情報ページを開きます。
- プロジェクトのプルダウン メニューから [新しいプロジェクトを作成] を選択し、プロジェクトの名前を入力します(表示されているプロジェクト ID は任意で編集することもできます)。[作成] をクリックします。
- 認証情報ページで [認証情報を作成] をクリックし、[OAuth クライアント ID] を選択します。
- 同意画面のページでプロダクト名の設定を促された場合は、[同意画面を設定] をクリックして必要な情報を入力し、[保存] をクリックして認証情報ページに戻ります。
- [アプリケーションのタイプ] は [ウェブ アプリケーション] を選択します。手順に従って JavaScript の生成元かリダイレクト URI(またはその両方)を入力します。
- [作成] をクリックします。
- 表示されたページでクライアント ID とクライアント シークレットをクリップボードにコピーします。この 2 つはクライアント ライブラリの設定時に必要になります。
3. DFP ネットワークを設定する
お客様が第三者デベロッパーの場合、状況によってはこの作業をクライアントに依頼していただく必要があります。
- DoubleClick for Publishers ネットワークを開きます。
- [管理者] タブをクリックします。
- [API アクセス] が有効になっていることを確認します。
- [サービス アカウント ユーザーを追加] をクリックします。
- フォームにサービス アカウントのメール情報を入力します。サービス アカウント ユーザーには、管理画面からエンティティにアクセスするための権限が付与されている必要があります。
- [保存] をクリックします。サービス アカウントの追加を確認するメッセージが表示されます。
- [ユーザー] タブに移動して既存のサービス アカウントのユーザーを確認した後、[サービス アカウント] フィルタをクリックします。
- DoubleClick for Publishers ネットワークを開きます。
- [管理者] タブをクリックします。
- [API アクセス] が有効になっていることを確認します。
4. クライアント ライブラリを設定して使用する
クライアント ライブラリで認証情報を使用するには、以下のガイドをご覧ください。
Java
.NET
Python
PHP
Ruby
Google が提供しているクライアント ライブラリを使用しない場合は、OAuth 2.0 のサービス アカウントまたはウェブアプリのフローをご自分で行う必要があります。
具体的な仕組み
クライアント ライブラリでは、以下の処理が自動的に行われます。バックグラウンド処理の内容にご関心がある場合にご覧ください。このセクションは、OAuth 2.0 の仕様と Google API で OAuth 2.0 を使用する方法を理解している上級者の方を対象としています。
HTTP リクエスト ヘッダー
DFP API に送信するリクエストの HTTP ヘッダーには、次の形式でアクセス トークンを含める必要があります。
Authorization: Bearer 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>
スコープ
1 つのアクセス トークンで、複数の API にさまざまなレベルのアクセス権を付与できます。scope
という変数パラメータを使って、アクセス トークンで許可するリソースと操作を制御することが可能です。アクセス トークンのリクエスト中に、アプリケーションから scope
パラメータの値が送信されます。
DFP のスコープは次の 1 つのみです。認証は、プロダクト内でユーザーレベルで行う必要があります。
スコープ | 権限 |
---|---|
https://www.googleapis.com/auth/dfp |
DoubleClick for Publishers でのキャンペーンの表示と管理 |