keep the header visible
[ouya-game-data.git] / game-metadata.html
index 7b56c1b301f4e2c696f83738188b570b048bdb7e..edfa9291331f25deeb653919403bbd59c13238a5 100644 (file)
  <head>
   <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
   <title>OUYA game meta data</title>
+  <style type="text/css">
+   thead th {
+     position: sticky;
+     top: 0px;
+   }
+  </style>
  </head>
  <body>
   <table border="1">
    <thead>
     <tr>
+     <th>Group</th>
      <th>Datum</th>
-     <th>Discover</th>
-     <th>App details</th>
+     <th>Game data field</th>
+     <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-discover">Discover field</a></th>
+     <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-apps-xxx">App details field</a></th>
+     <th><a href="https://gitlab.com/devirich/BrewyaOnOuya/blob/master/store/models.py">BrewyaOnOuya field</a></th>
      <th>Example</th>
+     <th>Description</th>
     </tr>
    </thead>
    <tbody>
+
     <tr>
+     <td>app</td>
+     <td>Game UUID</td>
+     <td>uuid</td>
      <td>uuid</td>
-     <td>x</td>
-     <td>x</td>
+     <td>uuid</td>
+     <td>App.uuid</td>
      <td>780688a9-95ee-429a-8755-69a8d0c88fe0</td>
+     <td></td>
     </tr>
     <tr>
+     <td>app</td>
+     <td>Game title</td>
+     <td>title</td>
+     <td>title</td>
      <td>title</td>
-     <td>x</td>
-     <td>x</td>
+     <td>App.title</td>
      <td>Bloo Kid 2</td>
+     <td></td>
     </tr>
     <tr>
-     <td>supportEmailAddress</td>
+     <td>app</td>
+     <td>Overview text</td>
+     <td>overview (optional)</td>
      <td></td>
-     <td>x</td>
+     <td>overview</td>
+     <td>App.overview</td>
+     <td>Released in October 2015 by winterworks GmbH.</td>
      <td></td>
     </tr>
     <tr>
-     <td>supportPhone</td>
+     <td>app</td>
+     <td>Description</td>
+     <td>description</td>
+     <td></td>
+     <td>description</td>
+     <td>App.description</td>
+     <td>Bloo Kid 2 is a classic 2D retro-style platformer experience with lovely designed pixel-graphics and a full chiptune soundtrack. Run, jump and swim your way through FIVE huge worlds with TWELVE levels each. Master brutal bossfights and discover lots of secrets in the world of Bloo Kid 2.\r\n\r\nBloo Kid 2 features:\r\n- five worlds with twelve levels each\r\n- handcrafted, colorful pixel-graphics\r\n- a full chiptune soundtrack\r\n- epic boss battles\r\n- tons of secrets\r\n- achievements</td>
+     <td></td>
+    </tr>
+    <tr>
+     <td>app</td>
+     <td>Number of players</td>
+     <td>players</td>
+     <td>gamerNumbers</td>
+     <td>gamerNumbers</td>
+     <td>App.playerNumbers</td>
+     <td>[1]</td>
+     <td>Any combination of 1-4</td>
+    </tr>
+    <tr>
+     <td>app</td>
+     <td>Genre list</td>
+     <td>genres</td>
+     <td>genres</td>
+     <td>genres</td>
+     <td>App.genres</td>
+     <td>[Platformer, Retro]</td>
+     <td>
+      original genre list:
+      <ul>
+       <li>Adventure</li>
+       <li>App</li>
+       <li>Arcade/Pinball</li>
+       <li>Card/Casino</li>
+       <li>Dual Stick</li>
+       <li>Entertainment</li>
+       <li>Fight!</li>
+       <li>FPS/Shooter</li>
+       <li>Kids List</li>
+       <li>Meditative</li>
+       <li>Multiplayer</li>
+       <li>Music</li>
+       <li>Platformer</li>
+       <li>Puzzle/Trivia</li>
+       <li>Racing</li>
+       <li>Retro</li>
+       <li>Role-Playing</li>
+       <li>Short on Time?</li>
+       <li>Sim/Strategy</li>
+       <li>Sports</li>
+       <li>Utility</li>
+       <li>Video</li>
+      </ul>
+     </td>
+    </tr>
+    <tr>
+     <td>app</td>
+     <td>Package name</td>
+     <td>package</td>
+     <td>package</td>
      <td></td>
-     <td>x</td>
+     <td>App.packageName</td>
+     <td>evil.corptron.DuckGame</td>
+     <td>Run "aapt dump badging file.apk", field "package: name"</td>
+    </tr>
+    <tr>
+     <td>app</td>
+     <td>Details URL</td>
+     <td>-</td>
+     <td>url</td>
+     <td></td>
+     <td>-</td>
+     <td>ouya://launcher/details?app=evil.corptron.DuckGame</td>
      <td></td>
     </tr>
     <tr>
+     <td>app</td>
+     <td>Game website</td>
      <td>website</td>
      <td></td>
-     <td>x</td>
+     <td>website</td>
+     <td>App.website</td>
      <td>http://www.winterworks.de</td>
+     <td></td>
     </tr>
     <tr>
-     <td>founder</td>
-     <td></td>
-     <td>x</td>
+     <td>app</td>
+     <td>Content rating</td>
+     <td>contentRating (optional)</td>
+     <td>contentRating</td>
+     <td>contentRating</td>
+     <td>App.contentRating</td>
+     <td>Everyone</td>
+     <td>
+      <ul>
+       <li>Everyone</li>
+       <li>9+</li>
+       <li>12+</li>
+       <li>17+</li>
+      </ul>
+     </td>
+    </tr>
+    <tr>
+     <td>app</td>
+     <td>FIXME</td>
+     <td>premium (optional)</td>
+     <td>premium</td>
+     <td>premium</td>
+     <td>App.premium</td>
      <td>false</td>
+     <td></td>
     </tr>
     <tr>
-     <td>versionNumber</td>
-     <td>x</td>
-     <td>x</td>
-     <td>1.6</td>
+     <td>app</td>
+     <td>When the game was published</td>
+     <td>firstPublishedAt (optional)</td>
+     <td></td>
+     <td>firstPublishedAt</td>
+     <td>App.firstPublishedAt</td>
+     <td>2015-10-09T07:53:25Z</td>
+     <td></td>
     </tr>
     <tr>
-     <td>likeCount</td>
+     <td>app</td>
+     <td>Are there in-app purchases?</td>
+     <td>inAppPurchases (optional)</td>
+     <td>inAppPurchases</td>
+     <td></td>
+     <td>-</td>
+     <td>true</td>
      <td></td>
-     <td>x</td>
-     <td>0</td>
     </tr>
     <tr>
-     <td>overview</td>
+     <td>app</td>
+     <td>FIXME</td>
+     <td>-</td>
+     <td>type</td>
      <td></td>
-     <td>x</td>
-     <td>Released in October 2015 by winterworks GmbH.</td>
+     <td>-</td>
+     <td>app</td>
+     <td>"app", "discover" or "details_page" (for bundles)</td>
     </tr>
     <tr>
-     <td>contentRating</td>
-     <td>x</td>
-     <td>x</td>
-     <td>Everyone</td>
+     <td>app</td>
+     <td>Last update (unix timestamp)</td>
+     <td>-</td>
+     <td>updated_at</td>
+     <td></td>
+     <td>AppVersion.releaseTime</td>
+     <td>1417731390</td>
+     <td></td>
     </tr>
     <tr>
-     <td>publicSize</td>
+     <td>app</td>
+     <td>Last update</td>
+     <td>releases.*.date (when "latest")</td>
+     <td>updatedAt</td>
+     <td></td>
+     <td>AppVersion.releaseTime</td>
+     <td>2014-12-04T22:16:30Z</td>
      <td></td>
-     <td>x</td>
-     <td>27275</td>
     </tr>
+
     <tr>
-     <td>nativeSize</td>
+     <td>rating</td>
+     <td>Number of likes?</td>
+     <td>rating.likeCount</td>
+     <td></td>
+     <td>likeCount</td>
+     <td>Rating.likeCount</td>
+     <td>0</td>
      <td></td>
-     <td>x</td>
-     <td>20292</td>
     </tr>
     <tr>
+     <td>rating</td>
+     <td>Average rating</td>
+     <td>rating.average</td>
+     <td>rating.average</td>
      <td>ratingAverage</td>
-     <td>x</td>
-     <td>x</td>
+     <td>Rating.rating</td>
      <td>4.1</td>
+     <td></td>
     </tr>
     <tr>
+     <td>rating</td>
+     <td>Number of ratings</td>
+     <td>rating.count</td>
+     <td>rating.count</td>
      <td>ratingCount</td>
-     <td>x</td>
-     <td>x</td>
+     <td>Rating.reviewCount</td>
      <td>355</td>
+     <td></td>
     </tr>
+
     <tr>
-     <td>gamerNumbers</td>
-     <td>x</td>
-     <td>x</td>
-     <td>[1]</td>
+     <td>product</td>
+     <td>Promotion data</td>
+     <td>products.* (when "promoted=true")</td>
+     <td>promotedProduct</td>
+     <td>promotedProduct</td>
+     <td>App.promotedProduct</td>
+     <td>null</td>
+     <td>May be "null" if none, otherwise object</td>
     </tr>
     <tr>
-     <td>developer</td>
+     <td>product</td>
+     <td>Product key</td>
+     <td>products.*.identifier</td>
+     <td>promotedProduct.identifier</td>
+     <td>promotedProduct.identifier</td>
+     <td>Product.identifier</td>
+     <td>unlock_rockets</td>
      <td></td>
-     <td>x</td>
-     <td>winterworks GmbH</td>
     </tr>
     <tr>
-     <td>description</td>
+     <td>product</td>
+     <td>Product name</td>
+     <td>products.*.name</td>
+     <td>promotedProduct.name</td>
+     <td>promotedProduct.name</td>
+     <td>Product.name</td>
+     <td>Unlock Full Game</td>
      <td></td>
-     <td>x</td>
-     <td>Bloo Kid 2 is a classic 2D retro-style platformer experience with lovely designed pixel-graphics and a full chiptune soundtrack. Run, jump and swim your way through FIVE huge worlds with TWELVE levels each. Master brutal bossfights and discover lots of secrets in the world of Bloo Kid 2.\r\n\r\nBloo Kid 2 features:\r\n- five worlds with twelve levels each\r\n- handcrafted, colorful pixel-graphics\r\n- a full chiptune soundtrack\r\n- epic boss battles\r\n- tons of secrets\r\n- achievements</td>
     </tr>
     <tr>
-     <td>premium</td>
-     <td>x</td>
-     <td>x</td>
-     <td>false</td>
+     <td>product</td>
+     <td>Product currency</td>
+     <td>products.*.currency</td>
+     <td>promotedProduct.currency</td>
+     <td>promotedProduct.currency</td>
+     <td>-</td>
+     <td>EUR</td>
+     <td></td>
     </tr>
     <tr>
-     <td>md5sum</td>
-     <td>x</td>
-     <td>x</td>
-     <td>a5b0f82d54df5f551a64295e43771a10</td>
+     <td>product</td>
+     <td>Product description</td>
+     <td>products.*.description</td>
+     <td>promotedProduct.description</td>
+     <td>promotedProduct.description</td>
+     <td>Product.description</td>
+     <td>Remove the 9 satellites limitation. Infinite satellites!</td>
+     <td></td>
     </tr>
     <tr>
-     <td>apkFileSize</td>
+     <td>product</td>
+     <td>Saving</td>
+     <td>-</td>
+     <td>promotedProduct.percentOff</td>
+     <td>promotedProduct.percentOff</td>
+     <td>-</td>
+     <td>0</td>
      <td></td>
-     <td>x</td>
-     <td>25507828</td>
     </tr>
     <tr>
-     <td>filepickerScreenshots</td>
+     <td>product</td>
+     <td>Current price</td>
+     <td>products.*.localPrice</td>
+     <td>promotedProduct.localPrice</td>
+     <td>promotedProduct.localPrice</td>
+     <td>-</td>
+     <td>1.99</td>
      <td></td>
-     <td>x</td>
-     <td>[urls]</td>
     </tr>
     <tr>
-     <td>mainImageFullUrl</td>
+     <td>product</td>
+     <td>Previous price</td>
+     <td>products.*.originalPrice</td>
+     <td>promotedProduct.originalPrice</td>
+     <td>promotedProduct.originalPrice</td>
+     <td>Product.originalPrice</td>
+     <td>1.99</td>
      <td></td>
-     <td>x</td>
-     <td>https:\/\/d3e4aumcqn8cw3.cloudfront.net\/api\/file\/MASaiOBlTEO7GKYXsIns</td>
     </tr>
+
     <tr>
-     <td>genres</td>
-     <td>x</td>
-     <td>x</td>
-     <td>[Platformer, Retro]</td>
+     <td>apk</td>
+     <td>Human readable version</td>
+     <td>releases.*.name</td>
+     <td>latestVersion.versionNumber</td>
+     <td>versionNumber</td>
+     <td>Apk.versionName</td>
+     <td>1.6</td>
+     <td>Run "aapt dump badging file.apk", field "versionName"</td>
     </tr>
     <tr>
+     <td>apk</td>
+     <td>UUID of latest apk version</td>
+     <td>releases.*.uuid</td>
+     <td>latestVersion.uuid</td>
      <td>latestVersion</td>
-     <td>x</td>
-     <td>x</td>
+     <td>-</td>
      <td>780688a9-95ee-429a-8755-69a8d0c88fe0</td>
+     <td></td>
     </tr>
     <tr>
-     <td>firstPublishedAt</td>
+     <td>apk</td>
+     <td>FIXME</td>
+     <td>releases.*.publicSize</td>
+     <td></td>
+     <td>publicSize</td>
+     <td>Apk.publicSize</td>
+     <td>27275</td>
      <td></td>
-     <td>x</td>
-     <td>2015-10-09T07:53:25Z</td>
     </tr>
     <tr>
-     <td>publishedAt</td>
+     <td>apk</td>
+     <td>FIXME</td>
+     <td>releases.*.nativeSize</td>
+     <td></td>
+     <td>nativeSize</td>
+     <td>Apk.nativeSize</td>
+     <td>20292</td>
+     <td></td>
+    </tr>
+    <tr>
+     <td>apk</td>
+     <td>MD5 file hash</td>
+     <td>releases.*.md5sum</td>
+     <td>latestVersion.apk.md5sum</td>
+     <td>md5sum</td>
+     <td>Apk.md5sum</td>
+     <td>a5b0f82d54df5f551a64295e43771a10</td>
      <td></td>
-     <td>x</td>
+    </tr>
+    <tr>
+     <td>apk</td>
+     <td>APK file size</td>
+     <td>releases.*.size</td>
+     <td></td>
+     <td>apkFileSize</td>
+     <td>Apk.size</td>
+     <td>25507828</td>
+     <td></td>
+    </tr>
+    <tr>
+     <td>apk</td>
+     <td>APK publish date</td>
+     <td>releases.*.date</td>
+     <td></td>
+     <td>publishedAt</td>
+     <td>AppVersion.releaseTime</td>
      <td>2015-10-23T09:58:19Z</td>
+     <td></td>
     </tr>
     <tr>
-     <td>videoUrl</td>
+     <td>apk</td>
+     <td>downloadLink</td>
+     <td>releases.*.url</td>
      <td></td>
-     <td>x</td>
-     <td><a href="https://vimeo.com/">https://vimeo.com/</a>141878938</td>
+     <td></td>
+     <td>Apk.location</td>
+     <td>https://devs-ouya-tv-prod.s3.amazonaws.com/apps/5a3fbb4d-852b-4af4-becc-324dce6a3b42/de.eiswuxe.blookid2/780688a9-95ee-429a-8755-69a8d0c88fe0/lFzMjcZyQauvWX5k8HvH_blookid2.apk</td>
+     <td>Also in download.json</td>
     </tr>
+
     <tr>
-     <td>mobileAppIcon</td>
+     <td>media</td>
+     <td>Discover image</td>
+     <td>media.discover</td>
+     <td>image</td>
+     <td></td>
+     <td>Media</td>
+     <td>https://www.filepicker.io/api/file/05y2T8cKTY6cUfX7RYFR</td>
      <td></td>
-     <td>x</td>
-     <td>null</td>
     </tr>
     <tr>
-     <td>promotedProduct</td>
-     <td>x</td>
-     <td>x</td>
-     <td>null</td>
+     <td>media</td>
+     <td>Large image</td>
+     <td>media.large</td>
+     <td></td>
+     <td>mainImageFullUrl</td>
+     <td>App.titleImage</td>
+     <td>https://d3e4aumcqn8cw3.cloudfront.net/api/file/MASaiOBlTEO7GKYXsIns</td>
+     <td></td>
     </tr>
     <tr>
-     <td>url</td>
-     <td>x</td>
+     <td>media</td>
+     <td>Video</td>
+     <td>media.video</td>
+     <td></td>
+     <td>videoUrl</td>
+     <td>Media</td>
+     <td>https://vimeo.com/141878938</td>
      <td></td>
-     <td>ouya://launcher/details?app=evil.corptron.DuckGame</td>
     </tr>
     <tr>
-     <td>inAppPurchases</td>
-     <td>x</td>
+     <td>media</td>
+     <td>Game screenshots</td>
+     <td>media.screenshots</td>
+     <td></td>
+     <td>filepickerScreenshots</td>
+     <td>Media</td>
+     <td>[urls]</td>
      <td></td>
-     <td>true</td>
     </tr>
     <tr>
-     <td>type</td>
-     <td>x</td>
+     <td>media</td>
+     <td>FIXME</td>
+     <td>-</td>
+     <td></td>
+     <td>mobileAppIcon</td>
+     <td>App.iconImage</td>
+     <td>null</td>
      <td></td>
-     <td>app</td>
     </tr>
+
     <tr>
-     <td>package</td>
-     <td>x</td>
+     <td>developer</td>
+     <td>Developer name</td>
+     <td>developer.name</td>
+     <td></td>
+     <td>developer</td>
+     <td>Developer.name</td>
+     <td>winterworks GmbH</td>
      <td></td>
-     <td>evil.corptron.DuckGame</td>
     </tr>
     <tr>
-     <td>updated_at</td>
-     <td>x</td>
+     <td>developer</td>
+     <td>Developer support mail</td>
+     <td>developer.supportEmail</td>
+     <td></td>
+     <td>supportEmailAddress</td>
+     <td>Developer.supportEmail</td>
+     <td>null</td>
      <td></td>
-     <td>1417731390</td>
     </tr>
     <tr>
-     <td>updatedAt</td>
-     <td>x</td>
+     <td>developer</td>
+     <td>Support phone number</td>
+     <td>developer.supportPhone</td>
+     <td></td>
+     <td>supportPhone</td>
+     <td>Developer.supportPhone</td>
+     <td>null</td>
      <td></td>
-     <td>2014-12-04T22:16:30Z</td>
     </tr>
     <tr>
-     <td>image</td>
-     <td>x</td>
+     <td>developer</td>
+     <td>Developer is a founder</td>
+     <td>developer.founder</td>
+     <td></td>
+     <td>founder</td>
+     <td>Developer.founder</td>
+     <td>false</td>
      <td></td>
-     <td>https://www.filepicker.io/api/file/05y2T8cKTY6cUfX7RYFR</td>
     </tr>
+
    </tbody>
   </table>
  </body>