Pages

2015年8月11日火曜日

DFPリファレンス日本語訳　７

How To ガイド




このページはAPIを使って主な機能を利用する方法を説明します。

ユーザの作成

UserServiceは、ユーザーが自分のネットワーク上で管理者権限を利用してuserディレクトリを作成できるようにします。

例えば、これを利用してすべてをAPIを管理者権限で呼び出すことなくAPIを試すことができます。
  1. 新しいGmailアドレスを作るasmy.name.dfp.salesperson@gmail.com.  Google accountなどでも可能
  2.  createUsersをそのアドレスで呼び出し、Role（役割）を選ぶ。 
  3. このユーザで認証後、アドレスとパスワードで認証トークンを作成できます。

すでに登録済みのユーザーを作成する場合には、新しいネットワークが作成され、そのユーザーは正当なネットワークコードを必要とします。

ルートとなる広告ユニットを取得する方法

広告ユニット情報を取得するためにもっとも効果的なルートを取得するには、, NetworkService.getCurrentNetwork()の戻り値のNeworkオブジェクトのeffectiveRootAdUnitIdフィールドを参照します。
そこから特定の広告ユニットを探し出すには、ルートとなる広告ユニットをクエリしてIDを取得、さらに別のクエリでそのIDを親のIDとする広告ユニットをすべて取得後、イテレートにより目的の広告ユニットを取得します。


注意：アカウントタイプにより階層パターンが異なります。サポートされる階層についてさらに詳しく学んでください。

オブジェクトのクエリ


PQLを使用することにより、IDから特定のオブジェクトを取得できます。

IDからクエリする

 getObject() 

criteriaによるクエリ

多くのサービス提供されるgetObjectsByStatement()を利用して、criteriaによりオブジェクトを探すことができます。
このメソッドはSQLのようにPQLクエリを取得、並び替え、などすることができます。 詳しくは、PQL Guideを参照 
Query results are broken into pages, where a page is a set of up to 500 results, and you can specify an offset value to get to results after the first 500. See the PQL Guide for more details on searching by statement.

 Orderを作成

orderを作成するには、オブジェクト作成したうえで広告主、営業マン、適切なユーザーのトラフィッカーのIDをセットし、さらに、名前をつけてcreateOrder()かcreateOrders()を呼びます。

結果には、もっとも新しく作成されたOrderかエラーが含まれます。
Example

 Line Itemの作成

新しいline item作成のステップ:
  1. 新たに Order オブジェクトを作成するか、既存のものを使用します。
  2.  LineItem オブジェクト作成し、rotationタイプ、creativeサイズ配列.開始日と終了日、その他のプロパティーをセットします。
  3. 新しくInventoryTargetingオブジェクトを作成し、どのプレイスメントまたは広告ユニットがターゲットになるのかを指定します。
  4.  InventoryTargeting オブジェクトを新たに作成したTargeting でラップし, LineItemの targeting プロパティにセットします。
  5. 新しいオブジェクトでlineitemサービスのcreateLineItem() メソッドを呼びます。
例

 Creativeの作成

別々のタイプのcreativeは、異なるコンポーネントサポートしています。
例えば、画像creativeは,単一の画像ソースファイルをサポートします。
例

レポート生成

DFPを利用して、配信レポートやセールスレポートなどの標準的なレポートを生成できます。

APIを利用することにより、このレポートをカスタマイズすることができます。以下はその生成方法です。
  1.  ReportQuery オブジェクト作成
  2. 取得する期間をセットする。
  3.  Columnenumeratedの値を使用して、どのカラムを含めるかを指定する。
  4. Optionally specify dimensions (groupings) and dimension filters (filters limiting which results to return).
  5.  ReportQuery を生成した ReportJob インスタンスに割り当てる
  6. ReportService.runReportJob(your_report_job).によりリポートを生成。ReportJobオブジェクトは即座にIDと状態を返しますが、 生成完了までには時間がかかりますので、この時点では状態は完了していないでしょう。
  7. 前述のように、多くの場合では、レポートは最初のコールでは完了しません。ReportService.getReportJob()を取得したIDで何度も呼んで状態は COMPLETED (か FAILED)になるまで待ちましょう。.
  8. 状態COMPLETEDになったら、ReportService.getReportDownloadURL()を呼んでレポートのダウンロード先URLを取得します。 

既存のオブジェクトの編集

getObject()でオブジェクトをクエリし,（またはgetObjectsByStatement()によりセットで取得し), たうえで、値を更新します。その後に、 updateObjects()を呼びます。
注意； アップロードされると元のオブジェクトが完全に置き換わります。値をセットし忘れた場合には、デフォルトに戻り前の値とのマージは行われませんので注意してください。  

オブジェクトの状態を変更

performObjectAction()を呼ぶ。このメソッドには２つの引数がある。 
  • 何をしたいのかを指定したactionオブジェクトのインスタンス　　　　　　　　　　例えば、 orderサービスは幾つかのオプションを提供します。 ApproveOrders, PauseOrders, そしてArchiveOrdersなどです。. Action オブジェクトはすべてあなたのサービスに適切な基底Actionクラスから派生しています。オブジェクトの状態を変更した場合には、メールの送信などの動作が行われることがあります。どの状態の変更がどんな動作を起こすのか詳しくは Object Status 
  • どのオブジェクトを変更するかの PQL クエリ　　　　　　　　　　　　　　　 　　これにより同時に複数を変更できます。

広告タグの編集

DFPのダッシュボードでのみ行え、APIでは編集できません。  詳しくはTagging ヘルプを

より詳しいサンプル

投稿者 時刻: 15:44

0 コメント:

コメントを投稿

登録: コメントの投稿 (Atom)