Network.Google.Resource.DFAReporting.Creatives.List

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

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

REST Resource

type CreativesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("creatives" :> (QueryParams "renderingIds" (Textual Int64) :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "sizeIds" (Textual Int64) :> (QueryParams "companionCreativeIds" (Textual Int64) :> (QueryParam "campaignId" (Textual Int64) :> (QueryParams "types" CreativesListTypes :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CreativesListSortOrder :> (QueryParam "active" Bool :> (QueryParams "creativeFieldIds" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CreativesListSortField :> (QueryParam "studioCreativeId" (Textual Int64) :> (QueryParam "archived" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CreativesListResponse)))))))))))))))))))))

A resource alias for dfareporting.creatives.list method which the CreativesList request conforms to.

Creating a Request

creativesList

Arguments

:: Int64

cProFileId

-> CreativesList

Creates a value of CreativesList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cRenderingIds
• cAdvertiserId
• cSearchString
• cSizeIds
• cCompanionCreativeIds
• cCampaignId
• cTypes
• cIds
• cProFileId
• cSortOrder
• cActive
• cCreativeFieldIds
• cPageToken
• cSortField
• cStudioCreativeId
• cArchived
• cMaxResults

data CreativesList

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

See: creativesList smart constructor.

Instances

Eq CreativesList

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

Methods

(==) :: CreativesList -> CreativesList -> Bool

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

Data CreativesList

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

Methods

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

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

toConstr :: CreativesList -> Constr

dataTypeOf :: CreativesList -> DataType

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

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

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

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

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

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

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

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

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

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

Show CreativesList

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

Methods

showsPrec :: Int -> CreativesList -> ShowS

show :: CreativesList -> String

showList :: [CreativesList] -> ShowS

Generic CreativesList

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

Associated Types

type Rep CreativesList :: Type -> Type

Methods

from :: CreativesList -> Rep CreativesList x

to :: Rep CreativesList x -> CreativesList

GoogleRequest CreativesList

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

Associated Types

type Rs CreativesList :: Type

type Scopes CreativesList :: [Symbol]

Methods

requestClient :: CreativesList -> GClient (Rs CreativesList)

type Rep CreativesList

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

type Rep CreativesList = D1 (MetaData "CreativesList" "Network.Google.Resource.DFAReporting.Creatives.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "CreativesList'" PrefixI True) ((((S1 (MetaSel (Just "_cRenderingIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_cAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :*: (S1 (MetaSel (Just "_cSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cSizeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: ((S1 (MetaSel (Just "_cCompanionCreativeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_cCampaignId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :*: (S1 (MetaSel (Just "_cTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CreativesListTypes])) :*: S1 (MetaSel (Just "_cIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))) :*: (((S1 (MetaSel (Just "_cProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: S1 (MetaSel (Just "_cSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CreativesListSortOrder)) :*: (S1 (MetaSel (Just "_cActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_cCreativeFieldIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: ((S1 (MetaSel (Just "_cPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CreativesListSortField)) :*: (S1 (MetaSel (Just "_cStudioCreativeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_cArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_cMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))))))))

type Scopes CreativesList

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

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

type Rs CreativesList

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

type Rs CreativesList = CreativesListResponse

Request Lenses

cRenderingIds :: Lens' CreativesList [Int64]

Select only creatives with these rendering IDs.

cAdvertiserId :: Lens' CreativesList (Maybe Int64)

Select only creatives with this advertiser ID.

cSearchString :: Lens' CreativesList (Maybe Text)

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 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 "creative" will match objects with name "my creative", "creative 2015", or simply "creative".

cSizeIds :: Lens' CreativesList [Int64]

Select only creatives with these size IDs.

cCompanionCreativeIds :: Lens' CreativesList [Int64]

Select only in-stream video creatives with these companion IDs.

cCampaignId :: Lens' CreativesList (Maybe Int64)

Select only creatives with this campaign ID.

cTypes :: Lens' CreativesList [CreativesListTypes]

Select only creatives with these creative types.

cIds :: Lens' CreativesList [Int64]

Select only creatives with these IDs.

cProFileId :: Lens' CreativesList Int64

User profile ID associated with this request.

cSortOrder :: Lens' CreativesList CreativesListSortOrder

Order of sorted results.

cActive :: Lens' CreativesList (Maybe Bool)

Select only active creatives. Leave blank to select active and inactive creatives.

cCreativeFieldIds :: Lens' CreativesList [Int64]

Select only creatives with these creative field IDs.

cPageToken :: Lens' CreativesList (Maybe Text)

Value of the nextPageToken from the previous result page.

cSortField :: Lens' CreativesList CreativesListSortField

Field by which to sort the list.

cStudioCreativeId :: Lens' CreativesList (Maybe Int64)

Select only creatives corresponding to this Studio creative ID.

cArchived :: Lens' CreativesList (Maybe Bool)

Select only archived creatives. Leave blank to select archived and unarchived creatives.

cMaxResults :: Lens' CreativesList Int32

Maximum number of results to return.