Method: accounts.campaignReport.generate

根據提供的規格產生廣告活動報表。

HTTP 要求

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

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

路徑參數

參數
parent

string

要產生報表的帳戶資源名稱。範例：accounts/pub-9876543210987654

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
欄位
reportSpec

object (CampaignReportSpec)

廣告活動報表規格。

回應主體

Campaign Report API 回應。

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

JSON 表示法 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
欄位
rows[]

object (ReportRow)

指定發布商的廣告活動報表資料。最多只能從 API 傳回 100,000 列。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

CampaignReportSpec

用於產生廣告活動報表的規格。舉例來說，按 CAMPAIGN_ID 劃分 IMPRESSIONS 和 CLICKS 的規格，可能如以下範例所示：

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
JSON 表示法 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
欄位
dateRange

object (DateRange)

產生報表的日期範圍。最長不得超過 30 天。
dimensions[]

enum (Dimension)

報表維度清單。系統會根據這些維度的值組合，決定報表中的資料列。如果沒有指定維度，報表就會把整個帳戶的請求指標資料列成一列。
metrics[]

enum (Metric)

報表的指標清單。報表必須至少指定一個指標。
languageCode

string

本地化文字所用的語言，例如特定適用的維度值。語言標記是在 IETF BCP47 中定義。預設值為「en-US」如未指定或無效

維度

廣告活動報表維度。

列舉
DIMENSION_UNSPECIFIED 未指定維度的預設值。請勿使用。
DATE 採用 YYYYMMDD 格式的日期 (例如「20210701」)。
CAMPAIGN_ID 廣告活動的專屬 ID (例如「123456789」)，與廣告活動清單 API 中的廣告活動 ID 一致。
CAMPAIGN_NAME 廣告活動名稱。
AD_ID 廣告的專屬 ID，例如「123456789」。
AD_NAME 廣告名稱，可以重複。
PLACEMENT_ID 刊登廣告應用程式的供應商專屬 ID。例如 com.goog.bar (適用於 Android) 和 123456789 (iOS 應用程式)。
PLACEMENT_NAME 刊登廣告的應用程式名稱。
PLACEMENT_PLATFORM 刊登廣告的應用程式平台。
COUNTRY 指定國家/地區的名稱。
FORMAT 廣告單元的格式 (例如「橫幅」、「原生」)，廣告放送維度。

指標

廣告活動報表的指標。

列舉
METRIC_UNSPECIFIED 未設定欄位的預設值。請勿使用。
IMPRESSIONS 廣告向使用者顯示的次數。
CLICKS 使用者點按廣告的次數。
CLICK_THROUGH_RATE 廣告點擊次數除以廣告顯示次數。
INSTALLS 應用程式下載到裝置的次數。
ESTIMATED_COST 放送廣告活動廣告 (而非賺取收益廣告) 的預估費用。幣別是廣告活動的報表帳面貨幣。
AVERAGE_CPI 平均單次安裝出價。是指為獲取新客而支出的平均金額。幣別是廣告活動的報表帳面貨幣。
INTERACTIONS 使用者與廣告互動的次數。包括點擊次數和參與次數。