Method: accounts.adUnits.list

列出指定 AdMob 帳戶下的廣告單元。

HTTP 要求

GET https://admob.googleapis.com/v1/{parent=accounts/*}/adUnits

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。要列出廣告單元的帳戶資源名稱。範例：accounts/pub-9876543210987654

查詢參數

參數
pageSize

integer

要傳回的廣告單元數量上限。如未指定或設為 0，系統最多會傳回 10,000 個廣告單元。許可的最大值為 20,000；超出的數值將一律指定為 20,000。
pageToken

string

最後一個 ListAdUnitsResponse 傳回的值；表示這是先前的 adUnits.list 呼叫的連續呼叫，且系統應傳回下一頁的資料。

要求主體

要求主體必須為空白。

回應主體

針對廣告單元清單請求的回應。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
欄位
adUnits[]

object (AdUnit)

所請求帳戶產生的廣告單元。
nextPageToken

string

若非空白，表示請求中可能會有更多廣告單元；此值應在新的 ListAdUnitsRequest 中傳遞。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/admob.readonly

詳情請參閱 OAuth 2.0 總覽。

AdUnit

說明 AdMob 廣告單元。

JSON 表示法 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
欄位
name

string

此廣告單元的資源名稱。格式為 accounts/{publisherId}/adUnits/{ad_unit_id_fragment} 範例：accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

廣告單元的外部可見 ID，可用來與 AdMob SDK 整合。這是唯讀屬性。範例：ca-app-pub-9876543210987654/0123456789
appId

string

與這個廣告單元相關聯的應用程式外部可見 ID。範例：ca-app-pub-9876543210987654~0123456789
displayName

string

AdMob UI 中顯示的廣告單元顯示名稱 (由使用者提供)。長度上限為 80 個半形字元。
adFormat

string

廣告單元的廣告格式。可能的值如下：

「APP_OPEN」- 應用程式開啟頁面廣告格式。「橫幅圖片」- 橫幅廣告格式。「BANNER_INTERSTITIAL」- 舊版格式，可用於橫幅廣告或插頁式廣告。這個格式無法再建立，但可透過中介服務群組指定。「INTERSTITIAL」(插頁式) - 全螢幕廣告。支援的廣告類型為「RICH_MEDIA」和「影片」。「NATIVE」(原生廣告格式)「已獎勵」- 使用者觀看廣告後，系統會傳送回呼驗證畫面，並向使用者提供獎勵。支援的廣告類型為「RICH_MEDIA」(互動式) 以及無法排除影片的影片。「REWARDED_INTERSTITIAL」 - 插頁式獎勵廣告格式。僅支援影片廣告類型。請參閱 https://support.google.com/admob/answer/9884467。
adTypes[]

string

這個廣告單元支援的廣告媒體類型。可能的值如下：

「RICH_MEDIA」：文字、圖片和其他非影片媒體。「VIDEO」- 影片媒體。