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.Campaigns.List

Contents

Description

Retrieves a list of campaigns, possibly filtered.

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

Synopsis

REST Resource

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

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.

clSortOrder :: Lens' CampaignsList (Maybe CampaignsListSortOrder) Source

Order of sorted results, default is ASCENDING.

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

Maximum number of results to return.