建立回應

應用程式處理 Google 的出價要求後，必須建構並傳送回應。本指南說明如何編寫應用程式程式碼來建構回應。

建立 BidResponse 訊息

如要提交出價，出價應用程式必須回應出價要求，並提供包含 Bid 的 BidResponse (格式為您設定的格式)。如果使用 JSON 格式，回應必須將 Content-Type 標頭設為 application/json; charset=utf-8，並在內文中加入 JSON BidResponse。如果使用 Protobuf 格式，應用程式必須將 Content-Type 標頭設為 application/octet-stream，並在主體中加入序列化的 BidResponse。

如要建構及序列化 Protobuf 格式的 BidResponse，您必須根據 openrtb.proto 和 openrtb-adx.proto 產生及使用 Protobuf 程式庫，這些程式庫分別在 Protobuf 中實作標準 OpenRTB BidResponse 欄位和 Google 擴充功能。您可以在「Protos & Reference Data」(Proto 和參考資料) 中找到這些資料。

如果您不想對曝光出價，則必須傳回空白的 HTTP 204 回應。應用程式必須針對每個 BidRequest 傳回回應。逾時和無法剖析的回應會視為錯誤，Google 會限制錯誤率偏高的出價工具。

廣告素材 ID

BidResponse 會透過 BidResponse.seatbid.bid.crid 欄位指定廣告素材 (上限 128 個位元組)。即使是相似的廣告素材，只要有任何顯著特徵不同 (包括但不限於大小、宣告網址、廣告素材屬性和供應商類型)，這個欄位就必須有不重複的值。換句話說，如果兩個廣告符合下列條件，就必須使用不同的廣告素材 ID：

  • 外觀或行為不同。
  • 算繪成不同圖片。
  • 以不同方式顯示 (例如一則廣告包含圖片，另一則廣告則是影片)。

設計應用程式時，請決定產生 ID 的系統化方式，以便與您打算提交的廣告素材類型搭配使用。

廣告屬性

Google 建議您宣告廣告素材屬性，使用 BidResponse.seatbid.bid.apis 和 BidResponse.seatbid.bid.attr 的組合，或 BidResponse.seatbid.bid.ext.attribute 擴充功能，描述廣告特性和指定目標。以下說明如何宣告屬性：

  • VPAID
    將 BidResponse.seatbid.bid.apis 設為 VPAID_1 或 VPAID_2。如果是 JSON 格式，則可分別設為 1 或 2。
  • MRAID
    將 BidResponse.seatbid.bid.apis 設為 MRAID_1，或設為 3 (JSON 格式)。
  • SIZELESS
    將 BidResponse.seatbid.bid.attr 設為 RESPONSIVE，或設為 18 (JSON 格式)。
  • PLAYABLE
    方法是將 BidResponse.seatbid.bid.attr 設為 USER_INTERACTIVE，或將 JSON 格式設為 13。

如要瞭解如何取得廣告素材偵測屬性的意見回饋，請參閱廣告素材資源。

公開出價欄位

參與公開出價的廣告交易平台和聯播網出價方，傳送的出價回應與參與標準即時出價的 Authorized Buyers 類似。公開出價客戶可以指定少數額外欄位，部分現有欄位可能有其他用途。其中包括：

欄位 詳細資料
BidResponse.imp.pmp.deals.id

與這項出價相關聯，且會回報給發布商的廣告交易平台命名空間交易 ID。
BidResponse.seatbid.bid.ext.exchange_deal_type

向發布商回報的交易類型，會影響交易在競價中的處理方式。
BidResponse.seatbid.bid.ext.third_party_buyer_token 如果公開出價方廣告交易平台是中介商，則用於識別最終第三方買方資訊的權杖。這項資訊是從第三方買家取得，必須在出價回應中原封不動傳遞給 Google。

建議

  • 在伺服器上啟用永久 HTTPS 連線 (也稱為「keep-alive」或「連線重複使用」)。請將逾時時間設為至少 10 秒，在許多情況下，較高的值會比較有利。Google 會在應用程式的初始延遲時間測試期間驗證這一點，因為 Authorized Buyers 會以高頻率傳送要求，且必須避免為每個要求建立個別 TCP 連線而產生的延遲時間負擔。

  • 加入選用的曝光追蹤網址，即可在曝光顯示時 (而非出價方得標時) 進行追蹤。由於勝出和顯示之間存在落差，因此這種做法可提供更準確的追蹤統計資料。

  • 請確保出價工具程式碼不依賴已淘汰的欄位，否則出價可能會失敗並發生錯誤。
  • 在 BidResponse 中加入 BidResponse.seatbid.bid.w 和 BidResponse.seatbid.bid.h。如果請求包含多個廣告大小，則 BidResponse 必須包含這些欄位，否則會從競價中移除。
  • 回應大小不得超過 8K。如果回應過大，可能會增加網路延遲時間，並導致逾時。
  • 請按照指南，對需要 SKAdNetwork 歸因的 iOS 廣告空間出價。

出價回應範例

以下範例是 Protobuf 和 JSON 要求的人類可讀範例。

OpenRTB Protobuf

OpenRTB JSON

重要事項：範例中的 Protobuf 訊息在此處以人類可讀的文字表示。不過，這並非訊息在網路上傳送的方式。使用 OpenRTB Protobuf 格式時，系統只會接受序列化的 BidResponse 訊息。

您可以使用下列 C++ 程式碼建立 BidResponse 訊息並序列化：

BidResponse bid_response;
// fill in bid response with bid information
string post_response;
if (bid_response.SerializeToString(&post_response)) {
  // respond to the POST with post_response as the content
} else {
  // return an error to the POST
}

指定廣告素材

出價回應會指定出價勝出時要放送的廣告素材。出價必須包含其中一種支援的廣告格式 (AMP、影片、原生)。在本範例中，我們使用 html_snippet 欄位指定廣告素材。

或者，您也可以根據廣告格式，使用下列其中一個欄位指定廣告素材：

  • SDK 顯示的廣告
    • BidResponse.seatbid.bid.ext.sdk_rendered_ad
  • AMP
    • BidResponse.seatbid.bid.amp_ad_url
  • 影片
    • BidResponse.seatbid.bid.adm
  • 原生廣告
    • BidResponse.seatbid.bid.adm_native

在 BidResponse.seatbid.bid.adm 欄位中使用 HTML 程式碼片段，指定託管於您伺服器的廣告。程式碼片段會封裝在插入網頁的 iFrame 中，因此系統會在網頁載入時擷取並顯示廣告。您必須精心設計 HTML 程式碼片段，確保廣告 (橫幅或插頁式) 能在 iframe 中正確顯示，且大小符合您出價的廣告版位。

此外，在下列情況下，出價回應中宣告的廣告大小必須與出價要求中的其中一個大小組合完全相符：

  • 廣告是一般橫幅廣告 (非影片、原生或插頁式廣告)。
  • 出價方已在出價回應中宣告大小。如果請求中有多個大小，則必須宣告大小。
  • 插頁式廣告則不在此限。插頁式廣告的寬度至少須為螢幕寬度的 50%，高度至少須為螢幕高度的 40%。

您可以使用任何能正確顯示的有效 HTML 程式碼，指定 HTML 程式碼片段廣告素材，但請留意「建立 BidResponse 訊息」一節中，指定 crid 欄位的限制。舉例來說，您可以在從伺服器擷取的網址引數中加入額外資訊，做為廣告顯示的一部分。這樣一來，您就能將曝光的任意資料傳回自己的伺服器。

出價回應中傳回的 HTML 程式碼片段，大部分政策都與第三方廣告相同。詳情請參閱「Authorized Buyers 計畫指南」、「第三方廣告放送相關規定」和「在廣告中宣告到達網址」。

使用一致的到達網址

您在 BidResponse.seatbid.bid.ext.clickurl 欄位中指定的到達網址，必須與廣告素材中指定的到達網頁網址相同。以下是支援格式的廣告素材範例，與設為 https://play.google.com/store/apps/details?id=com.example.myawesomeapp&referrer=utm_source%3Dgoogle_ab%26utm_medium%3Dcpc%26utm_campaign%3Dinstall_campaign_1 的 clickurl 欄位一致：

HTML

<div id="my-app-install-ad"
     style="font-family: sans-serif; border: 1px solid #ddd; padding: 10px;
            display: flex; align-items: center; width: 100%; height: 100%;
            box-sizing: border-box; cursor: pointer;"
     onclick="window.open('https://play.google.com/store/apps/details?id=com.example.myawesomeapp&referrer=utm_source%3Dgoogle_ab%26utm_medium%3Dcpc%26utm_campaign%3Dinstall_campaign_1', '_blank')">
  <img src="https://example.com/path/to/app_icon.png" alt="App Icon"
       style="width: 60px; height: 60px; margin-right: 10px;
              border-radius: 8px;">
  <div style="flex-grow: 1;">
    <h4 style="margin: 0 0 5px 0; font-size: 16px; color: #1a73e8;">
      My Awesome App
    </h4>
    <p style="margin: 0 0 10px 0; font-size: 14px; color: #5f6368;">
      The best app for doing awesome things! Download now and get started!
    </p>
    <span style="background-color: #1a73e8; color: white; padding: 8px 12px;
                 text-align: center; text-decoration: none;
                 display: inline-block; border-radius: 4px; font-size: 14px;
                 font-weight: bold;">Install</span>
  </div>
</div>

VAST XML

<VAST version="3.0">
  <Ad id="creative_id_789">
    <InLine>
      <AdSystem>MyBidderSystem</AdSystem>
      <AdTitle>My Awesome App Install Video</AdTitle>
      <Description>Install My Awesome App now!</Description>
      <Error>
        <![CDATA[https://tracking.example.com/vast_error?errorcode=[ERRORCODE]]]>
      </Error>
      <Impression>
        <![CDATA[https://tracking.example.com/vast_impression]]>
      </Impression>
      <Creatives>
        <!-- Main Video Creative -->
        <Creative>
          <Linear>
            <Duration>00:00:15</Duration>
            <TrackingEvents>
              <Tracking event="start">
                <![CDATA[https://tracking.example.com/vast_event?label=start]]>
              </Tracking>
              <Tracking event="firstQuartile">
                <![CDATA[https://tracking.example.com/vast_event?label=firstQuartile]]>
              </Tracking>
              <Tracking event="midpoint">
                <![CDATA[https://tracking.example.com/vast_event?label=midpoint]]>
              </Tracking>
              <Tracking event="thirdQuartile">
                <![CDATA[https://tracking.example.com/vast_event?label=thirdQuartile]]>
              </Tracking>
              <Tracking event="complete">
                <![CDATA[https://tracking.example.com/vast_event?label=complete]]>
              </Tracking>
            </TrackingEvents>
            <VideoClicks>
              <ClickThrough id="gplay-video">
                <![CDATA[https://play.google.com/store/apps/details?id=com.example.myawesomeapp&referrer=utm_source%3Dgoogle_ab%26utm_medium%3Dcpc%26utm_campaign%3Dinstall_campaign_1]]>
              </ClickThrough>
              <ClickTracking id="bidder-tracker-video">
                <![CDATA[https://tracking.example.com/vast_click]]>
              </ClickTracking>
            </VideoClicks>
            <MediaFiles>
              <MediaFile delivery="progressive" type="video/mp4" width="640"
                         height="360" bitrate="800" scalable="true"
                         maintainAspectRatio="true">
                <![CDATA[https://cdn.example.com/myawesomeapp_video.mp4]]>
              </MediaFile>
            </MediaFiles>
          </Linear>
        </Creative>
        <!-- Companion Ad Creative -->
        <Creative>
          <CompanionAds>
            <Companion id="companion1" width="300" height="250"
                       assetWidth="300" assetHeight="250">
              <StaticResource creativeType="image/png">
                <![CDATA[https://cdn.example.com/companion_banner_300x250.png]]>
              </StaticResource>
              <TrackingEvents>
                <Tracking event="creativeView">
                  <![CDATA[https://tracking.example.com/vast_companion_view]]>
                </Tracking>
              </TrackingEvents>
              <CompanionClickThrough>
                <![CDATA[https://play.google.com/store/apps/details?id=com.example.myawesomeapp&referrer=utm_source%3Dgoogle_ab%26utm_medium%3Dcpc%26utm_campaign%3Dinstall_campaign_1]]>
              </CompanionClickThrough>
              <CompanionClickTracking>
                <![CDATA[https://tracking.example.com/vast_companion_click]]>
              </CompanionClickTracking>
            </Companion>
          </CompanionAds>
        </Creative>
      </Creatives>
    </InLine>
  </Ad>
</VAST>

原生

{
  "ver": "1.2",
  "assets": [
    {
      "id": 1,
      "title": {
        "text": "My Awesome App"
      }
    },
    {
      "id": 2,
      "img": {
        "url": "https://example.com/path/to/app_icon.png",
        "w": 60,
        "h": 60
      }
    },
    {
      "id": 3,
      "data": {
        "value":
          "The best app for doing awesome things! Download now and get started!"
      }
    },
    {
      "id": 4,
      "data": {
        "value": "Install"
      }
    }
  ],
  "link": {
    "url": "https://play.google.com/store/apps/details?id=com.example.myawesomeapp&referrer=utm_source%3Dgoogle_ab%26utm_medium%3Dcpc%26utm_campaign%3Dinstall_campaign_1",
    "clicktrackers": [
      "https://tracking.example.com/native_click"
    ]
  },
  "imptrackers": [
    "https://tracking.example.com/native_impression"
  ]
}

指定巨集

巨集是嵌入在部分出價回應欄位中的格式化文字，其中包含網址，會在廣告放送時替換為相關值。舉例來說，如果得標出價在出價隨附的 HTML 程式碼片段廣告素材中包含 AUCTION_PRICE 巨集，系統會將巨集替換為可解密的值，以便判斷您在競價中為曝光支付的金額。

您可以在下列欄位中加入巨集：

  • BidResponse.seatbid.bid.adm

    巨集支援 HTML 程式碼片段、原生、影片網址和影片 VAST XML 格式。

  • BidResponse.seatbid.bid.adm_native.eventtrackers.url

  • BidResponse.seatbid.bid.adm_native.imptrackers

  • BidResponse.seatbid.bid.ext.amp_ad_url

    AMP 廣告素材僅支援 Google 專用的 WINNING_PRICE 和 WINNING_PRICE_ESC 巨集。

  • BidResponse.seatbid.bid.burl

  • BidResponse.seatbid.bid.ext.impression_tracking_url

    如果您需要多個帳單網址，請使用這個欄位，而非 BidResponse.seatbid.bid.burl。

舉例來說，您可以在用於擷取廣告素材的網址中嵌入 ${MACRO}，將巨集納入 HTML 程式碼片段，其中 MACRO 是 OpenRTB 規格中描述的支援巨集之一。

Google 巨集

除了 OpenRTB 規格中的巨集外，Google 還支援其他巨集。這些巨集的格式不同，如果嵌入網址，會顯示為 %%MACRO%%。下表說明這些巨集：

微距 說明
ADVERTISING_IDENTIFIER 允許買家在曝光顯示時接收 iOS 廣告識別碼或 Android 廣告 ID。詳情請參閱「解密廣告 ID」。
CACHEBUSTER 隨機、無正負號、四位元組整數的字串表示法。
CLICK_URL_UNESC

廣告的未逸出點擊網址。在程式碼片段中，巨集後面應直接加上逸出版本的第三方點擊網址。

舉例來說，如果第三方點擊網址是 http://my.adserver.com/some/path/handleclick?click=clk，則下列程式碼可與巨集叫用後單次逸出的第三方點擊網址搭配使用：

<a href="%%CLICK_URL_UNESC%%http%3A%2F%2Fmy.adserver.com%2Fsome%2Fpath%2Fhandleclick%3Fclick%3Dclk"></a>

廣告放送時，這個巨集會展開為：

<a href="http://google-click-url?...&ad_url=http%3A%2F%2Fmy.adserver.com%2Fsome%2Fpath%2Fhandleclick%3Fclick%3Dclk"></a>

這個網址會先向 Google 登錄點擊，然後重新導向至第三方點擊網址。
CLICK_URL_ESC

廣告的逸出點擊網址。若您需要先將值傳遞到另一部稍後將會傳回重新導向的伺服器，請使用此巨集取代 CLICK_URL_UNESC。

舉例來說，您可以在 HTML 程式碼片段中使用下列程式碼： 

<a href="http://my.adserver.com/click?google_click_url=%%CLICK_URL_ESC%%"></a>

在廣告放送時，這會展開為：

<a href="http://my.adserver.com/click?google_click_url=http://google-click- url%3F...%26ad_url%3D"></a>

這會向 my.adserver.com 註冊點擊，然後由負責重新導向至 google_click_url 參數中傳遞的網址。這項假設的前提是 my.adserver.com 會取消逸出 google_click_url 參數。

您可以在 %%CLICK_URL_ESC%% 後方附加雙重逸出的網址。my.adserver.com 完成取消逸出後，會留下附加至 google_click_url 的單一逸出版本網址。擷取 google_click_url 時，系統會再次取消逸出，然後重新導向。
CLICK_URL_ESC_ESC

廣告的雙重逸出網址。如果您需要先將值傳遞到另一部稍後將會傳回重新導向的伺服器，請使用此巨集取代 CLICK_URL_UNESC。

舉例來說，您可以在 HTML 程式碼片段中使用下列程式碼： 

<a href="http://my.adserver.com/click?google_click_url=%%CLICK_URL_ESC_ESC%%"></a>

廣告放送時，這個巨集會展開為：

<a href="http://my.otheradserver.com/click?google_click_url=http%3A%2F%2Fmy.adserver.com%2Fclick%3Fgoogle_click_url%3Dhttp%3A%2F%2Fgoogle-click-%20url%253F...%2526ad_url%253D"></a>
SCHEME 如果出價要求不需要 SSL，則會展開為 http:；如果出價要求需要 SSL，則會展開為 https:。
SITE 內容網址的網址逸出網域，或匿名廣告空間的匿名 ID。
SITE_URL 已淘汰，由 SITE 巨集取代，提供相同功能。
TZ_OFFSET 時區偏移。
VERIFICATION

實際工作環境和廣告素材在驗證管道中掃描時的不同值。格式為：%%?VERIFICATION:true-val:false-val%%，其中除了巨集以外，任何值都可用於 true-val 和 false-val，包括空字串。如果是公開出價，建議廣告交易平台使用這個巨集；這樣一來，需求端平台就不需要進行任何變更。

舉例來說，如果廣告素材包含 %%?VERIFICATION:-1:5000%%，則放送時的文字替換會是 5000，驗證管道中的文字替換則是 -1。這有助於區分這兩組連線偵測 (ping)。
WINNING_PRICE

經過編碼的曝光費用 (單次安裝出價，而非千次曝光出價)，以帳戶幣別的百萬分之一表示。舉例來說，以美金 $5 元贏得的千次曝光出價，相當於 5 百萬個百萬分之一的千次曝光出價，或是 5 千個百萬分之一單次安裝出價。在此情況下，WINNING_PRICE 的解碼值為 5,000。勝出價格會以單次安裝出價指定。

如要剖析這個巨集，您必須導入可解密價格確認資訊的應用程式。詳情請參閱「解密價格確認」頁面。
WINNING_PRICE_ESC 網址逸出的 WINNING_PRICE。

Google 要求您在第三方放送廣告的廣告素材中，使用 CLICK_URL_UNESC 或 CLICK_URL_ESC 巨集。Google 會使用 CLICK_URL 巨集進行點擊追蹤。

巨集中的網址逸出使用下列配置：

  • 空格字元會替換為加號 (+)。
  • 英數字元 (0-9、a-z、A-Z) 和 !()*,-./:_~ 組合中的字元會維持不變。
  • 所有其他字元都會替換為 %XX，其中 XX 是代表該字元的十六進位數字。

發布商限制和規定

出價要求包含發布商對競價中廣告素材設定的限制和規定。

  • BidRequest.bcat
    • 您可以使用 Real-time Bidding API 的 detectedCategories 欄位，比較這個欄位指定的封鎖類別，與提交廣告素材偵測到的類別。
  • BidRequest.imp.ext.allowed_vendor_type
  • BidRequest.imp.secure
    • 實際上，這項屬性一律會設為 true，因為 Google 要求所有廣告素材都必須支援 SSL。
  • BidRequest.imp.{audio/banner/native/video}
  • BidRequest.imp.{audio/banner/native/video}.api
  • BidRequest.imp.{audio/banner/native/video}.battr
  • BidRequest.imp.{audio/banner/video}.mimes

請勿使用含有受限功能的廣告出價。對於允許的功能 (例如供應商類型)，只有在廣告的供應商類型位於 BidRequest 的 allowed_vendor_type 清單中時，系統才會傳回廣告。出價中只能包含出價要求中指定的廣告格式，方法是填入 BidRequest.imp.banner 等欄位。如要進一步瞭解這些欄位，請參閱 BidRequest 通訊協定緩衝區定義中的註解。

如果 BidResponse 傳回廣告，您必須在 BidResponse 中準確設定 BidResponse.seatbid.bid.attr、BidResponse.seatbid.bid.cat，以及 BidResponse.seatbid.bid.adomain 或 BidResponse.seatbid.bid.adm_native.link.url 欄位。如果廣告在這些欄位有多個適用值，則必須包含所有值。如要進一步瞭解這些欄位，請參閱 BidResponse 通訊協定緩衝區定義中的註解。如果回應未設定這些欄位，系統會捨棄回應。

Open Measurement

Open Measurement 可讓您指定第三方供應商，為在行動應用程式環境中放送的廣告，提供獨立評估和驗證服務。

支援的廣告格式包括影片、橫幅和插頁式廣告。如要進一步瞭解如何在包含這些格式的出價回應中使用 Open Measurement，請參閱 Open Measurement 評估 SDK 說明中心文章。

出價回應範例

以下各節提供不同廣告類型的出價回應範例。

應用程式橫幅廣告

OpenRTB Protobuf

OpenRTB JSON

應用程式插頁式廣告

OpenRTB Protobuf

OpenRTB JSON

應用程式插頁式影片廣告

OpenRTB Protobuf

OpenRTB JSON

應用程式原生

OpenRTB Protobuf

OpenRTB JSON

網路影片

OpenRTB Protobuf

OpenRTB JSON

廣告交易平台出價的行動版網站橫幅廣告

OpenRTB Protobuf

OpenRTB JSON