gogol-dfareporting-0.0.1: Google DCM/DFA Reporting And Trafficking SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.DFAReporting.Ads.List

Contents

Description

Retrieves a list of ads, possibly filtered.

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

Synopsis

REST Resource

type AdsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("ads" :> (QueryParams "remarketingListIds" (Textual Int64) :> (QueryParams "landingPageIds" (Textual Int64) :> (QueryParams "creativeIds" (Textual Int64) :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "sizeIds" (Textual Int64) :> (QueryParam "sslCompliant" Bool :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AdsListSortOrder :> (QueryParam "active" Bool :> (QueryParams "creativeOptimizationConfigurationIds" (Textual Int64) :> (QueryParams "placementIds" (Textual Int64) :> (QueryParam "sslRequired" Bool :> (QueryParam "overriddenEventTagId" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdsListSortField :> (QueryParams "type" AdsListType :> (QueryParam "creativeType" AdsListCreativeType :> (QueryParam "dynamicClickTracker" Bool :> (QueryParam "compatibility" AdsListCompatibility :> (QueryParam "archived" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParams "audienceSegmentIds" (Textual Int64) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AdsListResponse))))))))))))))))))))))))))))) Source

A resource alias for dfareporting.ads.list method which the AdsList request conforms to.

Creating a Request

data AdsList Source

Retrieves a list of ads, possibly filtered.

See: adsList smart constructor.

Request Lenses

alRemarketingListIds :: Lens' AdsList [Int64] Source

Select only ads whose list targeting expression use these remarketing list IDs.

alLandingPageIds :: Lens' AdsList [Int64] Source

Select only ads with these landing page IDs.

alCreativeIds :: Lens' AdsList [Int64] Source

Select only ads with these creative IDs assigned.

alAdvertiserId :: Lens' AdsList (Maybe Int64) Source

Select only ads with this advertiser ID.

alCampaignIds :: Lens' AdsList [Int64] Source

Select only ads with these campaign IDs.

alSearchString :: Lens' AdsList (Maybe Text) Source

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

alSizeIds :: Lens' AdsList [Int64] Source

Select only ads with these size IDs.

alSSLCompliant :: Lens' AdsList (Maybe Bool) Source

Select only ads that are SSL-compliant.

alIds :: Lens' AdsList [Int64] Source

Select only ads with these IDs.

alProFileId :: Lens' AdsList Int64 Source

User profile ID associated with this request.

alSortOrder :: Lens' AdsList (Maybe AdsListSortOrder) Source

Order of sorted results, default is ASCENDING.

alActive :: Lens' AdsList (Maybe Bool) Source

Select only active ads.

alCreativeOptimizationConfigurationIds :: Lens' AdsList [Int64] Source

Select only ads with these creative optimization configuration IDs.

alPlacementIds :: Lens' AdsList [Int64] Source

Select only ads with these placement IDs assigned.

alSSLRequired :: Lens' AdsList (Maybe Bool) Source

Select only ads that require SSL.

alOverriddenEventTagId :: Lens' AdsList (Maybe Int64) Source

Select only ads with this event tag override ID.

alPageToken :: Lens' AdsList (Maybe Text) Source

Value of the nextPageToken from the previous result page.

alSortField :: Lens' AdsList (Maybe AdsListSortField) Source

Field by which to sort the list.

alType :: Lens' AdsList [AdsListType] Source

Select only ads with these types.

alCreativeType :: Lens' AdsList (Maybe AdsListCreativeType) Source

Select only ads with the specified creativeType.

alDynamicClickTracker :: Lens' AdsList (Maybe Bool) Source

Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

alCompatibility :: Lens' AdsList (Maybe AdsListCompatibility) Source

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.

alArchived :: Lens' AdsList (Maybe Bool) Source

Select only archived ads.

alMaxResults :: Lens' AdsList (Maybe Int32) Source

Maximum number of results to return.

alAudienceSegmentIds :: Lens' AdsList [Int64] Source

Select only ads with these audience segment IDs.