Skip to content

Commit ad65f49

Browse files
authored
reporting info provided via email thread (#3676)
1 parent b2995f1 commit ad65f49

File tree

3 files changed

+20
-26
lines changed

3 files changed

+20
-26
lines changed

uwp/monetize/get-response-info-for-app-reviews.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
---
2-
ms.assetid: fb6bb856-7a1b-4312-a602-f500646a3119
3-
description: Use this method in the Microsoft Store reviews API to determine whether you can respond to a particular review, or whether you can respond to any review for a given app.
42
title: Get response info for reviews
5-
ms.date: 02/08/2017
3+
description: Use this method in the Microsoft Store reviews API to determine whether you can respond to a particular review, or whether you can respond to any review for a given app.
4+
ms.assetid: fb6bb856-7a1b-4312-a602-f500646a3119
5+
ms.date: 07/14/2023
66
ms.topic: article
77
keywords: windows 10, uwp, Store services, Microsoft Store reviews API, response info
88
ms.localizationpriority: medium
99
---
10+
1011
# Get response info for reviews
1112

12-
If you want to programmatically respond to a customer review of your app, you can use this method in the Microsoft Store reviews API to first determine whether you have permission to respond to the review. You cannot respond to reviews submitted by customers who have chosen not to receive review responses. After you confirm that you can respond to the review, you can then use the [submit responses to app reviews](submit-responses-to-app-reviews.md) method to programmatically respond to it.
13+
> [!IMPORTANT]
14+
> The *Microsoft Store reviews API*, as documented in this topic, is currently not in a working state. Instead of using the APIs, you can achieve the same task(s) by [using Partner Center](/windows/apps/publish/respond-to-customer-reviews).
1315
16+
If you want to programmatically respond to a customer review of your app, you can use this method in the Microsoft Store reviews API to first determine whether you have permission to respond to the review. You cannot respond to reviews submitted by customers who have chosen not to receive review responses. After you confirm that you can respond to the review, you can then use the [submit responses to app reviews](submit-responses-to-app-reviews.md) method to programmatically respond to it.
1417

1518
## Prerequisites
1619

@@ -22,29 +25,25 @@ To use this method, you need to first do the following:
2225

2326
## Request
2427

25-
2628
### Request syntax
2729

2830
| Method | Request URI |
2931
|--------|------------------------------------------------------------------|
3032
| GET | ```https://manage.devcenter.microsoft.com/v1.0/my/reviews/{reviewId}/apps/{applicationId}/responses/info``` |
3133

32-
3334
### Request header
3435

3536
| Header | Type | Description |
3637
|---------------|--------|-----------------------------------------------------------------------------|
3738
| Authorization | string | Required. The Azure AD access token in the form **Bearer** <*token*>. |
3839

39-
4040
### Request parameters
4141

4242
| Parameter | Type | Description | Required |
4343
|---------------|--------|--------------------------------------------------|--------------|
4444
| applicationId | string | The Store ID of the app that contains the review for which you want to determine whether you can respond to. The Store ID is available on the [App identity page](/windows/apps/publish/view-app-identity-details) in Partner Center. An example Store ID is 9WZDNCRFJ3Q8. | Yes |
4545
| reviewId | string | The ID of the review you want to respond to (this is a GUID). Review IDs are available in the response data of the [get app reviews](get-app-reviews.md) method in the Microsoft Store analytics API and in the [offline download](/windows/apps/publish/download-analytic-reports) of the [Reviews report](/windows/apps/publish/reviews-report). <br/>If you omit this parameter, the response body for this method will indicate whether you have permissions to respond to any reviews for the specified app. | No |
4646

47-
4847
### Request example
4948

5049
The following examples how to use this method to determine whether you can respond to a given review.
@@ -56,14 +55,12 @@ Authorization: Bearer <your access token>
5655
5756
## Response
5857
59-
6058
### Response body
6159
6260
| Value | Type | Description |
6361
|------------|--------|-----------------------|
6462
| CanRespond | Boolean | The value **true** indicates that you can respond to the specified review, or that you have permissions to respond to any review for the specified app. Otherwise, this value is **false**. |
6563
| DefaultSupportEmail | string | Your app's [support email address](/windows/apps/publish/publish-your-app/enter-app-properties?pivots=store-installer-msix#support-contact-info) as specified in your app's Store listing. If you did not specify a support email address, this field is empty. |
66-
6764
 
6865
### Response example
6966

uwp/monetize/respond-to-reviews-using-windows-store-services.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
---
2-
ms.assetid: c92c0ea8-f742-4fc1-a3d7-e90aac11953e
3-
description: Use the Microsoft Store reviews API to programmatically submit responses to reviews of your app in the Store.
42
title: Respond to reviews using Store services
5-
ms.date: 06/04/2018
3+
description: Use the Microsoft Store reviews API to programmatically submit responses to reviews of your app in the Store.
4+
ms.assetid: c92c0ea8-f742-4fc1-a3d7-e90aac11953e
5+
ms.date: 07/14/2023
66
ms.topic: article
77
keywords: windows 10, uwp, Microsoft Store reviews API, respond to reviews
88
ms.localizationpriority: medium
99
---
10+
1011
# Respond to reviews using Store services
1112

13+
> [!IMPORTANT]
14+
> The *Microsoft Store reviews API*, as documented in this topic, is currently not in a working state. Instead of using the APIs, you can achieve the same task(s) by [using Partner Center](/windows/apps/publish/respond-to-customer-reviews).
15+
1216
Use the *Microsoft Store reviews API* to programmatically respond to reviews of your app in the Store. This API is especially useful for developers who want to bulk respond to many reviews without using Partner Center. This API uses Azure Active Directory (Azure AD) to authenticate the calls from your app or service.
1317

1418
The following steps describe the end-to-end process:
@@ -77,11 +81,8 @@ The Microsoft Store reviews API contains several methods you can use to determin
7781
2. Call the [get response info for app reviews](get-response-info-for-app-reviews.md) method to determine whether you are allowed to respond to the reviews. When a customer submits a review, they can choose not to receive responses to their review. You cannot respond to reviews submitted by customers who have chosen not to receive review responses.
7882
3. Call the [submit responses to app reviews](submit-responses-to-app-reviews.md) method to programmatically respond to the reviews.
7983

80-
8184
## Related topics
8285

8386
* [Get app reviews](get-app-reviews.md)
8487
* [Get response info for app reviews](get-response-info-for-app-reviews.md)
8588
* [Submit responses to app reviews](submit-responses-to-app-reviews.md)
86-
87-
 

uwp/monetize/submit-responses-to-app-reviews.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2-
ms.assetid: 038903d6-efab-4da6-96b5-046c7431e6e7
3-
description: Use this method in the Microsoft Store reviews API to submit responses to reviews of your app.
42
title: Submit responses to reviews
5-
ms.date: 02/08/2017
3+
description: Use this method in the Microsoft Store reviews API to submit responses to reviews of your app.
4+
ms.assetid: 038903d6-efab-4da6-96b5-046c7431e6e7
5+
ms.date: 07/14/2023
66
ms.topic: article
77
keywords: windows 10, uwp, Store services, Microsoft Store reviews API, add-on acquisitions
88
ms.localizationpriority: medium
99
---
10+
1011
# Submit responses to reviews
1112

13+
> [!IMPORTANT]
14+
> The *Microsoft Store reviews API*, as documented in this topic, is currently not in a working state. Instead of using the APIs, you can achieve the same task(s) by [using Partner Center](/windows/apps/publish/respond-to-customer-reviews).
1215
1316
Use this method in the Microsoft Store reviews API to programmatically respond to reviews of your app. When you call this method, you must specify the IDs of the reviews you want to respond to. Review IDs are available in the response data of the [get app reviews](get-app-reviews.md) method in the Microsoft Store analytics API and in the [offline download](/windows/apps/publish/download-analytic-reports) of the [Reviews report](/windows/apps/publish/reviews-report).
1417

@@ -33,19 +36,16 @@ To use this method, you need to first do the following:
3336
|--------|------------------------------------------------------------------|
3437
| POST | ```https://manage.devcenter.microsoft.com/v1.0/my/reviews/responses``` |
3538

36-
3739
### Request header
3840

3941
| Header | Type | Description |
4042
|---------------|--------|-----------------------------------------------------------------------------|
4143
| Authorization | string | Required. The Azure AD access token in the form **Bearer** &lt;*token*&gt;. |
4244

43-
4445
### Request parameters
4546

4647
This method has no request parameters.
4748

48-
4949
### Request body
5050

5151
The request body has the following values.
@@ -54,7 +54,6 @@ The request body has the following values.
5454
|---------------|--------|-----------------------------------------|
5555
| Responses | array | An array of objects that contain the response data you want to submit. For more information about the data in each object, see the following table. |
5656

57-
5857
Each object in the *Responses* array contains the following values.
5958

6059
| Value | Type | Description | Required |
@@ -65,7 +64,6 @@ Each object in the *Responses* array contains the following values.
6564
| SupportEmail | string | Your app's support email address, which the customer can use to contact you directly. This must be a valid email address. | Yes |
6665
| IsPublic | Boolean | If you specify **true**, your response will be displayed in your app's Store listing, directly below the customer's review, and will be visible to all customers. If you specify **false** and the user hasn't opted out of receiving email responses, your response will be sent to the customer via email, and it will not be visible to other customers in your app's Store listing. If you specify **false** and the user has opted out of receiving email responses, an error will be returned. | Yes |
6766

68-
6967
### Request example
7068

7169
The following example demonstrates how to use this method to submit responses to several reviews.
@@ -102,7 +100,6 @@ Content-Type: application/json
102100
|---------------|--------|---------------------|
103101
| Result | array | An array of objects that contain data about each response you submitted. For more information about the data in each object, see the following table. |
104102

105-
106103
Each object in the *Result* array contains the following values.
107104

108105
| Value | Type | Description |
@@ -112,7 +109,6 @@ Each object in the *Result* array contains the following values.
112109
| Successful | string | The value **true** indicates that your response was sent successfully. The value **false** indicates that your response was unsuccessful. |
113110
| FailureReason | string | If **Successful** is **false**, this value contains a reason for the failure. If **Successful** is **true**, this value is empty. |
114111

115-
116112
### Response example
117113

118114
The following example demonstrates an example JSON response body for this request.

0 commit comments

Comments
 (0)