more info about details page
[ouya-game-data.git] / game-metadata.html
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html>
3 <html xmlns="http://www.w3.org/1999/xhtml">
4  <head>
5   <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
6   <title>OUYA game meta data</title>
7   <style type="text/css">
8    thead th {
9      position: sticky;
10      top: 0px;
11      background-color: lightgrey;
12    }
13   </style>
14  </head>
15  <body>
16   <table border="1">
17    <thead>
18     <tr>
19      <th>Group</th>
20      <th>Datum</th>
21      <th>Game data field</th>
22      <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-discover">Discover field</a></th>
23      <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-apps-xxx">App field</a></th>
24      <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-details">Details field</a></th>
25      <th><a href="https://gitlab.com/devirich/BrewyaOnOuya/blob/master/store/models.py">BrewyaOnOuya field</a></th>
26      <th>Example</th>
27      <th>Description</th>
28     </tr>
29    </thead>
30    <tbody>
31
32     <tr>
33      <td>app</td>
34      <td>Game UUID</td>
35      <td>uuid</td>
36      <td>uuid</td>
37      <td>uuid</td>
38      <td>-</td>
39      <td>App.uuid</td>
40      <td>780688a9-95ee-429a-8755-69a8d0c88fe0</td>
41      <td></td>
42     </tr>
43     <tr>
44      <td>app</td>
45      <td>Game title</td>
46      <td>title</td>
47      <td>title</td>
48      <td>title</td>
49      <td>title</td>
50      <td>App.title</td>
51      <td>Bloo Kid 2</td>
52      <td></td>
53     </tr>
54     <tr>
55      <td>app</td>
56      <td>Overview text</td>
57      <td>overview (optional)</td>
58      <td></td>
59      <td>overview</td>
60      <td>-</td>
61      <td>App.overview</td>
62      <td>Released in October 2015 by winterworks GmbH.</td>
63      <td></td>
64     </tr>
65     <tr>
66      <td>app</td>
67      <td>Description</td>
68      <td>description</td>
69      <td></td>
70      <td>description</td>
71      <td>description</td>
72      <td>App.description</td>
73      <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>
74      <td></td>
75     </tr>
76     <tr>
77      <td>app</td>
78      <td>Number of players</td>
79      <td>players</td>
80      <td>gamerNumbers</td>
81      <td>gamerNumbers</td>
82      <td>gamerNumbers</td>
83      <td>App.playerNumbers</td>
84      <td>[1]</td>
85      <td>Any combination of 1-4</td>
86     </tr>
87     <tr>
88      <td>app</td>
89      <td>Genre list</td>
90      <td>genres</td>
91      <td>genres</td>
92      <td>genres</td>
93      <td>genres</td>
94      <td>App.genres</td>
95      <td>[Platformer, Retro]</td>
96      <td>
97       original genre list:
98       <ul>
99        <li>Adventure</li>
100        <li>App</li>
101        <li>Arcade/Pinball</li>
102        <li>Card/Casino</li>
103        <li>Dual Stick</li>
104        <li>Entertainment</li>
105        <li>Fight!</li>
106        <li>FPS/Shooter</li>
107        <li>Kids List</li>
108        <li>Meditative</li>
109        <li>Multiplayer</li>
110        <li>Music</li>
111        <li>Platformer</li>
112        <li>Puzzle/Trivia</li>
113        <li>Racing</li>
114        <li>Retro</li>
115        <li>Role-Playing</li>
116        <li>Short on Time?</li>
117        <li>Sim/Strategy</li>
118        <li>Sports</li>
119        <li>Utility</li>
120        <li>Video</li>
121       </ul>
122      </td>
123     </tr>
124     <tr>
125      <td>app</td>
126      <td>Package name</td>
127      <td>package</td>
128      <td>package</td>
129      <td></td>
130      <td>apk.package</td>
131      <td>App.packageName</td>
132      <td>evil.corptron.DuckGame</td>
133      <td>Run "aapt dump badging file.apk", field "package: name"</td>
134     </tr>
135     <tr>
136      <td>app</td>
137      <td>Details URL</td>
138      <td>-</td>
139      <td>url</td>
140      <td></td>
141      <td>-</td>
142      <td>-</td>
143      <td>ouya://launcher/details?app=evil.corptron.DuckGame</td>
144      <td></td>
145     </tr>
146     <tr>
147      <td>app</td>
148      <td>Game website</td>
149      <td>website</td>
150      <td></td>
151      <td>website</td>
152      <td>-</td>
153      <td>App.website</td>
154      <td>http://www.winterworks.de</td>
155      <td></td>
156     </tr>
157     <tr>
158      <td>app</td>
159      <td>Content rating</td>
160      <td>contentRating (optional)</td>
161      <td>contentRating</td>
162      <td>contentRating</td>
163      <td>suggestedAge</td>
164      <td>App.contentRating</td>
165      <td>Everyone</td>
166      <td>
167       <ul>
168        <li>Everyone</li>
169        <li>9+</li>
170        <li>12+</li>
171        <li>17+</li>
172       </ul>
173      </td>
174     </tr>
175     <tr>
176      <td>app</td>
177      <td>FIXME</td>
178      <td>premium (optional)</td>
179      <td>premium</td>
180      <td>premium</td>
181      <td>premium</td>
182      <td>App.premium</td>
183      <td>false</td>
184      <td></td>
185     </tr>
186     <tr>
187      <td>app</td>
188      <td>When the game was published</td>
189      <td>firstPublishedAt (optional)</td>
190      <td></td>
191      <td>firstPublishedAt</td>
192      <td>firstPublishedAt (unix timestamp)</td>
193      <td>App.firstPublishedAt</td>
194      <td>2015-10-09T07:53:25Z</td>
195      <td></td>
196     </tr>
197     <tr>
198      <td>app</td>
199      <td>Are there in-app purchases?</td>
200      <td>inAppPurchases (optional)</td>
201      <td>inAppPurchases</td>
202      <td></td>
203      <td>inAppPurchases</td>
204      <td>-</td>
205      <td>true</td>
206      <td></td>
207     </tr>
208     <tr>
209      <td>app</td>
210      <td>FIXME</td>
211      <td>-</td>
212      <td>type</td>
213      <td></td>
214      <td>type</td>
215      <td>-</td>
216      <td>app</td>
217      <td>
218       discover: "app", "discover" or "details_page" (for bundles)<br/>
219       details: "Game", FIXME
220      </td>
221     </tr>
222     <tr>
223      <td>app</td>
224      <td>Last update (unix timestamp)</td>
225      <td>-</td>
226      <td>updated_at</td>
227      <td></td>
228      <td>-</td>
229      <td>AppVersion.releaseTime</td>
230      <td>1417731390</td>
231      <td></td>
232     </tr>
233     <tr>
234      <td>app</td>
235      <td>Last update</td>
236      <td>releases.*.date (when "latest")</td>
237      <td>updatedAt</td>
238      <td></td>
239      <td>-</td>
240      <td>AppVersion.releaseTime</td>
241      <td>2014-12-04T22:16:30Z</td>
242      <td></td>
243     </tr>
244
245     <tr>
246      <td>?</td>
247      <td>Metadata about the file</td>
248      <td>-</td>
249      <td>-</td>
250      <td></td>
251      <td>metaData</td>
252      <td>-</td>
253      <td>["key:rating.average", "key:developer.name", "key:suggestedAge", "45.29 MiB"]</td>
254      <td>Always those 4 values and in the same order (at least for apps)</td>
255     </tr>
256
257     <tr>
258      <td>rating</td>
259      <td>Number of likes?</td>
260      <td>rating.likeCount</td>
261      <td></td>
262      <td>likeCount</td>
263      <td>-</td>
264      <td>Rating.likeCount</td>
265      <td>0</td>
266      <td></td>
267     </tr>
268     <tr>
269      <td>rating</td>
270      <td>Average rating</td>
271      <td>rating.average</td>
272      <td>rating.average</td>
273      <td>ratingAverage</td>
274      <td>rating.average</td>
275      <td>Rating.rating</td>
276      <td>4.1</td>
277      <td></td>
278     </tr>
279     <tr>
280      <td>rating</td>
281      <td>Number of ratings</td>
282      <td>rating.count</td>
283      <td>rating.count</td>
284      <td>ratingCount</td>
285      <td>rating.count</td>
286      <td>Rating.reviewCount</td>
287      <td>355</td>
288      <td></td>
289     </tr>
290
291     <tr>
292      <td>product</td>
293      <td>Promotion data</td>
294      <td>products.* (when "promoted=true")</td>
295      <td>promotedProduct</td>
296      <td>promotedProduct</td>
297      <td>promotedProduct</td>
298      <td>App.promotedProduct</td>
299      <td>null</td>
300      <td>May be "null" if none, otherwise object</td>
301     </tr>
302     <tr>
303      <td>product</td>
304      <td>Product key</td>
305      <td>products.*.identifier</td>
306      <td>promotedProduct.identifier</td>
307      <td>promotedProduct.identifier</td>
308      <td>promotedProduct.identifier</td>
309      <td>Product.identifier</td>
310      <td>unlock_rockets</td>
311      <td></td>
312     </tr>
313     <tr>
314      <td>product</td>
315      <td>Product name</td>
316      <td>products.*.name</td>
317      <td>promotedProduct.name</td>
318      <td>promotedProduct.name</td>
319      <td>promotedProduct.name</td>
320      <td>Product.name</td>
321      <td>Unlock Full Game</td>
322      <td></td>
323     </tr>
324     <tr>
325      <td>product</td>
326      <td>Product currency</td>
327      <td>products.*.currency</td>
328      <td>promotedProduct.currency</td>
329      <td>promotedProduct.currency</td>
330      <td>promotedProduct.currency</td>
331      <td>-</td>
332      <td>EUR</td>
333      <td></td>
334     </tr>
335     <tr>
336      <td>product</td>
337      <td>Product description</td>
338      <td>products.*.description</td>
339      <td>promotedProduct.description</td>
340      <td>promotedProduct.description</td>
341      <td>promotedProduct.description</td>
342      <td>Product.description</td>
343      <td>Remove the 9 satellites limitation. Infinite satellites!</td>
344      <td></td>
345     </tr>
346     <tr>
347      <td>product</td>
348      <td>Saving</td>
349      <td>-</td>
350      <td>promotedProduct.percentOff</td>
351      <td>promotedProduct.percentOff</td>
352      <td>promotedProduct.percentOff</td>
353      <td>-</td>
354      <td>0</td>
355      <td></td>
356     </tr>
357     <tr>
358      <td>product</td>
359      <td>Current price</td>
360      <td>products.*.localPrice</td>
361      <td>promotedProduct.localPrice</td>
362      <td>promotedProduct.localPrice</td>
363      <td>promotedProduct.localPrice</td>
364      <td>-</td>
365      <td>1.99</td>
366      <td></td>
367     </tr>
368     <tr>
369      <td>product</td>
370      <td>Previous price</td>
371      <td>products.*.originalPrice</td>
372      <td>promotedProduct.originalPrice</td>
373      <td>promotedProduct.originalPrice</td>
374      <td>promotedProduct.originalPrice</td>
375      <td>Product.originalPrice</td>
376      <td>1.99</td>
377      <td></td>
378     </tr>
379     <tr>
380      <td>product</td>
381      <td>FIXME</td>
382      <td>?</td>
383      <td>?</td>
384      <td>?</td>
385      <td>promotedProduct.type</td>
386      <td>?</td>
387      <td>"entitlement" (502x), null (758x)</td>
388      <td></td>
389     </tr>
390
391     <tr>
392      <td>apk</td>
393      <td>Human readable version</td>
394      <td>releases.*.name</td>
395      <td>latestVersion.versionNumber</td>
396      <td>versionNumber</td>
397      <td>version.number</td>
398      <td>Apk.versionName</td>
399      <td>1.6</td>
400      <td>Run "aapt dump badging file.apk", field "versionName"</td>
401     </tr>
402     <tr>
403      <td>apk</td>
404      <td>UUID of latest apk version</td>
405      <td>releases.*.uuid</td>
406      <td>latestVersion.uuid</td>
407      <td>latestVersion</td>
408      <td>version.uuid</td>
409      <td>-</td>
410      <td>780688a9-95ee-429a-8755-69a8d0c88fe0</td>
411      <td></td>
412     </tr>
413     <tr>
414      <td>apk</td>
415      <td>Internal version</td>
416      <td>-</td>
417      <td>-</td>
418      <td>-</td>
419      <td>apk.versionCode</td>
420      <td>Apk.versionCode</td>
421      <td>null, 120401, 11, 1001004</td>
422      <td>Run "aapt dump badging file.apk", field "versionCode"</td>
423     </tr>
424     <tr>
425      <td>apk</td>
426      <td>FIXME</td>
427      <td>releases.*.publicSize</td>
428      <td></td>
429      <td>publicSize</td>
430      <td>apk.publicSize</td>
431      <td>Apk.publicSize</td>
432      <td>27275</td>
433      <td></td>
434     </tr>
435     <tr>
436      <td>apk</td>
437      <td>FIXME</td>
438      <td>releases.*.nativeSize</td>
439      <td></td>
440      <td>nativeSize</td>
441      <td>apk.nativeSize</td>
442      <td>Apk.nativeSize</td>
443      <td>20292</td>
444      <td></td>
445     </tr>
446     <tr>
447      <td>apk</td>
448      <td>MD5 file hash</td>
449      <td>releases.*.md5sum</td>
450      <td>latestVersion.apk.md5sum</td>
451      <td>md5sum</td>
452      <td>apk.md5sum</td>
453      <td>Apk.md5sum</td>
454      <td>a5b0f82d54df5f551a64295e43771a10</td>
455      <td></td>
456     </tr>
457     <tr>
458      <td>apk</td>
459      <td>APK file size</td>
460      <td>releases.*.size</td>
461      <td></td>
462      <td>apkFileSize</td>
463      <td>apk.fileSize</td>
464      <td>Apk.size</td>
465      <td>25507828</td>
466      <td></td>
467     </tr>
468     <tr>
469      <td>apk</td>
470      <td>APK publish date</td>
471      <td>releases.*.date</td>
472      <td></td>
473      <td>publishedAt</td>
474      <td>version.publishedAt (unix timestamp)</td>
475      <td>AppVersion.releaseTime</td>
476      <td>2015-10-23T09:58:19Z</td>
477      <td></td>
478     </tr>
479     <tr>
480      <td>apk</td>
481      <td>downloadLink</td>
482      <td>releases.*.url</td>
483      <td></td>
484      <td></td>
485      <td>apk.filename</td>
486      <td>Apk.location</td>
487      <td>
488       url: 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<br/>
489       details: 1zbYKRSS1elKIYI9eseH_BombSquad-ouya-release.apk
490      </td>
491      <td>
492       Also in download.json<br/>
493       Details field: only a file name, no path/domain
494      </td>
495     </tr>
496     <tr>
497      <td>apk</td>
498      <td>state</td>
499      <td>-</td>
500      <td>?</td>
501      <td>?</td>
502      <td>apk.state</td>
503      <td>?</td>
504      <td>
505       "complete"
506      </td>
507      <td></td>
508     </tr>
509
510     <tr>
511      <td>media</td>
512      <td>Discover image</td>
513      <td>media.discover</td>
514      <td>image</td>
515      <td></td>
516      <td>tileImage</td>
517      <td>Media</td>
518      <td>https://www.filepicker.io/api/file/05y2T8cKTY6cUfX7RYFR</td>
519      <td></td>
520     </tr>
521     <tr>
522      <td>media</td>
523      <td>Large image</td>
524      <td>media.large</td>
525      <td></td>
526      <td>mainImageFullUrl</td>
527      <td>-</td>
528      <td>App.titleImage</td>
529      <td>https://d3e4aumcqn8cw3.cloudfront.net/api/file/MASaiOBlTEO7GKYXsIns</td>
530      <td></td>
531     </tr>
532     <tr>
533      <td>media</td>
534      <td>FIXME</td>
535      <td>-</td>
536      <td>-</td>
537      <td>-</td>
538      <td>heroImage.url</td>
539      <td>?</td>
540      <td>
541       https://s3.amazonaws.com/ouya-screenshots/3d819f4e-2195-433c-81ea-c766a6f3144f/ouya-image20170118-3-i56ad1<br/>
542       null
543      </td>
544      <td>
545       Most games, had "null" here, only 14 had one set.
546       When this was set, mobileAppIcon was also set.
547      </td>
548     </tr>
549     <tr>
550      <td>media</td>
551      <td>Video</td>
552      <td>media.video</td>
553      <td></td>
554      <td>videoUrl</td>
555      <td>mediaTiles.*.url (when mediaTiles.*.type=video)</td>
556      <td>Media</td>
557      <td>https://vimeo.com/141878938</td>
558      <td></td>
559     </tr>
560     <tr>
561      <td>media</td>
562      <td>Game screenshots</td>
563      <td>media.screenshots</td>
564      <td></td>
565      <td>filepickerScreenshots</td>
566      <td>mediaTiles.*.urls.full, mediaTiles.*.urls.thumb, mediaTiles.*.fp_url (when mediaTiles.*.type=image)</td>
567      <td>Media</td>
568      <td>[urls]</td>
569      <td></td>
570     </tr>
571     <tr>
572      <td>media</td>
573      <td>FIXME</td>
574      <td>-</td>
575      <td></td>
576      <td>mobileAppIcon</td>
577      <td>mobileAppIcon</td>
578      <td>App.iconImage</td>
579      <td>
580       null<br/>
581       https://s3.amazonaws.com/ouya-screenshots/3ae8fc67-f7f5-4f97-a48c-8ea2d31460fd/ouya-image20170911-3-v6tjz1
582      </td>
583      <td>
584       1246x null, rest had its own URL.
585       Set when heroImage was filled.
586      </td>
587     </tr>
588
589     <tr>
590      <td>developer</td>
591      <td>Developer name</td>
592      <td>developer.name</td>
593      <td></td>
594      <td>developer</td>
595      <td>developer.name</td>
596      <td>Developer.name</td>
597      <td>winterworks GmbH</td>
598      <td></td>
599     </tr>
600     <tr>
601      <td>developer</td>
602      <td>Developer support mail</td>
603      <td>developer.supportEmail</td>
604      <td></td>
605      <td>supportEmailAddress</td>
606      <td>-</td>
607      <td>Developer.supportEmail</td>
608      <td>null</td>
609      <td></td>
610     </tr>
611     <tr>
612      <td>developer</td>
613      <td>Support phone number</td>
614      <td>developer.supportPhone</td>
615      <td></td>
616      <td>supportPhone</td>
617      <td>-</td>
618      <td>Developer.supportPhone</td>
619      <td>null</td>
620      <td></td>
621     </tr>
622     <tr>
623      <td>developer</td>
624      <td>Developer is a founder</td>
625      <td>developer.founder</td>
626      <td></td>
627      <td>founder</td>
628      <td>developer.founder</td>
629      <td>Developer.founder</td>
630      <td>false</td>
631      <td></td>
632     </tr>
633     <tr>
634      <td>developer</td>
635      <td>Developer UUID</td>
636      <td>-</td>
637      <td>-</td>
638      <td>-</td>
639      <td>developer.url (part of)</td>
640      <td>Developer.uuid</td>
641      <td>ouya://launcher/details?developer=5b015434-8a78-4274-aa5d-0cb2e330e50e</td>
642      <td></td>
643     </tr>
644
645    </tbody>
646   </table>
647  </body>
648 </html>