| 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.Projects.List
Description
Retrieves a list of projects, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.projects.list.
- type ProjectsListResource = "dfareporting" :> ("v2.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))))))))))))
- projectsList :: Int64 -> ProjectsList
- data ProjectsList
- plSearchString :: Lens' ProjectsList (Maybe Text)
- plIds :: Lens' ProjectsList [Int64]
- plProFileId :: Lens' ProjectsList Int64
- plSortOrder :: Lens' ProjectsList (Maybe ProjectsListSortOrder)
- plPageToken :: Lens' ProjectsList (Maybe Text)
- plSortField :: Lens' ProjectsList (Maybe ProjectsListSortField)
- plAdvertiserIds :: Lens' ProjectsList [Int64]
- plMaxResults :: Lens' ProjectsList (Maybe Int32)
REST Resource
type ProjectsListResource = "dfareporting" :> ("v2.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
Arguments
| :: Int64 | |
| -> 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:
data ProjectsList Source
Retrieves a list of projects, possibly filtered.
See: projectsList smart constructor.
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.
plSortOrder :: Lens' ProjectsList (Maybe ProjectsListSortOrder) Source
Order of sorted results, default is ASCENDING.
plPageToken :: Lens' ProjectsList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
plSortField :: Lens' ProjectsList (Maybe ProjectsListSortField) Source
Field by which to sort the list.
plAdvertiserIds :: Lens' ProjectsList [Int64] Source
Select only projects with these advertiser IDs.
plMaxResults :: Lens' ProjectsList (Maybe Int32) Source
Maximum number of results to return.