API ワークフロー

取引を作成する

  1. 外部取引 ID フィルタを使用して商品を LIST し、商品がすでに作成されているかどうかを確認します。External_deal_id はすべての商品で一意である必要があります。

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"
    
  2. [Create Order](注文を作成)をクリックします。名前は DV3 によって生成されます。この ID は、将来の取得のためにシステム内のどこかに保存しておくことをおすすめします。

  3. 注文に商品を作成します。プロダクト名は DV3 によって生成されます。この ID は、後で取得できるように、システム内のどこかに保存しておくことをおすすめします。

    または、external_deal_id を使用して LIST を実行することもできます。名前フィールドには注文 ID と商品 ID の両方が含まれているため、この方法で親を簡単に識別できます。

取引をキャンセルする

  1. 注文ステータスを [キャンセル] に更新 注文が承認されていない場合にのみキャンセルをサポートします。Cancelled は最終状態です。注文をキャンセルすると、再度有効にすることはできません。

取引の詳細を取得する

  1. 注文の詳細を取得します。ステータスは、ユーザーが注文を承認、アーカイブ、キャンセルすると更新されます。
  2. プロダクトの詳細を取得します

取引のリストを取得する

  1. ステータス フィルタを使用して LIST 注文を行い、承認済みまたは承認待ちのすべての注文を取得します。
  2. external_deal_id フィルタを使用して商品を一覧表示します。
  3. 注文内のすべての商品を一覧表示します。

ディールを更新する

  1. パブリッシャーの連絡先情報の更新
    1. name は更新できません(field_mask で設定できません)。ステータスは API を介してのみ [Canceled] に設定できます。
    2. partner_id は更新できません。
  2. 特定の取引条件の更新について、商品を更新します。
    1. name、externalDealId、transactionType、pricingType、updateTime は更新できません。
    2. displayName の更新にはユーザーの同意は必要ありません。
    3. rateDetails と creativeConfig を更新すると、親注文のステータスが [承認待ち] に変更されます。DV3 広告主様には、以前の注文が承認されたかどうかに関係なく、交渉ページで新しい条件に同意していただくようお願いしています。

ユーザーが取引を承認したかどうかを確認する

  1. 対応する注文 ID がわかっている場合は、Get Order を使用します。ステータス フィールドを確認します。
  2. 注文 ID がトラッキングされていない場合: external_deal_id フィルタを使用して商品を一覧表示し、商品名から注文名を特定してから、注文を取得します。ステータス フィールドを確認します。

ユーザーがセール情報を設定しているかどうかを確認する(PG のみ)

  1. 広告枠ソースを取得します。名前は「exchanges/{exchangeId}/inventorysources/{external_deal_id}」です。購入者のステータスを確認してください。
    1. 予約のお得情報
      1. BUYER_STATUS_ACTIVE は、取引が承認され、設定されていることを意味します。DV360 が取引条件に一致する入札リクエストを受信すると、取引はこの状態になります。広告申込情報は、取引構成の手順で自動的に生成されます。詳しくは、取引の設定をご覧ください。
      2. BUYER_STATUS_PENDING は、注文は受け付けられたものの、取引がまだ設定されていないことを意味します。この状態では費用は発生しません。
      3. BUYER_STATUS_PAUSED は、広告主様によって取引が明示的に一時停止されたことを意味します。この状態では費用は発生しません。
    2. 純広告取引
      1. BUYER_STATUS_ACTIVE は、取引が承認されたことを意味します。この状態では、DV360 が取引条件に一致する入札リクエストを受け取り、この取引をターゲットに設定している有効な広告申込情報があり、入札リクエストが広告申込情報のターゲティング条件に一致する場合に、取引で費用が発生します。詳しくは、広告申込情報をご覧ください。** 広告申込情報で取引がターゲットに設定されているかどうかをクエリする Seller API はありません。**
      2. BUYER_STATUS_PENDINGの対象外です。
      3. BUYER_STATUS_PAUSED は、広告主様によって取引が明示的に一時停止されたことを意味します。この状態では費用は発生しません。

取引の承認後に一時停止または一時停止を解除する

  1. 広告枠ソースの更新販売者のステータス
    1. 一時停止/一時停止の解除は、取引の配信に影響しません。販売者が取引を一時停止した場合、広告主には参考情報として文字列メッセージのみが表示されます。これにより、広告主様は費用が発生していない取引のトラブルシューティングを行うことができます。

再交渉(承認後に取引を更新)

再交渉とは、購入者が取引を承認した後に取引に更新を加えることを指します。この機能は、エクスチェンジと購入者の両方が、承認済みのディールに新しい変更をプッシュする際に非常に役立ちます。たとえば、取引所が、承認済みの取引の終了時刻が正しくないことを検出し、取引がまだ開始されていない場合は、DV3 Update Product を使用して DV3 バイヤーに更新をプッシュできます。

許可される変更と許可されない変更。

startTimeendTimerateDetailscreativeConfig などの一部のサービング クリティカル フィールドを除き、すべてのフィールドの変更が許可されています。これらのサービング クリティカル フィールドについては、検証が行われます。一般的に、creativeConfig 以外のこれらのフィールドの更新は、取引の開始時間が 1 日以上先であれば許可されます。開始時間が過去で終了時間が未来の進行中の取引では、増分更新のみが許可されます。終了時刻が過去の完了した取引は変更できません。たとえば、1 年前に完了した取引の rateDetails を更新することはできません。このような場合、DV3 の [Update](更新)アイテムは検証エラーをスローします。