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)

廣告活動報表規格。

回應主體

廣告活動報表 API 回應。

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

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

object (ReportRow)

指定發布者的廣告活動報表資料。API 最多會傳回 100000 個資料列。

授權範圍

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

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

詳情請參閱OAuth 2.0 Overview。

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。例如 Android 應用程式為 com.goog.bar，iOS 應用程式為 123456789。
PLACEMENT_NAME 放送廣告的應用程式名稱。
PLACEMENT_PLATFORM 廣告放送的應用程式平台。
COUNTRY 指定國家/地區的名稱。
FORMAT 廣告單元格式 (例如「橫幅」、「原生」)，屬於廣告放送維度。

指標

廣告活動報表的指標。

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