在Microsoft市集分析 API 中使用這個方法,在指定的日期範圍和其他選擇性篩選期間,取得應用程式的匯總廣告績效數據。 這個方法會以 JSON 格式傳回數據。
此方法會傳回 合作夥伴中心 廣告績效報告所提供的相同數據。
先決條件
若要使用此方法,您必須先執行下列動作:
- 如果您尚未執行此操作,請完成 Microsoft Store 分析 API 的所有必要條件。
- 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取令牌之後,您必須在 60 分鐘内使用它,否則將會失效。 令牌到期之後,您可以取得新的令牌。
如需更多資訊,請參閱 使用 Microsoft Store 服務存取分析數據。
請求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance |
請求標頭
| 頁首 | 類型 | 說明 |
|---|---|---|
| 授權 | 字符串 | 必須的。 Azure AD 存取令牌的形式為 Bearer<token>。 |
要求參數
若要擷取特定應用程式的廣告績效數據,請使用 applicationId 參數。 若要擷取與您開發人員帳戶相關聯的所有應用程式的廣告績效數據,請省略 applicationId 參數。
| 參數 | 類型 | 說明 | 為必填項目 |
|---|---|---|---|
| 應用程式ID | 字符串 | 您想要擷取廣告績效數據之應用程式的 市集標識碼。 | 否 |
| 開始日期 | 日期 | 要擷取之廣告績效數據日期範圍的開始日期,格式為YYYY/MM/DD。 預設值為目前日期減去 30 天。 | 否 |
| 結束日期 | 日期 | 要擷取之廣告績效數據日期範圍的結束日期,格式為YYYY/MM/DD。 預設值為目前日期減去一天。 | 否 |
| 返回頁首 | 整數 (int) | 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多資料列,回應內容會包含下一個連結,您可以使用該連結來請求下一頁的資料。 | 否 |
| 略過 | 整數 (int) | 查詢中要略過的行數目。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 | 否 |
| 篩選器 | 字符串 | 一或多個語句用於篩選回應中的數據列。 如需詳細資訊,請參閱下方的 篩選字段 一節。 | 否 |
| 聚合層級 | 字符串 | 指定要擷取匯總數據的時間範圍。 可以是下列其中一個字串:day、week 或 month。 如果未指定,則預設值為 day。 | 否 |
| 排序 | 字符串 | 排序結果數據值的語句。 語法為 orderby=field [order],field [order],...。 field 參數可以是下列其中一個字符串:
order 參數是選擇性的,而且可以是 asc 或 desc,以指定每個欄位的遞增或遞減順序。 預設為asc。 以下是 orderby 字串範例: orderby=date,market |
否 |
| 按群組分類 | 字符串 | 僅將資料彙總套用至指定欄位的陳述式。 您可以指定下欄位:
groupby 參數可以搭配 aggregationLevel 參數使用。 例如: &groupby=applicationId&aggregationLevel=week |
否 |
篩選欄位
要求主體的 filter 參數包含一或多個語句,可篩選響應中的數據列。 每個語句都包含與 eq 或 ne 運算符相關聯的欄位和值,而且語句可以使用 和或結合。 以下是篩選 範例 參數:
- filter=market eq '美國' and deviceType eq 'phone'
如需支援欄位的清單,請參閱下表。 字串值必須以 篩選 參數中的單引弧括住。
| 領域 | 說明 |
|---|---|
| 市場 | 字串,其中包含提供廣告之市場的 ISO 3166 國家/地區代碼。 |
| 裝置類型 | 下列其中一個字串:個人電腦/平板電腦 或 手機。 |
| adUnitId (廣告單位識別碼) | 一個字串,指定要套用至篩選的廣告單元 ID。 |
| pubCenterApp名稱 | 字串,指定要套用至篩選之目前應用程式的 pubCenter 名稱。 |
| 廣告供應商 | 字串,指定要套用至篩選的廣告提供者名稱。 |
| 日期 | 一個字串,用於指定篩選時的日期,格式為YYYY/MM/DD。 |
範例請求
下列範例展示了幾種取得廣告效能數據的請求。 以您應用程式的市集標識碼取代 applicationId 值。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; and gender eq 'm' HTTP/1.1
Authorization: Bearer <your access token>
回應
回應主體
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 價值觀 | 陣列 | 對象的陣列,其中包含匯總廣告績效數據。 如需每個物件中數據的詳細資訊,請參閱下面的 廣告績效值 一節。 |
| @nextLink | 字符串 | 如果有額外的數據頁面,此字串會包含可用來要求下一頁數據的 URI。 例如,如果要求的 top 參數設定為 5,但查詢的資料項目數量超過 5 個,則會傳回此值。 |
| 總計數 | 整數 (int) | 查詢的資料結果中的總列數。 |
廣告績效值
Value 陣列中的元素包含下列值。
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 日期 | 字符串 | 廣告績效數據日期範圍中的第一個日期。 如果要求指定了單一天,這個值就是該日期。 如果要求指定了一周、月或其他日期範圍,這個值就是該日期範圍中的第一個日期。 |
| 應用程式ID | 字符串 | 您要擷取廣告績效數據的 App 市集標識碼。 |
| 應用程式名稱 | 字符串 | 應用程式的顯示名稱。 |
| adUnitId (廣告單位識別碼) | 字符串 | 廣告單元的標識碼。 |
| adUnitName | 字符串 | 合作夥伴中心開發人員所指定的廣告單元名稱。 |
| 廣告供應商 | 字符串 | 廣告提供者的名稱 |
| 裝置類型 | 字符串 | 提供廣告的裝置類型。 如需支援的字串清單,請參閱上面的 篩選欄位 一節。 |
| 市場 | 字符串 | 提供廣告之市場的 ISO 3166 國家/地區代碼。 |
| 帳戶貨幣代碼 | 字符串 | 帳戶的貨幣碼。 |
| pubCenterApp名稱 | 字符串 | 與 Partner Center 中應用程式相關聯的 pubCenter 應用程式的名稱。 |
| 廣告供應商請求 | 整數 (int) | 指定廣告提供者的廣告要求數目。 |
| 印象 | 整數 (int) | 廣告曝光數。 |
| 點擊數 | 整數 (int) | 廣告點擊次數。 |
| 帳戶貨幣收入 | 數字 | 以帳戶國家/地區貨幣為單位的收入。 |
| 要求 | 整數 (int) | 廣告請求數量。 |
回應範例
下列範例顯示這個請求的 JSON 回應示例內容。
{
"Value": [
{
"date": "2015-03-09",
"applicationId": "9NBLGGH4R315",
"applicationName": "Contoso Demo",
"market": "US",
"deviceType": "phone",
"adUnitId":"10765920",
"adUnitName":"TestAdUnit",
"revenueInAccountCurrency": 10.0,
"impressions": 1000,
"requests": 10000,
"clicks": 1,
"accountCurrencyCode":"USD"
},
{
"date": "2015-03-09",
"applicationId": "9NBLGGH4R315",
"applicationName": "Contoso Demo",
"market": "US",
"deviceType": "phone",
"adUnitId":"10795110",
"adUnitName":"TestAdUnit2",
"revenueInAccountCurrency": 20.0,
"impressions": 2000,
"requests": 20000,
"clicks": 3,
"accountCurrencyCode":"USD"
},
],
"@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
"TotalCount": 191753
}