Управление целевыми предложениями с помощью служб Store
Если вы создаете целевое предложение на странице "Целевые > предложения" для вашего приложения в Центре партнеров, используйте API целевых предложений в Microsoft Store в коде приложения для получения сведений, которые помогают реализовать интерфейс в приложении для целевого предложения. Дополнительные сведения о целевых предложениях и способах их создания на панели мониторинга см. в статье "Использование целевых предложений для максимально эффективного взаимодействия и преобразования".
Api целевых предложений — это простой REST API, который можно использовать для получения целевых предложений, доступных для текущего пользователя, в зависимости от того, является ли пользователь частью сегмента клиента для целевого предложения. Чтобы использовать этот API в коде приложения, выполните следующие действия.
- Получите маркер учетной записи Майкрософт для текущего пользователя, выполнившего вход в приложение.
- Получите целевые предложения для текущего пользователя.
- Реализуйте интерфейс покупки в приложении для надстройки, связанной с одним из целевых предложений. Дополнительные сведения о реализации покупок в приложении см . в этой статье.
Полный пример кода, демонстрирующий все эти действия, см . в примере кода в конце этой статьи. В следующих разделах содержатся дополнительные сведения о каждом шаге.
Получение маркера учетной записи Майкрософт для текущего пользователя
В коде приложения получите маркер учетной записи Майкрософт (MSA) для текущего пользователя, выполнившего вход. Этот маркер необходимо передать в заголовке Authorization запроса для API целевых предложений Microsoft Store. Этот маркер используется в Магазине для получения целевых предложений, доступных для текущего пользователя.
Чтобы получить маркер MSA, используйте класс WebAuthenticationCoreManager для запроса маркера с помощью области devcenter_implicit.basic,wl.basic. В следующем примере показано, как это сделать. Этот пример представляет собой фрагмент из полного примера, и для него требуются инструкции using , предоставляемые в полном примере.
private async Task<string> GetMicrosoftAccountTokenAsync()
{
var msaProvider = await WebAuthenticationCoreManager.FindAccountProviderAsync(
"https://login.microsoft.com", "consumers");
WebTokenRequest request = new WebTokenRequest(msaProvider, "devcenter_implicit.basic,wl.basic");
WebTokenRequestResult result = await WebAuthenticationCoreManager.RequestTokenAsync(request);
if (result.ResponseStatus == WebTokenRequestStatus.Success)
{
return result.ResponseData[0].Token;
}
else
{
return string.Empty;
}
}
Дополнительные сведения о получении маркеров MSA см. в разделе диспетчера веб-учетных записей.
Получение целевых предложений для текущего пользователя
После получения маркера MSA для текущего https://manage.devcenter.microsoft.com/v2.0/my/storeoffers/user пользователя вызовите метод GET URI, чтобы получить доступные целевые предложения для текущего пользователя. Дополнительные сведения об этом методе REST см. в разделе "Получение целевых предложений".
Этот метод возвращает идентификаторы продуктов надстроек, связанных с целевыми предложениями, доступными для текущего пользователя. С помощью этой информации вы можете предложить одно или несколько целевых предложений в качестве покупки в приложении пользователю.
В следующем примере показано, как получить целевые предложения для текущего пользователя. Этот пример представляет собой фрагмент из полного примера. Для этого требуется библиотека Json.NET из Newtonsoft и дополнительных классов и инструкций using , предоставляемых в полном примере.
private async Task<List<TargetedOfferData>> GetTargetedOffersForUserAsync(string msaToken)
{
if (string.IsNullOrEmpty(msaToken))
{
System.Diagnostics.Debug.WriteLine("Microsoft Account token is null or empty.");
return null;
}
HttpClient httpClientGetOffers = new HttpClient();
httpClientGetOffers.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", msaToken);
List<TargetedOfferData> availableOfferData = null;
try
{
string getOffersResponse = await httpClientGetOffers.GetStringAsync(new Uri(storeOffersUri));
availableOfferData =
Newtonsoft.Json.JsonConvert.DeserializeObject<List<TargetedOfferData>>(getOffersResponse);
}
catch (Exception ex)
{
System.Diagnostics.Debug.WriteLine(ex.Message);
}
return availableOfferData;
}
Полный пример кода
В следующем примере кода показаны следующие задачи:
- Получите маркер MSA для текущего пользователя.
- Получите все целевые предложения для текущего пользователя с помощью метода Получения целевых предложений .
- Приобретите надстройку, связанную с целевым предложением.
В этом примере требуется библиотека Json.NET из Newtonsoft. В примере используется эта библиотека для сериализации и десериализации данных в формате JSON.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Net.Http;
using System.Net.Http.Headers;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Windows.Services.Store;
using Windows.Security.Authentication.Web.Core;
namespace DocumenationExamples
{
public class TargetedOffersExample
{
private const string storeOffersUri = "https://manage.devcenter.microsoft.com/v2.0/my/storeoffers/user";
private const string jsonMediaType = "application/json";
private static string[] productKinds = { "Durable", "Consumable", "UnmanagedConsumable" };
private static StoreContext storeContext = StoreContext.GetDefault();
public async void DemonstrateTargetedOffers()
{
// Get the Microsoft Account token for the current user.
string msaToken = await GetMicrosoftAccountTokenAsync();
if (string.IsNullOrEmpty(msaToken))
{
System.Diagnostics.Debug.WriteLine("Microsoft Account token could not be retrieved.");
return;
}
// Get the targeted Store offers for the current user.
List<TargetedOfferData> availableOfferData =
await GetTargetedOffersForUserAsync(msaToken);
if (availableOfferData == null || availableOfferData.Count == 0)
{
System.Diagnostics.Debug.WriteLine("There was an error retrieving targeted offers," +
"or there are no targeted offers available for the current user.");
return;
}
// Get the product ID of the add-on that is associated with the first available offer
// in the response data.
TargetedOfferData offerData = availableOfferData[0];
string productId = offerData.Offers[0];
// Get the Store ID of the add-on that has the matching product ID, and then purchase the add-on.
List<String> filterList = new List<string>(productKinds);
StoreProductQueryResult queryResult = await storeContext.GetAssociatedStoreProductsAsync(filterList);
foreach (KeyValuePair<string, StoreProduct> result in queryResult.Products)
{
if (result.Value.InAppOfferToken == productId)
{
await PurchaseOfferAsync(result.Value.StoreId);
return;
}
}
System.Diagnostics.Debug.WriteLine("No add-on with the specified product ID could be found " +
"for the current app.");
return;
}
private async Task<string> GetMicrosoftAccountTokenAsync()
{
var msaProvider = await WebAuthenticationCoreManager.FindAccountProviderAsync(
"https://login.microsoft.com", "consumers");
WebTokenRequest request = new WebTokenRequest(msaProvider, "devcenter_implicit.basic,wl.basic");
WebTokenRequestResult result = await WebAuthenticationCoreManager.RequestTokenAsync(request);
if (result.ResponseStatus == WebTokenRequestStatus.Success)
{
return result.ResponseData[0].Token;
}
else
{
return string.Empty;
}
}
private async Task<List<TargetedOfferData>> GetTargetedOffersForUserAsync(string msaToken)
{
if (string.IsNullOrEmpty(msaToken))
{
System.Diagnostics.Debug.WriteLine("Microsoft Account token is null or empty.");
return null;
}
HttpClient httpClientGetOffers = new HttpClient();
httpClientGetOffers.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", msaToken);
List<TargetedOfferData> availableOfferData = null;
try
{
string getOffersResponse = await httpClientGetOffers.GetStringAsync(new Uri(storeOffersUri));
availableOfferData =
Newtonsoft.Json.JsonConvert.DeserializeObject<List<TargetedOfferData>>(getOffersResponse);
}
catch (Exception ex)
{
System.Diagnostics.Debug.WriteLine(ex.Message);
}
return availableOfferData;
}
private async Task PurchaseOfferAsync(string storeId)
{
if (string.IsNullOrEmpty(storeId))
{
System.Diagnostics.Debug.WriteLine("storeId is null or empty.");
return;
}
// Purchase the add-on for the current user. Typically, a game or app would first show
// a UI that prompts the user to buy the add-on; for simplicity, this example
// simply purchases the add-on.
StorePurchaseResult result = await storeContext.RequestPurchaseAsync(storeId);
// Capture the error message for the purchase operation, if any.
string extendedError = string.Empty;
if (result.ExtendedError != null)
{
extendedError = result.ExtendedError.Message;
}
switch (result.Status)
{
case StorePurchaseStatus.AlreadyPurchased:
System.Diagnostics.Debug.WriteLine("The user has already purchased the product.");
break;
case StorePurchaseStatus.Succeeded:
System.Diagnostics.Debug.WriteLine("The purchase was successful.");
break;
case StorePurchaseStatus.NotPurchased:
System.Diagnostics.Debug.WriteLine("The purchase did not complete. " +
"The user may have cancelled the purchase. ExtendedError: " + extendedError);
break;
case StorePurchaseStatus.NetworkError:
System.Diagnostics.Debug.WriteLine("The purchase was unsuccessful due to a network error. " +
"ExtendedError: " + extendedError);
break;
case StorePurchaseStatus.ServerError:
System.Diagnostics.Debug.WriteLine("The purchase was unsuccessful due to a server error. " +
"ExtendedError: " + extendedError);
break;
default:
System.Diagnostics.Debug.WriteLine("The purchase was unsuccessful due to an unknown error. " +
"ExtendedError: " + extendedError);
break;
}
}
}
public class TargetedOfferData
{
[JsonProperty(PropertyName = "offers")]
public IList<string> Offers { get; } = new List<string>();
[JsonProperty(PropertyName = "trackingId")]
public string TrackingId { get; set; }
}
}