Copyright | (c) 2015-2016 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 |
Gets a list of subaccounts, possibly filtered. This method supports paging.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.subaccounts.list
.
- type SubAccountsListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("subaccounts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" SubAccountsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" SubAccountsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] SubAccountsListResponse)))))))))))
- subAccountsList :: Int64 -> SubAccountsList
- data SubAccountsList
- salSearchString :: Lens' SubAccountsList (Maybe Text)
- salIds :: Lens' SubAccountsList [Int64]
- salProFileId :: Lens' SubAccountsList Int64
- salSortOrder :: Lens' SubAccountsList (Maybe SubAccountsListSortOrder)
- salPageToken :: Lens' SubAccountsList (Maybe Text)
- salSortField :: Lens' SubAccountsList (Maybe SubAccountsListSortField)
- salMaxResults :: Lens' SubAccountsList (Maybe Int32)
REST Resource
type SubAccountsListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("subaccounts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" SubAccountsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" SubAccountsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] SubAccountsListResponse))))))))))) Source #
A resource alias for dfareporting.subaccounts.list
method which the
SubAccountsList
request conforms to.
Creating a Request
Creates a value of SubAccountsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SubAccountsList Source #
Gets a list of subaccounts, possibly filtered. This method supports paging.
See: subAccountsList
smart constructor.
Request Lenses
salSearchString :: Lens' SubAccountsList (Maybe Text) Source #
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 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 "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
salProFileId :: Lens' SubAccountsList Int64 Source #
User profile ID associated with this request.
salSortOrder :: Lens' SubAccountsList (Maybe SubAccountsListSortOrder) Source #
Order of sorted results, default is ASCENDING.
salPageToken :: Lens' SubAccountsList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
salSortField :: Lens' SubAccountsList (Maybe SubAccountsListSortField) Source #
Field by which to sort the list.
salMaxResults :: Lens' SubAccountsList (Maybe Int32) Source #
Maximum number of results to return.