Uygulamadan API çağrısı yapmaCall API from an app

Bir smartphone uygulamasından Azure Özel Karar Alma Hizmeti API 'Lerine çağrılar yapın.Make calls to the Azure Custom Decision Service APIs from a smartphone app. Bu makalede, bazı temel seçeneklerle nasıl başlamak açıklanmaktadır.This article explains how to get started with some basic options.

Önce uygulamanızıkaydettiğinizden emin olun.Be sure to Register your application, first.

Akıllı telefonlardan Özel Karar Alma Hizmeti için oluşturduğunuz iki API çağrısı vardır: içeriğinizin sıralanmış bir listesini almak için derecelendirme API 'sine yapılan bir çağrı ve bir ödül bildirmek için bir Reward API çağrısı.There are two API calls you make from your smartphone app to Custom Decision Service: a call to the Ranking API to obtain a ranked list of your content and a call to the Reward API to report a reward. Örnek çağrılar aşağıda verilmiştir.Here are the sample calls in cURL.

Daha fazla bilgi için bkz. başvuru API 'si.For more information, see the reference API.

Derecelendirme API 'SI çağrısıyla başlayın.Start with the call to the Ranking API. Eylem kümesi kimliği <request.json>olan dosyayı oluşturun.Create the file <request.json>, which has the action set ID. Bu KIMLIK, portalda girdiğiniz karşılık gelen RSS veya Atom akışın adıdır:This ID is the name of the corresponding RSS or Atom feed that you entered on the portal:

{"decisions":
     [{ "actionSets":[{"id":{"id":"<actionSetId>"}}] }]}

Birçok eylem kümesi aşağıdaki şekilde belirtilebilir:Many action sets can be specified as follows:

{"decisions":
    [{ "actionSets":[{"id":{"id":"<actionSetId1>"}},
                     {"id":{"id":"<actionSetId2>"}}] }]}

Bu JSON dosyası daha sonra derecelendirme isteğinin bir parçası olarak gönderilir:This JSON file is then sent as part of the ranking request:

curl -d @<request.json> -X POST https://ds.microsoft.com/api/v2/<appId>/rank --header "Content-Type: application/json"

Burada, <appId> uygulamanızın portalda kayıtlı adı vardır.Here, <appId> is the name of your application registered on the portal. Uygulamanızda işleyebilmeniz için sıralı bir içerik öğeleri kümesi almalısınız.You should receive an ordered set of content items, which you can render in your application. Örnek bir dönüş şöyle görünür:A sample return looks like:

[{ "ranking":[{"id":"actionId3"}, {"id":"actionId1"}, {"id":"actionId2"}],
   "eventId":"<opaque event string>",
   "appId":"<your app id>",
   "rewardAction":"actionId3",
   "actionSets":[{"id":"<actionSetId1>","lastRefresh":"2017-04-29T22:34:25.3401438Z"},
                 {"id":"<actionSetId2>","lastRefresh":"2017-04-30T22:34:25.3401438Z"}]}]

Döndürün ilk bölümünde, eylem kimlikleri tarafından belirtilen sıralı eylemlerin bir listesi bulunur.The first part of the return has a list of ordered actions, specified by their action IDs. Bir makale için eylem KIMLIĞI bir URL 'dir.For an article, the action ID is a URL. Genel isteğin Ayrıca sistem tarafından oluşturulan benzersiz <eventId>bir de vardır.The overall request also has a unique <eventId>, created by the system.

Daha sonra, bu olaydaki ilk içerik öğesine tıkladıysanız, <actionId3>yani.Later, you can specify if you observed a click on the first content item from this event, which is <actionId3>. Daha sonra, aşağıdaki <eventId> gibi başka bir istek ile, ödül API aracılığıyla özel karar alma hizmeti için bir ödül bildirebilirsiniz:You can then report a reward on this <eventId> to Custom Decision Service via the Reward API, with another request such as:

curl -v https://ds.microsoft.com/api/v2/<appId>/reward/<eventId> -X POST

Son olarak, Özel Karar Alma Hizmeti tarafından kabul edilecek makalelerin (Eylemler) listesini döndüren eylem kümesi API 'sini sağlamanız gerekir.Finally, you need to provide the Action Set API, which returns the list of articles (actions) to be considered by Custom Decision Service. Bu API 'yi bir RSS akışı olarak aşağıda gösterildiği gibi uygulayın:Implement this API as an RSS feed, as shown here:

<rss version="2.0">
<channel>
   <item>
      <title><![CDATA[title (possibly with url) ]]></title>
      <link>url</link>
      <pubDate>Thu, 27 Apr 2017 16:30:52 GMT</pubDate>
    </item>
   <item>
       ....
   </item>
</channel>
</rss>

Burada, her üst düzey <item> öğe bir makale açıklar.Here, each top-level <item> element describes an article. <link> Zorunludur ve özel karar alma hizmeti tarafından bir eylem kimliği olarak kullanılır.The <link> is mandatory and is used as an action ID by Custom Decision Service. 15 <date> ' ten fazla makaleleriniz varsa (Standart bir RSS biçiminde) belirtin.Specify <date> (in a standard RSS format) if you've more than 15 articles. En son 15 makale kullanılır.The 15 most recent articles are used. , <title> İsteğe bağlıdır ve makale için metinle ilgili özellikler oluşturmak için kullanılır.The <title> is optional and is used to create text-related features for the article.

Sonraki adımlarNext steps

  • Daha ayrıntılı bir örnek için öğreticide çalışın.Work through a tutorial for a more in-depth example.
  • Belirtilen işlevsellik hakkında daha fazla bilgi edinmek için başvuru API 'sine başvurun.Consult the reference API to learn more about the provided functionality.