I am encountering an issue with retrieving the CampaignId ( cid ) parameter programmatically in an application installed from a Microsoft Store following Create a custom app promotion campaign guide . To retrieve the CampaignId , I am using code provided in the mentioned guide, but sku.CollectionData.CampaignId is always empty. I have tried both of url formats: https://www.microsoft.com/store/apps/skype/9wzdncrfj364?cid=custom_campaign ms-windows-store://pdp/?PRODUCTID=9wzdncrfj364&cid=custom_campaign Unfortunately, neither of them worked. The application was published via Package Flight and via regular publishing with Direct Link availability mode. Tested both on Win10 and Win11 PCs. I would greatly appreciate guidance on how to resolve this issue. Thanks in advance for your assistance

Issue Retrieving Campaign ID (cid) in Microsoft Store app

Joel 0

I am encountering an issue with retrieving the CampaignId (cid) parameter programmatically in an application installed from a Microsoft Store following Create a custom app promotion campaign guide. To retrieve the CampaignId, I am using code provided in the mentioned guide, but sku.CollectionData.CampaignId is always empty.

I have tried both of url formats:

https://www.microsoft.com/store/apps/skype/9wzdncrfj364?cid=custom_campaign
ms-windows-store://pdp/?PRODUCTID=9wzdncrfj364&cid=custom_campaign

Unfortunately, neither of them worked.

The application was published via Package Flight and via regular publishing with Direct Link availability mode. Tested both on Win10 and Win11 PCs.

I would greatly appreciate guidance on how to resolve this issue.

Thanks in advance for your assistance

Junjie Zhu - MSFT 19,751 Reputation points Microsoft Vendor

2024-11-25T08:21:34.61+00:00

Hello @Joel ,

Welcome to Microsoft Q&A!

Could you get the CampaignId directly by using CurrentAppSimulator.GetAppPurchaseCampaignIdAsync in debug mode?

Thank you.
Joel 0 Reputation points

2024-11-25T13:35:24.5933333+00:00

Hi,

Thank you for your response

I tested with CurrentAppSimulator, and I was able to successfully retrieve the CampaignId by using next code in debug mode:

var proxyFile = await Package.Current.InstalledLocation.GetFileAsync("WindowsStoreProxy.xml");

await CurrentAppSimulator.ReloadSimulatorAsync(proxyFile);

var cid = await CurrentAppSimulator.GetAppPurchaseCampaignIdAsync();

In my WindowsStoreProxy.xml file I had specified campaign id according to the guide:
<AppPurchaseCampaignId>my-test-campaign</AppPurchaseCampaignId>
Junjie Zhu - MSFT 19,751 Reputation points Microsoft Vendor

2024-11-26T08:32:00.9533333+00:00

Hello @Joel ,
Is your current app associated with the store? Try to output other properties of StoreCollectionData in the code to see if they are empty.
LOSTMSU 1 Reputation point

2024-11-27T18:31:54.91+00:00

Joel, do you see the campaign ID in the Partner Center?
I have the same problem as you do - my app does not seem to be receiving cid value, but also in the Partner Center I don't see any of the clicks being attributed to my campaign when I know for sure they should be. Junjie, my app is associated with the store.
LOSTMSU 1 Reputation point

2024-11-27T18:34:08.1966667+00:00

Joel, I seem to be having the same issue with my new app. Do you see your campaign show up in the Partner Center? I don't even get that, and I know for sure my only visits are from the campaign. I use the first form of the link BTW.
Joel 0 Reputation points

2024-11-29T13:32:42.0866667+00:00
Hi @Junjie Zhu - MSFT ,

I performed more detailed testing and extended my logging as you suggested. To avoid any issues with Store association, I created a build and submitted it to Package Flights.

I was able to obtain the cid programmatically and made the following observations:

Apparently, cid is linked to the account when the app is acquired, not when it is installed.

For example, if I uninstall the application and then reinstall it via an URL with a different cid, I still receive the initial cid.

cid``(sku.CollectionData.CampaignId) is sometimes empty on the first launch but becomes populated on subsequent launches.

I can confirm that my initial problem is resolved, but I would like to ask for clarification on one more point.

The guide I referenced in my original question includes the following note:

"This data is only tracked for customers on Windows 10. Customers using other operating systems can still follow the link to your app's listing, but data about those customers' activities will not be included."

Additionally, the accepted answer in a similar thread also mentions the same note.

Does this mean that this functionality is not intended to be used on Windows 11 (or it's future releases)?

Thank you for your assistance
Joel 0 Reputation points

2024-11-29T13:35:08.1833333+00:00

Hi, @LOSTMSU

I have never encountered any issues with cid logs in the Partner Center, my issue was specifically related to the programmatic cid access. In fact, I've just verified that cids are tracked even for cases where I was unable to retrieve the cid programmatically.

I also tested the first form of the link (web link) as you specified, and it worked for me as well.

I suggest testing with Package Flights to avoid potential issues with Store association. Additionally, if you are specifically having trouble retrieving the cid in code, try installing the application on a different Microsoft Store account, because, as I mentioned in my previous comment, the cid is likely linked to the account at the time the app is acquired.
Junjie Zhu - MSFT 19,751 Reputation points Microsoft Vendor

2024-12-02T07:35:12.74+00:00

Hello @Joel ,

Does this mean that this functionality is not intended to be used on Windows 11 (or it's future releases)?

According to the current documentation, win11 is not supported yet.

I'd suggest you submit a feature request about this feature in the Feedback Hub.

You could find the Feedback Hub in the Start Menu. Please select Developer Platform->API Feedback as the category when you submit your request. The related team will check the request.

Please share the link after submitting the request and I will help you submit this request through internal channels.

Thank you.
Joel 0 Reputation points

2024-12-02T11:45:24.8966667+00:00

Hello @Junjie Zhu - MSFT ,

Thank you for your guidance. I’ve submitted the feature request through the Feedback Hub as advised. You can find the request here: feature request link.

I appreciate your support in helping escalate this request through internal channels. Please let me know if there’s anything further I can do to assist.

Best regards,

Joel
Junjie Zhu - MSFT 19,751 Reputation points Microsoft Vendor

2024-12-03T06:05:50.2733333+00:00

Thank you for your submission, I have submitted this feedback.

Share via

Issue Retrieving Campaign ID (cid) in Microsoft Store app

Your answer