App Review & App Downloads params

onepf / OpenAEP

Open Application Exchange Protocol (for stores)

3 stars 1 forks source link

App Review & App Downloads params #3

Open oorlov opened 10 years ago

oorlov commented 10 years ago

Current: App Downloads and App Reviews

Date:

from [YYYY-MM-DD]
to [YYYY-MM-DD]

both optional?

jesper-sjovall commented 10 years ago

Yes, Both date format, from and to, and I also suggests a 'limit' value for limit the result to a given number and in this case return the latest/newest of the reviews/posts. This will get a impact of the natural sort order must be latest first and oldest last, which I think is fine for the must part of uses.

Examples: '

Will return the 3 latest review for this apps from the store. https://www.sourceappstore.com/openaep/appreviews?package=com.softspb.flashcards.sv&limit=3
Will return reviews in date rang 2013-10-15 to 2013-10-20 but never more then 100 reviews. https://www.sourceappstore.com/openaep/appreviews?package=com.softspb.flashcards.sv&limit=100&from=2013-10-15&to=2013-10-20

jesper-sjovall commented 10 years ago

As suggest from https://github.com/onepf/OpenAEP/issues/2, I also want to add country-code which I think will be must useful for only get reviews in a language that is supported by the store. For example, on a Swedish appstore this is no to little use of reviews written in Arabic

oorlov commented 10 years ago

Updated version of downloads :

https://www.sourceappstore.com/openaep/appreviews
?package=com.softspb.flashcards.sv - single parameter
[&datefrom=YYYY-MM-DD] - optional
[&dateto=YYYY-MM-DD] - optional
[&country=US] - optional
[&limit=100 &offsettoken= 500] - optional pair

Do paginate output there should be offset param used together with limit. And we need to return it in output like this

<?xml version="1.0" encoding="UTF-8"?>
<downloads version="1" offset=""> <!-- encoded value of request params, db state and offset -->
  <download>
...

is it simple to implement on backend?

jesper-sjovall commented 10 years ago

Use

[&limit=100] - optional
[&offset=7j8ad9go] - optional

and not

[&limit=100 &offsettoken= 500] - optional pair

as in Purchases case https://github.com/onepf/OpenAEP/issues/2#issuecomment-26706540 For get a equal interface for all requests that will do the interface more easy to understand for everybody.

I think this is simple to implement on backend (for most of all systems), a loot of this will map very good to querys on for a Relational database as SQL-database.

oorlov commented 10 years ago

OK, lets update spec

jesper-sjovall commented 10 years ago

Ok, Update and I will look at it again.