gogol-dfareporting-0.3.0: Google DCM/DFA Reporting And Trafficking SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.DFAReporting.Orders.List

Contents

Description

Retrieves a list of orders, possibly filtered. This method supports paging.

See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.orders.list.

Synopsis

REST Resource

type OrdersListResource = "dfareporting" :> ("v2.7" :> ("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)))))))))))))) #

A resource alias for dfareporting.orders.list method which the OrdersList request conforms to.

Creating a Request

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 #

Retrieves a list of orders, possibly filtered. This method supports paging.

See: ordersList smart constructor.

Instances

Eq OrdersList # 
Data OrdersList # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OrdersList -> c OrdersList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OrdersList #

toConstr :: OrdersList -> Constr #

dataTypeOf :: OrdersList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c OrdersList) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OrdersList) #

gmapT :: (forall b. Data b => b -> b) -> OrdersList -> OrdersList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OrdersList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OrdersList -> r #

gmapQ :: (forall d. Data d => d -> u) -> OrdersList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> OrdersList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OrdersList -> m OrdersList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OrdersList -> m OrdersList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OrdersList -> m OrdersList #

Show OrdersList # 
Generic OrdersList # 

Associated Types

type Rep OrdersList :: * -> * #

GoogleRequest OrdersList # 

Associated Types

type Rs OrdersList :: * #

type Scopes OrdersList :: [Symbol] #

type Rep OrdersList # 
type Scopes OrdersList # 
type Scopes OrdersList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs OrdersList # 

Request Lenses

olSearchString :: Lens' OrdersList (Maybe Text) #

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] #

Select only orders with these IDs.

olProFileId :: Lens' OrdersList Int64 #

User profile ID associated with this request.

olSortOrder :: Lens' OrdersList (Maybe OrdersListSortOrder) #

Order of sorted results, default is ASCENDING.

olPageToken :: Lens' OrdersList (Maybe Text) #

Value of the nextPageToken from the previous result page.

olProjectId :: Lens' OrdersList Int64 #

Project ID for orders.

olSortField :: Lens' OrdersList (Maybe OrdersListSortField) #

Field by which to sort the list.

olSiteId :: Lens' OrdersList [Int64] #

Select only orders that are associated with these site IDs.

olMaxResults :: Lens' OrdersList (Maybe Int32) #

Maximum number of results to return.