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