Network.Google.Resource.DFAReporting.Projects.List

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

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

REST Resource

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

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

Creating a Request

projectsList

Arguments

:: Int64

plProFileId

-> ProjectsList

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:

• plSearchString
• plIds
• plProFileId
• plSortOrder
• plPageToken
• plSortField
• plAdvertiserIds
• plMaxResults

data ProjectsList

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

See: projectsList smart constructor.

Instances

Eq ProjectsList

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

Methods

(==) :: ProjectsList -> ProjectsList -> Bool

(/=) :: ProjectsList -> ProjectsList -> Bool

Data ProjectsList

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

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

Methods

showsPrec :: Int -> ProjectsList -> ShowS

show :: ProjectsList -> String

showList :: [ProjectsList] -> ShowS

Generic ProjectsList

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

Associated Types

type Rep ProjectsList :: Type -> Type

Methods

from :: ProjectsList -> Rep ProjectsList x

to :: Rep ProjectsList x -> ProjectsList

GoogleRequest ProjectsList

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

Associated Types

type Rs ProjectsList :: Type

type Scopes ProjectsList :: [Symbol]

Methods

requestClient :: ProjectsList -> GClient (Rs ProjectsList)

type Rep ProjectsList

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

type Rep ProjectsList = D1 (MetaData "ProjectsList" "Network.Google.Resource.DFAReporting.Projects.List" "gogol-dfareporting-0.5.0-H2nEimqYPoYBpPsdI4WnkF" False) (C1 (MetaCons "ProjectsList'" PrefixI True) (((S1 (MetaSel (Just "_plSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_plIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_plProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: S1 (MetaSel (Just "_plSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProjectsListSortOrder))) :*: ((S1 (MetaSel (Just "_plPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_plSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProjectsListSortField)) :*: (S1 (MetaSel (Just "_plAdvertiserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_plMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))))))

type Scopes ProjectsList

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

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

type Rs ProjectsList

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

type Rs ProjectsList = ProjectsListResponse

Request Lenses

plSearchString :: Lens' ProjectsList (Maybe Text)

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]

Select only projects with these IDs.

plProFileId :: Lens' ProjectsList Int64

User profile ID associated with this request.

plSortOrder :: Lens' ProjectsList ProjectsListSortOrder

Order of sorted results.

plPageToken :: Lens' ProjectsList (Maybe Text)

Value of the nextPageToken from the previous result page.

plSortField :: Lens' ProjectsList ProjectsListSortField

Field by which to sort the list.

plAdvertiserIds :: Lens' ProjectsList [Int64]

Select only projects with these advertiser IDs.

plMaxResults :: Lens' ProjectsList Int32

Maximum number of results to return.