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 |
Retrieves a list of targeting templates, optionally filtered. This method supports paging.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.targetingTemplates.list
.
- type TargetingTemplatesListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("targetingTemplates" :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" TargetingTemplatesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" TargetingTemplatesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] TargetingTemplatesListResponse))))))))))))
- targetingTemplatesList :: Int64 -> TargetingTemplatesList
- data TargetingTemplatesList
- ttlAdvertiserId :: Lens' TargetingTemplatesList (Maybe Int64)
- ttlSearchString :: Lens' TargetingTemplatesList (Maybe Text)
- ttlIds :: Lens' TargetingTemplatesList [Int64]
- ttlProFileId :: Lens' TargetingTemplatesList Int64
- ttlSortOrder :: Lens' TargetingTemplatesList (Maybe TargetingTemplatesListSortOrder)
- ttlPageToken :: Lens' TargetingTemplatesList (Maybe Text)
- ttlSortField :: Lens' TargetingTemplatesList (Maybe TargetingTemplatesListSortField)
- ttlMaxResults :: Lens' TargetingTemplatesList (Maybe Int32)
REST Resource
type TargetingTemplatesListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("targetingTemplates" :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" TargetingTemplatesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" TargetingTemplatesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] TargetingTemplatesListResponse)))))))))))) Source #
A resource alias for dfareporting.targetingTemplates.list
method which the
TargetingTemplatesList
request conforms to.
Creating a Request
targetingTemplatesList Source #
Creates a value of TargetingTemplatesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data TargetingTemplatesList Source #
Retrieves a list of targeting templates, optionally filtered. This method supports paging.
See: targetingTemplatesList
smart constructor.
Request Lenses
ttlAdvertiserId :: Lens' TargetingTemplatesList (Maybe Int64) Source #
Select only targeting templates with this advertiser ID.
ttlSearchString :: Lens' TargetingTemplatesList (Maybe Text) Source #
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 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 "template" will match objects with name "my template", "template 2015", or simply "template".
ttlIds :: Lens' TargetingTemplatesList [Int64] Source #
Select only targeting templates with these IDs.
ttlProFileId :: Lens' TargetingTemplatesList Int64 Source #
User profile ID associated with this request.
ttlSortOrder :: Lens' TargetingTemplatesList (Maybe TargetingTemplatesListSortOrder) Source #
Order of sorted results, default is ASCENDING.
ttlPageToken :: Lens' TargetingTemplatesList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
ttlSortField :: Lens' TargetingTemplatesList (Maybe TargetingTemplatesListSortField) Source #
Field by which to sort the list.
ttlMaxResults :: Lens' TargetingTemplatesList (Maybe Int32) Source #
Maximum number of results to return.