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 creative field values, possibly filtered. This method supports paging.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.creativeFieldValues.list
.
Synopsis
- type CreativeFieldValuesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeFields" :> (Capture "creativeFieldId" (Textual Int64) :> ("creativeFieldValues" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeFieldValuesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeFieldValuesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CreativeFieldValuesListResponse)))))))))))))
- creativeFieldValuesList :: Int64 -> Int64 -> CreativeFieldValuesList
- data CreativeFieldValuesList
- cfvlCreativeFieldId :: Lens' CreativeFieldValuesList Int64
- cfvlSearchString :: Lens' CreativeFieldValuesList (Maybe Text)
- cfvlIds :: Lens' CreativeFieldValuesList [Int64]
- cfvlProFileId :: Lens' CreativeFieldValuesList Int64
- cfvlSortOrder :: Lens' CreativeFieldValuesList CreativeFieldValuesListSortOrder
- cfvlPageToken :: Lens' CreativeFieldValuesList (Maybe Text)
- cfvlSortField :: Lens' CreativeFieldValuesList CreativeFieldValuesListSortField
- cfvlMaxResults :: Lens' CreativeFieldValuesList Int32
REST Resource
type CreativeFieldValuesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeFields" :> (Capture "creativeFieldId" (Textual Int64) :> ("creativeFieldValues" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeFieldValuesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeFieldValuesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CreativeFieldValuesListResponse))))))))))))) Source #
A resource alias for dfareporting.creativeFieldValues.list
method which the
CreativeFieldValuesList
request conforms to.
Creating a Request
creativeFieldValuesList Source #
Creates a value of CreativeFieldValuesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreativeFieldValuesList Source #
Retrieves a list of creative field values, possibly filtered. This method supports paging.
See: creativeFieldValuesList
smart constructor.
Instances
Request Lenses
cfvlCreativeFieldId :: Lens' CreativeFieldValuesList Int64 Source #
Creative field ID for this creative field value.
cfvlSearchString :: Lens' CreativeFieldValuesList (Maybe Text) Source #
Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
cfvlIds :: Lens' CreativeFieldValuesList [Int64] Source #
Select only creative field values with these IDs.
cfvlProFileId :: Lens' CreativeFieldValuesList Int64 Source #
User profile ID associated with this request.
cfvlSortOrder :: Lens' CreativeFieldValuesList CreativeFieldValuesListSortOrder Source #
Order of sorted results.
cfvlPageToken :: Lens' CreativeFieldValuesList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
cfvlSortField :: Lens' CreativeFieldValuesList CreativeFieldValuesListSortField Source #
Field by which to sort the list.
cfvlMaxResults :: Lens' CreativeFieldValuesList Int32 Source #
Maximum number of results to return.