| 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.ContentCategories.List
Description
Retrieves a list of content categories, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.contentCategories.list.
- type ContentCategoriesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("contentCategories" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" ContentCategoriesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" ContentCategoriesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` ContentCategoriesListResponse)))))))))))
- contentCategoriesList :: Int64 -> ContentCategoriesList
- data ContentCategoriesList
- cclSearchString :: Lens' ContentCategoriesList (Maybe Text)
- cclIds :: Lens' ContentCategoriesList [Int64]
- cclProFileId :: Lens' ContentCategoriesList Int64
- cclSortOrder :: Lens' ContentCategoriesList (Maybe ContentCategoriesListSortOrder)
- cclPageToken :: Lens' ContentCategoriesList (Maybe Text)
- cclSortField :: Lens' ContentCategoriesList (Maybe ContentCategoriesListSortField)
- cclMaxResults :: Lens' ContentCategoriesList (Maybe Int32)
REST Resource
type ContentCategoriesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("contentCategories" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" ContentCategoriesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" ContentCategoriesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` ContentCategoriesListResponse))))))))))) Source
A resource alias for dfareporting.contentCategories.list method which the
ContentCategoriesList request conforms to.
Creating a Request
Arguments
| :: Int64 | |
| -> ContentCategoriesList |
Creates a value of ContentCategoriesList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ContentCategoriesList Source
Retrieves a list of content categories, possibly filtered.
See: contentCategoriesList smart constructor.
Request Lenses
cclSearchString :: Lens' ContentCategoriesList (Maybe Text) Source
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 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 "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
cclIds :: Lens' ContentCategoriesList [Int64] Source
Select only content categories with these IDs.
cclProFileId :: Lens' ContentCategoriesList Int64 Source
User profile ID associated with this request.
cclSortOrder :: Lens' ContentCategoriesList (Maybe ContentCategoriesListSortOrder) Source
Order of sorted results, default is ASCENDING.
cclPageToken :: Lens' ContentCategoriesList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
cclSortField :: Lens' ContentCategoriesList (Maybe ContentCategoriesListSortField) Source
Field by which to sort the list.
cclMaxResults :: Lens' ContentCategoriesList (Maybe Int32) Source
Maximum number of results to return.