diff --git a/annotations/net.appiast.apprating.md b/annotations/net.appiast.apprating.md new file mode 100644 index 0000000..f97d8ab --- /dev/null +++ b/annotations/net.appiast.apprating.md @@ -0,0 +1,63 @@ + +# App rating + + +> ### net.appiast.apprating + + +Identifies a post as an app rating and contains additional app rating data. + +In addition to the annotation described here, app rating posts contain an attached app icon image which is provided via the standard App.net mechanism using a net.app.core.attachments for Appiast 1.1.0 and up or a net.app.core.oembed for Appiast 1.0.0. + +Posts created by Appiast 1.0.0 contain an additional net.appiast.app.XXXX annotation that was used to find ratings for the same app. This annotation isn't used anymore as it created a new annotation for each app which could eventually have negative effects on the performance of app.net. Instead of this annotation Appiast 1.1.0 and newer use the iTunes App Store URL to which the app name in an Appiast post links to find ratings of the same app. + +Also the standard hashtag mechanism is used to tag app ratings in order to define what kind of app the rated app is. + +The post text contains + * the name of the app which is also a link to the app in the app store + * As much of the first paragraph of the app review as fits into the post + * Five stars that reflect the rating of the app by being filled or empty (e.g. ★★★☆☆) which is also a link to appiast.net showing the full text of the review + * The tags given by the user + + +## Example + +~~~ js +{ + "type":"net.appiast.apprating", + "value":{ + "app_name":"Appiast", + "app_type":"iOS", + "review":"Appiast is an app for writing and finding reviews of other apps. Reviews ...", + "full_review_url":"", + "rating":5, + "app_id":"868774614" + } +} +~~~ + + +## Fields + +| Field | Required? | Type | Description | +| ----- | --------- | ---- | ----------- | +| `app_name` | Required | string | The name of the app | +| `app_type` | Required | string | The type of the app. Currently there are "iOS" and "Mac" | +| `rating` | Required | integer | A rating of the app between 1 (lowest) and 5 (highest). | +| `review` | Optional | string | A short review of the app.| +| `full_review_url` | Optional | string | The URL of a longer review of the app | +| `app_id` | Optional | string | The id of the rated app in the specific app store or other source of apps. | + + + +## Maintainers +* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) + + +## Used by +* [Appiast](http://appiast.net) + + +## Related annotations +* [net.app.core.oembed.md](net.app.core.oembed.md) +* [net.app.core.attachments.md](net.app.core.attachments.md) diff --git a/annotations/net.bookitics.bookrating.md b/annotations/net.bookitics.bookrating.md index 521f68c..a15bef8 100644 --- a/annotations/net.bookitics.bookrating.md +++ b/annotations/net.bookitics.bookrating.md @@ -7,11 +7,15 @@ Identifies a post as a book rating and contains additional book rating data. -In addition to the annotation described here, book rating posts may contain an attached book cover image which is provided via the standard App.net mechanism using a net.app.core.oembed. +In addition to the annotation described here, book rating posts may contain an attached book cover image which is provided via the standard App.net mechanism using a net.app.core.oembed. Also the standard hashtag mechanism is used to tag book ratings in order to define to which genres the rated books belongs. -As it is currently not possible to search for posts containing specific annotation values, the post text contains the author and title of the book. Book ratings created based on another book rating also contain the book id as a hashtag #bid<book_id>, which allows to find other posts rating the same book. +The post text contains: + * As much of the author and title of the book as fits into the post text + * As much of the first paragraph of the review as fits into the post text + * Five stars that reflect the rating of the app by being filled or empty (e.g. ★★★☆☆) which is also a link to bookitics.net showing the full text of the review + * The tags given by the user ## Example @@ -39,17 +43,16 @@ As it is currently not possible to search for posts containing specific annotati | `rating` | Required | integer | A rating of the book between 1 (lowest) and 5 (highest). | | `short_review` | Optional | string | A short review of the book.| | `full_review_url` | Optional | string | The URL of a longer review of the book | -| `book_id` | Optional | string | The id of the rated book. This is the post id of the post which is the first rating of the book. If not present, the book rating becomes the book defining rating for any book rating based on it. | ## Maintainers -* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) +* Robert Beeger [@robertbeeger](https://alpha.app.net/robertbeeger), [robert@beeger.net](mailto:robert@beeger.net) -## Used by +## Used by * [Bookitics](http://bookitics.net) ## Related annotations -* [net.app.core.oembed.md](https://github.com/appdotnet/object-metadata/blob/master/annotation/net.app.core.oembed.md) \ No newline at end of file +* [net.app.core.oembed.md](https://github.com/appdotnet/object-metadata/blob/master/annotations/net.app.core.oembed.md)