gogol-dfareporting-0.4.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.Projects.List

Contents

Description

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

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

Synopsis

REST Resource

type ProjectsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("projects" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" ProjectsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" ProjectsListSortField :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ProjectsListResponse)))))))))))) Source #

A resource alias for dfareporting.projects.list method which the ProjectsList request conforms to.

Creating a Request

projectsList Source #

Creates a value of ProjectsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ProjectsList Source #

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

See: projectsList smart constructor.

Instances
Eq ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

Data ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

Methods

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

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

toConstr :: ProjectsList -> Constr #

dataTypeOf :: ProjectsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

Generic ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

Associated Types

type Rep ProjectsList :: Type -> Type #

GoogleRequest ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

Associated Types

type Rs ProjectsList :: Type #

type Scopes ProjectsList :: [Symbol] #

type Rep ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

type Scopes ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

type Scopes ProjectsList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs ProjectsList Source # 
Instance details

Defined in Network.Google.Resource.DFAReporting.Projects.List

Request Lenses

plSearchString :: Lens' ProjectsList (Maybe Text) Source #

Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 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 "project" will match projects with name "my project", "project 2015", or simply "project".

plIds :: Lens' ProjectsList [Int64] Source #

Select only projects with these IDs.

plProFileId :: Lens' ProjectsList Int64 Source #

User profile ID associated with this request.

plPageToken :: Lens' ProjectsList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

plSortField :: Lens' ProjectsList ProjectsListSortField Source #

Field by which to sort the list.

plAdvertiserIds :: Lens' ProjectsList [Int64] Source #

Select only projects with these advertiser IDs.

plMaxResults :: Lens' ProjectsList Int32 Source #

Maximum number of results to return.