Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Finds approved products that match a query.
See: Google Play EMM API Reference for androidenterprise.products.list
.
- type ProductsListResource = "androidenterprise" :> ("v1" :> ("enterprises" :> (Capture "enterpriseId" Text :> ("products" :> (QueryParam "token" Text :> (QueryParam "query" Text :> (QueryParam "language" Text :> (QueryParam "approved" Bool :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ProductsListResponse))))))))))
- productsList :: Text -> ProductsList
- data ProductsList
- plEnterpriseId :: Lens' ProductsList Text
- plToken :: Lens' ProductsList (Maybe Text)
- plQuery :: Lens' ProductsList (Maybe Text)
- plLanguage :: Lens' ProductsList (Maybe Text)
- plApproved :: Lens' ProductsList (Maybe Bool)
- plMaxResults :: Lens' ProductsList (Maybe Word32)
REST Resource
type ProductsListResource = "androidenterprise" :> ("v1" :> ("enterprises" :> (Capture "enterpriseId" Text :> ("products" :> (QueryParam "token" Text :> (QueryParam "query" Text :> (QueryParam "language" Text :> (QueryParam "approved" Bool :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ProductsListResponse)))))))))) Source #
A resource alias for androidenterprise.products.list
method which the
ProductsList
request conforms to.
Creating a Request
Creates a value of ProductsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProductsList Source #
Finds approved products that match a query.
See: productsList
smart constructor.
Request Lenses
plEnterpriseId :: Lens' ProductsList Text Source #
The ID of the enterprise.
plToken :: Lens' ProductsList (Maybe Text) Source #
A pagination token is contained in a request’s response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request.
plQuery :: Lens' ProductsList (Maybe Text) Source #
The search query as typed in the Google Play Store search box. If omitted, all approved apps will be returned (using the pagination parameters).
plLanguage :: Lens' ProductsList (Maybe Text) Source #
The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language.
plApproved :: Lens' ProductsList (Maybe Bool) Source #
Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified.
plMaxResults :: Lens' ProductsList (Maybe Word32) Source #
Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response.