| Copyright | (c) 2015 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 |
Network.Google.Resource.DFAReporting.Orders.List
Description
Retrieves a list of orders, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.orders.list.
- type OrdersListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("projects" :> (Capture "projectId" (Textual Int64) :> ("orders" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" OrdersListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" OrdersListSortField :> (QueryParams "siteId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` OrdersListResponse))))))))))))))
- ordersList :: Int64 -> Int64 -> OrdersList
- data OrdersList
- olSearchString :: Lens' OrdersList (Maybe Text)
- olIds :: Lens' OrdersList [Int64]
- olProFileId :: Lens' OrdersList Int64
- olSortOrder :: Lens' OrdersList (Maybe OrdersListSortOrder)
- olPageToken :: Lens' OrdersList (Maybe Text)
- olProjectId :: Lens' OrdersList Int64
- olSortField :: Lens' OrdersList (Maybe OrdersListSortField)
- olSiteId :: Lens' OrdersList [Int64]
- olMaxResults :: Lens' OrdersList (Maybe Int32)
REST Resource
type OrdersListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("projects" :> (Capture "projectId" (Textual Int64) :> ("orders" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" OrdersListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" OrdersListSortField :> (QueryParams "siteId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` OrdersListResponse)))))))))))))) Source
A resource alias for dfareporting.orders.list method which the
OrdersList request conforms to.
Creating a Request
Arguments
| :: Int64 | |
| -> Int64 | |
| -> OrdersList |
Creates a value of OrdersList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data OrdersList Source
Retrieves a list of orders, possibly filtered.
See: ordersList smart constructor.
Instances
Request Lenses
olSearchString :: Lens' OrdersList (Maybe Text) Source
Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
olIds :: Lens' OrdersList [Int64] Source
Select only orders with these IDs.
olProFileId :: Lens' OrdersList Int64 Source
User profile ID associated with this request.
olSortOrder :: Lens' OrdersList (Maybe OrdersListSortOrder) Source
Order of sorted results, default is ASCENDING.
olPageToken :: Lens' OrdersList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
olProjectId :: Lens' OrdersList Int64 Source
Project ID for orders.
olSortField :: Lens' OrdersList (Maybe OrdersListSortField) Source
Field by which to sort the list.
olSiteId :: Lens' OrdersList [Int64] Source
Select only orders that are associated with these site IDs.
olMaxResults :: Lens' OrdersList (Maybe Int32) Source
Maximum number of results to return.