Network.Google.Resource.DFAReporting.Creatives.List

Retrieves a list of creatives, possibly filtered.

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

REST Resource

type CreativesListResource = "dfareporting" :> ("v2.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.

See: creativesList smart constructor.

Instances

Eq CreativesList

Data CreativesList

Show CreativesList

Generic CreativesList

GoogleRequest CreativesList

type Rep CreativesList

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 (Maybe CreativesListSortOrder)

Order of sorted results, default is ASCENDING.

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 (Maybe 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 (Maybe Int32)

Maximum number of results to return.