Network.Google.Resource.DFAReporting.CreativeFields.List

Retrieves a list of creative fields, possibly filtered. This method supports paging.

See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.creativeFields.list.

REST Resource

type CreativeFieldsListResource = "dfareporting" :> ("v3.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))))))))))))

A resource alias for dfareporting.creativeFields.list method which the CreativeFieldsList request conforms to.

Creating a Request

creativeFieldsList

Arguments

:: Int64

cflProFileId

-> 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:

• cflSearchString
• cflIds
• cflProFileId
• cflSortOrder
• cflPageToken
• cflSortField
• cflAdvertiserIds
• cflMaxResults

data CreativeFieldsList

Retrieves a list of creative fields, possibly filtered. This method supports paging.

See: creativeFieldsList smart constructor.

Instances

Eq CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

Methods

(==) :: CreativeFieldsList -> CreativeFieldsList -> Bool

(/=) :: CreativeFieldsList -> CreativeFieldsList -> Bool

Data CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreativeFieldsList -> c CreativeFieldsList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreativeFieldsList

toConstr :: CreativeFieldsList -> Constr

dataTypeOf :: CreativeFieldsList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreativeFieldsList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreativeFieldsList)

gmapT :: (forall b. Data b => b -> b) -> CreativeFieldsList -> CreativeFieldsList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreativeFieldsList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreativeFieldsList -> r

gmapQ :: (forall d. Data d => d -> u) -> CreativeFieldsList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreativeFieldsList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreativeFieldsList -> m CreativeFieldsList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreativeFieldsList -> m CreativeFieldsList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreativeFieldsList -> m CreativeFieldsList

Show CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

Methods

showsPrec :: Int -> CreativeFieldsList -> ShowS

show :: CreativeFieldsList -> String

showList :: [CreativeFieldsList] -> ShowS

Generic CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

Associated Types

type Rep CreativeFieldsList :: Type -> Type

Methods

from :: CreativeFieldsList -> Rep CreativeFieldsList x

to :: Rep CreativeFieldsList x -> CreativeFieldsList

GoogleRequest CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

Associated Types

type Rs CreativeFieldsList :: Type

type Scopes CreativeFieldsList :: [Symbol]

Methods

requestClient :: CreativeFieldsList -> GClient (Rs CreativeFieldsList)

type Rep CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

type Rep CreativeFieldsList = D1 (MetaData "CreativeFieldsList" "Network.Google.Resource.DFAReporting.CreativeFields.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "CreativeFieldsList'" PrefixI True) (((S1 (MetaSel (Just "_cflSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cflIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_cflProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: S1 (MetaSel (Just "_cflSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CreativeFieldsListSortOrder))) :*: ((S1 (MetaSel (Just "_cflPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cflSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CreativeFieldsListSortField)) :*: (S1 (MetaSel (Just "_cflAdvertiserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_cflMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))))))

type Scopes CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

type Scopes CreativeFieldsList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])

type Rs CreativeFieldsList

Defined in Network.Google.Resource.DFAReporting.CreativeFields.List

type Rs CreativeFieldsList = CreativeFieldsListResponse

Request Lenses

cflSearchString :: Lens' CreativeFieldsList (Maybe Text)

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]

Select only creative fields with these IDs.

cflProFileId :: Lens' CreativeFieldsList Int64

User profile ID associated with this request.

cflSortOrder :: Lens' CreativeFieldsList CreativeFieldsListSortOrder

Order of sorted results.

cflPageToken :: Lens' CreativeFieldsList (Maybe Text)

Value of the nextPageToken from the previous result page.

cflSortField :: Lens' CreativeFieldsList CreativeFieldsListSortField

Field by which to sort the list.

cflAdvertiserIds :: Lens' CreativeFieldsList [Int64]

Select only creative fields that belong to these advertisers.

cflMaxResults :: Lens' CreativeFieldsList Int32

Maximum number of results to return.