Method: accounts.mediationReport.generate

• HTTP 要求
• 路徑參數
• 要求主體
  • JSON 表示法
• 回應主體
  • JSON 表示法
• 授權範圍
• MediationReportSpec
  • JSON 表示法
• 尺寸
• 指標
• DimensionFilter
  • JSON 表示法
• SortCondition
  • JSON 表示法
• 範例
• 試試看！

根據提供的報表規格，產生 AdMob 中介服務報表。傳回伺服器端串流 RPC 的結果。結果會以一連串的回應形式傳回。

HTTP 要求

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

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

路徑參數

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

要求主體

要求主體會包含結構如下的資料：

JSON 表示法
{ "reportSpec": { object (MediationReportSpec) } }

欄位
reportSpec	object (MediationReportSpec) 聯播網報表規格。

回應主體

AdMob 中介服務報表的串流回應，其中第一個回應包含報表標題，接著是資料列回應串流，最後一個回應訊息則是頁尾。

例如：

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         "displayLabel": "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

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

JSON 表示法
{ // Union field payload can be only one of the following: "header": { object (ReportHeader) }, "row": { object (ReportRow) }, "footer": { object (ReportFooter) } // End of list of possible types for union field payload. }

欄位
聯集欄位 payload。每個串流回應訊息都包含一種酬載。payload 只能是下列其中一項：
header	object (ReportHeader) 報表產生設定，說明報表內容，例如報表日期範圍和本地化設定。
row	object (ReportRow) 實際報表資料。
footer	object (ReportFooter) 生成報表的額外資訊，例如資料警告。

授權範圍

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

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

詳情請參閱OAuth 2.0 Overview。

MediationReportSpec

產生 AdMob 中介服務報表的規格。舉例來說，如要取得「美國」和「中國」的廣告來源和應用程式觀察到的每千次曝光出價，規格可能如下所示：

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 9, "day": 1},
    "endDate": {"year": 2021, "month": 9, "day": 30}
  },
  "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
  "metrics": ["OBSERVED_ECPM"],
  "dimensionFilters": [
    {
      "dimension": "COUNTRY",
      "matchesAny": {"values": [{"value": "US", "value": "CN"}]}
    }
  ],
  "sortConditions": [
    {"dimension":"APP", order: "ASCENDING"}
  ],
  "localizationSettings": {
    "currencyCode": "USD",
    "languageCode": "en-US"
  }
}

為方便瞭解，您可以將上述規格視為下列虛擬 SQL：

SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;

JSON 表示法
{ "dateRange": { object (DateRange) }, "dimensions": [ enum (Dimension) ], "metrics": [ enum (Metric) ], "dimensionFilters": [ { object (DimensionFilter) } ], "sortConditions": [ { object (SortCondition) } ], "localizationSettings": { object (LocalizationSettings) }, "maxReportRows": integer, "timeZone": string }

欄位
dateRange	object (DateRange) 產生報表的日期範圍。
dimensions[]	enum (Dimension) 報表的維度清單。這些維度的值組合會決定報表的資料列。如未指定任何維度，報表會傳回整個帳戶的單一列要求指標。
metrics[]	enum (Metric) 報表的指標清單。報表必須指定至少一個指標。
dimensionFilters[]	object (DimensionFilter) 說明要根據維度值比對哪些報表列。
sortConditions[]	object (SortCondition) 說明報表資料列的排序方式。清單中條件的順序會定義優先順序，條件越早出現，優先順序就越高。如未指定排序條件，系統不會定義資料列順序。
localizationSettings	object (LocalizationSettings) 報表的本地化設定。
maxReportRows	integer 要傳回的報表資料列數上限。如未設定值，API 會盡可能傳回最多資料列，上限為 100000 列。可接受的值介於 1 至 100000 之間 (包括 1 與 100000)。如果值大於 100000，系統會傳回錯誤。
timeZone	string 報表時區。接受 IANA TZ 名稱值，例如「America/Los_Angeles」。如果未定義時區，系統會採用帳戶預設時區。透過「取得帳戶」動作檢查預設值。 警告：目前僅支援「America/Los_Angeles」。

維度

中介服務報表的維度。維度是資料屬性，可按特定屬性 (例如廣告格式或廣告放送平台) 細分或調整量化評估 (指標)。

列舉
DIMENSION_UNSPECIFIED	未設定欄位的預設值。請勿使用。
DATE	日期，格式為 YYYYMMDD (例如「20210701」)。要求最多只能指定一個時間維度。
MONTH	以 YYYYMM 格式表示的月份 (例如「202107」)。要求最多只能指定一個時間維度。
WEEK	一週的第一天，格式為 YYYYMMDD (例如「20210701」)。要求最多只能指定一個時間維度。
AD_SOURCE	廣告來源的專屬 ID (例如「5450213213286189855」，以及標籤值「AdMob 聯播網」)。
AD_SOURCE_INSTANCE	廣告來源例項的專屬 ID (例如「ca-app-pub-1234:asi:5678」和「AdMob (預設)」做為標籤值)。
AD_UNIT	廣告單元的專屬 ID (例如「ca-app-pub-1234/8790」)。如果指定 AD_UNIT 維度，系統會自動納入 APP。
APP	行動應用程式的專屬 ID (例如「ca-app-pub-1234~1234」)。
MEDIATION_GROUP	中介服務群組的專屬 ID (例如「ca-app-pub-1234:mg:1234」和「AdMob (預設)」做為標籤值)。
COUNTRY	廣告獲得觀看/點擊的國家/地區 CLDR 代碼 (例如「US」或「FR」)。這是地理位置維度。
FORMAT	廣告單元格式 (例如「橫幅」、「原生」)，屬於廣告放送維度。
PLATFORM	應用程式的行動作業系統平台 (例如「Android」或「iOS」)。
MOBILE_OS_VERSION	行動作業系統版本，例如「iOS 13.5.1」。
GMA_SDK_VERSION	GMA SDK 版本，例如「iOS 7.62.0」。
APP_VERSION_NAME	如果是 Android，應用程式版本名稱位於 PackageInfo 的 versionName 中。如果是 iOS，應用程式版本名稱位於 CFBundleShortVersionString 中。
SERVING_RESTRICTION	廣告放送的限制模式 (例如「非個人化廣告」)。

指標

中介服務報表的指標。指標是量化評估，可指出發布商業務的成效。這些資料是從個別廣告事件匯總而來，並依報表維度分組。指標值為整數或小數 (不四捨五入)。

列舉
METRIC_UNSPECIFIED	未設定欄位的預設值。請勿使用。
AD_REQUESTS	要求數量。此值為整數。
CLICKS	使用者點擊廣告的次數。此值為整數。
ESTIMATED_EARNINGS	AdMob 發布商的預估收益。收益指標的幣別單位 (美元、歐元或其他) 取決於幣別的本地化設定。金額以百萬分之一為單位。舉例來說，$6.50 會表示為 6500000。 系統支援查看自 2019 年 10 月 20 日起，每個中介服務群組和每個廣告來源例項層級的預估收益。如果日期在 2019 年 10 月 20 日之前，第三方預估收益會顯示為 0。
IMPRESSIONS	廣告向使用者顯示的總次數。此值為整數。
IMPRESSION_CTR	點擊次數與曝光次數的比率。此值為雙精確度 (近似) 小數值。
MATCHED_REQUESTS	系統回應請求而傳回廣告的次數。此值為整數。
MATCH_RATE	比對成功的廣告請求與廣告請求總數的比率。此值為雙精確度 (近似) 小數值。
OBSERVED_ECPM	第三方廣告聯播網的預估平均有效千次曝光出價。收益指標的幣別單位 (美元、歐元或其他) 取決於幣別的本地化設定。金額以百萬分之一為單位。舉例來說，$2.30 美元會表示為 2300000。 系統支援查看自 2019 年 10 月 20 日起，每個中介服務群組和每個廣告來源例項層級的預估平均有效千次曝光出價。2019 年 10 月 20 日之前的日期，第三方預估平均有效千次曝光出價會顯示為 0。

DimensionFilter

說明要根據維度值比對哪些報表列。

JSON 表示法
{ "dimension": enum (Dimension), // Union field operator can be only one of the following: "matchesAny": { object (StringList) } // End of list of possible types for union field operator. }

欄位
dimension	enum (Dimension) 將篩選條件套用至指定維度。
聯集欄位 operator。要套用的篩選器運算子。operator 只能是下列其中一項：
matchesAny	object (StringList) 如果資料列的指定維度值符合這個條件中指定的值，就會相符。

SortCondition

要套用至維度或指標的排序方向。

JSON 表示法
{ "order": enum (SortOrder), // Union field sort_on can be only one of the following: "dimension": enum (Dimension), "metric": enum (Metric) // End of list of possible types for union field sort_on. }

欄位
order	enum (SortOrder) 維度或指標的排序順序。
聯集欄位 sort_on。識別要排序的值。sort_on 只能是下列其中一項：
dimension	enum (Dimension) 依指定維度排序。
metric	enum (Metric) 依指定指標排序。