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

Copyright(c) 2015-2016 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. This method supports paging.

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

Synopsis

REST Resource

type AdsListResource = "dfareporting" :> ("v2.7" :> ("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 "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. This method supports paging.

See: adsList smart constructor.

Instances

Eq AdsList Source # 

Methods

(==) :: AdsList -> AdsList -> Bool #

(/=) :: AdsList -> AdsList -> Bool #

Data AdsList Source # 

Methods

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

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

toConstr :: AdsList -> Constr #

dataTypeOf :: AdsList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdsList) #

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

gmapT :: (forall b. Data b => b -> b) -> AdsList -> AdsList #

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

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

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

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

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

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

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

Show AdsList Source # 
Generic AdsList Source # 

Associated Types

type Rep AdsList :: * -> * #

Methods

from :: AdsList -> Rep AdsList x #

to :: Rep AdsList x -> AdsList #

GoogleRequest AdsList Source # 

Associated Types

type Rs AdsList :: * #

type Scopes AdsList :: [Symbol] #

type Rep AdsList Source # 
type Rep AdsList = D1 (MetaData "AdsList" "Network.Google.Resource.DFAReporting.Ads.List" "gogol-dfareporting-0.2.0-3vkytqIdbR4DxGH3Av8E8" False) (C1 (MetaCons "AdsList'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_alRemarketingListIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) ((:*:) (S1 (MetaSel (Just Symbol "_alLandingPageIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) (S1 (MetaSel (Just Symbol "_alCreativeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))) ((:*:) (S1 (MetaSel (Just Symbol "_alAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) ((:*:) (S1 (MetaSel (Just Symbol "_alCampaignIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) (S1 (MetaSel (Just Symbol "_alSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_alSizeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) ((:*:) (S1 (MetaSel (Just Symbol "_alSSLCompliant") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_alIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))) ((:*:) (S1 (MetaSel (Just Symbol "_alProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) ((:*:) (S1 (MetaSel (Just Symbol "_alSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdsListSortOrder))) (S1 (MetaSel (Just Symbol "_alActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_alCreativeOptimizationConfigurationIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) ((:*:) (S1 (MetaSel (Just Symbol "_alPlacementIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) (S1 (MetaSel (Just Symbol "_alSSLRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) (S1 (MetaSel (Just Symbol "_alOverriddenEventTagId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) ((:*:) (S1 (MetaSel (Just Symbol "_alPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_alSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdsListSortField)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_alType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AdsListType]))) ((:*:) (S1 (MetaSel (Just Symbol "_alDynamicClickTracker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_alCompatibility") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdsListCompatibility))))) ((:*:) (S1 (MetaSel (Just Symbol "_alArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_alMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_alAudienceSegmentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))))))))
type Scopes AdsList Source # 
type Scopes AdsList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs AdsList Source # 

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.

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. DISPLAY and DISPLAY_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.