このページでは、API を使用して一般的なタスクを実行する方法について詳しく説明します。
ユーザーを作成する
UserService を使用すると、管理者権限を持つユーザーはネットワークに直接ユーザーを作成できます。この登録は、新規ユーザーを最初に登録しなくても、どのデベロッパーでも行えます。たとえば、API を初めて試す場合は、すべての API 呼び出しを管理者(メールアドレスのデフォルト)として実行する代わりに、実際のワークフローをテストするために、営業担当者、入稿担当者、広告主などのロールを持つユーザーを数人作成することをおすすめします。
- 新しい Gmail アドレス(
my.name.dfp.salesperson@gmail.com
など)を作成します。または、Gmail 以外の既存のアドレスを新しい Google アカウントとして登録します。 - その新しいアドレスと選択した
Role
を使用して、createUsers
を呼び出します。 - OAuth 2.0 を使用して新しいユーザーとして認証を行い、アクセス トークンを生成できます。
ルート 広告ユニットを取得する
子ノードを追加できる最上位の AdUnit
と許可される階層の深さは、アカウントの種類(小規模ビジネスまたはプレミアム)によって異なります。子ノードの変更をサポートする最上位の AdUnit
は、実質ルート AdUnit
と呼ばれます。
実質ルートを取得するには、NetworkService.getCurrentNetwork()
を呼び出して、返された Network
オブジェクトの effectiveRootAdUnitId
フィールドを調べます。
注: アカウントの種類によって、サポートされる階層のパターンは異なります。
オブジェクトのクエリ
検索条件によってオブジェクトを検索するには、多くのサービスで公開されている getObjectsByStatement()
メソッドを使用します。ここで、Object は特定のオブジェクト タイプです。このメソッドは PQL クエリを使用します。PQL クエリでは、検索対象のフィールド(フィールド名はオブジェクトのプロパティにマッピングされます)、並べ替え、制限、検索結果のオフセットを指定できます。PQL の詳細と、フィルタ条件にできるオブジェクト フィールドについては、PQL ガイドをご覧ください。
注文の作成
オーダーを作成するには、Order
オブジェクトを作成し、広告主、営業担当者、広告担当者の ID を適切なユーザーに設定し、一意の名前を割り当てて、createOrders()
を呼び出します。結果には、新しく作成された Order
またはエラーが含まれます。
例
注文を作成する Java コードの例をご覧ください。
広告申込情報を作成する
新しい広告申込情報を作成する手順は次のとおりです。
- 新しい
Order
オブジェクトを作成するか、既存のオブジェクトを使用します。 - 新しい
LineItem
オブジェクトを作成し、ローテーション タイプ、クリエイティブ サイズの配列、開始日と終了日、その他のプロパティを設定します。 - 新しい
InventoryTargeting
オブジェクトを作成し、ターゲットまたは除外するPlacement
オブジェクトまたはAdUnit
オブジェクトを指定します。 InventoryTargeting
オブジェクトを新しいTargeting
オブジェクトでラップして、LineItem
のターゲティング プロパティに割り当てます。- 作成したオブジェクトを使って、lineitem サービスのメソッド
createLineItems()
を呼び出し、その結果を調べて、オブジェクトが作成されたかどうかを確認します。
例
広告申込情報を作成する Java コードの例をご覧ください。
クリエイティブを作成する
サポートされるコンポーネントはクリエイティブの種類によって異なります。たとえば、イメージ クリエイティブはイメージのソースファイルを 1 つサポートします。Flash クリエイティブの場合は、基盤となる 2 つのアセット ファイル(Flash ファイルと代替画像ファイル(Flash ファイルを配信できない場合))がサポートされます。第三者のサイトでホストされているクリエイティブの場合は、第三者のサーバーにあるファイルを参照する HTML スニペットのみをアップロードします。クリエイティブを作成するためにアップロードする必要があるアセットについては、特定の Creative
サブクラスをご確認ください。
例
イメージ クリエイティブを作成する Java コードの例をご覧ください。
既存のオブジェクトの変更
既存のオブジェクトを変更するには、getObjectsByStatement()
を呼び出してオブジェクトを検索し、返されたオブジェクトの値を更新してから、updateObjects()
を呼び出します。
注: オブジェクトを更新すると、既存のオブジェクトが完全に置き換えられます。そのため、送信するオブジェクトでプロパティ値を設定しなかった場合、保存されたオブジェクトには、以前の値ではなく、そのプロパティのデフォルト値が使用されます。
オブジェクトのステータスを変更する
オブジェクトのステータスを変更するには、サービスによって公開される performObjectAction()
メソッドを呼び出します。このメソッドは次の 2 つのパラメータを受け取ります。
- 何をしたいかを記述するアクション オブジェクトのインスタンス。たとえば、orders サービスは
ApproveOrders
、PauseOrders
、ArchiveOrders
などの複数のアクションを公開しています。アクション オブジェクトはすべて、サービスに適した基本アクション クラスから派生しています。 - 変更するオブジェクトを記述する PQL クエリ。適切な PQL ステートメントを指定することで、一度に 1 つ以上のオブジェクトのステータスを変更できます。
広告タグの生成
API を使って広告タグを生成することはできません。代わりに Google アド マネージャーのウェブサイトを使用してください。詳しくは、ヘルプセンターのタグ設定 のセクションをご覧ください。
その他の例
クライアント ライブラリのサンプルコードには、さまざまなプログラミング言語で記述された多数の例が含まれています。クライアント ライブラリとサンプルコード のページで、ご使用のプログラミング言語でのサンプルへのリンクをご確認ください。