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

Network.Google.Resource.DFAReporting.Orders.List

Contents

REST Resource
Creating a Request
Request Lenses

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

type OrdersListResource = "dfareporting" :> ("v3.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 OrdersListSortOrder
olPageToken :: Lens' OrdersList (Maybe Text)
olProjectId :: Lens' OrdersList Int64
olSortField :: Lens' OrdersList OrdersListSortField
olSiteId :: Lens' OrdersList [Int64]
olMaxResults :: Lens' OrdersList Int32

REST Resource

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

ordersList Source #

Arguments

:: Int64	`olProFileId`
-> Int64	`olProjectId`
-> 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. This method supports paging.

See: ordersList smart constructor.

Instances

Eq OrdersList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List Methods (==) :: OrdersList -> OrdersList -> Bool # (/=) :: OrdersList -> OrdersList -> Bool #
Data OrdersList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List 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 Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List Methods showsPrec :: Int -> OrdersList -> ShowS # show :: OrdersList -> String # showList :: [OrdersList] -> ShowS #
Generic OrdersList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List Associated Types type Rep OrdersList :: Type -> Type # Methods from :: OrdersList -> Rep OrdersList x # to :: Rep OrdersList x -> OrdersList #
GoogleRequest OrdersList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List Associated Types type Rs OrdersList :: Type # type Scopes OrdersList :: [Symbol] # Methods requestClient :: OrdersList -> GClient (Rs OrdersList) #
type Rep OrdersList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List type Rep OrdersList = D1 (MetaData "OrdersList" "Network.Google.Resource.DFAReporting.Orders.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "OrdersList'" PrefixI True) (((S1 (MetaSel (Just "_olSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_olIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :: (S1 (MetaSel (Just "_olProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :: S1 (MetaSel (Just "_olSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OrdersListSortOrder))) :: ((S1 (MetaSel (Just "_olPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_olProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) :: (S1 (MetaSel (Just "_olSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OrdersListSortField) :: (S1 (MetaSel (Just "_olSiteId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: S1 (MetaSel (Just "_olMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes OrdersList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List type Scopes OrdersList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs OrdersList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Orders.List type Rs OrdersList = OrdersListResponse

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 OrdersListSortOrder Source #

Order of sorted results.

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 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 Int32 Source #

Maximum number of results to return.