疑難排解

在許多情況下,當您使用 Display & Video 360 API 時可能會發生錯誤。這可能與程式碼中的錯誤、使用者輸入內容無效,甚至是 API 本身有關的問題。無論原因為何,瞭解如何排解錯誤,都是開發程序中相當重要的一環。本指南提供一些最佳做法提示,協助您快速上手。

探討基本概念

  1. 詳閱事前準備指南。請確認您有權存取 Display & Video 360 以及設定妥當的 API 專案。
  2. 如果回應包含 HTTP 錯誤,請務必仔細檢查這些錯誤,並確保要求是向正確的 API 和服務發出。
  3. 請詳閱授權指南。請確認您的要求包含必要的 OAuth 2.0 憑證。
  4. 驗證您使用的是正確的憑證。若要進一步瞭解如何產生驗證憑證,請參閱設定應用程式指南。您也可以將存取權杖傳送至 Google OAuth2 API 的權杖資訊端點,驗證該憑證已核發至正確的 API 專案,且已授權給正確的範圍:

    POST https://www.googleapis.com/oauth2/v2/tokeninfo?access_token={YOUR_ACCESS_TOKEN}
    
    200 OK
    
    {
     "issued_to": "{API_PROJECT_CLIENT_ID}",
     "audience": "...",
     "scope": "{API_SCOPES}",
     "expires_in": ...
    }
    

瞭解錯誤

當 API 發生錯誤時,通常會傳回包含 error 物件的 JSON 回應。這個物件可提供特定錯誤的額外背景資訊。

{
 "error": {
  "code": 404,
  "message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
  "status": "NOT_FOUND"
 }
}

error 物件的內容通常包含足夠的資訊,可協助您找出問題所在。否則,您可能需要進一步研究,才能找出錯誤所代表的意義。

研究錯誤

  1. 請參閱常見錯誤一節,其中針對一些最常見的錯誤提供詳細說明。

  2. 如果錯誤章節並未說明錯誤,請參閱參考說明文件,並嘗試搜尋錯誤代碼、狀態和訊息。

  3. 如果發現任何未列出的錯誤,請通知我們。

找出根本原因

在這個階段,您已找出錯誤並瞭解其意義。如果沒有,請繼續閱讀瞭解錯誤一節,或如果您認為自己無法自行修正的 API 錯誤,請參閱取得協助一節。

在修正錯誤之前,您必須先找出造成錯誤的原因。這通常是程式碼中的錯誤,或是輸入值無效。

如要判斷問題是否與程式碼中的錯誤有關,請先確認程式碼是否正常運作。首先,建議您查看負責提出失敗要求的程式碼部分,檢查是否有明顯的問題。在某些情況下,您可能需要使用偵錯工具逐行執行程式碼,確保程式碼能夠正確運作。

檢查 HTTP 要求是找出潛在錯誤及無效輸入情況的好方法。許多官方用戶端程式庫都可設為記錄 HTTP 要求和回應;詳情請參閱所選程式庫的說明文件。CharlesSquidFiddler 等 HTTP Proxy 也可用來擷取要求與回應記錄。取得這些記錄後,請查看這些記錄,以確保應用程式提供的要求參數值正確無誤,且符合預期。

找出導致錯誤的錯誤或無效輸入內容後,應該就能明顯地修正這項錯誤。如果您遇到困難,或不確定如何最有效修正問題,可以使用取得到目前為止所收集到的資訊。

取得協助

如果無法自行解決錯誤,您可以透過 Display & Video 360 說明中心的這份表單與支援團隊聯絡。

填寫這份表單時,請盡可能詳述您遇到的問題以及已採取的疑難排解步驟。加入以下實用資訊:

  • HTTP 要求和回應記錄。請務必遮蓋 OAuth 2.0 存取權杖、電子郵件地址等機密資訊。
  • 程式碼片段。您可以將問題單獨顯示在程式碼的特定區段,或懷疑問題因語言而異,請加入一小段程式碼片段來說明您的操作。
  • 執行階段/解譯器版本和平台等其他資訊,可能有助於其他人重現問題。

修正問題

確定問題原因並提出解決方案後,就可以開始實作修正。請盡可能在受控的環境 (例如專為測試設計的合作夥伴或廣告客戶) 中,針對各種良好和錯誤的輸入測試修正內容,然後再部署至實際工作環境。