操作ガイド

ここでは、API を使って一般的なタスクを実行する方法について詳しく説明します。

ユーザーを作成する

管理者権限を持つユーザーは、UserService を使って、ネットワーク内に直接ユーザーを作成できます。新しいユーザーを事前に登録しておく必要はありません。たとえば API を初めて試してみる場合に、管理者(登録したメールアドレスに既定で割り当てられる権限)として各 API を呼び出すのではなく、実際のワークフローをテストするために営業担当者、入稿担当者、広告主などの役割のユーザーを何人か作成することができます。

  1. 新しい Gmail アドレス(例: my.name.dfp.salesperson@gmail.com)を作成します。または、Gmail 以外の既存のメールアドレスを新しい Google アカウントとして登録します。
  2. この新しいアドレスと選択した Role を使って、createUsers を呼び出します。
  3. OAuth 2.0 を使って、作成した新しいユーザーの認証を行い、認証トークンを生成できます。

ルート AdUnit を取得する

子ノードを追加できる最上位の AdUnit と作成可能な階層の深さは、アカウント タイプ(DFP Small Business または DFP Premium)によって異なります。子ノードの変更がサポートされる最上位の AdUnit は、実質ルート AdUnit と呼ばれます。

実質ルートを取得するには、NetworkService.getCurrentNetwork() を呼び出し、返された Network オブジェクトの effectiveRootAdUnitId フィールドを調べます。

注: アカウント タイプによって、サポートされる階層構造のパターンは異なります。

オブジェクトを検索する

多くのサービスで公開されている getObjectsByStatement() メソッドを使い、検索条件を指定してオブジェクトを検索します。Object の部分には特定のオブジェクト タイプが入ります。このメソッドのパラメータには PQL クエリを指定します。PQL クエリでは SQL クエリと同じように、検索対象のフィールド(フィールド名はオブジェクトのプロパティに対応)、並べ替え、上限数、検索結果のオフセットを指定できます。PQL の詳細と、フィルタ条件に指定できるオブジェクト フィールドについては、PQL ガイドをご覧ください。

オーダーを作成する

オーダーを作成するには、Order オブジェクトを作成して、広告主、営業担当者、広告担当者の ID を適切なユーザーに設定し、固有の名前を指定したうえで、createOrders() を呼び出します。結果には、新規作成された Order またはエラーが返されます。

オーダーを作成する Java コードの例をご覧ください。

広告申込情報を作成する

新しい広告申込情報を作成する手順は次のとおりです。

  1. 新しい Order オブジェクトを作成します。または、既存のオブジェクトを使います。
  2. 新しい LineItem オブジェクトを作成し、ローテーションの種類、クリエイティブ サイズの配列、開始日、終了日などのプロパティを設定します。
  3. 新しい InventoryTargeting オブジェクトを作成し、Placement オブジェクトまたは AdUnit オブジェクトのターゲティングまたは除外を指定します。
  4. 作成した InventoryTargeting オブジェクトを新しい Targeting オブジェクトでラップし、LineItem オブジェクトのターゲティング プロパティに割り当てます。
  5. 作成したオブジェクトを使って、lineitem サービスのメソッド createLineItems() を呼び出し、オブジェクトが作成されたかどうかを確認します。

広告申込情報を作成する Java コードの例をご覧ください。

クリエイティブを作成する

クリエイティブでサポートされる構成要素はクリエイティブの種類によって異なります。たとえば、イメージ クリエイティブでは 1 つの画像ファイルがサポートされます。Flash クリエイティブでは、基になる 2 つのアセット ファイルとして、Flash ファイルと代替画像ファイル(Flash ファイルを利用できない場合)がサポートされます。第三者のサイトでホストされるクリエイティブの場合は、その第三者のサーバー上のファイルを参照する HTML コードのみをアップロードします。クリエイティブを作成するためにアップロードする必要のあるアセットについては、特定の Creative サブクラスをご確認ください。

イメージ クリエイティブを作成する Java コードの例をご覧ください。

既存のオブジェクトを修正する

既存のオブジェクトを変更するには、getObjectsByStatement() を呼び出してオブジェクトを検索し、返されたオブジェクトの値を更新してから、updateObjects() を呼び出します。

注: 既存のオブジェクトは修正後のオブジェクトに完全に置き換えられます。そのため、送信するオブジェクトにプロパティ値を設定していなかった場合、保存後のオブジェクトで該当のプロパティには以前の値ではなくデフォルトの値が適用されます。

オブジェクトのステータスを変更する

オブジェクトのステータスを変更するには、ご利用のサービスで公開されている performObjectAction() メソッドを呼び出します。このメソッドは次の 2 つのパラメータをとります。

  • 実行するアクションを表すオブジェクトのインスタンス。 たとえば、order サービスでは ApproveOrdersPauseOrdersArchiveOrders などのアクションが公開されます。アクション オブジェクトはすべて、ご利用のサービスに該当する基本アクション クラスから派生しています。
  • ステータスを変更するオブジェクトを表す PQL クエリ。 適切な PQL ステートメントを指定することで、一度に 1 つまたは複数のオブジェクトのステータスを変更できます。

広告タグを作成する

API を使って広告タグを作成することはできません。広告タグの作成は DFP ウェブサイトで行う必要があります。詳しくは、ヘルプセンターのタグ設定のセクションをご覧ください。

その他の例

クライアント ライブラリのサンプルコードには、ここで紹介した以外にも、さまざまなプログラミング言語による例が多数含まれています。ご利用のプログラミング言語のサンプルへのリンクについては、クライアント ライブラリとサンプルコードのページをご覧ください。

 

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

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