このページは Cloud Translation API によって翻訳されました。

背景

始める前に

アプリケーションがアクセスするアカウントに適切な権限を設定するようアカウント担当者に依頼してください。
認定バイヤーのコンセプトに慣れていない方は、認定バイヤーヘルプセンターで管理画面をぜひお試しください。アプリケーションでリアルタイムビッダーを実行する場合は、RTB プロトコルのドキュメントをご覧ください。
新しいプロジェクトを設定するには、API Console にアクセスします。デベロッパーの Google アカウントにログインするか、アカウントを作成します。プロジェクトを作成し、いくつかの利用規約への同意を求めるメッセージが表示されます。

親アカウントと子アカウント

親アカウントと子アカウントを含むアカウント構造内で作業している場合は、それぞれの相互作用を理解することでより効果的な作業を行える可能性があります。概要は次のとおりです。

子アカウント

子アカウントへのアクセスを許可する認証情報を持つユーザーは、自分のアカウントに関連付けられているリソースの表示と変更のみを行えます。子アカウントで、他の子アカウントまたは親アカウントに属するリソースを表示または変更することはできません。

親アカウント

親アカウントへのアクセス権を付与する認証情報を持つユーザーは、関連付けられたすべての子アカウントに加えて、親アカウントのリソースを表示および変更できます。指定したすべてのリソースをリストするオペレーションの場合、このユーザーは自分のアカウントとすべての子アカウントのデータを含むレスポンスを受け取ります。子シートのリソースをターゲットとする他のタイプのリクエストでは、親アカウントが自身の accountId ではなく、子アカウントの accountId パスパラメータを指定する必要があります。

REST API データモデル

リソースとは、一意の識別子を持つ個別のデータエンティティです。Accounts リソースは、認定バイヤーアカウントのエントリを表し、Ad Exchange Buyer API のルートデータクラスです。この API のメソッドは、個々の Accounts リソースと Accounts リソースのコレクションに対して機能します。

Accounts リソースには、アカウント ID、Cookie マッチングで使用される情報、入札者のロケーション、入札リクエストが送信される URL、アドエクスチェンジから送信される 1 秒あたりの最大クエリ数を指定するリクエストが含まれます。

Account リソースとコレクションに加えて、Ad Exchange Buyer API では次のデータ構造が定義されます。

ビッダーの地域

ビッダーのロケーションは、アカウントリソースとともに返される構造で、アドエクスチェンジが入札リクエストを送信する URL と、アドエクスチェンジが送信する 1 秒あたりの最大クエリ数を指定します。JSON で表現されたビッダーの地域の例を次に示します。

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

項目

項目にはアカウントのリストが表示されます。JSON で表現されたアイテムの例を次に示します。

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

サポートされているオペレーション

Ad Exchange Buyer API では、コレクションとリソースに対して次の表に示す 3 種類のメソッドを呼び出すことができます。すべてのオペレーションで承認が必要です。

オペレーション	説明	REST HTTP マッピング
list	現在認証されているユーザーがアクセスできるすべてのアカウントを一覧表示します。	コレクション URI に対する `GET`。
get	特定の Accounts リソースを取得します。	リソース URI に対する `GET`。
update	特定の Accounts リソースを更新します。	リソース URI に対する `PUT`。更新されたリソースのデータを渡します。

通話スタイル

REST は、データをリクエストして変更するための便利で一貫したアプローチを提供するソフトウェアアーキテクチャのスタイルです。

REST という用語は「Representational State Transfer」の省略形です。Google API のコンテキストでは、HTTP 動詞を使用して、Google が保存しているデータ表現を取得および変更することを表しています。

RESTful システムでは、リソースはデータストアに保存されており、クライアントはサーバーが特定のアクション（リソースの作成、取得、更新、削除など）を実行するようにリクエストを送信します。サーバーはそのアクションを実行し、多くの場合、指定されたリソースの表現形式でレスポンスを送信します。

Google の RESTful API では、クライアントは POST、GET、PUT、DELETE などの HTTP 動詞を使用してアクションを指定します。次の形式のグローバルに一意な URI でリソースを指定します。

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

すべての API リソースは HTTP でアクセス可能な一意の URI を持っているため、REST はデータキャッシュを有効にし、ウェブの分散インフラストラクチャで動作するように最適化されています。

HTTP 1.1 標準のドキュメントのメソッド定義をご覧ください。GET、POST、PUT、DELETE の仕様が記載されています。

Ad Exchange Buyer API の REST

API オペレーションで説明されているように、サポートされているオペレーションは REST HTTP 動詞に直接マッピングされます。

API URI の具体的な形式は次のとおりです。

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

ここで、resourceID はアカウントリソースの識別子、parameters はクエリに適用するパラメータです。詳細については、標準クエリパラメータとリファレンスドキュメントをご覧ください。

resourceID パス拡張の形式を使用すると、現在操作しているリソースを識別できます。次に例を示します。

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

API でサポートされている各オペレーションで使用される URI の完全なセットは、リファレンスドキュメントにまとめられています。

Ad Exchange Buyer API での動作例を以下に示します。

認証されたユーザーのアカウントのリストを取得します。

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

データ形式

JSON

JSON（JavaScript Object Notation）は言語に依存しない一般的なデータフォーマットで、任意のデータ構造を単純なテキスト形式で表すことができます。詳しくは json.org をご覧ください。