Marketplace API

概要

認定バイヤー Marketplace API は、購入者がプログラムで次の情報を管理できるリソースのコレクションです。

  • パブリッシャーとの交渉
  • オークション パッケージ
  • 認定バイヤー マーケットプレイスの UI へのクライアント アクセス

このガイドでは Marketplace API を紹介し、Marketplace API リソースが認定バイヤー管理画面の Marketplace の機能にどのように対応しているかについて説明します。

入札者と購入者

Marketplace API は、Real-time Bidding API の構造と同じです。どちらの API も、ビッダーと購入者のオペレーションのルートレベルのリソースとして bidders と buyers を使用します。Realtime Bidding API と Marketplace API のリソースパスで同じビッダー名と購入者名を使用できます。

クライアントとクライアント ユーザー

Marketplace API を使用すると、クライアントやクライアント ユーザーを作成、管理できるほか、認定バイヤーの UI の [マーケットプレイス] タブへのアクセス権を代理店や広告主にプログラムで付与できます。

Client は、認定バイヤー アカウントに関連付けられているクライアント、代理店、広告主を表します。

ClientUser は、Client で UI のアクセス権を持つ特定の個人を表します。クライアント ユーザーは Marketplace API にアクセスできません。クライアント ユーザーは、アカウントの [マーケットプレイス] タブへのアクセスが制限されています。クライアント ユーザー権限は、親 Client で指定された role によって決まります。

Marketplace API の他のリソースは、Clients リソースで指定された名前でクライアントを参照します。

認定バイヤー マーケットプレイスの UI でのクライアントとクライアント ユーザーについて詳しくは、次のヘルプセンター記事をご覧ください。

メディア プランナー

メディア プランナーとは、パブリッシャーと個別に取引の交渉を行い、1 人以上の入札者が最終的な取引に代わって入札できるようにする代理店などの事業体です。この取引は、プライベート オークションまたは優先取引のいずれかであり、確定するまで表示や操作はできません。確定すると、bidders.finalizedDeals.list レスポンスに表示されます。

特定の確定済み取引がメディア プランナーと交渉済みかどうかを判断するには、取引の mediaPlanner フィールドにデータが入力されているかどうかを確認します。メディア プランナーは、取引の対象とする DSP 固有のシート ID のリストを設定します。これは、eligibleSeatIds フィールドで表示できます。リアルタイム ビッダーの入札リクエストでは、パブリッシャーが設定した許可リストまたはブロックリストにこれらのシート ID が含まれることがあり、それによって入札がオークションから除外されるかどうかが決まります。次の BidRequest フィールドに表示されます。

  • OpenRTB プロトコル
    • BidRequest.wseat
    • BidRequest.bseat
    • BidRequest.imp.pmp.deals.wseat
  • Google RTB プロトコル
    • BidRequest.adslot.allowed_seat_ids
    • BidRequest.adslot.blocked_seat_ids
    • BidRequest.adslot.matching_ad_data.direct_deal.allowed_seat_ids

オークション パッケージ

Marketplace API を使用して、オークション パッケージに対する購入者とクライアントの登録と登録解除、および登録しているオークション パッケージの確認を行うことができます。

AuctionPackage は、マーケットプレイス広告枠のターゲティング バンドルに似ています。たとえば、オークション パッケージでは、購入者のビジネス上の利益に関連する URL とモバイルアプリ ID のコレクションをターゲットに設定します。

Marketplace API を使用して新しいオークション パッケージを作成することはできません。オークション パッケージは、認定バイヤーのマーケットプレイスの管理画面から作成できます。Marketplace API には、オークション パッケージに関連付けられた特定のターゲティング情報は含まれません。

オークション パッケージを他の購入者やクライアントと共有したり、Google または他の購入者が作成したオークション パッケージをお客様と共有したりできます。

詳しくは、オークション パッケージをご覧ください。

パブリッシャー プロフィール

Marketplace API を使用して、交渉可能なパブリッシャーのプロファイルを表示できます。

PublisherProfile は、Marketplace API のパブリッシャーを表します。Marketplace API の他のリソースは、PublisherProfile で指定された名前でパブリッシャーを参照します。

パブリッシャー プロフィールには、認定バイヤー マーケットプレイスの UI の [探す] タブにある [パブリッシャー] と同様の情報が表示されます。

詳細については、パブリッシャーを見つける方法をご覧ください。

提案と取引

Marketplace API を使用して、パブリッシャーと取引を交渉できます。Marketplace API を使用して取引を管理する方法をいくつか紹介します。

プロポーザルは、購入者またはクライアントとパブリッシャーの間で交わされた 1 つ以上の取引の最新の交渉ステータスを表すもので、認定バイヤー マーケットプレイスの UI の [交渉] タブに似ています。

取引は、特定のプロポーザルの下で交渉中の取引の最新の条件を表し、認定バイヤーのマーケットプレイス UI に表示される、特定のプロポーザルに関する現在の交渉と表示される取引のリストに相当します。

確定した取引は、交渉フェーズが完了し、配信可能な状態になっている取引を表します。これには、すでに配信中の取引も含まれます。確定した取引は、認定バイヤー マーケットプレイスの UI の [取引] タブに似ています。

交渉するディールの種類によっては、Marketplace API リソース間で動作が異なる場合があります。たとえば、購入者がすべての取引タイプで交渉を開始することはできません。交渉での Marketplace API の実装について詳しくは、次のリソースをご覧ください。

認定バイヤー マーケットプレイスの UI での交渉について詳しくは、以下をご覧ください。