Network.Google.Resource.DFAReporting.Campaigns.List

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

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

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))))))))))))))))))

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

Creating a Request

campaignsList

Arguments

:: Int64

clProFileId

-> CampaignsList

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

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

• clExcludedIds
• clSearchString
• clIds
• clProFileId
• clSortOrder
• clAdvertiserGroupIds
• clAtLeastOneOptimizationActivity
• clOverriddenEventTagId
• clPageToken
• clSortField
• clSubAccountId
• clAdvertiserIds
• clArchived
• clMaxResults

data CampaignsList

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

See: campaignsList smart constructor.

Instances

Eq CampaignsList

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

Methods

(==) :: CampaignsList -> CampaignsList -> Bool

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

Data CampaignsList

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

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

Methods

showsPrec :: Int -> CampaignsList -> ShowS

show :: CampaignsList -> String

showList :: [CampaignsList] -> ShowS

Generic CampaignsList

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

Associated Types

type Rep CampaignsList :: Type -> Type

Methods

from :: CampaignsList -> Rep CampaignsList x

to :: Rep CampaignsList x -> CampaignsList

GoogleRequest CampaignsList

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

Associated Types

type Rs CampaignsList :: Type

type Scopes CampaignsList :: [Symbol]

Methods

requestClient :: CampaignsList -> GClient (Rs CampaignsList)

type Rep CampaignsList

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

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

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

type Rs CampaignsList

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

type Rs CampaignsList = CampaignsListResponse

Request Lenses

clExcludedIds :: Lens' CampaignsList [Int64]

Exclude campaigns with these IDs.

clSearchString :: Lens' CampaignsList (Maybe Text)

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]

Select only campaigns with these IDs.

clProFileId :: Lens' CampaignsList Int64

User profile ID associated with this request.

clSortOrder :: Lens' CampaignsList CampaignsListSortOrder

Order of sorted results.

clAdvertiserGroupIds :: Lens' CampaignsList [Int64]

Select only campaigns whose advertisers belong to these advertiser groups.

clAtLeastOneOptimizationActivity :: Lens' CampaignsList (Maybe Bool)

Select only campaigns that have at least one optimization activity.

clOverriddenEventTagId :: Lens' CampaignsList (Maybe Int64)

Select only campaigns that have overridden this event tag ID.

clPageToken :: Lens' CampaignsList (Maybe Text)

Value of the nextPageToken from the previous result page.

clSortField :: Lens' CampaignsList CampaignsListSortField

Field by which to sort the list.

clSubAccountId :: Lens' CampaignsList (Maybe Int64)

Select only campaigns that belong to this subaccount.

clAdvertiserIds :: Lens' CampaignsList [Int64]

Select only campaigns that belong to these advertisers.

clArchived :: Lens' CampaignsList (Maybe Bool)

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

clMaxResults :: Lens' CampaignsList Int32

Maximum number of results to return.