| 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.CreativeGroups.List
Description
Retrieves a list of creative groups, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.creativeGroups.list.
- type CreativeGroupsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeGroups" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeGroupsListSortOrder :> (QueryParam "groupNumber" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeGroupsListSortField :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` CreativeGroupsListResponse)))))))))))))
- creativeGroupsList :: Int64 -> CreativeGroupsList
- data CreativeGroupsList
- cglSearchString :: Lens' CreativeGroupsList (Maybe Text)
- cglIds :: Lens' CreativeGroupsList [Int64]
- cglProFileId :: Lens' CreativeGroupsList Int64
- cglSortOrder :: Lens' CreativeGroupsList (Maybe CreativeGroupsListSortOrder)
- cglGroupNumber :: Lens' CreativeGroupsList (Maybe Int32)
- cglPageToken :: Lens' CreativeGroupsList (Maybe Text)
- cglSortField :: Lens' CreativeGroupsList (Maybe CreativeGroupsListSortField)
- cglAdvertiserIds :: Lens' CreativeGroupsList [Int64]
- cglMaxResults :: Lens' CreativeGroupsList (Maybe Int32)
REST Resource
type CreativeGroupsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeGroups" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeGroupsListSortOrder :> (QueryParam "groupNumber" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeGroupsListSortField :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` CreativeGroupsListResponse))))))))))))) Source
A resource alias for dfareporting.creativeGroups.list method which the
CreativeGroupsList request conforms to.
Creating a Request
Arguments
| :: Int64 | |
| -> CreativeGroupsList |
Creates a value of CreativeGroupsList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreativeGroupsList Source
Retrieves a list of creative groups, possibly filtered.
See: creativeGroupsList smart constructor.
Request Lenses
cglSearchString :: Lens' CreativeGroupsList (Maybe Text) Source
Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
cglIds :: Lens' CreativeGroupsList [Int64] Source
Select only creative groups with these IDs.
cglProFileId :: Lens' CreativeGroupsList Int64 Source
User profile ID associated with this request.
cglSortOrder :: Lens' CreativeGroupsList (Maybe CreativeGroupsListSortOrder) Source
Order of sorted results, default is ASCENDING.
cglGroupNumber :: Lens' CreativeGroupsList (Maybe Int32) Source
Select only creative groups that belong to this subgroup.
cglPageToken :: Lens' CreativeGroupsList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
cglSortField :: Lens' CreativeGroupsList (Maybe CreativeGroupsListSortField) Source
Field by which to sort the list.
cglAdvertiserIds :: Lens' CreativeGroupsList [Int64] Source
Select only creative groups that belong to these advertisers.
cglMaxResults :: Lens' CreativeGroupsList (Maybe Int32) Source
Maximum number of results to return.