| 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.AdvertiserGroups.List
Description
Retrieves a list of advertiser groups, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.advertiserGroups.list.
- type AdvertiserGroupsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertiserGroups" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AdvertiserGroupsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertiserGroupsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AdvertiserGroupsListResponse)))))))))))
- advertiserGroupsList :: Int64 -> AdvertiserGroupsList
- data AdvertiserGroupsList
- aglSearchString :: Lens' AdvertiserGroupsList (Maybe Text)
- aglIds :: Lens' AdvertiserGroupsList [Int64]
- aglProFileId :: Lens' AdvertiserGroupsList Int64
- aglSortOrder :: Lens' AdvertiserGroupsList (Maybe AdvertiserGroupsListSortOrder)
- aglPageToken :: Lens' AdvertiserGroupsList (Maybe Text)
- aglSortField :: Lens' AdvertiserGroupsList (Maybe AdvertiserGroupsListSortField)
- aglMaxResults :: Lens' AdvertiserGroupsList (Maybe Int32)
REST Resource
type AdvertiserGroupsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertiserGroups" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AdvertiserGroupsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertiserGroupsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AdvertiserGroupsListResponse))))))))))) Source
A resource alias for dfareporting.advertiserGroups.list method which the
AdvertiserGroupsList request conforms to.
Creating a Request
Arguments
| :: Int64 | |
| -> AdvertiserGroupsList |
Creates a value of AdvertiserGroupsList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AdvertiserGroupsList Source
Retrieves a list of advertiser groups, possibly filtered.
See: advertiserGroupsList smart constructor.
Request Lenses
aglSearchString :: Lens' AdvertiserGroupsList (Maybe Text) Source
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 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 "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
aglIds :: Lens' AdvertiserGroupsList [Int64] Source
Select only advertiser groups with these IDs.
aglProFileId :: Lens' AdvertiserGroupsList Int64 Source
User profile ID associated with this request.
aglSortOrder :: Lens' AdvertiserGroupsList (Maybe AdvertiserGroupsListSortOrder) Source
Order of sorted results, default is ASCENDING.
aglPageToken :: Lens' AdvertiserGroupsList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
aglSortField :: Lens' AdvertiserGroupsList (Maybe AdvertiserGroupsListSortField) Source
Field by which to sort the list.
aglMaxResults :: Lens' AdvertiserGroupsList (Maybe Int32) Source
Maximum number of results to return.