gogol-dfareporting-0.5.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.Campaigns.List

Contents

Description

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

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

Synopsis

REST Resource

type CampaignsListResource = "dfareporting" :> ("v3.3" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("campaigns" :> (QueryParams "excludedIds" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" CampaignsListSortOrder :> (QueryParams "advertiserGroupIds" (Textual Int64) :> (QueryParam "atLeastOneOptimizationActivity" Bool :> (QueryParam "overriddenEventTagId" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" CampaignsListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "archived" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CampaignsListResponse)))))))))))))))))) Source #

A resource alias for dfareporting.campaigns.list method which the CampaignsList request conforms to.

Creating a Request

data CampaignsList Source #

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

See: campaignsList smart constructor.

Instances
Eq CampaignsList Source # 
Instance details

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

Data CampaignsList Source # 
Instance details

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

Methods

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

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

toConstr :: CampaignsList -> Constr #

dataTypeOf :: CampaignsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CampaignsList Source # 
Instance details

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

Generic CampaignsList Source # 
Instance details

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

Associated Types

type Rep CampaignsList :: Type -> Type #

GoogleRequest CampaignsList Source # 
Instance details

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

Associated Types

type Rs CampaignsList :: Type #

type Scopes CampaignsList :: [Symbol] #

type Rep CampaignsList Source # 
Instance details

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

type Rep CampaignsList = D1 (MetaData "CampaignsList" "Network.Google.Resource.DFAReporting.Campaigns.List" "gogol-dfareporting-0.5.0-H2nEimqYPoYBpPsdI4WnkF" False) (C1 (MetaCons "CampaignsList'" PrefixI True) (((S1 (MetaSel (Just "_clExcludedIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: (S1 (MetaSel (Just "_clSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: ((S1 (MetaSel (Just "_clProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: S1 (MetaSel (Just "_clSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CampaignsListSortOrder)) :*: (S1 (MetaSel (Just "_clAdvertiserGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_clAtLeastOneOptimizationActivity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 (MetaSel (Just "_clOverriddenEventTagId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_clPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CampaignsListSortField))) :*: ((S1 (MetaSel (Just "_clSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_clAdvertiserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_clArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_clMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes CampaignsList Source # 
Instance details

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

type Scopes CampaignsList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs CampaignsList Source # 
Instance details

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

Request Lenses

clExcludedIds :: Lens' CampaignsList [Int64] Source #

Exclude campaigns with these IDs.

clSearchString :: Lens' CampaignsList (Maybe Text) Source #

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

clIds :: Lens' CampaignsList [Int64] Source #

Select only campaigns with these IDs.

clProFileId :: Lens' CampaignsList Int64 Source #

User profile ID associated with this request.

clAdvertiserGroupIds :: Lens' CampaignsList [Int64] Source #

Select only campaigns whose advertisers belong to these advertiser groups.

clAtLeastOneOptimizationActivity :: Lens' CampaignsList (Maybe Bool) Source #

Select only campaigns that have at least one optimization activity.

clOverriddenEventTagId :: Lens' CampaignsList (Maybe Int64) Source #

Select only campaigns that have overridden this event tag ID.

clPageToken :: Lens' CampaignsList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

clSortField :: Lens' CampaignsList CampaignsListSortField Source #

Field by which to sort the list.

clSubAccountId :: Lens' CampaignsList (Maybe Int64) Source #

Select only campaigns that belong to this subaccount.

clAdvertiserIds :: Lens' CampaignsList [Int64] Source #

Select only campaigns that belong to these advertisers.

clArchived :: Lens' CampaignsList (Maybe Bool) Source #

Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.

clMaxResults :: Lens' CampaignsList Int32 Source #

Maximum number of results to return.