| 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.CreativeFields.List
Description
Retrieves a list of creative fields, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.creativeFields.list.
- type CreativeFieldsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeFields" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeFieldsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeFieldsListSortField :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` CreativeFieldsListResponse))))))))))))
- creativeFieldsList :: Int64 -> CreativeFieldsList
- data CreativeFieldsList
- cflSearchString :: Lens' CreativeFieldsList (Maybe Text)
- cflIds :: Lens' CreativeFieldsList [Int64]
- cflProFileId :: Lens' CreativeFieldsList Int64
- cflSortOrder :: Lens' CreativeFieldsList (Maybe CreativeFieldsListSortOrder)
- cflPageToken :: Lens' CreativeFieldsList (Maybe Text)
- cflSortField :: Lens' CreativeFieldsList (Maybe CreativeFieldsListSortField)
- cflAdvertiserIds :: Lens' CreativeFieldsList [Int64]
- cflMaxResults :: Lens' CreativeFieldsList (Maybe Int32)
REST Resource
type CreativeFieldsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creativeFields" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativeFieldsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativeFieldsListSortField :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` CreativeFieldsListResponse)))))))))))) Source
A resource alias for dfareporting.creativeFields.list method which the
CreativeFieldsList request conforms to.
Creating a Request
Arguments
| :: Int64 | |
| -> CreativeFieldsList |
Creates a value of CreativeFieldsList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreativeFieldsList Source
Retrieves a list of creative fields, possibly filtered.
See: creativeFieldsList smart constructor.
Request Lenses
cflSearchString :: Lens' CreativeFieldsList (Maybe Text) Source
Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 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 "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
cflIds :: Lens' CreativeFieldsList [Int64] Source
Select only creative fields with these IDs.
cflProFileId :: Lens' CreativeFieldsList Int64 Source
User profile ID associated with this request.
cflSortOrder :: Lens' CreativeFieldsList (Maybe CreativeFieldsListSortOrder) Source
Order of sorted results, default is ASCENDING.
cflPageToken :: Lens' CreativeFieldsList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
cflSortField :: Lens' CreativeFieldsList (Maybe CreativeFieldsListSortField) Source
Field by which to sort the list.
cflAdvertiserIds :: Lens' CreativeFieldsList [Int64] Source
Select only creative fields that belong to these advertisers.
cflMaxResults :: Lens' CreativeFieldsList (Maybe Int32) Source
Maximum number of results to return.