Add usage information for several endpoints

[ouya-store-api.git] / api / devs.ouya.tv / api-v1-details.rst

diff --git a/api/devs.ouya.tv/api-v1-details.rst b/api/devs.ouya.tv/api-v1-details.rst
index 162107d7168737766660c2070ba2d06ac6759583..d504b1bfb9bd57155646f98f3216d04b9a3a9b9e 100644 (file)
--- a/api/devs.ouya.tv/api-v1-details.rst
+++ b/api/devs.ouya.tv/api-v1-details.rst
@@ -4,6 +4,13 @@
 
 Detail page for an app bundle.
 
+Also used as detail page for installed games when opened through
+the "Play" section.
+
+If there are no details available, the error code 2005 needs to be returned.
+Otherwise opening the details for an installed but unlisted game will
+fail on the OUYA.
+
 
 HTTP request
 ============
@@ -21,9 +28,22 @@ GET parameters
   ``auth_token``
     Same as ``X-OUYA-AuthToken``
   ``page``
-    UUID of the page to show
+    UUID of the bundle page to show
 
     Example: ``be239ca4-10fd-42dd-89cd-1806e80b1362``
+  ``app``
+    Package name of an app.
+
+    Example: ``org.blockinger.game``
+  ``developer``
+    UUID of the developer
+
+    Example: ``5b015434-8a78-4274-aa5d-0cb2e330e50e``
+  ``community_content``
+    UUID of a community content module
+
+Only one of ``app``, ``developer`` or ``page`` is provided.
+
 
 HTTP response
 =============
@@ -32,8 +52,88 @@ Status code
 Content-type
   ``application/json; charset=utf-8``
 
-Example
--------
 
-.. include:: api-v1-details.response.json
+Response body definition
+------------------------
+
+``ccUrl``
+  Show community content for this game
+
+``developer.url``
+  Not set for everyone.
+  If set, a "Developer page" button is shown on the game details screen.
+
+  Example when set: ``ouya://launcher/details?developer=92345f8d-ddbd-43f2-afcf-2628b1234713``
+
+``metaData``
+  Array of strings that determine which data are shown in the top row.
+
+  Allowed values:
+
+  - ``key:rating.average``: Shows the rating stars from ``rating.average``
+  - ``key:apk.fileSize``: Shows the ``apk.fileSize`` as readable size with unit.
+  - ``key:twitterHandle``: Shows the ``twitterHandle`` property, automatically prefixes an "@".
+  - Any string value beginning with "key:" fetches the key path from JSON, e.g. ``developer.name``.
+  - Any string value that does not begin with ``key:`` is shown as-is.
+
+``promotedProduct``
+  When set, the "Buy" button is shown on the details screen.
+
+
+Example: App
+------------
+
+.. include:: api-v1-details.response-app.json
+   :code:
+
+Example: Bundle
+---------------
+
+.. include:: api-v1-details.response-bundle.json
    :code:
+
+A full version of that response data is available in git at
+``api/devs.ouya.tv/api-v1-details.response-bundle-full.json``
+
+
+Example: Unlisted game
+-----------------------
+
+.. include:: api-v1-details.response-unlisted.json
+   :code:
+
+
+Buttons
+=======
+It is possible to add buttons in each of the detail types.
+
+There are two types of buttons:
+
+- Switchable buttons (on/off state)
+- URL buttons (``android.intent.action.VIEW``,
+  e.g. to open URLs or detail pages of other apps)
+
+
+Button for a detail page of an app
+----------------------------------
+.. include:: api-v1-details.response-button-appdetails.json
+   :code:
+
+Button for a website URL
+------------------------
+.. include:: api-v1-details.response-button-url.json
+   :code:
+
+Switchable button
+-----------------
+.. include:: api-v1-details.response-button-switchable.json
+   :code:
+
+When the details page is loaded, ``status_url`` is fetched.
+It needs to return ``{"status":true}`` or ``{"status":false}``.
+
+If "true" is returned, ``on_text`` is shown.
+Clicking will launch ``off_url``.
+
+If "false is returned, ``text`` is shown.
+Clicking will launch ``url``.