Network.Google.Resource.DFAReporting.Ads.List

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

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

REST Resource

type AdsListResource = "dfareporting" :> ("v3.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 "dynamicClickTracker" Bool :> (QueryParam "compatibility" AdsListCompatibility :> (QueryParam "archived" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParams "audienceSegmentIds" (Textual Int64) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdsListResponse))))))))))))))))))))))))))))

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

Creating a Request

adsList

Arguments

:: Int64

alProFileId

-> AdsList

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

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

• alRemarketingListIds
• alLandingPageIds
• alCreativeIds
• alAdvertiserId
• alCampaignIds
• alSearchString
• alSizeIds
• alSSLCompliant
• alIds
• alProFileId
• alSortOrder
• alActive
• alCreativeOptimizationConfigurationIds
• alPlacementIds
• alSSLRequired
• alOverriddenEventTagId
• alPageToken
• alSortField
• alType
• alDynamicClickTracker
• alCompatibility
• alArchived
• alMaxResults
• alAudienceSegmentIds

data AdsList

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

See: adsList smart constructor.

Instances

Eq AdsList

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

Methods

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

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

Data AdsList

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

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

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

Methods

showsPrec :: Int -> AdsList -> ShowS

show :: AdsList -> String

showList :: [AdsList] -> ShowS

Generic AdsList

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

Associated Types

type Rep AdsList :: Type -> Type

Methods

from :: AdsList -> Rep AdsList x

to :: Rep AdsList x -> AdsList

GoogleRequest AdsList

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

Associated Types

type Rs AdsList :: Type

type Scopes AdsList :: [Symbol]

Methods

requestClient :: AdsList -> GClient (Rs AdsList)

type Rep AdsList

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

type Rep AdsList = D1 (MetaData "AdsList" "Network.Google.Resource.DFAReporting.Ads.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "AdsList'" PrefixI True) ((((S1 (MetaSel (Just "_alRemarketingListIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: (S1 (MetaSel (Just "_alLandingPageIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_alCreativeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: (S1 (MetaSel (Just "_alAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_alCampaignIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_alSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_alSizeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: (S1 (MetaSel (Just "_alSSLCompliant") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_alIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: (S1 (MetaSel (Just "_alProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: (S1 (MetaSel (Just "_alSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AdsListSortOrder) :*: S1 (MetaSel (Just "_alActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))) :*: (((S1 (MetaSel (Just "_alCreativeOptimizationConfigurationIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: (S1 (MetaSel (Just "_alPlacementIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_alSSLRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 (MetaSel (Just "_alOverriddenEventTagId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_alPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_alSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AdsListSortField)))) :*: ((S1 (MetaSel (Just "_alType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AdsListType])) :*: (S1 (MetaSel (Just "_alDynamicClickTracker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_alCompatibility") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdsListCompatibility)))) :*: (S1 (MetaSel (Just "_alArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_alMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)) :*: S1 (MetaSel (Just "_alAudienceSegmentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))))))

type Scopes AdsList

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

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

type Rs AdsList

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

type Rs AdsList = AdsListResponse

Request Lenses

alRemarketingListIds :: Lens' AdsList [Int64]

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

alLandingPageIds :: Lens' AdsList [Int64]

Select only ads with these landing page IDs.

alCreativeIds :: Lens' AdsList [Int64]

Select only ads with these creative IDs assigned.

alAdvertiserId :: Lens' AdsList (Maybe Int64)

Select only ads with this advertiser ID.

alCampaignIds :: Lens' AdsList [Int64]

Select only ads with these campaign IDs.

alSearchString :: Lens' AdsList (Maybe Text)

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]

Select only ads with these size IDs.

alSSLCompliant :: Lens' AdsList (Maybe Bool)

Select only ads that are SSL-compliant.

alIds :: Lens' AdsList [Int64]

Select only ads with these IDs.

alProFileId :: Lens' AdsList Int64

User profile ID associated with this request.

alSortOrder :: Lens' AdsList AdsListSortOrder

Order of sorted results.

alActive :: Lens' AdsList (Maybe Bool)

Select only active ads.

alCreativeOptimizationConfigurationIds :: Lens' AdsList [Int64]

Select only ads with these creative optimization configuration IDs.

alPlacementIds :: Lens' AdsList [Int64]

Select only ads with these placement IDs assigned.

alSSLRequired :: Lens' AdsList (Maybe Bool)

Select only ads that require SSL.

alOverriddenEventTagId :: Lens' AdsList (Maybe Int64)

Select only ads with this event tag override ID.

alPageToken :: Lens' AdsList (Maybe Text)

Value of the nextPageToken from the previous result page.

alSortField :: Lens' AdsList AdsListSortField

Field by which to sort the list.

alType :: Lens' AdsList [AdsListType]

Select only ads with these types.

alDynamicClickTracker :: Lens' AdsList (Maybe Bool)

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)

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)

Select only archived ads.

alMaxResults :: Lens' AdsList Int32

Maximum number of results to return.

alAudienceSegmentIds :: Lens' AdsList [Int64]

Select only ads with these audience segment IDs.