依管道取得附加元件轉換

發行項
03/24/2024

在 Microsoft Store 分析 API 中使用此方法，在特定日期範圍期間和其他選擇性篩選條件依附加元件的管道取得彙總轉換。

「轉換」表示客戶 (使用 Microsoft 帳戶登入) 最近取得附加元件授權 (無論是您收費還是免費提供)。
「管道」是客戶抵達您應用程式的列示頁面的方法 (例如，透過市集或自訂應用程式宣傳行銷活動)。

此資訊也可在合作夥伴中心的附加元件獲取報告中取得。

必要條件

要使用此方法，您需要先執行以下操作：

如果您尚未執行此操作，請完成 Microsoft Store 分析 API 的所有必要條件。
取得 Azure AD 存取權杖以便用於此方法的要求標頭中。取得存取權杖之後，您在其到期之前有 60 分鐘的時間可以使用。權杖到期之後，您可以取得新的權杖。

要求

要求語法

方法	要求 URI
GET	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions`

要求標頭

標題	類型	描述
授權	字串	必要。持有人<權杖>形式的 Azure AD 存取權杖。

要求參數

參數	類型	描述	必要
applicationId	字串	您想要擷取附加元件轉換資料之應用程式的 Store ID。範例 Store ID 為 9WZDNCRFJ3Q8。	是
inAppProductId	字串	您想要擷取轉換資料之附加元件的 Store ID。	是
startDate	date	要擷取轉換資料之日期範圍的開始日期。預設是 1/1/2016。	否
endDate	date	要擷取轉換資料之日期範圍的結束日期。預設值是目前的日期。	否
熱門	int	要求中要傳回的資料列數。如果未指定，則最大值和預設值為 10000。如果查詢中有更多資料列，回應本文會包含下一個連結，您可以用來要求下一頁的資料。	否
skip	int	要在查詢中忽略的列數。使用此參數逐頁瀏覽大型資料集。例如，top=10000 和 skip=0 會擷取前 10000 列資料，top=10000 和 skip=10000 會擷取接下來的 10000 列資料，依此類推。	否
篩選器	字串	篩選回應本文的一或多個陳述式。每個陳述式都可以使用 eq 或 ne 運算子，而且可以使用 and 或 or 結合陳述式。您可以在篩選陳述式中指定下列字串。如需描述，請參閱本文中的轉換值一節。 applicationName appType customCampaignId referrerUriDomain channelType storeClient deviceType market 以下是範例 filter 參數：filter=deviceType eq 'PC'。	否
aggregationLevel	字串	指定要擷取彙總資料的時間範圍。可以是下列其中一個字串：day、week 或 month。如果未指定，則預設值為 day。	否
orderby	字串	對每個轉換的結果資料值進行排序的陳述式。語法為 orderby=field [order],field [order],...。field 參數可以是下列其中一個字串： date applicationName inAppProductName appType customCampaignId referrerUriDomain channelType storeClient deviceType market order 參數是選擇性的，而且可以是 asc 或 desc，以指定每個欄位的遞增或遞減順序。預設為asc。以下是範例 orderby 字串：orderby=date,market	否
groupby	字串	僅將資料彙總套用至指定欄位的陳述式。您可以指定下列功能變數： date applicationName inAppProductName appType customCampaignId referrerUriDomain channelType storeClient deviceType market 傳回的資料列將包含 groupby 參數中指定的欄位，以及下列項目： date applicationId inAppProductId inAppProductName conversionCount clickCount groupby 參數可以搭配 aggregationLevel 參數使用。例如：groupby=ageGroup,market&aggregationLevel=week	否

要求範例

下列範例示範數個取得應用程式轉換資料的要求。以您應用程式的 Store ID 取代 applicationId 值。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US'  HTTP/1.1
Authorization: Bearer <your access token>

回應

回應本文

值	類型	描述
值	陣列	物件的陣列，其中包含附加元件的彙總轉換資料。如需關於每個物件中的資料的詳細資訊，請參閱下方的轉換值一節。
@nextLink	字串	如果有額外的資料頁面，此字串會包含可用來要求下一頁資料的 URI。例如，如果要求的 top 參數設定為 10，但轉換資料超過 10 個資料列，則會傳回此值。
TotalCount	int	查詢的資料結果中的總列數。

轉換值

Value 陣列中的物件包含下列值。

值	類型	描述
date	字串	轉換資料之日期範圍中的第一個日期。如果要求指定了單天，這個值就是該日期。如果要求指定了一週、月或其他日期範圍，這個值就是該日期範圍中的第一個日期。
inAppProductId	字串	您正在擷取轉換資料之附加元件的 Store ID。
inAppProductName	字串	您正在擷取轉換資料之附加元件的顯示名稱。
applicationId	字串	您正在擷取轉換資料之應用程式的 Store ID。
applicationName	字串	您正在擷取轉換資料之應用程式的顯示名稱。
appType	字串	您要擷取轉換資料的產品類型。對於此方法，唯一支援的值是 Add-On。
customCampaignId	字串	與應用程式相關聯之自訂應用程式促銷活動的識別碼字串。
referrerUriDomain	字串	指定已啟用自訂應用程式宣傳行銷活動識別碼之應用程式列示的所在網域。
channelType	字串	下列其中一個字串，指定轉換的管道： CustomCampaignId Store Traffic 其他
storeClient	字串	發生轉換的市集版本。目前唯一支援的值是 SFC。
deviceType	字串	下列其中一個字串： PC 手機 Console-Xbox One Console-Xbox Series X IoT Holographic Unknown
market	字串	發生轉換之市場的 ISO 3166 國家/地區代碼。
clickCount	值	客戶點擊您的應用程式列示連結的數目。
conversionCount	值	客戶轉換的數目。

要求和回應範例

下列程式碼片段示範一些要求的範例要求和 JSON 回應本文。

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

範例回應

{
    "Value": [
        {
            "inAppProductId": "9NN2HW33ZB2G",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 220636,
            "conversionCount": 154
        },
        {
            "inAppProductId": "9PN07J0WC18B",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 277061,
            "conversionCount": 187
        }
    ],
    "@nextLink": "",
    "TotalCount": 2
}

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>

範例回應

{
    "Value": [
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_mahjong_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "BR",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_solitaire_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "AT",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5Z",
            "inAppProductName": "Episode1Combo",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4Z",
            "inAppProductName": "Episode1Grandfathered",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "|autosuggest",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "ES",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5W",
            "inAppProductName": "Episode2Combo",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4P",
            "inAppProductName": "SeasonPass24",
            "appType": "Add-On",
            "date": "2022-07-12",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "9wzdncrfjbd8",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CA",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-07-17",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "scom-web-store",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "US",
            "clickCount": 1,
            "conversionCount": 1
        }
    ],
    "@nextLink": "",
    "TotalCount": 9
}

依管道取得附加元件轉換

必要條件

要求

要求語法

要求標頭

要求參數

要求範例

回應

回應本文

轉換值

要求和回應範例

範例要求

範例回應

範例要求

範例回應

意見反應

意見反應

其他資源

依管道取得附加元件轉換

必要條件

要求

要求語法

要求標頭

要求參數

要求範例

回應

回應本文

轉換值

要求和回應範例

範例要求

範例回應

範例要求

範例回應

相關主題

意見反應

意見反應

其他資源