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.DFAReporting.Types

Contents

Description

 

Synopsis

Service Configuration

dFAReportingService :: Service Source

Default request referring to version 'v2.2' of the DCM/DFA Reporting And Trafficking API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

dfareportingScope :: OAuthScope Source

View and manage DoubleClick for Advertisers reports

dfatraffickingScope :: OAuthScope Source

View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

PlacementsListSortOrder

data PlacementsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

Ascending
ASCENDING
Descending
DESCENDING

Instances

DateRangeRelativeDateRange

data DateRangeRelativeDateRange Source

The date range relative to the date of when the report is run.

Constructors

Last24Months
LAST_24_MONTHS
Last30Days
LAST_30_DAYS
Last365Days
LAST_365_DAYS
Last7Days
LAST_7_DAYS
Last90Days
LAST_90_DAYS
MonthToDate
MONTH_TO_DATE
PreviousMonth
PREVIOUS_MONTH
PreviousQuarter
PREVIOUS_QUARTER
PreviousWeek
PREVIOUS_WEEK
PreviousYear
PREVIOUS_YEAR
QuarterToDate
QUARTER_TO_DATE
Today
TODAY
WeekToDate
WEEK_TO_DATE
YearToDate
YEAR_TO_DATE
Yesterday
YESTERDAY

Instances

AdvertisersListSortField

data AdvertisersListSortField Source

Field by which to sort the list.

Constructors

ID
ID
Name
NAME

Instances

CreativeFieldsListSortOrder

data CreativeFieldsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

CFLSOAscending
ASCENDING
CFLSODescending
DESCENDING

Instances

FileList

data FileList Source

Represents the list of File resources.

See: fileList smart constructor.

Instances

fileList :: FileList Source

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

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

flEtag :: Lens' FileList (Maybe Text) Source

The eTag of this response for caching purposes.

flNextPageToken :: Lens' FileList (Maybe Text) Source

Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.

flKind :: Lens' FileList Text Source

The kind of list this is, in this case dfareporting#fileList.

flItems :: Lens' FileList [File] Source

The files returned in this response.

OptimizationActivity

data OptimizationActivity Source

Creative optimization activity.

See: optimizationActivity smart constructor.

Instances

optimizationActivity :: OptimizationActivity Source

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

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

oaWeight :: Lens' OptimizationActivity (Maybe Int32) Source

Weight associated with this optimization. Must be greater than 1. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities.

oaFloodlightActivityId :: Lens' OptimizationActivity (Maybe Int64) Source

Floodlight activity ID of this optimization activity. This is a required field.

oaFloodlightActivityIdDimensionValue :: Lens' OptimizationActivity (Maybe DimensionValue) Source

Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.

ListPopulationClause

data ListPopulationClause Source

A group clause made up of list population terms representing constraints joined by ORs.

See: listPopulationClause smart constructor.

Instances

listPopulationClause :: ListPopulationClause Source

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

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

lpcTerms :: Lens' ListPopulationClause [ListPopulationTerm] Source

Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.

CreativeCustomEvent

data CreativeCustomEvent Source

Creative Custom Event.

See: creativeCustomEvent smart constructor.

Instances

creativeCustomEvent :: CreativeCustomEvent Source

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

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

cceAdvertiserCustomEventType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventAdvertiserCustomEventType) Source

Type of the event. This is a read-only field.

cceAdvertiserCustomEventName :: Lens' CreativeCustomEvent (Maybe Text) Source

User-entered name for the event.

cceExitURL :: Lens' CreativeCustomEvent (Maybe Text) Source

Exit URL of the event. This field is used only for exit events.

cceTargetType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventTargetType) Source

Target type used by the event.

ccePopupWindowProperties :: Lens' CreativeCustomEvent (Maybe PopupWindowProperties) Source

Properties for rich media popup windows. This field is used only for exit events.

cceVideoReportingId :: Lens' CreativeCustomEvent (Maybe Text) Source

Reporting ID, used to differentiate multiple videos in a single creative.

cceId :: Lens' CreativeCustomEvent (Maybe Int64) Source

ID of this event. This is a required field and should not be modified after insertion.

cceArtworkLabel :: Lens' CreativeCustomEvent (Maybe Text) Source

Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion.

cceArtworkType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventArtworkType) Source

Artwork type used by the creative.This is a read-only field.

ClickTag

data ClickTag Source

Creative Click Tag.

See: clickTag smart constructor.

Instances

clickTag :: ClickTag Source

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

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

ctValue :: Lens' ClickTag (Maybe Text) Source

Parameter value for the specified click tag. This field contains a click-through url.

ctName :: Lens' ClickTag (Maybe Text) Source

Parameter name for the specified click tag. For ENHANCED_IMAGE creative assets, this field must match the value of the creative asset's creativeAssetId.name field.

ctEventName :: Lens' ClickTag (Maybe Text) Source

Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.

CampaignsListResponse

data CampaignsListResponse Source

Campaign List Response

See: campaignsListResponse smart constructor.

Instances

campaignsListResponse :: CampaignsListResponse Source

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

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

clrNextPageToken :: Lens' CampaignsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

clrCampaigns :: Lens' CampaignsListResponse [Campaign] Source

Campaign collection.

clrKind :: Lens' CampaignsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".

GeoTargeting

data GeoTargeting Source

Geographical Targeting.

See: geoTargeting smart constructor.

Instances

geoTargeting :: GeoTargeting Source

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

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

gtRegions :: Lens' GeoTargeting [Region] Source

Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.

gtCountries :: Lens' GeoTargeting [Country] Source

Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.

gtCities :: Lens' GeoTargeting [City] Source

Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.

gtMetros :: Lens' GeoTargeting [Metro] Source

Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.

gtExcludeCountries :: Lens' GeoTargeting (Maybe Bool) Source

Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.

gtPostalCodes :: Lens' GeoTargeting [PostalCode] Source

Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.

UserRolesListSortField

data UserRolesListSortField Source

Field by which to sort the list.

Constructors

URLSFID
ID
URLSFName
NAME

Instances

ReachReportCompatibleFields

data ReachReportCompatibleFields Source

Represents fields that are compatible to be selected for a report of type "REACH".

See: reachReportCompatibleFields smart constructor.

Instances

reachReportCompatibleFields :: ReachReportCompatibleFields Source

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

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

rrcfMetrics :: Lens' ReachReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected in the "metricNames" section of the report.

rrcfReachByFrequencyMetrics :: Lens' ReachReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.

rrcfKind :: Lens' ReachReportCompatibleFields Text Source

The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.

rrcfDimensionFilters :: Lens' ReachReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

rrcfPivotedActivityMetrics :: Lens' ReachReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.

rrcfDimensions :: Lens' ReachReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "dimensions" section of the report.

Browser

data Browser Source

Contains information about a browser that can be targeted by ads.

See: browser smart constructor.

Instances

browser :: Browser Source

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

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

bMinorVersion :: Lens' Browser (Maybe Text) Source

Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.

bKind :: Lens' Browser Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".

bBrowserVersionId :: Lens' Browser (Maybe Int64) Source

ID referring to this grouping of browser and version numbers. This is the ID used for targeting.

bMajorVersion :: Lens' Browser (Maybe Text) Source

Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.

bName :: Lens' Browser (Maybe Text) Source

Name of this browser.

bDartId :: Lens' Browser (Maybe Int64) Source

DART ID of this browser. This is the ID used when generating reports.

FloodlightActivityTagFormat

data FloodlightActivityTagFormat Source

Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.

Constructors

HTML
HTML
Xhtml
XHTML

Instances

OrderDocumentsListSortOrder

data OrderDocumentsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

ODLSOAscending
ASCENDING
ODLSODescending
DESCENDING

Instances

CreativeGroupAssignment

data CreativeGroupAssignment Source

Creative Group Assignment.

See: creativeGroupAssignment smart constructor.

Instances

creativeGroupAssignment :: CreativeGroupAssignment Source

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

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

cgaCreativeGroupNumber :: Lens' CreativeGroupAssignment (Maybe CreativeGroupAssignmentCreativeGroupNumber) Source

Creative group number of the creative group assignment.

cgaCreativeGroupId :: Lens' CreativeGroupAssignment (Maybe Int64) Source

ID of the creative group to be assigned.

CreativeAssetRole

data CreativeAssetRole Source

Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives. TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives. ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM. For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.

Constructors

AdditionalFlash
ADDITIONAL_FLASH
AdditionalImage
ADDITIONAL_IMAGE
AlternateVideo
ALTERNATE_VIDEO
BackupImage
BACKUP_IMAGE
Other
OTHER
ParentVideo
PARENT_VIDEO
Primary
PRIMARY
TranscodedVideo
TRANSCODED_VIDEO

Instances

RecipientDeliveryType

data RecipientDeliveryType Source

The delivery type for the recipient.

Constructors

Attachment
ATTACHMENT
Link
LINK

Instances

ThirdPartyTrackingURLThirdPartyURLType

data ThirdPartyTrackingURLThirdPartyURLType Source

Third-party URL type for in-stream video creatives.

Constructors

ClickTracking
CLICK_TRACKING
Impression
IMPRESSION
RichMediaBackupImpression
RICH_MEDIA_BACKUP_IMPRESSION
RichMediaImpression
RICH_MEDIA_IMPRESSION
RichMediaRmImpression
RICH_MEDIA_RM_IMPRESSION
Survey
SURVEY
VideoComplete
VIDEO_COMPLETE
VideoCustom
VIDEO_CUSTOM
VideoFirstQuartile
VIDEO_FIRST_QUARTILE
VideoFullscreen
VIDEO_FULLSCREEN
VideoMidpoint
VIDEO_MIDPOINT
VideoMute
VIDEO_MUTE
VideoPause
VIDEO_PAUSE
VideoRewind
VIDEO_REWIND
VideoStart
VIDEO_START
VideoStop
VIDEO_STOP
VideoThirdQuartile
VIDEO_THIRD_QUARTILE

Instances

DirectorySiteSettings

data DirectorySiteSettings Source

Directory Site Settings

See: directorySiteSettings smart constructor.

Instances

directorySiteSettings :: DirectorySiteSettings Source

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

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

dssInterstitialPlacementAccepted :: Lens' DirectorySiteSettings (Maybe Bool) Source

Whether this site accepts interstitial ads.

dssDfpSettings :: Lens' DirectorySiteSettings (Maybe DfpSettings) Source

Directory site DFP settings.

dssVerificationTagOptOut :: Lens' DirectorySiteSettings (Maybe Bool) Source

Whether this directory site has disabled generation of Verification ins tags.

dssActiveViewOptOut :: Lens' DirectorySiteSettings (Maybe Bool) Source

Whether this directory site has disabled active view creatives.

dssVideoActiveViewOptOut :: Lens' DirectorySiteSettings (Maybe Bool) Source

Whether this directory site has disabled active view for in-stream video creatives.

dssInstreamVideoPlacementAccepted :: Lens' DirectorySiteSettings (Maybe Bool) Source

Whether this site accepts in-stream video ads.

dssNielsenOCROptOut :: Lens' DirectorySiteSettings (Maybe Bool) Source

Whether this directory site has disabled Nielsen OCR reach ratings.

TargetableRemarketingListsListSortOrder

data TargetableRemarketingListsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

TRLLSOAscending
ASCENDING
TRLLSODescending
DESCENDING

Instances

CreativeAssetPositionLeftUnit

data CreativeAssetPositionLeftUnit Source

Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

Constructors

OffSetUnitPercent
OFFSET_UNIT_PERCENT
OffSetUnitPixel
OFFSET_UNIT_PIXEL
OffSetUnitPixelFromCenter
OFFSET_UNIT_PIXEL_FROM_CENTER

Instances

PricingScheduleCapCostOption

data PricingScheduleCapCostOption Source

Placement cap cost option.

Constructors

CapCostCumulative
CAP_COST_CUMULATIVE
CapCostMonthly
CAP_COST_MONTHLY
CapCostNone
CAP_COST_NONE

Instances

ListPopulationRule

data ListPopulationRule Source

Remarketing List Population Rule.

See: listPopulationRule smart constructor.

Instances

listPopulationRule :: ListPopulationRule Source

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

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

lprFloodlightActivityName :: Lens' ListPopulationRule (Maybe Text) Source

Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.

lprFloodlightActivityId :: Lens' ListPopulationRule (Maybe Int64) Source

Floodlight activity ID associated with this rule. This field can be left blank.

lprListPopulationClauses :: Lens' ListPopulationRule [ListPopulationClause] Source

Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.

UserRolePermissionAvailability

data UserRolePermissionAvailability Source

Levels of availability for a user role permission.

Constructors

AccountAlways
ACCOUNT_ALWAYS
AccountByDefault
ACCOUNT_BY_DEFAULT
NotAvailableByDefault
NOT_AVAILABLE_BY_DEFAULT
SubAccountAndAccountAlways
SUBACCOUNT_AND_ACCOUNT_ALWAYS
SubAccountAndAccountByDefault
SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT

Instances

DirectorySiteContactAssignmentVisibility

data DirectorySiteContactAssignmentVisibility Source

Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.

Constructors

Private
PRIVATE
Public
PUBLIC

Instances

SizesListResponse

data SizesListResponse Source

Size List Response

See: sizesListResponse smart constructor.

Instances

sizesListResponse :: SizesListResponse Source

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

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

slrKind :: Lens' SizesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".

slrSizes :: Lens' SizesListResponse [Size] Source

Size collection.

PlacementCompatibility

data PlacementCompatibility Source

Placement compatibility. WEB and WEB_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 in in-stream video ads developed with the VAST standard. This field is required on insertion.

Constructors

App
APP
AppInterstitial
APP_INTERSTITIAL
InStreamVideo
IN_STREAM_VIDEO
Web
WEB
WebInterstitial
WEB_INTERSTITIAL

Instances

CreativeRotation

data CreativeRotation Source

Creative Rotation.

See: creativeRotation smart constructor.

Instances

creativeRotation :: CreativeRotation Source

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

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

crWeightCalculationStrategy :: Lens' CreativeRotation (Maybe CreativeRotationWeightCalculationStrategy) Source

Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.

crCreativeAssignments :: Lens' CreativeRotation [CreativeAssignment] Source

Creative assignments in this creative rotation.

crCreativeOptimizationConfigurationId :: Lens' CreativeRotation (Maybe Int64) Source

Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.

crType :: Lens' CreativeRotation (Maybe CreativeRotationType) Source

Type of creative rotation. Can be used to specify whether to use sequential or random rotation.

TechnologyTargeting

data TechnologyTargeting Source

Technology Targeting.

See: technologyTargeting smart constructor.

Instances

technologyTargeting :: TechnologyTargeting Source

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

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

ttMobileCarriers :: Lens' TechnologyTargeting [MobileCarrier] Source

Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.

ttOperatingSystemVersions :: Lens' TechnologyTargeting [OperatingSystemVersion] Source

Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.

ttPlatformTypes :: Lens' TechnologyTargeting [PlatformType] Source

Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.

ttBrowsers :: Lens' TechnologyTargeting [Browser] Source

Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used.The other fields are populated automatically when the ad is inserted or updated.

ttConnectionTypes :: Lens' TechnologyTargeting [ConnectionType] Source

Connection types that this ad targets. For each connection type only id is required.The other fields are populated automatically when the ad is inserted or updated.

ttOperatingSystems :: Lens' TechnologyTargeting [OperatingSystem] Source

Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.

ListPopulationTermOperator

data ListPopulationTermOperator Source

Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.

Constructors

NumEquals
NUM_EQUALS
NumGreaterThan
NUM_GREATER_THAN
NumGreaterThanEqual
NUM_GREATER_THAN_EQUAL
NumLessThan
NUM_LESS_THAN
NumLessThanEqual
NUM_LESS_THAN_EQUAL
StringContains
STRING_CONTAINS
StringEquals
STRING_EQUALS

Instances

PlacementsListPaymentSource

data PlacementsListPaymentSource Source

Select only placements with this payment source.

Constructors

PlacementAgencyPaid
PLACEMENT_AGENCY_PAID
PlacementPublisherPaid
PLACEMENT_PUBLISHER_PAID

Instances

InventoryItem

data InventoryItem Source

Represents a buy from the DoubleClick Planning inventory store.

See: inventoryItem smart constructor.

Instances

inventoryItem :: InventoryItem Source

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

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

iiPlacementStrategyId :: Lens' InventoryItem (Maybe Int64) Source

Placement strategy ID of this inventory item.

iiEstimatedClickThroughRate :: Lens' InventoryItem (Maybe Int64) Source

Estimated click-through rate of this inventory item.

iiPricing :: Lens' InventoryItem (Maybe Pricing) Source

Pricing of this inventory item.

iiKind :: Lens' InventoryItem Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".

iiAdvertiserId :: Lens' InventoryItem (Maybe Int64) Source

Advertiser ID of this inventory item.

iiRfpId :: Lens' InventoryItem (Maybe Int64) Source

RFP ID of this inventory item.

iiContentCategoryId :: Lens' InventoryItem (Maybe Int64) Source

Content category ID of this inventory item.

iiInPlan :: Lens' InventoryItem (Maybe Bool) Source

Whether this inventory item is in plan.

iiAccountId :: Lens' InventoryItem (Maybe Int64) Source

Account ID of this inventory item.

iiName :: Lens' InventoryItem (Maybe Text) Source

Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.

iiAdSlots :: Lens' InventoryItem [AdSlot] Source

Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.

iiNegotiationChannelId :: Lens' InventoryItem (Maybe Int64) Source

Negotiation channel ID of this inventory item.

iiLastModifiedInfo :: Lens' InventoryItem (Maybe LastModifiedInfo) Source

Information about the most recent modification of this inventory item.

iiId :: Lens' InventoryItem (Maybe Int64) Source

ID of this inventory item.

iiEstimatedConversionRate :: Lens' InventoryItem (Maybe Int64) Source

Estimated conversion rate of this inventory item.

iiProjectId :: Lens' InventoryItem (Maybe Int64) Source

Project ID of this inventory item.

iiSubAccountId :: Lens' InventoryItem (Maybe Int64) Source

Subaccount ID of this inventory item.

iiOrderId :: Lens' InventoryItem (Maybe Int64) Source

Order ID of this inventory item.

iiSiteId :: Lens' InventoryItem (Maybe Int64) Source

ID of the site this inventory item is associated with.

ProjectsListResponse

data ProjectsListResponse Source

Project List Response

See: projectsListResponse smart constructor.

Instances

projectsListResponse :: ProjectsListResponse Source

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

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

plrNextPageToken :: Lens' ProjectsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

plrKind :: Lens' ProjectsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".

plrProjects :: Lens' ProjectsListResponse [Project] Source

Project collection.

AdsListResponse

data AdsListResponse Source

Ad List Response

See: adsListResponse smart constructor.

Instances

adsListResponse :: AdsListResponse Source

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

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

alrNextPageToken :: Lens' AdsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

alrKind :: Lens' AdsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".

alrAds :: Lens' AdsListResponse [Ad] Source

Ad collection.

ReportsListSortField

data ReportsListSortField Source

The field by which to sort the list.

Constructors

RLSFID

ID Sort by report ID.

RLSFLastModifiedTime

LAST_MODIFIED_TIME Sort by 'lastModifiedTime' field.

RLSFName

NAME Sort by name of reports.

Instances

AdSlotCompatibility

data AdSlotCompatibility Source

Ad slot compatibility. WEB and WEB_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 in in-stream video ads developed with the VAST standard.

Constructors

PlanningRenderingEnvironmentTypeApp
PLANNING_RENDERING_ENVIRONMENT_TYPE_APP
PlanningRenderingEnvironmentTypeAppInterstitial
PLANNING_RENDERING_ENVIRONMENT_TYPE_APP_INTERSTITIAL
PlanningRenderingEnvironmentTypeInStreamVideo
PLANNING_RENDERING_ENVIRONMENT_TYPE_IN_STREAM_VIDEO
PlanningRenderingEnvironmentTypeWeb
PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB
PlanningRenderingEnvironmentTypeWebInterstitial
PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB_INTERSTITIAL

Instances

ListPopulationTerm

data ListPopulationTerm Source

Remarketing List Population Rule Term.

See: listPopulationTerm smart constructor.

Instances

listPopulationTerm :: ListPopulationTerm Source

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

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

lptOperator :: Lens' ListPopulationTerm (Maybe ListPopulationTermOperator) Source

Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.

lptValue :: Lens' ListPopulationTerm (Maybe Text) Source

Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.

lptVariableFriendlyName :: Lens' ListPopulationTerm (Maybe Text) Source

Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.

lptNegation :: Lens' ListPopulationTerm (Maybe Bool) Source

Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.

lptVariableName :: Lens' ListPopulationTerm (Maybe Text) Source

Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.

lptRemarketingListId :: Lens' ListPopulationTerm (Maybe Int64) Source

ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.

lptType :: Lens' ListPopulationTerm (Maybe ListPopulationTermType) Source

List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.

lptContains :: Lens' ListPopulationTerm (Maybe Bool) Source

Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.

TagSettings

data TagSettings Source

Dynamic and Image Tag Settings.

See: tagSettings smart constructor.

Instances

tagSettings :: TagSettings Source

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

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

tsDynamicTagEnabled :: Lens' TagSettings (Maybe Bool) Source

Whether dynamic floodlight tags are enabled.

tsImageTagEnabled :: Lens' TagSettings (Maybe Bool) Source

Whether image tags are enabled.

SubAccountsListResponse

data SubAccountsListResponse Source

Subaccount List Response

See: subAccountsListResponse smart constructor.

Instances

subAccountsListResponse :: SubAccountsListResponse Source

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

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

salrNextPageToken :: Lens' SubAccountsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

salrKind :: Lens' SubAccountsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".

salrSubAccounts :: Lens' SubAccountsListResponse [SubAccount] Source

Subaccount collection.

CampaignsListSortField

data CampaignsListSortField Source

Field by which to sort the list.

Constructors

CLSFID
ID
CLSFName
NAME

Instances

DirectorySiteContact

data DirectorySiteContact Source

Contains properties of a Site Directory contact.

See: directorySiteContact smart constructor.

Instances

directorySiteContact :: DirectorySiteContact Source

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

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

dscEmail :: Lens' DirectorySiteContact (Maybe Text) Source

Email address of this directory site contact.

dscPhone :: Lens' DirectorySiteContact (Maybe Text) Source

Phone number of this directory site contact.

dscLastName :: Lens' DirectorySiteContact (Maybe Text) Source

Last name of this directory site contact.

dscKind :: Lens' DirectorySiteContact Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".

dscAddress :: Lens' DirectorySiteContact (Maybe Text) Source

Address of this directory site contact.

dscRole :: Lens' DirectorySiteContact (Maybe DirectorySiteContactRole) Source

Directory site contact role.

dscFirstName :: Lens' DirectorySiteContact (Maybe Text) Source

First name of this directory site contact.

dscId :: Lens' DirectorySiteContact (Maybe Int64) Source

ID of this directory site contact. This is a read-only, auto-generated field.

dscTitle :: Lens' DirectorySiteContact (Maybe Text) Source

Title or designation of this directory site contact.

dscType :: Lens' DirectorySiteContact (Maybe DirectorySiteContactType) Source

Directory site contact type.

RegionsListResponse

data RegionsListResponse Source

Region List Response

See: regionsListResponse smart constructor.

Instances

regionsListResponse :: RegionsListResponse Source

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

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

rlrKind :: Lens' RegionsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".

rlrRegions :: Lens' RegionsListResponse [Region] Source

Region collection.

FloodlightActivityDynamicTag

data FloodlightActivityDynamicTag Source

Dynamic Tag

See: floodlightActivityDynamicTag smart constructor.

Instances

floodlightActivityDynamicTag :: FloodlightActivityDynamicTag Source

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

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

fadtTag :: Lens' FloodlightActivityDynamicTag (Maybe Text) Source

Tag code.

fadtName :: Lens' FloodlightActivityDynamicTag (Maybe Text) Source

Name of this tag.

fadtId :: Lens' FloodlightActivityDynamicTag (Maybe Int64) Source

ID of this dynamic tag. This is a read-only, auto-generated field.

AccountUserProFileTraffickerType

data AccountUserProFileTraffickerType Source

Trafficker type of this user profile.

Constructors

ExternalTrafficker
EXTERNAL_TRAFFICKER
InternalNonTrafficker
INTERNAL_NON_TRAFFICKER
InternalTrafficker
INTERNAL_TRAFFICKER

Instances

DirectorySite

data DirectorySite Source

DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.

See: directorySite smart constructor.

Instances

directorySite :: DirectorySite Source

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

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

dsCurrencyId :: Lens' DirectorySite (Maybe Int64) Source

Currency ID of this directory site. Possible values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ

dsSettings :: Lens' DirectorySite (Maybe DirectorySiteSettings) Source

Directory site settings.

dsInterstitialTagFormats :: Lens' DirectorySite [DirectorySiteInterstitialTagFormatsItem] Source

Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL"

dsKind :: Lens' DirectorySite Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".

dsURL :: Lens' DirectorySite (Maybe Text) Source

URL of this directory site.

dsIdDimensionValue :: Lens' DirectorySite (Maybe DimensionValue) Source

Dimension value for the ID of this directory site. This is a read-only, auto-generated field.

dsInpageTagFormats :: Lens' DirectorySite [DirectorySiteInpageTagFormatsItem] Source

Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE"

dsActive :: Lens' DirectorySite (Maybe Bool) Source

Whether this directory site is active.

dsName :: Lens' DirectorySite (Maybe Text) Source

Name of this directory site.

dsId :: Lens' DirectorySite (Maybe Int64) Source

ID of this directory site. This is a read-only, auto-generated field.

dsCountryId :: Lens' DirectorySite (Maybe Int64) Source

Country ID of this directory site.

dsContactAssignments :: Lens' DirectorySite [DirectorySiteContactAssignment] Source

Directory site contacts.

dsDescription :: Lens' DirectorySite (Maybe Text) Source

Description of this directory site.

dsParentId :: Lens' DirectorySite (Maybe Int64) Source

Parent directory site ID.

CreativeAssetMetadataDetectedFeaturesItem

data CreativeAssetMetadataDetectedFeaturesItem Source

Constructors

ApplicationCache
APPLICATION_CACHE
Audio
AUDIO
Canvas
CANVAS
CanvasText
CANVAS_TEXT
CssAnimations
CSS_ANIMATIONS
CssBackgRoundSize
CSS_BACKGROUND_SIZE
CssBOrderImage
CSS_BORDER_IMAGE
CssBOrderRadius
CSS_BORDER_RADIUS
CssBoxShadow
CSS_BOX_SHADOW
CssColumns
CSS_COLUMNS
CssFlexBox
CSS_FLEX_BOX
CssFontFace
CSS_FONT_FACE
CssGeneratedContent
CSS_GENERATED_CONTENT
CssGradients
CSS_GRADIENTS
CssHsla
CSS_HSLA
CssMultipleBgs
CSS_MULTIPLE_BGS
CssOpacity
CSS_OPACITY
CssReflections
CSS_REFLECTIONS
CssRgba
CSS_RGBA
CssTextShadow
CSS_TEXT_SHADOW
CssTransforms
CSS_TRANSFORMS
CssTRANSFORMS3D
CSS_TRANSFORMS3D
CssTransitions
CSS_TRANSITIONS
DragAndDrop
DRAG_AND_DROP
GeoLocation
GEO_LOCATION
HashChange
HASH_CHANGE
History
HISTORY
IndexedDB
INDEXED_DB
InlineSvg
INLINE_SVG
InputAttrAutocomplete
INPUT_ATTR_AUTOCOMPLETE
InputAttrAutofocus
INPUT_ATTR_AUTOFOCUS
InputAttrList
INPUT_ATTR_LIST
InputAttrMax
INPUT_ATTR_MAX
InputAttrMin
INPUT_ATTR_MIN
InputAttrMultiple
INPUT_ATTR_MULTIPLE
InputAttrPattern
INPUT_ATTR_PATTERN
InputAttrPlaceholder
INPUT_ATTR_PLACEHOLDER
InputAttrRequired
INPUT_ATTR_REQUIRED
InputAttrStep
INPUT_ATTR_STEP
InputTypeColor
INPUT_TYPE_COLOR
InputTypeDate
INPUT_TYPE_DATE
InputTypeDatetime
INPUT_TYPE_DATETIME
InputTypeDatetimeLocal
INPUT_TYPE_DATETIME_LOCAL
InputTypeEmail
INPUT_TYPE_EMAIL
InputTypeMonth
INPUT_TYPE_MONTH
InputTypeNumber
INPUT_TYPE_NUMBER
InputTypeRange
INPUT_TYPE_RANGE
InputTypeSearch
INPUT_TYPE_SEARCH
InputTypeTel
INPUT_TYPE_TEL
InputTypeTime
INPUT_TYPE_TIME
InputTypeURL
INPUT_TYPE_URL
InputTypeWeek
INPUT_TYPE_WEEK
LocalStorage
LOCAL_STORAGE
PostMessage
POST_MESSAGE
SessionStorage
SESSION_STORAGE
Smil
SMIL
SvgClipPaths
SVG_CLIP_PATHS
SvgFeImage
SVG_FE_IMAGE
SvgFilters
SVG_FILTERS
SvgHref
SVG_HREF
Touch
TOUCH
Video
VIDEO
Webgl
WEBGL
WebSockets
WEB_SOCKETS
WebSQLDatabase
WEB_SQL_DATABASE
WebWorkers
WEB_WORKERS

Instances

ReportFloodlightCriteriaReportProperties

data ReportFloodlightCriteriaReportProperties Source

The properties of the report.

See: reportFloodlightCriteriaReportProperties smart constructor.

Instances

reportFloodlightCriteriaReportProperties :: ReportFloodlightCriteriaReportProperties Source

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

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

rfcrpIncludeUnattributedIPConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) Source

Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.

rfcrpIncludeUnattributedCookieConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) Source

Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.

rfcrpIncludeAttributedIPConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) Source

Include conversions that have no cookie, but do have an exposure path.

FloodlightActivityGroup

data FloodlightActivityGroup Source

Contains properties of a Floodlight activity group.

See: floodlightActivityGroup smart constructor.

Instances

floodlightActivityGroup :: FloodlightActivityGroup Source

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

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

fagTagString :: Lens' FloodlightActivityGroup (Maybe Text) Source

Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.

fagFloodlightConfigurationId :: Lens' FloodlightActivityGroup (Maybe Int64) Source

Floodlight configuration ID of this floodlight activity group. This is a required field.

fagKind :: Lens' FloodlightActivityGroup Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".

fagAdvertiserId :: Lens' FloodlightActivityGroup (Maybe Int64) Source

Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.

fagAdvertiserIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

fagIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) Source

Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.

fagAccountId :: Lens' FloodlightActivityGroup (Maybe Int64) Source

Account ID of this floodlight activity group. This is a read-only field that can be left blank.

fagName :: Lens' FloodlightActivityGroup (Maybe Text) Source

Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.

fagId :: Lens' FloodlightActivityGroup (Maybe Int64) Source

ID of this floodlight activity group. This is a read-only, auto-generated field.

fagSubAccountId :: Lens' FloodlightActivityGroup (Maybe Int64) Source

Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.

fagType :: Lens' FloodlightActivityGroup (Maybe FloodlightActivityGroupType) Source

Type of the floodlight activity group. This is a required field that is read-only after insertion.

fagFloodlightConfigurationIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) Source

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

AdsListCompatibility

data AdsListCompatibility Source

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_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.

Constructors

ALCApp
APP
ALCAppInterstitial
APP_INTERSTITIAL
ALCInStreamVideo
IN_STREAM_VIDEO
ALCWeb
WEB
ALCWebInterstitial
WEB_INTERSTITIAL

Instances

CrossDimensionReachReportCompatibleFields

data CrossDimensionReachReportCompatibleFields Source

Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".

See: crossDimensionReachReportCompatibleFields smart constructor.

Instances

crossDimensionReachReportCompatibleFields :: CrossDimensionReachReportCompatibleFields Source

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

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

cdrrcfMetrics :: Lens' CrossDimensionReachReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected in the "metricNames" section of the report.

cdrrcfBreakdown :: Lens' CrossDimensionReachReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "breakdown" section of the report.

cdrrcfKind :: Lens' CrossDimensionReachReportCompatibleFields Text Source

The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.

cdrrcfDimensionFilters :: Lens' CrossDimensionReachReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

cdrrcfOverlapMetrics :: Lens' CrossDimensionReachReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.

FsCommand

data FsCommand Source

FsCommand.

See: fsCommand smart constructor.

Instances

fsCommand :: FsCommand Source

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

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

fcPositionOption :: Lens' FsCommand (Maybe FsCommandPositionOption) Source

Position in the browser where the window will open.

fcLeft :: Lens' FsCommand (Maybe Int32) Source

Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.

fcWindowHeight :: Lens' FsCommand (Maybe Int32) Source

Height of the window.

fcWindowWidth :: Lens' FsCommand (Maybe Int32) Source

Width of the window.

fcTop :: Lens' FsCommand (Maybe Int32) Source

Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.

PlacementAssignment

data PlacementAssignment Source

Placement Assignment.

See: placementAssignment smart constructor.

Instances

placementAssignment :: PlacementAssignment Source

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

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

paPlacementId :: Lens' PlacementAssignment (Maybe Int64) Source

ID of the placement to be assigned. This is a required field.

paPlacementIdDimensionValue :: Lens' PlacementAssignment (Maybe DimensionValue) Source

Dimension value for the ID of the placement. This is a read-only, auto-generated field.

paActive :: Lens' PlacementAssignment (Maybe Bool) Source

Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.

paSSLRequired :: Lens' PlacementAssignment (Maybe Bool) Source

Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.

CreativeFieldValue

data CreativeFieldValue Source

Contains properties of a creative field value.

See: creativeFieldValue smart constructor.

Instances

creativeFieldValue :: CreativeFieldValue Source

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

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

cfvKind :: Lens' CreativeFieldValue Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".

cfvValue :: Lens' CreativeFieldValue (Maybe Text) Source

Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.

cfvId :: Lens' CreativeFieldValue (Maybe Int64) Source

ID of this creative field value. This is a read-only, auto-generated field.

EventTagStatus

data EventTagStatus Source

Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.

Constructors

Disabled
DISABLED
Enabled
ENABLED

Instances

SitesListSortField

data SitesListSortField Source

Field by which to sort the list.

Constructors

SLSFID
ID
SLSFName
NAME

Instances

DimensionValueRequest

data DimensionValueRequest Source

Represents a DimensionValuesRequest.

See: dimensionValueRequest smart constructor.

Instances

dimensionValueRequest :: DimensionValueRequest Source

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

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

dvrKind :: Lens' DimensionValueRequest Text Source

The kind of request this is, in this case dfareporting#dimensionValueRequest.

dvrEndDate :: Lens' DimensionValueRequest (Maybe Day) Source

The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".

dvrFilters :: Lens' DimensionValueRequest [DimensionFilter] Source

The list of filters by which to filter values. The filters are ANDed.

dvrStartDate :: Lens' DimensionValueRequest (Maybe Day) Source

The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".

dvrDimensionName :: Lens' DimensionValueRequest (Maybe Text) Source

The name of the dimension for which values should be requested.

EventTagsListEventTagTypes

data EventTagsListEventTagTypes Source

Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.

Constructors

ClickThroughEventTag
CLICK_THROUGH_EVENT_TAG
ImpressionImageEventTag
IMPRESSION_IMAGE_EVENT_TAG
ImpressionJavascriptEventTag
IMPRESSION_JAVASCRIPT_EVENT_TAG

Instances

FloodlightConfigurationsListResponse

data FloodlightConfigurationsListResponse Source

Floodlight Configuration List Response

See: floodlightConfigurationsListResponse smart constructor.

Instances

floodlightConfigurationsListResponse :: FloodlightConfigurationsListResponse Source

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

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

fclrKind :: Lens' FloodlightConfigurationsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".

fclrFloodlightConfigurations :: Lens' FloodlightConfigurationsListResponse [FloodlightConfiguration] Source

Floodlight configuration collection.

FloodlightActivitiesListResponse

data FloodlightActivitiesListResponse Source

Floodlight Activity List Response

See: floodlightActivitiesListResponse smart constructor.

Instances

floodlightActivitiesListResponse :: FloodlightActivitiesListResponse Source

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

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

falrNextPageToken :: Lens' FloodlightActivitiesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

falrKind :: Lens' FloodlightActivitiesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".

falrFloodlightActivities :: Lens' FloodlightActivitiesListResponse [FloodlightActivity] Source

Floodlight activity collection.

FileStatus

data FileStatus Source

The status of the report file.

Constructors

Cancelled
CANCELLED
Failed
FAILED
Processing
PROCESSING
ReportAvailable
REPORT_AVAILABLE

Instances

CreativeCustomEventArtworkType

data CreativeCustomEventArtworkType Source

Artwork type used by the creative.This is a read-only field.

Constructors

ArtworkTypeFlash
ARTWORK_TYPE_FLASH
ArtworkTypeHTML5
ARTWORK_TYPE_HTML5
ArtworkTypeMixed
ARTWORK_TYPE_MIXED

Instances

CreativeFieldAssignment

data CreativeFieldAssignment Source

Creative Field Assignment.

See: creativeFieldAssignment smart constructor.

Instances

creativeFieldAssignment :: CreativeFieldAssignment Source

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

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

cfaCreativeFieldId :: Lens' CreativeFieldAssignment (Maybe Int64) Source

ID of the creative field.

cfaCreativeFieldValueId :: Lens' CreativeFieldAssignment (Maybe Int64) Source

ID of the creative field value.

AdvertiserGroup

data AdvertiserGroup Source

Groups advertisers together so that reports can be generated for the entire group at once.

See: advertiserGroup smart constructor.

Instances

advertiserGroup :: AdvertiserGroup Source

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

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

agKind :: Lens' AdvertiserGroup Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".

agAccountId :: Lens' AdvertiserGroup (Maybe Int64) Source

Account ID of this advertiser group. This is a read-only field that can be left blank.

agName :: Lens' AdvertiserGroup (Maybe Text) Source

Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.

agId :: Lens' AdvertiserGroup (Maybe Int64) Source

ID of this advertiser group. This is a read-only, auto-generated field.

TagData

data TagData Source

Placement Tag Data

See: tagData smart constructor.

Instances

tagData :: TagData Source

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

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

tdClickTag :: Lens' TagData (Maybe Text) Source

Tag string to record a click.

tdFormat :: Lens' TagData (Maybe TagDataFormat) Source

TagData tag format of this tag.

tdCreativeId :: Lens' TagData (Maybe Int64) Source

Creative associated with this placement tag.

tdAdId :: Lens' TagData (Maybe Int64) Source

Ad associated with this placement tag.

tdImpressionTag :: Lens' TagData (Maybe Text) Source

Tag string for serving an ad.

DayPartTargeting

data DayPartTargeting Source

Day Part Targeting.

See: dayPartTargeting smart constructor.

Instances

dayPartTargeting :: DayPartTargeting Source

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

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

dptDaysOfWeek :: Lens' DayPartTargeting [DayPartTargetingDaysOfWeekItem] Source

Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"

dptHoursOfDay :: Lens' DayPartTargeting [Int32] Source

Hours of the day when the ad will serve. Must be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example, if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm.

dptUserLocalTime :: Lens' DayPartTargeting (Maybe Bool) Source

Whether or not to use the user's local time. If false, the America/New York time zone applies.

CreativeOptimizationConfiguration

data CreativeOptimizationConfiguration Source

Creative optimization settings.

See: creativeOptimizationConfiguration smart constructor.

Instances

creativeOptimizationConfiguration :: CreativeOptimizationConfiguration Source

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

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

cocOptimizationModel :: Lens' CreativeOptimizationConfiguration (Maybe CreativeOptimizationConfigurationOptimizationModel) Source

Optimization model for this configuration.

cocName :: Lens' CreativeOptimizationConfiguration (Maybe Text) Source

Name of this creative optimization config. This is a required field and must be less than 129 characters long.

cocOptimizationActivitys :: Lens' CreativeOptimizationConfiguration [OptimizationActivity] Source

List of optimization activities associated with this configuration.

cocId :: Lens' CreativeOptimizationConfiguration (Maybe Int64) Source

ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.

ReportCriteria

data ReportCriteria Source

The report criteria for a report of type "STANDARD".

See: reportCriteria smart constructor.

Instances

reportCriteria :: ReportCriteria Source

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

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

rcMetricNames :: Lens' ReportCriteria [Text] Source

The list of names of metrics the report should include.

rcCustomRichMediaEvents :: Lens' ReportCriteria (Maybe CustomRichMediaEvents) Source

Custom Rich Media Events group.

rcDimensionFilters :: Lens' ReportCriteria [DimensionValue] Source

The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

rcActivities :: Lens' ReportCriteria (Maybe Activities) Source

Activity group.

rcDateRange :: Lens' ReportCriteria (Maybe DateRange) Source

The date range for which this report should be run.

rcDimensions :: Lens' ReportCriteria [SortedDimension] Source

The list of standard dimensions the report should include.

FloodlightConfigurationNATuralSearchConversionAttributionOption

data FloodlightConfigurationNATuralSearchConversionAttributionOption Source

Types of attribution options for natural search conversions.

Constructors

ExcludeNATuralSearchConversionAttribution
EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION
IncludeNATuralSearchConversionAttribution
INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION
IncludeNATuralSearchTieredConversionAttribution
INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION

Instances

PlacementStrategiesListResponse

data PlacementStrategiesListResponse Source

Placement Strategy List Response

See: placementStrategiesListResponse smart constructor.

Instances

placementStrategiesListResponse :: PlacementStrategiesListResponse Source

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

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

pslrPlacementStrategies :: Lens' PlacementStrategiesListResponse [PlacementStrategy] Source

Placement strategy collection.

pslrNextPageToken :: Lens' PlacementStrategiesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

pslrKind :: Lens' PlacementStrategiesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".

CreativeAssetArtworkType

data CreativeAssetArtworkType Source

Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

Constructors

CAATArtworkTypeFlash
ARTWORK_TYPE_FLASH
CAATArtworkTypeHTML5
ARTWORK_TYPE_HTML5
CAATArtworkTypeMixed
ARTWORK_TYPE_MIXED

Instances

SubAccount

data SubAccount Source

Contains properties of a DCM subaccount.

See: subAccount smart constructor.

Instances

subAccount :: SubAccount Source

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

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

saKind :: Lens' SubAccount Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".

saAvailablePermissionIds :: Lens' SubAccount [Int64] Source

IDs of the available user role permissions for this subaccount.

saAccountId :: Lens' SubAccount (Maybe Int64) Source

ID of the account that contains this subaccount. This is a read-only field that can be left blank.

saName :: Lens' SubAccount (Maybe Text) Source

Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.

saId :: Lens' SubAccount (Maybe Int64) Source

ID of this subaccount. This is a read-only, auto-generated field.

InventoryItemsListResponse

data InventoryItemsListResponse Source

Inventory item List Response

See: inventoryItemsListResponse smart constructor.

Instances

inventoryItemsListResponse :: InventoryItemsListResponse Source

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

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

iilrInventoryItems :: Lens' InventoryItemsListResponse [InventoryItem] Source

Inventory item collection

iilrNextPageToken :: Lens' InventoryItemsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

iilrKind :: Lens' InventoryItemsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".

Ad

data Ad Source

Contains properties of a DCM ad.

See: ad smart constructor.

Instances

ad :: Ad Source

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

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

aCreativeGroupAssignments :: Lens' Ad [CreativeGroupAssignment] Source

Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.

aGeoTargeting :: Lens' Ad (Maybe GeoTargeting) Source

Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.

aCreativeRotation :: Lens' Ad (Maybe CreativeRotation) Source

Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.

aTechnologyTargeting :: Lens' Ad (Maybe TechnologyTargeting) Source

Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.

aAudienceSegmentId :: Lens' Ad (Maybe Int64) Source

Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.

aDayPartTargeting :: Lens' Ad (Maybe DayPartTargeting) Source

Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.

aSize :: Lens' Ad (Maybe Size) Source

Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.

aStartTime :: Lens' Ad (Maybe UTCTime) Source

Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.

aKind :: Lens' Ad Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".

aClickThroughURLSuffixProperties :: Lens' Ad (Maybe ClickThroughURLSuffixProperties) Source

Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.

aCampaignIdDimensionValue :: Lens' Ad (Maybe DimensionValue) Source

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

aAdvertiserId :: Lens' Ad (Maybe Int64) Source

Advertiser ID of this ad. This is a required field on insertion.

aAdvertiserIdDimensionValue :: Lens' Ad (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

aSSLCompliant :: Lens' Ad (Maybe Bool) Source

Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.

aCampaignId :: Lens' Ad (Maybe Int64) Source

Campaign ID of this ad. This is a required field on insertion.

aIdDimensionValue :: Lens' Ad (Maybe DimensionValue) Source

Dimension value for the ID of this ad. This is a read-only, auto-generated field.

aClickThroughURL :: Lens' Ad (Maybe ClickThroughURL) Source

Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.

aDeliverySchedule :: Lens' Ad (Maybe DeliverySchedule) Source

Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.

aEventTagOverrides :: Lens' Ad [EventTagOverride] Source

Event tag overrides for this ad.

aActive :: Lens' Ad (Maybe Bool) Source

Whether this ad is active.

aAccountId :: Lens' Ad (Maybe Int64) Source

Account ID of this ad. This is a read-only field that can be left blank.

aName :: Lens' Ad (Maybe Text) Source

Name of this ad. This is a required field and must be less than 256 characters long.

aKeyValueTargetingExpression :: Lens' Ad (Maybe KeyValueTargetingExpression) Source

Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.

aEndTime :: Lens' Ad (Maybe UTCTime) Source

Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.

aCreateInfo :: Lens' Ad (Maybe LastModifiedInfo) Source

Information about the creation of this ad.This is a read-only field.

aLastModifiedInfo :: Lens' Ad (Maybe LastModifiedInfo) Source

Information about the most recent modification of this ad. This is a read-only field.

aId :: Lens' Ad (Maybe Int64) Source

ID of this ad. This is a read-only, auto-generated field.

aSSLRequired :: Lens' Ad (Maybe Bool) Source

Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.

aComments :: Lens' Ad (Maybe Text) Source

Comments for this ad.

aSubAccountId :: Lens' Ad (Maybe Int64) Source

Subaccount ID of this ad. This is a read-only field that can be left blank.

aType :: Lens' Ad (Maybe AdType) Source

Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).

aRemarketingListExpression :: Lens' Ad (Maybe ListTargetingExpression) Source

Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.

aDynamicClickTracker :: Lens' Ad (Maybe Bool) Source

Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.

aCompatibility :: Lens' Ad (Maybe AdCompatibility) Source

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_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.

aArchived :: Lens' Ad (Maybe Bool) Source

Whether this ad is archived.

aDefaultClickThroughEventTagProperties :: Lens' Ad (Maybe DefaultClickThroughEventTagProperties) Source

Default click-through event tag properties for this ad.

aPlacementAssignments :: Lens' Ad [PlacementAssignment] Source

Placement assignments for this ad.

FloodlightActivitiesListSortOrder

data FloodlightActivitiesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

FALSOAscending
ASCENDING
FALSODescending
DESCENDING

Instances

Project

data Project Source

Contains properties of a DoubleClick Planning project.

See: project smart constructor.

Instances

project :: Project Source

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

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

pTargetClicks :: Lens' Project (Maybe Int64) Source

Number of clicks that the advertiser is targeting.

pClientBillingCode :: Lens' Project (Maybe Text) Source

Client billing code of this project.

pTargetCpmNanos :: Lens' Project (Maybe Int64) Source

CPM that the advertiser is targeting.

pTargetConversions :: Lens' Project (Maybe Int64) Source

Number of conversions that the advertiser is targeting.

pBudget :: Lens' Project (Maybe Int64) Source

Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.

pKind :: Lens' Project Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".

pAdvertiserId :: Lens' Project (Maybe Int64) Source

Advertiser ID of this project.

pEndDate :: Lens' Project (Maybe Day) Source

End date of the project.

pOverview :: Lens' Project (Maybe Text) Source

Overview of this project.

pTargetImpressions :: Lens' Project (Maybe Int64) Source

Number of impressions that the advertiser is targeting.

pStartDate :: Lens' Project (Maybe Day) Source

Start date of the project.

pTargetCpcNanos :: Lens' Project (Maybe Int64) Source

CPC that the advertiser is targeting.

pAccountId :: Lens' Project (Maybe Int64) Source

Account ID of this project.

pName :: Lens' Project (Maybe Text) Source

Name of this project.

pLastModifiedInfo :: Lens' Project (Maybe LastModifiedInfo) Source

Information about the most recent modification of this project.

pId :: Lens' Project (Maybe Int64) Source

ID of this project. This is a read-only, auto-generated field.

pAudienceAgeGroup :: Lens' Project (Maybe ProjectAudienceAgeGroup) Source

Audience age group of this project.

pSubAccountId :: Lens' Project (Maybe Int64) Source

Subaccount ID of this project.

pAudienceGender :: Lens' Project (Maybe ProjectAudienceGender) Source

Audience gender of this project.

pClientName :: Lens' Project (Maybe Text) Source

Name of the project client.

pTargetCpaNanos :: Lens' Project (Maybe Int64) Source

CPA that the advertiser is targeting.

FileFormat

data FileFormat Source

The output format of the report. Only available once the file is available.

Constructors

CSV
CSV
Excel
EXCEL

Instances

PricingSchedulePricingType

data PricingSchedulePricingType Source

Placement pricing type. This field is required on insertion.

Constructors

PricingTypeCpa
PRICING_TYPE_CPA
PricingTypeCpc
PRICING_TYPE_CPC
PricingTypeCpm
PRICING_TYPE_CPM
PricingTypeFlatRateClicks
PRICING_TYPE_FLAT_RATE_CLICKS
PricingTypeFlatRateImpressions
PRICING_TYPE_FLAT_RATE_IMPRESSIONS

Instances

ReportFloodlightCriteria

data ReportFloodlightCriteria Source

The report criteria for a report of type "FLOODLIGHT".

See: reportFloodlightCriteria smart constructor.

Instances

reportFloodlightCriteria :: ReportFloodlightCriteria Source

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

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

rfcReportProperties :: Lens' ReportFloodlightCriteria (Maybe ReportFloodlightCriteriaReportProperties) Source

The properties of the report.

rfcMetricNames :: Lens' ReportFloodlightCriteria [Text] Source

The list of names of metrics the report should include.

rfcCustomRichMediaEvents :: Lens' ReportFloodlightCriteria [DimensionValue] Source

The list of custom rich media events to include.

rfcDimensionFilters :: Lens' ReportFloodlightCriteria [DimensionValue] Source

The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

rfcDateRange :: Lens' ReportFloodlightCriteria (Maybe DateRange) Source

The date range this report should be run for.

rfcFloodlightConfigId :: Lens' ReportFloodlightCriteria (Maybe DimensionValue) Source

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

rfcDimensions :: Lens' ReportFloodlightCriteria [SortedDimension] Source

The list of dimensions the report should include.

CreativeCustomEventTargetType

data CreativeCustomEventTargetType Source

Target type used by the event.

Constructors

TargetBlank
TARGET_BLANK
TargetParent
TARGET_PARENT
TargetPopup
TARGET_POPUP
TargetSelf
TARGET_SELF
TargetTop
TARGET_TOP

Instances

ReportsListScope

data ReportsListScope Source

The scope that defines which results are returned, default is 'MINE'.

Constructors

All

ALL All reports in account.

Mine

MINE My reports.

Instances

Size

data Size Source

Represents the dimensions of ads, placements, creatives, or creative assets.

See: size smart constructor.

Instances

size :: Size Source

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

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

sHeight :: Lens' Size (Maybe Int32) Source

Height of this size.

sKind :: Lens' Size Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".

sWidth :: Lens' Size (Maybe Int32) Source

Width of this size.

sIab :: Lens' Size (Maybe Bool) Source

IAB standard size. This is a read-only, auto-generated field.

sId :: Lens' Size (Maybe Int64) Source

ID of this size. This is a read-only, auto-generated field.

CreativeAssetDurationType

data CreativeAssetDurationType Source

Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.

Constructors

AssetDurationTypeAuto
ASSET_DURATION_TYPE_AUTO
AssetDurationTypeCustom
ASSET_DURATION_TYPE_CUSTOM
AssetDurationTypeNone
ASSET_DURATION_TYPE_NONE

Instances

TargetableRemarketingListListSource

data TargetableRemarketingListListSource Source

Product from which this targetable remarketing list was originated.

Constructors

RemarketingListSourceDBm
REMARKETING_LIST_SOURCE_DBM
RemarketingListSourceDfa
REMARKETING_LIST_SOURCE_DFA
RemarketingListSourceDmp
REMARKETING_LIST_SOURCE_DMP
RemarketingListSourceGa
REMARKETING_LIST_SOURCE_GA
RemarketingListSourceOther
REMARKETING_LIST_SOURCE_OTHER

Instances

ObjectFilter

data ObjectFilter Source

Object Filter.

See: objectFilter smart constructor.

Instances

objectFilter :: ObjectFilter Source

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

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

ofStatus :: Lens' ObjectFilter (Maybe ObjectFilterStatus) Source

Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.

ofKind :: Lens' ObjectFilter Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".

ofObjectIds :: Lens' ObjectFilter [Int64] Source

Applicable when status is ASSIGNED. The user has access to objects with these object IDs.

CreativeGroupsListSortField

data CreativeGroupsListSortField Source

Field by which to sort the list.

Constructors

CGLSFID
ID
CGLSFName
NAME

Instances

ReportsConfiguration

data ReportsConfiguration Source

Reporting Configuration

See: reportsConfiguration smart constructor.

Instances

reportsConfiguration :: ReportsConfiguration Source

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

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

rcExposureToConversionEnabled :: Lens' ReportsConfiguration (Maybe Bool) Source

Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.

rcReportGenerationTimeZoneId :: Lens' ReportsConfiguration (Maybe Int64) Source

Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo"

rcLookbackConfiguration :: Lens' ReportsConfiguration (Maybe LookbackConfiguration) Source

Default lookback windows for new advertisers in this account.

PricingSchedule

data PricingSchedule Source

Pricing Schedule

See: pricingSchedule smart constructor.

Instances

pricingSchedule :: PricingSchedule Source

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

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

psTestingStartDate :: Lens' PricingSchedule (Maybe Day) Source

Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.

psFloodlightActivityId :: Lens' PricingSchedule (Maybe Int64) Source

Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.

psEndDate :: Lens' PricingSchedule (Maybe Day) Source

Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.

psDisregardOverdelivery :: Lens' PricingSchedule (Maybe Bool) Source

Whether cap costs are ignored by ad serving.

psStartDate :: Lens' PricingSchedule (Maybe Day) Source

Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.

psCapCostOption :: Lens' PricingSchedule (Maybe PricingScheduleCapCostOption) Source

Placement cap cost option.

psPricingType :: Lens' PricingSchedule (Maybe PricingSchedulePricingType) Source

Placement pricing type. This field is required on insertion.

psPricingPeriods :: Lens' PricingSchedule [PricingSchedulePricingPeriod] Source

Pricing periods for this placement.

psFlighted :: Lens' PricingSchedule (Maybe Bool) Source

Whether this placement is flighted. If true, pricing periods will be computed automatically.

PostalCode

data PostalCode Source

Contains information about a postal code that can be targeted by ads.

See: postalCode smart constructor.

Instances

postalCode :: PostalCode Source

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

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

pcKind :: Lens' PostalCode Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".

pcCode :: Lens' PostalCode (Maybe Text) Source

Postal code. This is equivalent to the id field.

pcCountryCode :: Lens' PostalCode (Maybe Text) Source

Country code of the country to which this postal code belongs.

pcId :: Lens' PostalCode (Maybe Text) Source

ID of this postal code.

pcCountryDartId :: Lens' PostalCode (Maybe Int64) Source

DART ID of the country to which this postal code belongs.

AccountPermissionsListResponse

data AccountPermissionsListResponse Source

Account Permission List Response

See: accountPermissionsListResponse smart constructor.

Instances

accountPermissionsListResponse :: AccountPermissionsListResponse Source

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

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

aplrKind :: Lens' AccountPermissionsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".

aplrAccountPermissions :: Lens' AccountPermissionsListResponse [AccountPermission] Source

Account permission collection.

Country

data Country Source

Contains information about a country that can be targeted by ads.

See: country smart constructor.

Instances

country :: Country Source

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

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

cKind :: Lens' Country Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".

cName :: Lens' Country (Maybe Text) Source

Name of this country.

cCountryCode :: Lens' Country (Maybe Text) Source

Country code.

cDartId :: Lens' Country (Maybe Int64) Source

DART ID of this country. This is the ID used for targeting and generating reports.

cSSLEnabled :: Lens' Country (Maybe Bool) Source

Whether ad serving supports secure servers in this country.

PlacementsListSortField

data PlacementsListSortField Source

Field by which to sort the list.

Constructors

PLSFID
ID
PLSFName
NAME

Instances

CreativeBackupImageFeaturesItem

data CreativeBackupImageFeaturesItem Source

Constructors

CBIFIApplicationCache
APPLICATION_CACHE
CBIFIAudio
AUDIO
CBIFICanvas
CANVAS
CBIFICanvasText
CANVAS_TEXT
CBIFICssAnimations
CSS_ANIMATIONS
CBIFICssBackgRoundSize
CSS_BACKGROUND_SIZE
CBIFICssBOrderImage
CSS_BORDER_IMAGE
CBIFICssBOrderRadius
CSS_BORDER_RADIUS
CBIFICssBoxShadow
CSS_BOX_SHADOW
CBIFICssColumns
CSS_COLUMNS
CBIFICssFlexBox
CSS_FLEX_BOX
CBIFICssFontFace
CSS_FONT_FACE
CBIFICssGeneratedContent
CSS_GENERATED_CONTENT
CBIFICssGradients
CSS_GRADIENTS
CBIFICssHsla
CSS_HSLA
CBIFICssMultipleBgs
CSS_MULTIPLE_BGS
CBIFICssOpacity
CSS_OPACITY
CBIFICssReflections
CSS_REFLECTIONS
CBIFICssRgba
CSS_RGBA
CBIFICssTextShadow
CSS_TEXT_SHADOW
CBIFICssTransforms
CSS_TRANSFORMS
CBIFICssTRANSFORMS3D
CSS_TRANSFORMS3D
CBIFICssTransitions
CSS_TRANSITIONS
CBIFIDragAndDrop
DRAG_AND_DROP
CBIFIGeoLocation
GEO_LOCATION
CBIFIHashChange
HASH_CHANGE
CBIFIHistory
HISTORY
CBIFIIndexedDB
INDEXED_DB
CBIFIInlineSvg
INLINE_SVG
CBIFIInputAttrAutocomplete
INPUT_ATTR_AUTOCOMPLETE
CBIFIInputAttrAutofocus
INPUT_ATTR_AUTOFOCUS
CBIFIInputAttrList
INPUT_ATTR_LIST
CBIFIInputAttrMax
INPUT_ATTR_MAX
CBIFIInputAttrMin
INPUT_ATTR_MIN
CBIFIInputAttrMultiple
INPUT_ATTR_MULTIPLE
CBIFIInputAttrPattern
INPUT_ATTR_PATTERN
CBIFIInputAttrPlaceholder
INPUT_ATTR_PLACEHOLDER
CBIFIInputAttrRequired
INPUT_ATTR_REQUIRED
CBIFIInputAttrStep
INPUT_ATTR_STEP
CBIFIInputTypeColor
INPUT_TYPE_COLOR
CBIFIInputTypeDate
INPUT_TYPE_DATE
CBIFIInputTypeDatetime
INPUT_TYPE_DATETIME
CBIFIInputTypeDatetimeLocal
INPUT_TYPE_DATETIME_LOCAL
CBIFIInputTypeEmail
INPUT_TYPE_EMAIL
CBIFIInputTypeMonth
INPUT_TYPE_MONTH
CBIFIInputTypeNumber
INPUT_TYPE_NUMBER
CBIFIInputTypeRange
INPUT_TYPE_RANGE
CBIFIInputTypeSearch
INPUT_TYPE_SEARCH
CBIFIInputTypeTel
INPUT_TYPE_TEL
CBIFIInputTypeTime
INPUT_TYPE_TIME
CBIFIInputTypeURL
INPUT_TYPE_URL
CBIFIInputTypeWeek
INPUT_TYPE_WEEK
CBIFILocalStorage
LOCAL_STORAGE
CBIFIPostMessage
POST_MESSAGE
CBIFISessionStorage
SESSION_STORAGE
CBIFISmil
SMIL
CBIFISvgClipPaths
SVG_CLIP_PATHS
CBIFISvgFeImage
SVG_FE_IMAGE
CBIFISvgFilters
SVG_FILTERS
CBIFISvgHref
SVG_HREF
CBIFITouch
TOUCH
CBIFIVideo
VIDEO
CBIFIWebgl
WEBGL
CBIFIWebSockets
WEB_SOCKETS
CBIFIWebSQLDatabase
WEB_SQL_DATABASE
CBIFIWebWorkers
WEB_WORKERS

Instances

OperatingSystemVersionsListResponse

data OperatingSystemVersionsListResponse Source

Operating System Version List Response

See: operatingSystemVersionsListResponse smart constructor.

Instances

operatingSystemVersionsListResponse :: OperatingSystemVersionsListResponse Source

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

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

osvlrKind :: Lens' OperatingSystemVersionsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".

osvlrOperatingSystemVersions :: Lens' OperatingSystemVersionsListResponse [OperatingSystemVersion] Source

Operating system version collection.

ClickThroughURLSuffixProperties

data ClickThroughURLSuffixProperties Source

Click Through URL Suffix settings.

See: clickThroughURLSuffixProperties smart constructor.

Instances

clickThroughURLSuffixProperties :: ClickThroughURLSuffixProperties Source

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

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

ctuspOverrideInheritedSuffix :: Lens' ClickThroughURLSuffixProperties (Maybe Bool) Source

Whether this entity should override the inherited click-through URL suffix with its own defined value.

ctuspClickThroughURLSuffix :: Lens' ClickThroughURLSuffixProperties (Maybe Text) Source

Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.

AdvertisersListSortOrder

data AdvertisersListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

ALSOAscending
ASCENDING
ALSODescending
DESCENDING

Instances

CreativeFieldsListSortField

data CreativeFieldsListSortField Source

Field by which to sort the list.

Constructors

CFLSFID
ID
CFLSFName
NAME

Instances

Pricing

data Pricing Source

Pricing Information

See: pricing smart constructor.

Instances

pricing :: Pricing Source

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

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

priEndDate :: Lens' Pricing (Maybe Day) Source

End date of this inventory item.

priStartDate :: Lens' Pricing (Maybe Day) Source

Start date of this inventory item.

priGroupType :: Lens' Pricing (Maybe PricingGroupType) Source

Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.

priPricingType :: Lens' Pricing (Maybe PricingPricingType) Source

Pricing type of this inventory item.

priFlights :: Lens' Pricing [Flight] Source

Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.

priCapCostType :: Lens' Pricing (Maybe PricingCapCostType) Source

Cap cost type of this inventory item.

AudienceSegmentGroup

data AudienceSegmentGroup Source

Audience Segment Group.

See: audienceSegmentGroup smart constructor.

Instances

audienceSegmentGroup :: AudienceSegmentGroup Source

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

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

asgAudienceSegments :: Lens' AudienceSegmentGroup [AudienceSegment] Source

Audience segments assigned to this group. The number of segments must be between 2 and 100.

asgName :: Lens' AudienceSegmentGroup (Maybe Text) Source

Name of this audience segment group. This is a required field and must be less than 65 characters long.

asgId :: Lens' AudienceSegmentGroup (Maybe Int64) Source

ID of this audience segment group. This is a read-only, auto-generated field.

OperatingSystem

data OperatingSystem Source

Contains information about an operating system that can be targeted by ads.

See: operatingSystem smart constructor.

Instances

operatingSystem :: OperatingSystem Source

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

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

osDesktop :: Lens' OperatingSystem (Maybe Bool) Source

Whether this operating system is for desktop.

osKind :: Lens' OperatingSystem Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".

osName :: Lens' OperatingSystem (Maybe Text) Source

Name of this operating system.

osMobile :: Lens' OperatingSystem (Maybe Bool) Source

Whether this operating system is for mobile.

osDartId :: Lens' OperatingSystem (Maybe Int64) Source

DART ID of this operating system. This is the ID used for targeting.

Flight

data Flight Source

Flight

See: flight smart constructor.

Instances

flight :: Flight Source

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

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

fRateOrCost :: Lens' Flight (Maybe Int64) Source

Rate or cost of this flight.

fEndDate :: Lens' Flight (Maybe Day) Source

Inventory item flight end date.

fStartDate :: Lens' Flight (Maybe Day) Source

Inventory item flight start date.

fUnits :: Lens' Flight (Maybe Int64) Source

Units of this flight.

UserDefinedVariableConfigurationVariableType

data UserDefinedVariableConfigurationVariableType Source

Variable name in the tag. This is a required field.

Constructors

U1
U1
U10
U10
U11
U11
U12
U12
U13
U13
U14
U14
U15
U15
U16
U16
U17
U17
U18
U18
U19
U19
U2
U2
U20
U20
U3
U3
U4
U4
U5
U5
U6
U6
U7
U7
U8
U8
U9
U9

Instances

FsCommandPositionOption

data FsCommandPositionOption Source

Position in the browser where the window will open.

Constructors

Centered
CENTERED
DistanceFromTopLeftCorner
DISTANCE_FROM_TOP_LEFT_CORNER

Instances

CitiesListResponse

data CitiesListResponse Source

City List Response

See: citiesListResponse smart constructor.

Instances

citiesListResponse :: CitiesListResponse Source

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

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

citKind :: Lens' CitiesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".

citCities :: Lens' CitiesListResponse [City] Source

City collection.

Dimension

data Dimension Source

Represents a dimension.

See: dimension smart constructor.

Instances

dimension :: Dimension Source

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

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

dKind :: Lens' Dimension Text Source

The kind of resource this is, in this case dfareporting#dimension.

dName :: Lens' Dimension (Maybe Text) Source

The dimension name, e.g. dfa:advertiser

ReportReachCriteria

data ReportReachCriteria Source

The report criteria for a report of type "REACH".

See: reportReachCriteria smart constructor.

Instances

reportReachCriteria :: ReportReachCriteria Source

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

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

rrcReachByFrequencyMetricNames :: Lens' ReportReachCriteria [Text] Source

The list of names of Reach By Frequency metrics the report should include.

rrcEnableAllDimensionCombinations :: Lens' ReportReachCriteria (Maybe Bool) Source

Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months.

rrcMetricNames :: Lens' ReportReachCriteria [Text] Source

The list of names of metrics the report should include.

rrcCustomRichMediaEvents :: Lens' ReportReachCriteria (Maybe CustomRichMediaEvents) Source

Custom Rich Media Events group.

rrcDimensionFilters :: Lens' ReportReachCriteria [DimensionValue] Source

The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

rrcActivities :: Lens' ReportReachCriteria (Maybe Activities) Source

Activity group.

rrcDateRange :: Lens' ReportReachCriteria (Maybe DateRange) Source

The date range this report should be run for.

rrcDimensions :: Lens' ReportReachCriteria [SortedDimension] Source

The list of dimensions the report should include.

CustomRichMediaEvents

data CustomRichMediaEvents Source

Represents a Custom Rich Media Events group.

See: customRichMediaEvents smart constructor.

Instances

customRichMediaEvents :: CustomRichMediaEvents Source

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

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

crmeKind :: Lens' CustomRichMediaEvents Text Source

The kind of resource this is, in this case dfareporting#customRichMediaEvents.

crmeFilteredEventIds :: Lens' CustomRichMediaEvents [DimensionValue] Source

List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.

UserRolesListSortOrder

data UserRolesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

URLSOAscending
ASCENDING
URLSODescending
DESCENDING

Instances

PlacementsListCompatibilities

data PlacementsListCompatibilities Source

Select only placements that are associated with these compatibilities. WEB and WEB_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 in in-stream video ads developed with the VAST standard.

Constructors

PLCApp
APP
PLCAppInterstitial
APP_INTERSTITIAL
PLCInStreamVideo
IN_STREAM_VIDEO
PLCWeb
WEB
PLCWebInterstitial
WEB_INTERSTITIAL

Instances

TargetableRemarketingListsListResponse

data TargetableRemarketingListsListResponse Source

Targetable remarketing list response

See: targetableRemarketingListsListResponse smart constructor.

Instances

targetableRemarketingListsListResponse :: TargetableRemarketingListsListResponse Source

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

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

trllrNextPageToken :: Lens' TargetableRemarketingListsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

trllrKind :: Lens' TargetableRemarketingListsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".

trllrTargetableRemarketingLists :: Lens' TargetableRemarketingListsListResponse [TargetableRemarketingList] Source

Targetable remarketing list collection.

OrderDocumentsListSortField

data OrderDocumentsListSortField Source

Field by which to sort the list.

Constructors

ODLSFID
ID
ODLSFName
NAME

Instances

CreativeCompatibilityItem

data CreativeCompatibilityItem Source

Constructors

CCIApp
APP
CCIAppInterstitial
APP_INTERSTITIAL
CCIInStreamVideo
IN_STREAM_VIDEO
CCIWeb
WEB
CCIWebInterstitial
WEB_INTERSTITIAL

Instances

ChangeLogsListResponse

data ChangeLogsListResponse Source

Change Log List Response

See: changeLogsListResponse smart constructor.

Instances

changeLogsListResponse :: ChangeLogsListResponse Source

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

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

cllrNextPageToken :: Lens' ChangeLogsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

cllrKind :: Lens' ChangeLogsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".

cllrChangeLogs :: Lens' ChangeLogsListResponse [ChangeLog] Source

Change log collection.

ReportDeliveryEmailOwnerDeliveryType

data ReportDeliveryEmailOwnerDeliveryType Source

The type of delivery for the owner to receive, if enabled.

Constructors

RDEODTAttachment
ATTACHMENT
RDEODTLink
LINK

Instances

SiteContactContactType

data SiteContactContactType Source

Site contact type.

Constructors

SalesPerson
SALES_PERSON
Trafficker
TRAFFICKER

Instances

AccountUserProFile

data AccountUserProFile Source

AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.

See: accountUserProFile smart constructor.

Instances

accountUserProFile :: AccountUserProFile Source

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

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

aupfEmail :: Lens' AccountUserProFile (Maybe Text) Source

Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.

aupfUserRoleFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) Source

Filter that describes which user roles are visible to the user profile.

aupfAdvertiserFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) Source

Filter that describes which advertisers are visible to the user profile.

aupfUserRoleId :: Lens' AccountUserProFile (Maybe Int64) Source

User role ID of the user profile. This is a required field.

aupfKind :: Lens' AccountUserProFile Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".

aupfLocale :: Lens' AccountUserProFile (Maybe Text) Source

Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)

aupfSiteFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) Source

Filter that describes which sites are visible to the user profile.

aupfTraffickerType :: Lens' AccountUserProFile (Maybe AccountUserProFileTraffickerType) Source

Trafficker type of this user profile.

aupfActive :: Lens' AccountUserProFile (Maybe Bool) Source

Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.

aupfAccountId :: Lens' AccountUserProFile (Maybe Int64) Source

Account ID of the user profile. This is a read-only field that can be left blank.

aupfName :: Lens' AccountUserProFile (Maybe Text) Source

Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".

aupfId :: Lens' AccountUserProFile (Maybe Int64) Source

ID of the user profile. This is a read-only, auto-generated field.

aupfUserAccessType :: Lens' AccountUserProFile (Maybe AccountUserProFileUserAccessType) Source

User type of the user profile. This is a read-only field that can be left blank.

aupfComments :: Lens' AccountUserProFile (Maybe Text) Source

Comments for this user profile.

aupfSubAccountId :: Lens' AccountUserProFile (Maybe Int64) Source

Subaccount ID of the user profile. This is a read-only field that can be left blank.

aupfCampaignFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) Source

Filter that describes which campaigns are visible to the user profile.

ReportsListSortOrder

data ReportsListSortOrder Source

Order of sorted results, default is 'DESCENDING'.

Constructors

RLSOAscending

ASCENDING Ascending order.

RLSODescending

DESCENDING Descending order.

Instances

DimensionValue

data DimensionValue Source

Represents a DimensionValue resource.

See: dimensionValue smart constructor.

Instances

dimensionValue :: DimensionValue Source

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

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

dvEtag :: Lens' DimensionValue (Maybe Text) Source

The eTag of this response for caching purposes.

dvKind :: Lens' DimensionValue Text Source

The kind of resource this is, in this case dfareporting#dimensionValue.

dvValue :: Lens' DimensionValue (Maybe Text) Source

The value of the dimension.

dvMatchType :: Lens' DimensionValue (Maybe DimensionValueMatchType) Source

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.

dvDimensionName :: Lens' DimensionValue (Maybe Text) Source

The name of the dimension.

dvId :: Lens' DimensionValue (Maybe Text) Source

The ID associated with the value if available.

TargetableRemarketingListsListSortField

data TargetableRemarketingListsListSortField Source

Field by which to sort the list.

Constructors

TRLLSFID
ID
TRLLSFName
NAME

Instances

CampaignsListSortOrder

data CampaignsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

CLSOAscending
ASCENDING
CLSODescending
DESCENDING

Instances

Activities

data Activities Source

Represents an activity group.

See: activities smart constructor.

Instances

activities :: Activities Source

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

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

actKind :: Lens' Activities Text Source

The kind of resource this is, in this case dfareporting#activities.

actMetricNames :: Lens' Activities [Text] Source

List of names of floodlight activity metrics.

actFilters :: Lens' Activities [DimensionValue] Source

List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".

FloodlightActivityGroupsListType

data FloodlightActivityGroupsListType Source

Select only floodlight activity groups with the specified floodlight activity group type.

Constructors

Counter
COUNTER
Sale
SALE

Instances

FloodlightConfigurationFirstDayOfWeek

data FloodlightConfigurationFirstDayOfWeek Source

Day that will be counted as the first day of the week in reports. This is a required field.

Constructors

Monday
MONDAY
Sunday
SUNDAY

Instances

UserRolePermissionGroupsListResponse

data UserRolePermissionGroupsListResponse Source

User Role Permission Group List Response

See: userRolePermissionGroupsListResponse smart constructor.

Instances

userRolePermissionGroupsListResponse :: UserRolePermissionGroupsListResponse Source

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

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

urpglrUserRolePermissionGroups :: Lens' UserRolePermissionGroupsListResponse [UserRolePermissionGroup] Source

User role permission group collection.

urpglrKind :: Lens' UserRolePermissionGroupsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".

PlacementTag

data PlacementTag Source

Placement Tag

See: placementTag smart constructor.

Instances

placementTag :: PlacementTag Source

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

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

ptPlacementId :: Lens' PlacementTag (Maybe Int64) Source

Placement ID

ptTagDatas :: Lens' PlacementTag [TagData] Source

Tags generated for this placement.

DeliverySchedulePriority

data DeliverySchedulePriority Source

Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.

Constructors

AdPriority01
AD_PRIORITY_01
AdPriority02
AD_PRIORITY_02
AdPriority03
AD_PRIORITY_03
AdPriority04
AD_PRIORITY_04
AdPriority05
AD_PRIORITY_05
AdPriority06
AD_PRIORITY_06
AdPriority07
AD_PRIORITY_07
AdPriority08
AD_PRIORITY_08
AdPriority09
AD_PRIORITY_09
AdPriority10
AD_PRIORITY_10
AdPriority11
AD_PRIORITY_11
AdPriority12
AD_PRIORITY_12
AdPriority13
AD_PRIORITY_13
AdPriority14
AD_PRIORITY_14
AdPriority15
AD_PRIORITY_15
AdPriority16
AD_PRIORITY_16

Instances

FloodlightActivitiesListFloodlightActivityGroupType

data FloodlightActivitiesListFloodlightActivityGroupType Source

Select only floodlight activities with the specified floodlight activity group type.

Constructors

FALFAGTCounter
COUNTER
FALFAGTSale
SALE

Instances

RemarketingListsListResponse

data RemarketingListsListResponse Source

Remarketing list response

See: remarketingListsListResponse smart constructor.

Instances

remarketingListsListResponse :: RemarketingListsListResponse Source

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

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

rllrNextPageToken :: Lens' RemarketingListsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

rllrRemarketingLists :: Lens' RemarketingListsListResponse [RemarketingList] Source

Remarketing list collection.

rllrKind :: Lens' RemarketingListsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".

Creative

data Creative Source

Contains properties of a Creative.

See: creative smart constructor.

Instances

creative :: Creative Source

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

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

creConvertFlashToHTML5 :: Lens' Creative (Maybe Bool) Source

Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.

creBackupImageTargetWindow :: Lens' Creative (Maybe TargetWindow) Source

Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.

creRenderingIdDimensionValue :: Lens' Creative (Maybe DimensionValue) Source

Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.

creCustomKeyValues :: Lens' Creative [Text] Source

Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creVideoDuration :: Lens' Creative (Maybe Double) Source

Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.

creRenderingId :: Lens' Creative (Maybe Int64) Source

ID of current rendering version. This is a read-only field. Applicable to all creative types.

creThirdPartyBackupImageImpressionsURL :: Lens' Creative (Maybe Text) Source

Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA

creFsCommand :: Lens' Creative (Maybe FsCommand) Source

OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.

creAllowScriptAccess :: Lens' Creative (Maybe Bool) Source

Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.

creHTMLCodeLocked :: Lens' Creative (Maybe Bool) Source

Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.

creRequiredFlashPluginVersion :: Lens' Creative (Maybe Text) Source

The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creAuthoringTool :: Lens' Creative (Maybe CreativeAuthoringTool) Source

Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

creSize :: Lens' Creative (Maybe Size) Source

Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.

creThirdPartyURLs :: Lens' Creative [ThirdPartyTrackingURL] Source

Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

creCounterCustomEvents :: Lens' Creative [CreativeCustomEvent] Source

List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creKind :: Lens' Creative Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".

creSSLOverride :: Lens' Creative (Maybe Bool) Source

Whether creative should be treated as SSL compliant even if the system scan shows it's not.

creHTMLCode :: Lens' Creative (Maybe Text) Source

HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.

creAdvertiserId :: Lens' Creative (Maybe Int64) Source

Advertiser ID of this creative. This is a required field. Applicable to all creative types.

creRequiredFlashVersion :: Lens' Creative (Maybe Int32) Source

The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.

creBackgRoundColor :: Lens' Creative (Maybe Text) Source

The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.

creAdTagKeys :: Lens' Creative [Text] Source

Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creSkippable :: Lens' Creative (Maybe Bool) Source

Whether the user can choose to skip the creative. Applicable to the following creative types: INSTREAM_VIDEO.

creSSLCompliant :: Lens' Creative (Maybe Bool) Source

Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.

creIdDimensionValue :: Lens' Creative (Maybe DimensionValue) Source

Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.

creBackupImageReportingLabel :: Lens' Creative (Maybe Text) Source

Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.

creCommercialId :: Lens' Creative (Maybe Text) Source

Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

creActive :: Lens' Creative (Maybe Bool) Source

Whether the creative is active. Applicable to all creative types.

creExitCustomEvents :: Lens' Creative [CreativeCustomEvent] Source

List of exit events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creAccountId :: Lens' Creative (Maybe Int64) Source

Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

creBackupImageClickThroughURL :: Lens' Creative (Maybe Text) Source

Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.

creName :: Lens' Creative (Maybe Text) Source

Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.

creOverrideCss :: Lens' Creative (Maybe Text) Source

Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.

creVideoDescription :: Lens' Creative (Maybe Text) Source

Description of the video ad. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

creClickTags :: Lens' Creative [ClickTag] Source

Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER.

creAdParameters :: Lens' Creative (Maybe Text) Source

Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.

creVersion :: Lens' Creative (Maybe Int32) Source

The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.

creLatestTraffickedCreativeId :: Lens' Creative (Maybe Int64) Source

Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creThirdPartyRichMediaImpressionsURL :: Lens' Creative (Maybe Text) Source

Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA

creLastModifiedInfo :: Lens' Creative (Maybe LastModifiedInfo) Source

Creative last modification information. This is a read-only field. Applicable to all creative types.

creId :: Lens' Creative (Maybe Int64) Source

ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.

creStudioAdvertiserId :: Lens' Creative (Maybe Int64) Source

Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creCreativeAssets :: Lens' Creative [CreativeAsset] Source

Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT

creSubAccountId :: Lens' Creative (Maybe Int64) Source

Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

creType :: Lens' Creative (Maybe CreativeType) Source

Type of this creative.This is a required field. Applicable to all creative types.

creTimerCustomEvents :: Lens' Creative [CreativeCustomEvent] Source

List of timer events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creStudioCreativeId :: Lens' Creative (Maybe Int64) Source

Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creCompatibility :: Lens' Creative [CreativeCompatibilityItem] Source

Compatibilities associated with this creative. This is a read-only field. WEB and WEB_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 in in-stream video ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "WEB" - "WEB_INTERSTITIAL"

creBackupImageFeatures :: Lens' Creative [CreativeBackupImageFeaturesItem] Source

List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.

creArtworkType :: Lens' Creative (Maybe CreativeArtworkType) Source

Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creArchived :: Lens' Creative (Maybe Bool) Source

Whether the creative is archived. Applicable to all creative types.

creCompanionCreatives :: Lens' Creative [Int64] Source

List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

creTotalFileSize :: Lens' Creative (Maybe Int64) Source

Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creStudioTraffickedCreativeId :: Lens' Creative (Maybe Int64) Source

Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

creRedirectURL :: Lens' Creative (Maybe Text) Source

URL of hosted image or another ad tag. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT

creAutoAdvanceImages :: Lens' Creative (Maybe Bool) Source

Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.

creCreativeFieldAssignments :: Lens' Creative [CreativeFieldAssignment] Source

Creative field assignments for this creative. Applicable to all creative types.

SiteContact

data SiteContact Source

Site Contact

See: siteContact smart constructor.

Instances

siteContact :: SiteContact Source

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

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

scEmail :: Lens' SiteContact (Maybe Text) Source

Email address of this site contact. This is a required field.

scPhone :: Lens' SiteContact (Maybe Text) Source

Primary phone number of this site contact.

scLastName :: Lens' SiteContact (Maybe Text) Source

Last name of this site contact.

scAddress :: Lens' SiteContact (Maybe Text) Source

Address of this site contact.

scFirstName :: Lens' SiteContact (Maybe Text) Source

First name of this site contact.

scId :: Lens' SiteContact (Maybe Int64) Source

ID of this site contact. This is a read-only, auto-generated field.

scTitle :: Lens' SiteContact (Maybe Text) Source

Title or designation of this site contact.

scContactType :: Lens' SiteContact (Maybe SiteContactContactType) Source

Site contact type.

AccountsListResponse

data AccountsListResponse Source

Account List Response

See: accountsListResponse smart constructor.

Instances

accountsListResponse :: AccountsListResponse Source

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

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

accNextPageToken :: Lens' AccountsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

accAccounts :: Lens' AccountsListResponse [Account] Source

Account collection.

accKind :: Lens' AccountsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".

DateRange

data DateRange Source

Represents a date range.

See: dateRange smart constructor.

Instances

dateRange :: DateRange Source

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

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

drKind :: Lens' DateRange Text Source

The kind of resource this is, in this case dfareporting#dateRange.

drEndDate :: Lens' DateRange (Maybe Day) Source

The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".

drStartDate :: Lens' DateRange (Maybe Day) Source

The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".

drRelativeDateRange :: Lens' DateRange (Maybe DateRangeRelativeDateRange) Source

The date range relative to the date of when the report is run.

FloodlightConfigurationStandardVariableTypesItem

data FloodlightConfigurationStandardVariableTypesItem Source

Constructors

Num
NUM
Ord
ORD
Tran
TRAN
U
U

Instances

Report

data Report Source

Represents a Report resource.

See: report smart constructor.

Instances

report :: Report Source

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

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

rDelivery :: Lens' Report (Maybe ReportDelivery) Source

The report's email delivery settings.

rEtag :: Lens' Report (Maybe Text) Source

The eTag of this response for caching purposes.

rOwnerProFileId :: Lens' Report (Maybe Int64) Source

The user profile id of the owner of this report.

rSchedule :: Lens' Report (Maybe ReportSchedule) Source

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

rPathToConversionCriteria :: Lens' Report (Maybe ReportPathToConversionCriteria) Source

The report criteria for a report of type "PATH_TO_CONVERSION".

rKind :: Lens' Report Text Source

The kind of resource this is, in this case dfareporting#report.

rFormat :: Lens' Report (Maybe ReportFormat) Source

The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.

rReachCriteria :: Lens' Report (Maybe ReportReachCriteria) Source

The report criteria for a report of type "REACH".

rLastModifiedTime :: Lens' Report (Maybe Word64) Source

The timestamp (in milliseconds since epoch) of when this report was last modified.

rAccountId :: Lens' Report (Maybe Int64) Source

The account ID to which this report belongs.

rName :: Lens' Report (Maybe Text) Source

The name of the report.

rId :: Lens' Report (Maybe Int64) Source

The unique ID identifying this report resource.

rCrossDimensionReachCriteria :: Lens' Report (Maybe ReportCrossDimensionReachCriteria) Source

The report criteria for a report of type "CROSS_DIMENSION_REACH".

rType :: Lens' Report (Maybe ReportType) Source

The type of the report.

rSubAccountId :: Lens' Report (Maybe Int64) Source

The subaccount ID to which this report belongs if applicable.

rFloodlightCriteria :: Lens' Report (Maybe ReportFloodlightCriteria) Source

The report criteria for a report of type "FLOODLIGHT".

rCriteria :: Lens' Report (Maybe ReportCriteria) Source

The report criteria for a report of type "STANDARD".

rFileName :: Lens' Report (Maybe Text) Source

The filename used when generating report files for this report.

PlacementPaymentSource

data PlacementPaymentSource Source

Payment source for this placement. This is a required field that is read-only after insertion.

Constructors

PPSPlacementAgencyPaid
PLACEMENT_AGENCY_PAID
PPSPlacementPublisherPaid
PLACEMENT_PUBLISHER_PAID

Instances

ReportsFilesListSortOrder

data ReportsFilesListSortOrder Source

Order of sorted results, default is 'DESCENDING'.

Constructors

RFLSOAscending

ASCENDING Ascending order.

RFLSODescending

DESCENDING Descending order.

Instances

Campaign

data Campaign Source

Contains properties of a DCM campaign.

See: campaign smart constructor.

Instances

campaign :: Campaign Source

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

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

camCreativeOptimizationConfiguration :: Lens' Campaign (Maybe CreativeOptimizationConfiguration) Source

Creative optimization configuration for the campaign.

camCreativeGroupIds :: Lens' Campaign [Int64] Source

List of creative group IDs that are assigned to the campaign.

camNielsenOCREnabled :: Lens' Campaign (Maybe Bool) Source

Whether Nielsen reports are enabled for this campaign.

camKind :: Lens' Campaign Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".

camClickThroughURLSuffixProperties :: Lens' Campaign (Maybe ClickThroughURLSuffixProperties) Source

Click-through URL suffix override properties for this campaign.

camAdvertiserId :: Lens' Campaign (Maybe Int64) Source

Advertiser ID of this campaign. This is a required field.

camEndDate :: Lens' Campaign (Maybe Day) Source

Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.

camAdvertiserIdDimensionValue :: Lens' Campaign (Maybe DimensionValue) Source

Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.

camIdDimensionValue :: Lens' Campaign (Maybe DimensionValue) Source

Dimension value for the ID of this campaign. This is a read-only, auto-generated field.

camEventTagOverrides :: Lens' Campaign [EventTagOverride] Source

Overrides that can be used to activate or deactivate advertiser event tags.

camLookbackConfiguration :: Lens' Campaign (Maybe LookbackConfiguration) Source

Lookback window settings for the campaign.

camStartDate :: Lens' Campaign (Maybe Day) Source

Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.

camAccountId :: Lens' Campaign (Maybe Int64) Source

Account ID of this campaign. This is a read-only field that can be left blank.

camComscoreVceEnabled :: Lens' Campaign (Maybe Bool) Source

Whether comScore vCE reports are enabled for this campaign.

camName :: Lens' Campaign (Maybe Text) Source

Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.

camAdvertiserGroupId :: Lens' Campaign (Maybe Int64) Source

Advertiser group ID of the associated advertiser.

camBillingInvoiceCode :: Lens' Campaign (Maybe Text) Source

Billing invoice code included in the DCM client billing invoices associated with the campaign.

camCreateInfo :: Lens' Campaign (Maybe LastModifiedInfo) Source

Information about the creation of this campaign. This is a read-only field.

camLastModifiedInfo :: Lens' Campaign (Maybe LastModifiedInfo) Source

Information about the most recent modification of this campaign. This is a read-only field.

camId :: Lens' Campaign (Maybe Int64) Source

ID of this campaign. This is a read-only auto-generated field.

camSubAccountId :: Lens' Campaign (Maybe Int64) Source

Subaccount ID of this campaign. This is a read-only field that can be left blank.

camAdditionalCreativeOptimizationConfigurations :: Lens' Campaign [CreativeOptimizationConfiguration] Source

Additional creative optimization configurations for the campaign.

camExternalId :: Lens' Campaign (Maybe Text) Source

External ID for this campaign.

camComment :: Lens' Campaign (Maybe Text) Source

Arbitrary comments about this campaign. Must be less than 256 characters long.

camAudienceSegmentGroups :: Lens' Campaign [AudienceSegmentGroup] Source

Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.

camArchived :: Lens' Campaign (Maybe Bool) Source

Whether this campaign has been archived.

camTraffickerEmails :: Lens' Campaign [Text] Source

Campaign trafficker contact emails.

camDefaultClickThroughEventTagProperties :: Lens' Campaign (Maybe DefaultClickThroughEventTagProperties) Source

Click-through event tag ID override properties for this campaign.

InventoryItemsListSortField

data InventoryItemsListSortField Source

Field by which to sort the list.

Constructors

IILSFID
ID
IILSFName
NAME

Instances

EventTagType

data EventTagType Source

Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.

Constructors

ETTClickThroughEventTag
CLICK_THROUGH_EVENT_TAG
ETTImpressionImageEventTag
IMPRESSION_IMAGE_EVENT_TAG
ETTImpressionJavascriptEventTag
IMPRESSION_JAVASCRIPT_EVENT_TAG

Instances

CreativesListSortOrder

data CreativesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

CAscending
ASCENDING
CDescending
DESCENDING

Instances

ThirdPartyAuthenticationToken

data ThirdPartyAuthenticationToken Source

Third Party Authentication Token

See: thirdPartyAuthenticationToken smart constructor.

Instances

thirdPartyAuthenticationToken :: ThirdPartyAuthenticationToken Source

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

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

tpatValue :: Lens' ThirdPartyAuthenticationToken (Maybe Text) Source

Value of the third-party authentication token. This is a read-only, auto-generated field.

tpatName :: Lens' ThirdPartyAuthenticationToken (Maybe Text) Source

Name of the third-party authentication token.

PopupWindowPropertiesPositionType

data PopupWindowPropertiesPositionType Source

Popup window position either centered or at specific coordinate.

Constructors

Center
CENTER
Coordinates
COORDINATES

Instances

DirectorySiteContactRole

data DirectorySiteContactRole Source

Directory site contact role.

Constructors

Admin
ADMIN
Edit
EDIT
View
VIEW

Instances

ClickThroughURL

data ClickThroughURL Source

Click-through URL

See: clickThroughURL smart constructor.

Instances

clickThroughURL :: ClickThroughURL Source

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

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

ctuDefaultLandingPage :: Lens' ClickThroughURL (Maybe Bool) Source

Whether the campaign default landing page is used.

ctuComputedClickThroughURL :: Lens' ClickThroughURL (Maybe Text) Source

Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.

ctuCustomClickThroughURL :: Lens' ClickThroughURL (Maybe Text) Source

Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.

ctuLandingPageId :: Lens' ClickThroughURL (Maybe Int64) Source

ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.

TagSettingKeywordOption

data TagSettingKeywordOption Source

Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.

Constructors

GenerateSeparateTagForEachKeyword
GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD
Ignore
IGNORE
PlaceholderWithListOfKeywords
PLACEHOLDER_WITH_LIST_OF_KEYWORDS

Instances

CreativeAuthoringTool

data CreativeAuthoringTool Source

Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

Constructors

Ninja
NINJA
Swiffy
SWIFFY

Instances

OrderContactContactType

data OrderContactContactType Source

Type of this contact.

Constructors

PlanningOrderContactBuyerBillingContact
PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT
PlanningOrderContactBuyerContact
PLANNING_ORDER_CONTACT_BUYER_CONTACT
PlanningOrderContactSellerContact
PLANNING_ORDER_CONTACT_SELLER_CONTACT

Instances

CreativeAssetIdType

data CreativeAssetIdType Source

Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.

Constructors

CAITFlash
FLASH
CAITHTML
HTML
CAITHTMLImage
HTML_IMAGE
CAITImage
IMAGE
CAITVideo
VIDEO

Instances

AccountUserProFilesListSortOrder

data AccountUserProFilesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

AUPFLSOAscending
ASCENDING
AUPFLSODescending
DESCENDING

Instances

RemarketingListListSource

data RemarketingListListSource Source

Product from which this remarketing list was originated.

Constructors

RLLSRemarketingListSourceDBm
REMARKETING_LIST_SOURCE_DBM
RLLSRemarketingListSourceDfa
REMARKETING_LIST_SOURCE_DFA
RLLSRemarketingListSourceDmp
REMARKETING_LIST_SOURCE_DMP
RLLSRemarketingListSourceGa
REMARKETING_LIST_SOURCE_GA
RLLSRemarketingListSourceOther
REMARKETING_LIST_SOURCE_OTHER

Instances

BrowsersListResponse

data BrowsersListResponse Source

Browser List Response

See: browsersListResponse smart constructor.

Instances

browsersListResponse :: BrowsersListResponse Source

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

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

blrKind :: Lens' BrowsersListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".

blrBrowsers :: Lens' BrowsersListResponse [Browser] Source

Browser collection.

AccountUserProFileUserAccessType

data AccountUserProFileUserAccessType Source

User type of the user profile. This is a read-only field that can be left blank.

Constructors

InternalAdministrator
INTERNAL_ADMINISTRATOR
NormalUser
NORMAL_USER
SuperUser
SUPER_USER

Instances

CreativeAssetStartTimeType

data CreativeAssetStartTimeType Source

Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.

Constructors

AssetStartTimeTypeCustom
ASSET_START_TIME_TYPE_CUSTOM
AssetStartTimeTypeNone
ASSET_START_TIME_TYPE_NONE

Instances

ProjectAudienceGender

data ProjectAudienceGender Source

Audience gender of this project.

Constructors

PlanningAudienceGenderFemale
PLANNING_AUDIENCE_GENDER_FEMALE
PlanningAudienceGenderMale
PLANNING_AUDIENCE_GENDER_MALE

Instances

SiteSettings

data SiteSettings Source

Site Settings

See: siteSettings smart constructor.

Instances

siteSettings :: SiteSettings Source

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

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

ssDisableNewCookie :: Lens' SiteSettings (Maybe Bool) Source

Whether new cookies are disabled for this site.

ssDisableBrandSafeAds :: Lens' SiteSettings (Maybe Bool) Source

Whether brand safe ads are disabled for this site.

ssLookbackConfiguration :: Lens' SiteSettings (Maybe LookbackConfiguration) Source

Lookback window settings for this site.

ssTagSetting :: Lens' SiteSettings (Maybe TagSetting) Source

Configuration settings for dynamic and image floodlight tags.

ssActiveViewOptOut :: Lens' SiteSettings (Maybe Bool) Source

Whether active view creatives are disabled for this site.

ssCreativeSettings :: Lens' SiteSettings (Maybe CreativeSettings) Source

Site-wide creative settings.

PlacementStrategiesListSortField

data PlacementStrategiesListSortField Source

Field by which to sort the list.

Constructors

PSLSFID
ID
PSLSFName
NAME

Instances

ContentCategoriesListResponse

data ContentCategoriesListResponse Source

Content Category List Response

See: contentCategoriesListResponse smart constructor.

Instances

contentCategoriesListResponse :: ContentCategoriesListResponse Source

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

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

cclrNextPageToken :: Lens' ContentCategoriesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

cclrKind :: Lens' ContentCategoriesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".

cclrContentCategories :: Lens' ContentCategoriesListResponse [ContentCategory] Source

Content category collection.

UserDefinedVariableConfigurationDataType

data UserDefinedVariableConfigurationDataType Source

Data type for the variable. This is a required field.

Constructors

Number
NUMBER
String
STRING

Instances

FloodlightActivityCacheBustingType

data FloodlightActivityCacheBustingType Source

Code type used for cache busting in the generated tag.

Constructors

ActiveServerPage
ACTIVE_SERVER_PAGE
ColdFusion
COLD_FUSION
Javascript
JAVASCRIPT
Jsp
JSP
Php
PHP

Instances

CreativesListResponse

data CreativesListResponse Source

Creative List Response

See: creativesListResponse smart constructor.

Instances

creativesListResponse :: CreativesListResponse Source

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

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

clrlNextPageToken :: Lens' CreativesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

clrlKind :: Lens' CreativesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".

clrlCreatives :: Lens' CreativesListResponse [Creative] Source

Creative collection.

CreativeGroupsListSortOrder

data CreativeGroupsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

CGLSOAscending
ASCENDING
CGLSODescending
DESCENDING

Instances

OrderDocumentType

data OrderDocumentType Source

Type of this order document

Constructors

PlanningOrderTypeChangeOrder
PLANNING_ORDER_TYPE_CHANGE_ORDER
PlanningOrderTypeInsertionOrder
PLANNING_ORDER_TYPE_INSERTION_ORDER

Instances

TagDataFormat

data TagDataFormat Source

TagData tag format of this tag.

Constructors

PlacementTagClickCommands
PLACEMENT_TAG_CLICK_COMMANDS
PlacementTagIframeIlayer
PLACEMENT_TAG_IFRAME_ILAYER
PlacementTagIframeJavascript
PLACEMENT_TAG_IFRAME_JAVASCRIPT
PlacementTagIframeJavascriptLegacy
PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY
PlacementTagInstreamVideoPrefetch
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH
PlacementTagInstreamVideoPrefetchVast3
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3
PlacementTagInternalRedirect
PLACEMENT_TAG_INTERNAL_REDIRECT
PlacementTagInterstitialIframeJavascript
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT
PlacementTagInterstitialIframeJavascriptLegacy
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY
PlacementTagInterstitialInternalRedirect
PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT
PlacementTagInterstitialJavascript
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT
PlacementTagInterstitialJavascriptLegacy
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY
PlacementTagJavascript
PLACEMENT_TAG_JAVASCRIPT
PlacementTagJavascriptLegacy
PLACEMENT_TAG_JAVASCRIPT_LEGACY
PlacementTagStandard
PLACEMENT_TAG_STANDARD
PlacementTagTracking
PLACEMENT_TAG_TRACKING
PlacementTagTrackingIframe
PLACEMENT_TAG_TRACKING_IFRAME
PlacementTagTrackingJavascript
PLACEMENT_TAG_TRACKING_JAVASCRIPT

Instances

Account

data Account Source

Contains properties of a DCM account.

See: account smart constructor.

Instances

account :: Account Source

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

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

aaAccountPermissionIds :: Lens' Account [Int64] Source

Account permissions assigned to this account.

aaMaximumImageSize :: Lens' Account (Maybe Int64) Source

Maximum image size allowed for this account.

aaCurrencyId :: Lens' Account (Maybe Int64) Source

ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ

aaReportsConfiguration :: Lens' Account (Maybe ReportsConfiguration) Source

Reporting configuration of this account.

aaNielsenOCREnabled :: Lens' Account (Maybe Bool) Source

Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.

aaKind :: Lens' Account Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".

aaLocale :: Lens' Account (Maybe Text) Source

Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)

aaActive :: Lens' Account (Maybe Bool) Source

Whether this account is active.

aaAvailablePermissionIds :: Lens' Account [Int64] Source

User role permissions available to the user roles of this account.

aaTeaserSizeLimit :: Lens' Account (Maybe Int64) Source

File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.

aaComscoreVceEnabled :: Lens' Account (Maybe Bool) Source

Whether campaigns created in this account will be enabled for comScore vCE by default.

aaActiveViewOptOut :: Lens' Account (Maybe Bool) Source

Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.

aaName :: Lens' Account (Maybe Text) Source

Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.

aaAccountProFile :: Lens' Account (Maybe AccountAccountProFile) Source

Profile for this account. This is a read-only field that can be left blank.

aaId :: Lens' Account (Maybe Int64) Source

ID of this account. This is a read-only, auto-generated field.

aaCountryId :: Lens' Account (Maybe Int64) Source

ID of the country associated with this account.

aaActiveAdsLimitTier :: Lens' Account (Maybe AccountActiveAdsLimitTier) Source

Maximum number of active ads allowed for this account.

aaDefaultCreativeSizeId :: Lens' Account (Maybe Int64) Source

Default placement dimensions for this account.

aaDescription :: Lens' Account (Maybe Text) Source

Description of this account.

AccountActiveAdSummaryActiveAdsLimitTier

data AccountActiveAdSummaryActiveAdsLimitTier Source

Maximum number of active ads allowed for the account.

Constructors

ActiveAdsTier100K
ACTIVE_ADS_TIER_100K
ActiveAdsTier200K
ACTIVE_ADS_TIER_200K
ActiveAdsTier300K
ACTIVE_ADS_TIER_300K
ActiveAdsTier40K
ACTIVE_ADS_TIER_40K
ActiveAdsTier75K
ACTIVE_ADS_TIER_75K

Instances

CreativeAssetChildAssetType

data CreativeAssetChildAssetType Source

Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.

Constructors

ChildAssetTypeData
CHILD_ASSET_TYPE_DATA
ChildAssetTypeFlash
CHILD_ASSET_TYPE_FLASH
ChildAssetTypeImage
CHILD_ASSET_TYPE_IMAGE
ChildAssetTypeVideo
CHILD_ASSET_TYPE_VIDEO

Instances

PlacementGroupsListPlacementGroupType

data PlacementGroupsListPlacementGroupType Source

Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.

Constructors

PlacementPackage
PLACEMENT_PACKAGE
PlacementRoadblock
PLACEMENT_ROADBLOCK

Instances

AccountUserProFilesListResponse

data AccountUserProFilesListResponse Source

Account User Profile List Response

See: accountUserProFilesListResponse smart constructor.

Instances

accountUserProFilesListResponse :: AccountUserProFilesListResponse Source

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

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

aupflrNextPageToken :: Lens' AccountUserProFilesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

aupflrAccountUserProFiles :: Lens' AccountUserProFilesListResponse [AccountUserProFile] Source

Account user profile collection.

aupflrKind :: Lens' AccountUserProFilesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".

ContentCategory

data ContentCategory Source

Organizes placements according to the contents of their associated webpages.

See: contentCategory smart constructor.

Instances

contentCategory :: ContentCategory Source

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

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

conKind :: Lens' ContentCategory Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".

conAccountId :: Lens' ContentCategory (Maybe Int64) Source

Account ID of this content category. This is a read-only field that can be left blank.

conName :: Lens' ContentCategory (Maybe Text) Source

Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.

conId :: Lens' ContentCategory (Maybe Int64) Source

ID of this content category. This is a read-only, auto-generated field.

ObjectFilterStatus

data ObjectFilterStatus Source

Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.

Constructors

OFSAll
ALL
OFSAssigned
ASSIGNED
OFSNone
NONE

Instances

ReportCompatibleFields

data ReportCompatibleFields Source

Represents fields that are compatible to be selected for a report of type "STANDARD".

See: reportCompatibleFields smart constructor.

Instances

reportCompatibleFields :: ReportCompatibleFields Source

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

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

rcfMetrics :: Lens' ReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected in the "metricNames" section of the report.

rcfKind :: Lens' ReportCompatibleFields Text Source

The kind of resource this is, in this case dfareporting#reportCompatibleFields.

rcfDimensionFilters :: Lens' ReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

rcfPivotedActivityMetrics :: Lens' ReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.

rcfDimensions :: Lens' ReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "dimensions" section of the report.

CampaignCreativeAssociationsListSortOrder

data CampaignCreativeAssociationsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

CCALSOAscending
ASCENDING
CCALSODescending
DESCENDING

Instances

DeliverySchedule

data DeliverySchedule Source

Delivery Schedule.

See: deliverySchedule smart constructor.

Instances

deliverySchedule :: DeliverySchedule Source

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

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

dsHardCutoff :: Lens' DeliverySchedule (Maybe Bool) Source

Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.

dsPriority :: Lens' DeliverySchedule (Maybe DeliverySchedulePriority) Source

Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.

dsImpressionRatio :: Lens' DeliverySchedule (Maybe Int64) Source

Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Must be between 1 and 10.

dsFrequencyCap :: Lens' DeliverySchedule (Maybe FrequencyCap) Source

Limit on the number of times an individual user can be served the ad within a specified period of time.

RemarketingList

data RemarketingList Source

Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.

See: remarketingList smart constructor.

Instances

remarketingList :: RemarketingList Source

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

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

rlListSize :: Lens' RemarketingList (Maybe Int64) Source

Number of users currently in the list. This is a read-only field.

rlListPopulationRule :: Lens' RemarketingList (Maybe ListPopulationRule) Source

Rule used to populate the remarketing list with users.

rlLifeSpan :: Lens' RemarketingList (Maybe Int64) Source

Number of days that a user should remain in the remarketing list without an impression.

rlKind :: Lens' RemarketingList Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".

rlAdvertiserId :: Lens' RemarketingList (Maybe Int64) Source

Dimension value for the advertiser ID that owns this remarketing list. This is a required field.

rlAdvertiserIdDimensionValue :: Lens' RemarketingList (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

rlActive :: Lens' RemarketingList (Maybe Bool) Source

Whether this remarketing list is active.

rlAccountId :: Lens' RemarketingList (Maybe Int64) Source

Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

rlName :: Lens' RemarketingList (Maybe Text) Source

Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.

rlListSource :: Lens' RemarketingList (Maybe RemarketingListListSource) Source

Product from which this remarketing list was originated.

rlId :: Lens' RemarketingList (Maybe Int64) Source

Remarketing list ID. This is a read-only, auto-generated field.

rlSubAccountId :: Lens' RemarketingList (Maybe Int64) Source

Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

rlDescription :: Lens' RemarketingList (Maybe Text) Source

Remarketing list description.

FloodlightActivitiesListSortField

data FloodlightActivitiesListSortField Source

Field by which to sort the list.

Constructors

FALSFID
ID
FALSFName
NAME

Instances

DimensionValueList

data DimensionValueList Source

Represents the list of DimensionValue resources.

See: dimensionValueList smart constructor.

Instances

dimensionValueList :: DimensionValueList Source

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

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

dvlEtag :: Lens' DimensionValueList (Maybe Text) Source

The eTag of this response for caching purposes.

dvlNextPageToken :: Lens' DimensionValueList (Maybe Text) Source

Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.

dvlKind :: Lens' DimensionValueList Text Source

The kind of list this is, in this case dfareporting#dimensionValueList.

dvlItems :: Lens' DimensionValueList [DimensionValue] Source

The dimension values returned in this response.

FloodlightReportCompatibleFields

data FloodlightReportCompatibleFields Source

Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".

See: floodlightReportCompatibleFields smart constructor.

Instances

floodlightReportCompatibleFields :: FloodlightReportCompatibleFields Source

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

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

frcfMetrics :: Lens' FloodlightReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected in the "metricNames" section of the report.

frcfKind :: Lens' FloodlightReportCompatibleFields Text Source

The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.

frcfDimensionFilters :: Lens' FloodlightReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

frcfDimensions :: Lens' FloodlightReportCompatibleFields [Dimension] Source

Dimensions which are compatible to be selected in the "dimensions" section of the report.

UserRolePermissionGroup

data UserRolePermissionGroup Source

Represents a grouping of related user role permissions.

See: userRolePermissionGroup smart constructor.

Instances

userRolePermissionGroup :: UserRolePermissionGroup Source

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

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

urpgKind :: Lens' UserRolePermissionGroup Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".

urpgName :: Lens' UserRolePermissionGroup (Maybe Text) Source

Name of this user role permission group.

urpgId :: Lens' UserRolePermissionGroup (Maybe Int64) Source

ID of this user role permission.

CreativesListTypes

data CreativesListTypes Source

Select only creatives with these creative types.

Constructors

BrandSafeDefaultInstreamVideo
BRAND_SAFE_DEFAULT_INSTREAM_VIDEO
CustomInpage
CUSTOM_INPAGE
CustomInterstitial
CUSTOM_INTERSTITIAL
EnhancedBanner
ENHANCED_BANNER
EnhancedImage
ENHANCED_IMAGE
FlashInpage
FLASH_INPAGE
HTML5Banner
HTML5_BANNER
Image
IMAGE
InstreamVideo
INSTREAM_VIDEO
InternalRedirect
INTERNAL_REDIRECT
InterstitialInternalRedirect
INTERSTITIAL_INTERNAL_REDIRECT
Redirect
REDIRECT
RichMediaExpanding
RICH_MEDIA_EXPANDING
RichMediaImExpand
RICH_MEDIA_IM_EXPAND
RichMediaInpage
RICH_MEDIA_INPAGE
RichMediaInpageFloating
RICH_MEDIA_INPAGE_FLOATING
RichMediaInterstitialFloat
RICH_MEDIA_INTERSTITIAL_FLOAT
RichMediaMobileInApp
RICH_MEDIA_MOBILE_IN_APP
RichMediaMultiFloating
RICH_MEDIA_MULTI_FLOATING
RichMediaPeelDown
RICH_MEDIA_PEEL_DOWN
TrackingText
TRACKING_TEXT
VastRedirect
VAST_REDIRECT
VpaidLinear
VPAID_LINEAR
VpaidNonLinear
VPAID_NON_LINEAR

Instances

DirectorySiteInpageTagFormatsItem

data DirectorySiteInpageTagFormatsItem Source

Constructors

IframeJavascriptInpage
IFRAME_JAVASCRIPT_INPAGE
InternalRedirectInpage
INTERNAL_REDIRECT_INPAGE
JavascriptInpage
JAVASCRIPT_INPAGE
Standard
STANDARD

Instances

TagSetting

data TagSetting Source

Tag Settings

See: tagSetting smart constructor.

Instances

tagSetting :: TagSetting Source

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

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

tsKeywordOption :: Lens' TagSetting (Maybe TagSettingKeywordOption) Source

Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.

tsIncludeClickThroughURLs :: Lens' TagSetting (Maybe Bool) Source

Whether static landing page URLs should be included in the tags. This setting applies only to placements.

tsIncludeClickTracking :: Lens' TagSetting (Maybe Bool) Source

Whether click-tracking string should be included in the tags.

tsAdditionalKeyValues :: Lens' TagSetting (Maybe Text) Source

Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.

CreativeAssetWindowMode

data CreativeAssetWindowMode Source

Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.

Constructors

Opaque
OPAQUE
Transparent
TRANSPARENT
Window
WINDOW

Instances

CreativeAssetAlignment

data CreativeAssetAlignment Source

Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.

Constructors

AlignmentBottom
ALIGNMENT_BOTTOM
AlignmentLeft
ALIGNMENT_LEFT
AlignmentRight
ALIGNMENT_RIGHT
AlignmentTop
ALIGNMENT_TOP

Instances

RemarketingListsListSortOrder

data RemarketingListsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

RLLSOAscending
ASCENDING
RLLSODescending
DESCENDING

Instances

ReportPathToConversionCriteriaReportProperties

data ReportPathToConversionCriteriaReportProperties Source

The properties of the report.

See: reportPathToConversionCriteriaReportProperties smart constructor.

Instances

reportPathToConversionCriteriaReportProperties :: ReportPathToConversionCriteriaReportProperties Source

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

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

rptccrpMaximumInteractionGap :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) Source

The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.

rptccrpMaximumClickInteractions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) Source

The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.

rptccrpPivotOnInteractionPath :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) Source

Enable pivoting on interaction path.

rptccrpMaximumImpressionInteractions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) Source

The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.

rptccrpIncludeUnattributedIPConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) Source

Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.

rptccrpImpressionsLookbackWindow :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) Source

DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.

rptccrpClicksLookbackWindow :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) Source

DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.

rptccrpIncludeUnattributedCookieConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) Source

Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.

rptccrpIncludeAttributedIPConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) Source

Deprecated: has no effect.

UserRolePermissionsListResponse

data UserRolePermissionsListResponse Source

User Role Permission List Response

See: userRolePermissionsListResponse smart constructor.

Instances

userRolePermissionsListResponse :: UserRolePermissionsListResponse Source

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

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

urplrKind :: Lens' UserRolePermissionsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".

urplrUserRolePermissions :: Lens' UserRolePermissionsListResponse [UserRolePermission] Source

User role permission collection.

PlacementGroupsListPricingTypes

data PlacementGroupsListPricingTypes Source

Select only placement groups with these pricing types.

Constructors

PGLPTPricingTypeCpa
PRICING_TYPE_CPA
PGLPTPricingTypeCpc
PRICING_TYPE_CPC
PGLPTPricingTypeCpm
PRICING_TYPE_CPM
PGLPTPricingTypeFlatRateClicks
PRICING_TYPE_FLAT_RATE_CLICKS
PGLPTPricingTypeFlatRateImpressions
PRICING_TYPE_FLAT_RATE_IMPRESSIONS

Instances

AccountActiveAdsLimitTier

data AccountActiveAdsLimitTier Source

Maximum number of active ads allowed for this account.

Constructors

AAALTActiveAdsTier100K
ACTIVE_ADS_TIER_100K
AAALTActiveAdsTier200K
ACTIVE_ADS_TIER_200K
AAALTActiveAdsTier300K
ACTIVE_ADS_TIER_300K
AAALTActiveAdsTier40K
ACTIVE_ADS_TIER_40K
AAALTActiveAdsTier75K
ACTIVE_ADS_TIER_75K

Instances

AccountsListSortOrder

data AccountsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

AAscending
ASCENDING
ADescending
DESCENDING

Instances

PlacementGroupsListResponse

data PlacementGroupsListResponse Source

Placement Group List Response

See: placementGroupsListResponse smart constructor.

Instances

placementGroupsListResponse :: PlacementGroupsListResponse Source

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

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

pglrNextPageToken :: Lens' PlacementGroupsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

pglrKind :: Lens' PlacementGroupsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".

pglrPlacementGroups :: Lens' PlacementGroupsListResponse [PlacementGroup] Source

Placement group collection.

MobileCarrier

data MobileCarrier Source

Contains information about a mobile carrier that can be targeted by ads.

See: mobileCarrier smart constructor.

Instances

mobileCarrier :: MobileCarrier Source

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

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

mcKind :: Lens' MobileCarrier Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".

mcName :: Lens' MobileCarrier (Maybe Text) Source

Name of this mobile carrier.

mcCountryCode :: Lens' MobileCarrier (Maybe Text) Source

Country code of the country to which this mobile carrier belongs.

mcId :: Lens' MobileCarrier (Maybe Int64) Source

ID of this mobile carrier.

mcCountryDartId :: Lens' MobileCarrier (Maybe Int64) Source

DART ID of the country to which this mobile carrier belongs.

LandingPage

data LandingPage Source

Contains information about where a user's browser is taken after the user clicks an ad.

See: landingPage smart constructor.

Instances

landingPage :: LandingPage Source

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

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

lpKind :: Lens' LandingPage Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".

lpDefault :: Lens' LandingPage (Maybe Bool) Source

Whether or not this landing page will be assigned to any ads or creatives that do not have a landing page assigned explicitly. Only one default landing page is allowed per campaign.

lpURL :: Lens' LandingPage (Maybe Text) Source

URL of this landing page. This is a required field.

lpName :: Lens' LandingPage (Maybe Text) Source

Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.

lpId :: Lens' LandingPage (Maybe Int64) Source

ID of this landing page. This is a read-only, auto-generated field.

ConnectionTypesListResponse

data ConnectionTypesListResponse Source

Connection Type List Response

See: connectionTypesListResponse smart constructor.

Instances

connectionTypesListResponse :: ConnectionTypesListResponse Source

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

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

ctlrKind :: Lens' ConnectionTypesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".

ctlrConnectionTypes :: Lens' ConnectionTypesListResponse [ConnectionType] Source

Collection of connection types such as broadband and mobile.

OrdersListResponse

data OrdersListResponse Source

Order List Response

See: ordersListResponse smart constructor.

Instances

ordersListResponse :: OrdersListResponse Source

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

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

olrNextPageToken :: Lens' OrdersListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

olrKind :: Lens' OrdersListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".

olrOrders :: Lens' OrdersListResponse [Order] Source

Order collection.

ReportList

data ReportList Source

Represents the list of reports.

See: reportList smart constructor.

Instances

reportList :: ReportList Source

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

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

repEtag :: Lens' ReportList (Maybe Text) Source

The eTag of this response for caching purposes.

repNextPageToken :: Lens' ReportList (Maybe Text) Source

Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.

repKind :: Lens' ReportList Text Source

The kind of list this is, in this case dfareporting#reportList.

repItems :: Lens' ReportList [Report] Source

The reports returned in this response.

CreativeGroup

data CreativeGroup Source

Contains properties of a creative group.

See: creativeGroup smart constructor.

Instances

creativeGroup :: CreativeGroup Source

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

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

cgKind :: Lens' CreativeGroup Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".

cgAdvertiserId :: Lens' CreativeGroup (Maybe Int64) Source

Advertiser ID of this creative group. This is a required field on insertion.

cgAdvertiserIdDimensionValue :: Lens' CreativeGroup (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

cgGroupNumber :: Lens' CreativeGroup (Maybe Int32) Source

Subgroup of the creative group. Assign your creative groups to one of the following subgroups in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are: - 1 - 2

cgAccountId :: Lens' CreativeGroup (Maybe Int64) Source

Account ID of this creative group. This is a read-only field that can be left blank.

cgName :: Lens' CreativeGroup (Maybe Text) Source

Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.

cgId :: Lens' CreativeGroup (Maybe Int64) Source

ID of this creative group. This is a read-only, auto-generated field.

cgSubAccountId :: Lens' CreativeGroup (Maybe Int64) Source

Subaccount ID of this creative group. This is a read-only field that can be left blank.

SubAccountsListSortField

data SubAccountsListSortField Source

Field by which to sort the list.

Constructors

SALSFID
ID
SALSFName
NAME

Instances

CampaignCreativeAssociation

data CampaignCreativeAssociation Source

Identifies a creative which has been associated with a given campaign.

See: campaignCreativeAssociation smart constructor.

Instances

campaignCreativeAssociation :: CampaignCreativeAssociation Source

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

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

ccaKind :: Lens' CampaignCreativeAssociation Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".

ccaCreativeId :: Lens' CampaignCreativeAssociation (Maybe Int64) Source

ID of the creative associated with the campaign. This is a required field.

LookbackConfiguration

data LookbackConfiguration Source

Lookback configuration settings.

See: lookbackConfiguration smart constructor.

Instances

lookbackConfiguration :: LookbackConfiguration Source

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

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

lcClickDuration :: Lens' LookbackConfiguration (Maybe Int32) Source

Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.

lcPostImpressionActivitiesDuration :: Lens' LookbackConfiguration (Maybe Int32) Source

Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used.

AdsListSortField

data AdsListSortField Source

Field by which to sort the list.

Constructors

ALSFID
ID
ALSFName
NAME

Instances

ProjectsListSortField

data ProjectsListSortField Source

Field by which to sort the list.

Constructors

PID
ID
PName
NAME

Instances

FloodlightActivityPublisherDynamicTag

data FloodlightActivityPublisherDynamicTag Source

Publisher Dynamic Tag

See: floodlightActivityPublisherDynamicTag smart constructor.

Instances

floodlightActivityPublisherDynamicTag :: FloodlightActivityPublisherDynamicTag Source

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

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

fapdtClickThrough :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Bool) Source

Whether this tag is applicable only for click-throughs.

fapdtSiteIdDimensionValue :: Lens' FloodlightActivityPublisherDynamicTag (Maybe DimensionValue) Source

Dimension value for the ID of the site. This is a read-only, auto-generated field.

fapdtDynamicTag :: Lens' FloodlightActivityPublisherDynamicTag (Maybe FloodlightActivityDynamicTag) Source

Dynamic floodlight tag.

fapdtDirectorySiteId :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Int64) Source

Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.

fapdtSiteId :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Int64) Source

Site ID of this dynamic tag.

fapdtViewThrough :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Bool) Source

Whether this tag is applicable only for view-throughs.

AdsListType

data AdsListType Source

Select only ads with these types.

Constructors

AdServingClickTracker
AD_SERVING_CLICK_TRACKER
AdServingDefaultAd
AD_SERVING_DEFAULT_AD
AdServingStandardAd
AD_SERVING_STANDARD_AD
AdServingTracking
AD_SERVING_TRACKING

Instances

AccountActiveAdSummary

data AccountActiveAdSummary Source

Gets a summary of active ads in an account.

See: accountActiveAdSummary smart constructor.

Instances

accountActiveAdSummary :: AccountActiveAdSummary Source

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

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

aaasAvailableAds :: Lens' AccountActiveAdSummary (Maybe Int64) Source

Ads that can be activated for the account.

aaasKind :: Lens' AccountActiveAdSummary Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".

aaasAccountId :: Lens' AccountActiveAdSummary (Maybe Int64) Source

ID of the account.

aaasActiveAds :: Lens' AccountActiveAdSummary (Maybe Int64) Source

Ads that have been activated for the account

aaasActiveAdsLimitTier :: Lens' AccountActiveAdSummary (Maybe AccountActiveAdSummaryActiveAdsLimitTier) Source

Maximum number of active ads allowed for the account.

CreativeOptimizationConfigurationOptimizationModel

data CreativeOptimizationConfigurationOptimizationModel Source

Optimization model for this configuration.

Constructors

Click
CLICK
PostClick
POST_CLICK
PostClickAndImpression
POST_CLICK_AND_IMPRESSION
PostImpression
POST_IMPRESSION

Instances

AccountPermissionLevel

data AccountPermissionLevel Source

Administrative level required to enable this account permission.

Constructors

Administrator
ADMINISTRATOR
User
USER

Instances

OffSetPosition

data OffSetPosition Source

Offset Position.

See: offSetPosition smart constructor.

Instances

offSetPosition :: OffSetPosition Source

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

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

ospLeft :: Lens' OffSetPosition (Maybe Int32) Source

Offset distance from left side of an asset or a window.

ospTop :: Lens' OffSetPosition (Maybe Int32) Source

Offset distance from top side of an asset or a window.

Metric

data Metric Source

Represents a metric.

See: metric smart constructor.

Instances

metric :: Metric Source

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

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

mKind :: Lens' Metric Text Source

The kind of resource this is, in this case dfareporting#metric.

mName :: Lens' Metric (Maybe Text) Source

The metric name, e.g. dfa:impressions

RemarketingListShare

data RemarketingListShare Source

Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.

See: remarketingListShare smart constructor.

Instances

remarketingListShare :: RemarketingListShare Source

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

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

rlsSharedAdvertiserIds :: Lens' RemarketingListShare [Int64] Source

Advertisers that the remarketing list is shared with.

rlsKind :: Lens' RemarketingListShare Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".

rlsRemarketingListId :: Lens' RemarketingListShare (Maybe Int64) Source

Remarketing list ID. This is a read-only, auto-generated field.

rlsSharedAccountIds :: Lens' RemarketingListShare [Int64] Source

Accounts that the remarketing list is shared with.

EventTagsListResponse

data EventTagsListResponse Source

Event Tag List Response

See: eventTagsListResponse smart constructor.

Instances

eventTagsListResponse :: EventTagsListResponse Source

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

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

etlrKind :: Lens' EventTagsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".

etlrEventTags :: Lens' EventTagsListResponse [EventTag] Source

Event tag collection.

UserRolesListResponse

data UserRolesListResponse Source

User Role List Response

See: userRolesListResponse smart constructor.

Instances

userRolesListResponse :: UserRolesListResponse Source

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

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

urlrNextPageToken :: Lens' UserRolesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

urlrKind :: Lens' UserRolesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".

urlrUserRoles :: Lens' UserRolesListResponse [UserRole] Source

User role collection.

ListPopulationTermType

data ListPopulationTermType Source

List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.

Constructors

CustomVariableTerm
CUSTOM_VARIABLE_TERM
ListMembershipTerm
LIST_MEMBERSHIP_TERM
ReferrerTerm
REFERRER_TERM

Instances

AdvertiserGroupsListSortOrder

data AdvertiserGroupsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

AGLSOAscending
ASCENDING
AGLSODescending
DESCENDING

Instances

CreativeFieldValuesListSortOrder

data CreativeFieldValuesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

CFVLSOAscending
ASCENDING
CFVLSODescending
DESCENDING

Instances

SortedDimensionSortOrder

data SortedDimensionSortOrder Source

An optional sort order for the dimension column.

Constructors

SDSOAscending
ASCENDING
SDSODescending
DESCENDING

Instances

CompatibleFields

data CompatibleFields Source

Represents a response to the queryCompatibleFields method.

See: compatibleFields smart constructor.

Instances

compatibleFields :: CompatibleFields Source

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

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

cfReachReportCompatibleFields :: Lens' CompatibleFields (Maybe ReachReportCompatibleFields) Source

Contains items that are compatible to be selected for a report of type "REACH".

cfCrossDimensionReachReportCompatibleFields :: Lens' CompatibleFields (Maybe CrossDimensionReachReportCompatibleFields) Source

Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".

cfKind :: Lens' CompatibleFields Text Source

The kind of resource this is, in this case dfareporting#compatibleFields.

cfFloodlightReportCompatibleFields :: Lens' CompatibleFields (Maybe FloodlightReportCompatibleFields) Source

Contains items that are compatible to be selected for a report of type "FLOODLIGHT".

cfReportCompatibleFields :: Lens' CompatibleFields (Maybe ReportCompatibleFields) Source

Contains items that are compatible to be selected for a report of type "STANDARD".

cfPathToConversionReportCompatibleFields :: Lens' CompatibleFields (Maybe PathToConversionReportCompatibleFields) Source

Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".

AudienceSegment

data AudienceSegment Source

Audience Segment.

See: audienceSegment smart constructor.

Instances

audienceSegment :: AudienceSegment Source

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

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

asName :: Lens' AudienceSegment (Maybe Text) Source

Name of this audience segment. This is a required field and must be less than 65 characters long.

asId :: Lens' AudienceSegment (Maybe Int64) Source

ID of this audience segment. This is a read-only, auto-generated field.

asAllocation :: Lens' AudienceSegment (Maybe Int32) Source

Weight allocated to this segment. Must be between 1 and 1000. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group.

FilesListSortField

data FilesListSortField Source

The field by which to sort the list.

Constructors

FLSFID

ID Sort by file ID.

FLSFLastModifiedTime

LAST_MODIFIED_TIME Sort by 'lastmodifiedAt' field.

Instances

DirectorySiteInterstitialTagFormatsItem

data DirectorySiteInterstitialTagFormatsItem Source

Constructors

IframeJavascriptInterstitial
IFRAME_JAVASCRIPT_INTERSTITIAL
InternalRedirectInterstitial
INTERNAL_REDIRECT_INTERSTITIAL
JavascriptInterstitial
JAVASCRIPT_INTERSTITIAL

Instances

DfpSettings

data DfpSettings Source

DFP Settings

See: dfpSettings smart constructor.

Instances

dfpSettings :: DfpSettings Source

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

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

dsPubPaidPlacementAccepted :: Lens' DfpSettings (Maybe Bool) Source

Whether this directory site accepts publisher-paid tags.

dsDfpNetworkName :: Lens' DfpSettings (Maybe Text) Source

DFP network name for this directory site.

dsPublisherPortalOnly :: Lens' DfpSettings (Maybe Bool) Source

Whether this directory site is available only via DoubleClick Publisher Portal.

dsProgrammaticPlacementAccepted :: Lens' DfpSettings (Maybe Bool) Source

Whether this directory site accepts programmatic placements.

dsDfpNetworkCode :: Lens' DfpSettings (Maybe Text) Source

DFP network code for this directory site.

EventTagsListSortField

data EventTagsListSortField Source

Field by which to sort the list.

Constructors

ETLSFID
ID
ETLSFName
NAME

Instances

PathToConversionReportCompatibleFields

data PathToConversionReportCompatibleFields Source

Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION".

See: pathToConversionReportCompatibleFields smart constructor.

Instances

pathToConversionReportCompatibleFields :: PathToConversionReportCompatibleFields Source

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

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

ptcrcfMetrics :: Lens' PathToConversionReportCompatibleFields [Metric] Source

Metrics which are compatible to be selected in the "metricNames" section of the report.

ptcrcfKind :: Lens' PathToConversionReportCompatibleFields Text Source

The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.

ptcrcfConversionDimensions :: Lens' PathToConversionReportCompatibleFields [Dimension] Source

Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.

ptcrcfCustomFloodlightVariables :: Lens' PathToConversionReportCompatibleFields [Dimension] Source

Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.

ptcrcfPerInteractionDimensions :: Lens' PathToConversionReportCompatibleFields [Dimension] Source

Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.

CreativeAssetPositionTopUnit

data CreativeAssetPositionTopUnit Source

Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.

Constructors

CAPTUOffSetUnitPercent
OFFSET_UNIT_PERCENT
CAPTUOffSetUnitPixel
OFFSET_UNIT_PIXEL
CAPTUOffSetUnitPixelFromCenter
OFFSET_UNIT_PIXEL_FROM_CENTER

Instances

City

data City Source

Contains information about a city that can be targeted by ads.

See: city smart constructor.

Instances

city :: City Source

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

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

ccMetroCode :: Lens' City (Maybe Text) Source

Metro region code of the metro region (DMA) to which this city belongs.

ccRegionCode :: Lens' City (Maybe Text) Source

Region code of the region to which this city belongs.

ccKind :: Lens' City Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".

ccRegionDartId :: Lens' City (Maybe Int64) Source

DART ID of the region to which this city belongs.

ccMetroDmaId :: Lens' City (Maybe Int64) Source

ID of the metro region (DMA) to which this city belongs.

ccName :: Lens' City (Maybe Text) Source

Name of this city.

ccCountryCode :: Lens' City (Maybe Text) Source

Country code of the country to which this city belongs.

ccCountryDartId :: Lens' City (Maybe Int64) Source

DART ID of the country to which this city belongs.

ccDartId :: Lens' City (Maybe Int64) Source

DART ID of this city. This is the ID used for targeting and generating reports.

PlatformType

data PlatformType Source

Contains information about a platform type that can be targeted by ads.

See: platformType smart constructor.

Instances

platformType :: PlatformType Source

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

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

ptKind :: Lens' PlatformType Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".

ptName :: Lens' PlatformType (Maybe Text) Source

Name of this platform type.

ptId :: Lens' PlatformType (Maybe Int64) Source

ID of this platform type.

FloodlightActivityFloodlightActivityGroupType

data FloodlightActivityFloodlightActivityGroupType Source

Type of the associated floodlight activity group. This is a read-only field.

Constructors

FAFAGTCounter
COUNTER
FAFAGTSale
SALE

Instances

DirectorySiteContactsListSortOrder

data DirectorySiteContactsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

DSCLSOAscending
ASCENDING
DSCLSODescending
DESCENDING

Instances

PricingGroupType

data PricingGroupType Source

Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.

Constructors

PlanningPlacementGroupTypePackage
PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE
PlanningPlacementGroupTypeRoadblock
PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK

Instances

KeyValueTargetingExpression

data KeyValueTargetingExpression Source

Key Value Targeting Expression.

See: keyValueTargetingExpression smart constructor.

Instances

keyValueTargetingExpression :: KeyValueTargetingExpression Source

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

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

kvteExpression :: Lens' KeyValueTargetingExpression (Maybe Text) Source

Keyword expression being targeted by the ad.

CompanionClickThroughOverride

data CompanionClickThroughOverride Source

Companion Click-through override.

See: companionClickThroughOverride smart constructor.

Instances

companionClickThroughOverride :: CompanionClickThroughOverride Source

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

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

cctoCreativeId :: Lens' CompanionClickThroughOverride (Maybe Int64) Source

ID of the creative for this companion click-through override.

cctoClickThroughURL :: Lens' CompanionClickThroughOverride (Maybe ClickThroughURL) Source

Click-through URL of this companion click-through override.

AdsListCreativeType

data AdsListCreativeType Source

Select only ads with the specified creativeType.

Constructors

ALCTBrandSafeDefaultInstreamVideo
BRAND_SAFE_DEFAULT_INSTREAM_VIDEO
ALCTCustomInpage
CUSTOM_INPAGE
ALCTCustomInterstitial
CUSTOM_INTERSTITIAL
ALCTEnhancedBanner
ENHANCED_BANNER
ALCTEnhancedImage
ENHANCED_IMAGE
ALCTFlashInpage
FLASH_INPAGE
ALCTHTML5Banner
HTML5_BANNER
ALCTImage
IMAGE
ALCTInstreamVideo
INSTREAM_VIDEO
ALCTInternalRedirect
INTERNAL_REDIRECT
ALCTInterstitialInternalRedirect
INTERSTITIAL_INTERNAL_REDIRECT
ALCTRedirect
REDIRECT
ALCTRichMediaExpanding
RICH_MEDIA_EXPANDING
ALCTRichMediaImExpand
RICH_MEDIA_IM_EXPAND
ALCTRichMediaInpage
RICH_MEDIA_INPAGE
ALCTRichMediaInpageFloating
RICH_MEDIA_INPAGE_FLOATING
ALCTRichMediaInterstitialFloat
RICH_MEDIA_INTERSTITIAL_FLOAT
ALCTRichMediaMobileInApp
RICH_MEDIA_MOBILE_IN_APP
ALCTRichMediaMultiFloating
RICH_MEDIA_MULTI_FLOATING
ALCTRichMediaPeelDown
RICH_MEDIA_PEEL_DOWN
ALCTTrackingText
TRACKING_TEXT
ALCTVastRedirect
VAST_REDIRECT
ALCTVpaidLinear
VPAID_LINEAR
ALCTVpaidNonLinear
VPAID_NON_LINEAR

Instances

FloodlightActivityGroupsListSortOrder

data FloodlightActivityGroupsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

FAGLSOAscending
ASCENDING
FAGLSODescending
DESCENDING

Instances

CreativeRotationType

data CreativeRotationType Source

Type of creative rotation. Can be used to specify whether to use sequential or random rotation.

Constructors

CreativeRotationTypeRandom
CREATIVE_ROTATION_TYPE_RANDOM
CreativeRotationTypeSequential
CREATIVE_ROTATION_TYPE_SEQUENTIAL

Instances

OrdersListSortField

data OrdersListSortField Source

Field by which to sort the list.

Constructors

OLSFID
ID
OLSFName
NAME

Instances

PlacementGroupsListSortField

data PlacementGroupsListSortField Source

Field by which to sort the list.

Constructors

PGLSFID
ID
PGLSFName
NAME

Instances

DirectorySitesListSortOrder

data DirectorySitesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

DSLSOAscending
ASCENDING
DSLSODescending
DESCENDING

Instances

AdvertisersListResponse

data AdvertisersListResponse Source

Advertiser List Response

See: advertisersListResponse smart constructor.

Instances

advertisersListResponse :: AdvertisersListResponse Source

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

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

advNextPageToken :: Lens' AdvertisersListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

advKind :: Lens' AdvertisersListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".

advAdvertisers :: Lens' AdvertisersListResponse [Advertiser] Source

Advertiser collection.

CountriesListResponse

data CountriesListResponse Source

Country List Response

See: countriesListResponse smart constructor.

Instances

countriesListResponse :: CountriesListResponse Source

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

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

couKind :: Lens' CountriesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".

couCountries :: Lens' CountriesListResponse [Country] Source

Country collection.

AccountPermissionGroupsListResponse

data AccountPermissionGroupsListResponse Source

Account Permission Group List Response

See: accountPermissionGroupsListResponse smart constructor.

Instances

accountPermissionGroupsListResponse :: AccountPermissionGroupsListResponse Source

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

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

apglrKind :: Lens' AccountPermissionGroupsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".

apglrAccountPermissionGroups :: Lens' AccountPermissionGroupsListResponse [AccountPermissionGroup] Source

Account permission group collection.

PopupWindowProperties

data PopupWindowProperties Source

Popup Window Properties.

See: popupWindowProperties smart constructor.

Instances

popupWindowProperties :: PopupWindowProperties Source

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

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

pwpOffSet :: Lens' PopupWindowProperties (Maybe OffSetPosition) Source

Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.

pwpDimension :: Lens' PopupWindowProperties (Maybe Size) Source

Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID

pwpShowStatusBar :: Lens' PopupWindowProperties (Maybe Bool) Source

Whether to display the browser status bar.

pwpShowMenuBar :: Lens' PopupWindowProperties (Maybe Bool) Source

Whether to display the browser menu bar.

pwpPositionType :: Lens' PopupWindowProperties (Maybe PopupWindowPropertiesPositionType) Source

Popup window position either centered or at specific coordinate.

pwpShowAddressBar :: Lens' PopupWindowProperties (Maybe Bool) Source

Whether to display the browser address bar.

pwpShowScrollBar :: Lens' PopupWindowProperties (Maybe Bool) Source

Whether to display the browser scroll bar.

pwpShowToolBar :: Lens' PopupWindowProperties (Maybe Bool) Source

Whether to display the browser tool bar.

pwpTitle :: Lens' PopupWindowProperties (Maybe Text) Source

Title of popup window.

CreativeAssetDetectedFeaturesItem

data CreativeAssetDetectedFeaturesItem Source

Constructors

CADFIApplicationCache
APPLICATION_CACHE
CADFIAudio
AUDIO
CADFICanvas
CANVAS
CADFICanvasText
CANVAS_TEXT
CADFICssAnimations
CSS_ANIMATIONS
CADFICssBackgRoundSize
CSS_BACKGROUND_SIZE
CADFICssBOrderImage
CSS_BORDER_IMAGE
CADFICssBOrderRadius
CSS_BORDER_RADIUS
CADFICssBoxShadow
CSS_BOX_SHADOW
CADFICssColumns
CSS_COLUMNS
CADFICssFlexBox
CSS_FLEX_BOX
CADFICssFontFace
CSS_FONT_FACE
CADFICssGeneratedContent
CSS_GENERATED_CONTENT
CADFICssGradients
CSS_GRADIENTS
CADFICssHsla
CSS_HSLA
CADFICssMultipleBgs
CSS_MULTIPLE_BGS
CADFICssOpacity
CSS_OPACITY
CADFICssReflections
CSS_REFLECTIONS
CADFICssRgba
CSS_RGBA
CADFICssTextShadow
CSS_TEXT_SHADOW
CADFICssTransforms
CSS_TRANSFORMS
CADFICssTRANSFORMS3D
CSS_TRANSFORMS3D
CADFICssTransitions
CSS_TRANSITIONS
CADFIDragAndDrop
DRAG_AND_DROP
CADFIGeoLocation
GEO_LOCATION
CADFIHashChange
HASH_CHANGE
CADFIHistory
HISTORY
CADFIIndexedDB
INDEXED_DB
CADFIInlineSvg
INLINE_SVG
CADFIInputAttrAutocomplete
INPUT_ATTR_AUTOCOMPLETE
CADFIInputAttrAutofocus
INPUT_ATTR_AUTOFOCUS
CADFIInputAttrList
INPUT_ATTR_LIST
CADFIInputAttrMax
INPUT_ATTR_MAX
CADFIInputAttrMin
INPUT_ATTR_MIN
CADFIInputAttrMultiple
INPUT_ATTR_MULTIPLE
CADFIInputAttrPattern
INPUT_ATTR_PATTERN
CADFIInputAttrPlaceholder
INPUT_ATTR_PLACEHOLDER
CADFIInputAttrRequired
INPUT_ATTR_REQUIRED
CADFIInputAttrStep
INPUT_ATTR_STEP
CADFIInputTypeColor
INPUT_TYPE_COLOR
CADFIInputTypeDate
INPUT_TYPE_DATE
CADFIInputTypeDatetime
INPUT_TYPE_DATETIME
CADFIInputTypeDatetimeLocal
INPUT_TYPE_DATETIME_LOCAL
CADFIInputTypeEmail
INPUT_TYPE_EMAIL
CADFIInputTypeMonth
INPUT_TYPE_MONTH
CADFIInputTypeNumber
INPUT_TYPE_NUMBER
CADFIInputTypeRange
INPUT_TYPE_RANGE
CADFIInputTypeSearch
INPUT_TYPE_SEARCH
CADFIInputTypeTel
INPUT_TYPE_TEL
CADFIInputTypeTime
INPUT_TYPE_TIME
CADFIInputTypeURL
INPUT_TYPE_URL
CADFIInputTypeWeek
INPUT_TYPE_WEEK
CADFILocalStorage
LOCAL_STORAGE
CADFIPostMessage
POST_MESSAGE
CADFISessionStorage
SESSION_STORAGE
CADFISmil
SMIL
CADFISvgClipPaths
SVG_CLIP_PATHS
CADFISvgFeImage
SVG_FE_IMAGE
CADFISvgFilters
SVG_FILTERS
CADFISvgHref
SVG_HREF
CADFITouch
TOUCH
CADFIVideo
VIDEO
CADFIWebgl
WEBGL
CADFIWebSockets
WEB_SOCKETS
CADFIWebSQLDatabase
WEB_SQL_DATABASE
CADFIWebWorkers
WEB_WORKERS

Instances

FloodlightActivityGroupType

data FloodlightActivityGroupType Source

Type of the floodlight activity group. This is a required field that is read-only after insertion.

Constructors

FAGTCounter
COUNTER
FAGTSale
SALE

Instances

DirectorySiteContactType

data DirectorySiteContactType Source

Directory site contact type.

Constructors

DSCTBilling
BILLING
DSCTOther
OTHER
DSCTSales
SALES
DSCTTechnical
TECHNICAL

Instances

EventTagOverride

data EventTagOverride Source

Event tag override information.

See: eventTagOverride smart constructor.

Instances

eventTagOverride :: EventTagOverride Source

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

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

etoEnabled :: Lens' EventTagOverride (Maybe Bool) Source

Whether this override is enabled.

etoId :: Lens' EventTagOverride (Maybe Int64) Source

ID of this event tag override. This is a read-only, auto-generated field.

PlacementsGeneratetagsTagFormats

data PlacementsGeneratetagsTagFormats Source

Tag formats to generate for these placements.

Constructors

PGTFPlacementTagClickCommands
PLACEMENT_TAG_CLICK_COMMANDS
PGTFPlacementTagIframeIlayer
PLACEMENT_TAG_IFRAME_ILAYER
PGTFPlacementTagIframeJavascript
PLACEMENT_TAG_IFRAME_JAVASCRIPT
PGTFPlacementTagIframeJavascriptLegacy
PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY
PGTFPlacementTagInstreamVideoPrefetch
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH
PGTFPlacementTagInstreamVideoPrefetchVast3
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3
PGTFPlacementTagInternalRedirect
PLACEMENT_TAG_INTERNAL_REDIRECT
PGTFPlacementTagInterstitialIframeJavascript
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT
PGTFPlacementTagInterstitialIframeJavascriptLegacy
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY
PGTFPlacementTagInterstitialInternalRedirect
PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT
PGTFPlacementTagInterstitialJavascript
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT
PGTFPlacementTagInterstitialJavascriptLegacy
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY
PGTFPlacementTagJavascript
PLACEMENT_TAG_JAVASCRIPT
PGTFPlacementTagJavascriptLegacy
PLACEMENT_TAG_JAVASCRIPT_LEGACY
PGTFPlacementTagStandard
PLACEMENT_TAG_STANDARD
PGTFPlacementTagTracking
PLACEMENT_TAG_TRACKING
PGTFPlacementTagTrackingIframe
PLACEMENT_TAG_TRACKING_IFRAME
PGTFPlacementTagTrackingJavascript
PLACEMENT_TAG_TRACKING_JAVASCRIPT

Instances

AccountUserProFilesListSortField

data AccountUserProFilesListSortField Source

Field by which to sort the list.

Constructors

AUPFLSFID
ID
AUPFLSFName
NAME

Instances

OperatingSystemVersion

data OperatingSystemVersion Source

Contains information about a particular version of an operating system that can be targeted by ads.

See: operatingSystemVersion smart constructor.

Instances

operatingSystemVersion :: OperatingSystemVersion Source

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

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

osvMinorVersion :: Lens' OperatingSystemVersion (Maybe Text) Source

Minor version (number after the first dot) of this operating system version.

osvKind :: Lens' OperatingSystemVersion Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".

osvOperatingSystem :: Lens' OperatingSystemVersion (Maybe OperatingSystem) Source

Operating system of this operating system version.

osvMajorVersion :: Lens' OperatingSystemVersion (Maybe Text) Source

Major version (leftmost number) of this operating system version.

osvName :: Lens' OperatingSystemVersion (Maybe Text) Source

Name of this operating system version.

osvId :: Lens' OperatingSystemVersion (Maybe Int64) Source

ID of this operating system version.

InventoryItemsListSortOrder

data InventoryItemsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

IILSOAscending
ASCENDING
IILSODescending
DESCENDING

Instances

PlacementStrategiesListSortOrder

data PlacementStrategiesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

PSLSOAscending
ASCENDING
PSLSODescending
DESCENDING

Instances

AccountPermission

data AccountPermission Source

AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.

See: accountPermission smart constructor.

Instances

accountPermission :: AccountPermission Source

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

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

acccKind :: Lens' AccountPermission Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".

acccAccountProFiles :: Lens' AccountPermission [AccountPermissionAccountProFilesItem] Source

Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD"

acccName :: Lens' AccountPermission (Maybe Text) Source

Name of this account permission.

acccId :: Lens' AccountPermission (Maybe Int64) Source

ID of this account permission.

acccLevel :: Lens' AccountPermission (Maybe AccountPermissionLevel) Source

Administrative level required to enable this account permission.

acccPermissionGroupId :: Lens' AccountPermission (Maybe Int64) Source

Permission group of this account permission.

UserProFile

data UserProFile Source

Represents a UserProfile resource.

See: userProFile smart constructor.

Instances

userProFile :: UserProFile Source

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

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

upfEtag :: Lens' UserProFile (Maybe Text) Source

The eTag of this response for caching purposes.

upfKind :: Lens' UserProFile Text Source

The kind of resource this is, in this case dfareporting#userProfile.

upfAccountName :: Lens' UserProFile (Maybe Text) Source

The account name this profile belongs to.

upfProFileId :: Lens' UserProFile (Maybe Int64) Source

The unique ID of the user profile.

upfUserName :: Lens' UserProFile (Maybe Text) Source

The user name.

upfAccountId :: Lens' UserProFile (Maybe Int64) Source

The account ID to which this profile belongs.

upfSubAccountName :: Lens' UserProFile (Maybe Text) Source

The sub account name this profile belongs to if applicable.

upfSubAccountId :: Lens' UserProFile (Maybe Int64) Source

The sub account ID this profile belongs to if applicable.

OperatingSystemsListResponse

data OperatingSystemsListResponse Source

Operating System List Response

See: operatingSystemsListResponse smart constructor.

Instances

operatingSystemsListResponse :: OperatingSystemsListResponse Source

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

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

oslrKind :: Lens' OperatingSystemsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".

oslrOperatingSystems :: Lens' OperatingSystemsListResponse [OperatingSystem] Source

Operating system collection.

ReportDelivery

data ReportDelivery Source

The report's email delivery settings.

See: reportDelivery smart constructor.

Instances

reportDelivery :: ReportDelivery Source

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

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

rdEmailOwner :: Lens' ReportDelivery (Maybe Bool) Source

Whether the report should be emailed to the report owner.

rdRecipients :: Lens' ReportDelivery [Recipient] Source

The list of recipients to which to email the report.

rdMessage :: Lens' ReportDelivery (Maybe Text) Source

The message to be sent with each email.

rdEmailOwnerDeliveryType :: Lens' ReportDelivery (Maybe ReportDeliveryEmailOwnerDeliveryType) Source

The type of delivery for the owner to receive, if enabled.

TargetableRemarketingList

data TargetableRemarketingList Source

Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.

See: targetableRemarketingList smart constructor.

Instances

targetableRemarketingList :: TargetableRemarketingList Source

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

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

trlListSize :: Lens' TargetableRemarketingList (Maybe Int64) Source

Number of users currently in the list. This is a read-only field.

trlLifeSpan :: Lens' TargetableRemarketingList (Maybe Int64) Source

Number of days that a user should remain in the targetable remarketing list without an impression.

trlKind :: Lens' TargetableRemarketingList Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".

trlAdvertiserId :: Lens' TargetableRemarketingList (Maybe Int64) Source

Dimension value for the advertiser ID that owns this targetable remarketing list.

trlAdvertiserIdDimensionValue :: Lens' TargetableRemarketingList (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser.

trlActive :: Lens' TargetableRemarketingList (Maybe Bool) Source

Whether this targetable remarketing list is active.

trlAccountId :: Lens' TargetableRemarketingList (Maybe Int64) Source

Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

trlName :: Lens' TargetableRemarketingList (Maybe Text) Source

Name of the targetable remarketing list. Is no greater than 128 characters long.

trlListSource :: Lens' TargetableRemarketingList (Maybe TargetableRemarketingListListSource) Source

Product from which this targetable remarketing list was originated.

trlId :: Lens' TargetableRemarketingList (Maybe Int64) Source

Targetable remarketing list ID.

trlSubAccountId :: Lens' TargetableRemarketingList (Maybe Int64) Source

Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.

trlDescription :: Lens' TargetableRemarketingList (Maybe Text) Source

Targetable remarketing list description.

ReportsFilesListSortField

data ReportsFilesListSortField Source

The field by which to sort the list.

Constructors

RFLSFID

ID Sort by file ID.

RFLSFLastModifiedTime

LAST_MODIFIED_TIME Sort by 'lastmodifiedAt' field.

Instances

PostalCodesListResponse

data PostalCodesListResponse Source

Postal Code List Response

See: postalCodesListResponse smart constructor.

Instances

postalCodesListResponse :: PostalCodesListResponse Source

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

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

pclrKind :: Lens' PostalCodesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".

pclrPostalCodes :: Lens' PostalCodesListResponse [PostalCode] Source

Postal code collection.

ChangeLog

data ChangeLog Source

Describes a change that a user has made to a resource.

See: changeLog smart constructor.

Instances

changeLog :: ChangeLog Source

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

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

chaUserProFileId :: Lens' ChangeLog (Maybe Int64) Source

ID of the user who modified the object.

chaObjectType :: Lens' ChangeLog (Maybe Text) Source

Object type of the change log.

chaUserProFileName :: Lens' ChangeLog (Maybe Text) Source

User profile name of the user who modified the object.

chaKind :: Lens' ChangeLog Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".

chaObjectId :: Lens' ChangeLog (Maybe Int64) Source

ID of the object of this change log. The object could be a campaign, placement, ad, or other type.

chaAction :: Lens' ChangeLog (Maybe Text) Source

Action which caused the change.

chaTransactionId :: Lens' ChangeLog (Maybe Int64) Source

Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.

chaOldValue :: Lens' ChangeLog (Maybe Text) Source

Old value of the object field.

chaAccountId :: Lens' ChangeLog (Maybe Int64) Source

Account ID of the modified object.

chaNewValue :: Lens' ChangeLog (Maybe Text) Source

New value of the object field.

chaFieldName :: Lens' ChangeLog (Maybe Text) Source

Field name of the object which changed.

chaId :: Lens' ChangeLog (Maybe Int64) Source

ID of this change log.

chaSubAccountId :: Lens' ChangeLog (Maybe Int64) Source

Subaccount ID of the modified object.

chaChangeTime :: Lens' ChangeLog (Maybe UTCTime) Source

Time when the object was modified.

CreativesListSortField

data CreativesListSortField Source

Field by which to sort the list.

Constructors

CID
ID
CName
NAME

Instances

PlacementStrategy

data PlacementStrategy Source

Contains properties of a placement strategy.

See: placementStrategy smart constructor.

Instances

placementStrategy :: PlacementStrategy Source

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

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

psKind :: Lens' PlacementStrategy Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".

psAccountId :: Lens' PlacementStrategy (Maybe Int64) Source

Account ID of this placement strategy.This is a read-only field that can be left blank.

psName :: Lens' PlacementStrategy (Maybe Text) Source

Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.

psId :: Lens' PlacementStrategy (Maybe Int64) Source

ID of this placement strategy. This is a read-only, auto-generated field.

FloodlightActivity

data FloodlightActivity Source

Contains properties of a Floodlight activity.

See: floodlightActivity smart constructor.

Instances

floodlightActivity :: FloodlightActivity Source

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

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

faCountingMethod :: Lens' FloodlightActivity (Maybe FloodlightActivityCountingMethod) Source

Counting method for conversions for this floodlight activity. This is a required field.

faTagString :: Lens' FloodlightActivity (Maybe Text) Source

Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.

faSecure :: Lens' FloodlightActivity (Maybe Bool) Source

Whether this tag should use SSL.

faExpectedURL :: Lens' FloodlightActivity (Maybe Text) Source

URL where this tag will be deployed. If specified, must be less than 256 characters long.

faFloodlightActivityGroupTagString :: Lens' FloodlightActivity (Maybe Text) Source

Tag string of the associated floodlight activity group. This is a read-only field.

faFloodlightConfigurationId :: Lens' FloodlightActivity (Maybe Int64) Source

Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.

faKind :: Lens' FloodlightActivity Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".

faImageTagEnabled :: Lens' FloodlightActivity (Maybe Bool) Source

Whether the image tag is enabled for this activity.

faAdvertiserId :: Lens' FloodlightActivity (Maybe Int64) Source

Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.

faAdvertiserIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

faSSLCompliant :: Lens' FloodlightActivity (Maybe Bool) Source

Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.

faIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) Source

Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.

faTagFormat :: Lens' FloodlightActivity (Maybe FloodlightActivityTagFormat) Source

Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.

faCacheBustingType :: Lens' FloodlightActivity (Maybe FloodlightActivityCacheBustingType) Source

Code type used for cache busting in the generated tag.

faAccountId :: Lens' FloodlightActivity (Maybe Int64) Source

Account ID of this floodlight activity. This is a read-only field that can be left blank.

faName :: Lens' FloodlightActivity (Maybe Text) Source

Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.

faPublisherTags :: Lens' FloodlightActivity [FloodlightActivityPublisherDynamicTag] Source

Publisher dynamic floodlight tags.

faFloodlightActivityGroupId :: Lens' FloodlightActivity (Maybe Int64) Source

Floodlight activity group ID of this floodlight activity. This is a required field.

faHidden :: Lens' FloodlightActivity (Maybe Bool) Source

Whether this activity is archived.

faFloodlightActivityGroupType :: Lens' FloodlightActivity (Maybe FloodlightActivityFloodlightActivityGroupType) Source

Type of the associated floodlight activity group. This is a read-only field.

faDefaultTags :: Lens' FloodlightActivity [FloodlightActivityDynamicTag] Source

Dynamic floodlight tags.

faFloodlightActivityGroupName :: Lens' FloodlightActivity (Maybe Text) Source

Name of the associated floodlight activity group. This is a read-only field.

faId :: Lens' FloodlightActivity (Maybe Int64) Source

ID of this floodlight activity. This is a read-only, auto-generated field.

faSSLRequired :: Lens' FloodlightActivity (Maybe Bool) Source

Whether this floodlight activity must be SSL-compliant.

faUserDefinedVariableTypes :: Lens' FloodlightActivity [FloodlightActivityUserDefinedVariableTypesItem] Source

List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. Acceptable values are: - "U1" - "U2" - "U3" - "U4" - "U5" - "U6" - "U7" - "U8" - "U9" - "U10" - "U11" - "U12" - "U13" - "U14" - "U15" - "U16" - "U17" - "U18" - "U19" - "U20"

faSubAccountId :: Lens' FloodlightActivity (Maybe Int64) Source

Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.

faNotes :: Lens' FloodlightActivity (Maybe Text) Source

General notes or implementation instructions for the tag.

faFloodlightConfigurationIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) Source

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

DayPartTargetingDaysOfWeekItem

data DayPartTargetingDaysOfWeekItem Source

Constructors

DPTDOWIFriday
FRIDAY
DPTDOWIMonday
MONDAY
DPTDOWISaturday
SATURDAY
DPTDOWISunday
SUNDAY
DPTDOWIThursday
THURSDAY
DPTDOWITuesday
TUESDAY
DPTDOWIWednesday
WEDNESDAY

Instances

CreativeRotationWeightCalculationStrategy

data CreativeRotationWeightCalculationStrategy Source

Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.

Constructors

WeightStrategyCustom
WEIGHT_STRATEGY_CUSTOM
WeightStrategyEqual
WEIGHT_STRATEGY_EQUAL
WeightStrategyHighestCtr
WEIGHT_STRATEGY_HIGHEST_CTR
WeightStrategyOptimized
WEIGHT_STRATEGY_OPTIMIZED

Instances

FilesListScope

data FilesListScope Source

The scope that defines which results are returned, default is 'MINE'.

Constructors

FLSAll

ALL All files in account.

FLSMine

MINE My files.

FLSSharedWithMe

SHARED_WITH_ME Files shared with me.

Instances

ContentCategoriesListSortField

data ContentCategoriesListSortField Source

Field by which to sort the list.

Constructors

CCLSFID
ID
CCLSFName
NAME

Instances

ProjectAudienceAgeGroup

data ProjectAudienceAgeGroup Source

Audience age group of this project.

Constructors

PlanningAudienceAge1824
PLANNING_AUDIENCE_AGE_18_24
PlanningAudienceAge2534
PLANNING_AUDIENCE_AGE_25_34
PlanningAudienceAge3544
PLANNING_AUDIENCE_AGE_35_44
PlanningAudienceAge4554
PLANNING_AUDIENCE_AGE_45_54
PlanningAudienceAge5564
PLANNING_AUDIENCE_AGE_55_64
PlanningAudienceAge65OrMore
PLANNING_AUDIENCE_AGE_65_OR_MORE
PlanningAudienceAgeUnknown
PLANNING_AUDIENCE_AGE_UNKNOWN

Instances

PlatformTypesListResponse

data PlatformTypesListResponse Source

Platform Type List Response

See: platformTypesListResponse smart constructor.

Instances

platformTypesListResponse :: PlatformTypesListResponse Source

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

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

ptlrKind :: Lens' PlatformTypesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".

ptlrPlatformTypes :: Lens' PlatformTypesListResponse [PlatformType] Source

Platform type collection.

AdType

data AdType Source

Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).

Constructors

ATAdServingClickTracker
AD_SERVING_CLICK_TRACKER
ATAdServingDefaultAd
AD_SERVING_DEFAULT_AD
ATAdServingStandardAd
AD_SERVING_STANDARD_AD
ATAdServingTracking
AD_SERVING_TRACKING

Instances

LastModifiedInfo

data LastModifiedInfo Source

Modification timestamp.

See: lastModifiedInfo smart constructor.

Instances

lastModifiedInfo :: LastModifiedInfo Source

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

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

lmiTime :: Lens' LastModifiedInfo (Maybe Int64) Source

Timestamp of the last change in milliseconds since epoch.

TargetWindow

data TargetWindow Source

Target Window.

See: targetWindow smart constructor.

Instances

targetWindow :: TargetWindow Source

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

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

twCustomHTML :: Lens' TargetWindow (Maybe Text) Source

User-entered value.

twTargetWindowOption :: Lens' TargetWindow (Maybe TargetWindowTargetWindowOption) Source

Type of browser window for which the backup image of the flash creative can be displayed.

ChangeLogsListAction

data ChangeLogsListAction Source

Select only change logs with the specified action.

Constructors

ActionAdd
ACTION_ADD
ActionAssign
ACTION_ASSIGN
ActionAssociate
ACTION_ASSOCIATE
ActionCreate
ACTION_CREATE
ActionDelete
ACTION_DELETE
ActionDisable
ACTION_DISABLE
ActionEmailTags
ACTION_EMAIL_TAGS
ActionEnable
ACTION_ENABLE
ActionLink
ACTION_LINK
ActionMarkAsDefault
ACTION_MARK_AS_DEFAULT
ActionPush
ACTION_PUSH
ActionRemove
ACTION_REMOVE
ActionSend
ACTION_SEND
ActionShare
ACTION_SHARE
ActionUnassign
ACTION_UNASSIGN
ActionUnlink
ACTION_UNLINK
ActionUpdate
ACTION_UPDATE

Instances

CreativeArtworkType

data CreativeArtworkType Source

Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

Constructors

CATArtworkTypeFlash
ARTWORK_TYPE_FLASH
CATArtworkTypeHTML5
ARTWORK_TYPE_HTML5
CATArtworkTypeMixed
ARTWORK_TYPE_MIXED

Instances

PlacementStatus

data PlacementStatus Source

Third-party placement status.

Constructors

AcknowledgeAcceptance
ACKNOWLEDGE_ACCEPTANCE
AcknowledgeRejection
ACKNOWLEDGE_REJECTION
Draft
DRAFT
PaymentAccepted
PAYMENT_ACCEPTED
PaymentRejected
PAYMENT_REJECTED
PendingReview
PENDING_REVIEW

Instances

AccountPermissionGroup

data AccountPermissionGroup Source

AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.

See: accountPermissionGroup smart constructor.

Instances

accountPermissionGroup :: AccountPermissionGroup Source

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

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

apgpKind :: Lens' AccountPermissionGroup Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".

apgpName :: Lens' AccountPermissionGroup (Maybe Text) Source

Name of this account permission group.

apgpId :: Lens' AccountPermissionGroup (Maybe Int64) Source

ID of this account permission group.

Advertiser

data Advertiser Source

Contains properties of a DCM advertiser.

See: advertiser smart constructor.

Instances

advertiser :: Advertiser Source

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

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

advdOriginalFloodlightConfigurationId :: Lens' Advertiser (Maybe Int64) Source

Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.

advdStatus :: Lens' Advertiser (Maybe AdvertiserStatus) Source

Status of this advertiser.

advdFloodlightConfigurationId :: Lens' Advertiser (Maybe Int64) Source

Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.

advdKind :: Lens' Advertiser Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".

advdSuspended :: Lens' Advertiser (Maybe Bool) Source

Suspension status of this advertiser.

advdIdDimensionValue :: Lens' Advertiser (Maybe DimensionValue) Source

Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.

advdAccountId :: Lens' Advertiser (Maybe Int64) Source

Account ID of this advertiser.This is a read-only field that can be left blank.

advdDefaultEmail :: Lens' Advertiser (Maybe Text) Source

Default email address used in sender field for tag emails.

advdName :: Lens' Advertiser (Maybe Text) Source

Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.

advdAdvertiserGroupId :: Lens' Advertiser (Maybe Int64) Source

ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.

advdDefaultClickThroughEventTagId :: Lens' Advertiser (Maybe Int64) Source

ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.

advdId :: Lens' Advertiser (Maybe Int64) Source

ID of this advertiser. This is a read-only, auto-generated field.

advdSubAccountId :: Lens' Advertiser (Maybe Int64) Source

Subaccount ID of this advertiser.This is a read-only field that can be left blank.

advdFloodlightConfigurationIdDimensionValue :: Lens' Advertiser (Maybe DimensionValue) Source

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

advdClickThroughURLSuffix :: Lens' Advertiser (Maybe Text) Source

Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.

ReportScheduleRunsOnDayOfMonth

data ReportScheduleRunsOnDayOfMonth Source

Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.

Constructors

DayOfMonth
DAY_OF_MONTH
WeekOfMonth
WEEK_OF_MONTH

Instances

UserRole

data UserRole Source

Contains properties of auser role, which is used to manage user access.

See: userRole smart constructor.

Instances

userRole :: UserRole Source

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

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

urParentUserRoleId :: Lens' UserRole (Maybe Int64) Source

ID of the user role that this user role is based on or copied from. This is a required field.

urKind :: Lens' UserRole Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".

urDefaultUserRole :: Lens' UserRole (Maybe Bool) Source

Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.

urAccountId :: Lens' UserRole (Maybe Int64) Source

Account ID of this user role. This is a read-only field that can be left blank.

urName :: Lens' UserRole (Maybe Text) Source

Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.

urId :: Lens' UserRole (Maybe Int64) Source

ID of this user role. This is a read-only, auto-generated field.

urPermissions :: Lens' UserRole [UserRolePermission] Source

List of permissions associated with this user role.

urSubAccountId :: Lens' UserRole (Maybe Int64) Source

Subaccount ID of this user role. This is a read-only field that can be left blank.

FloodlightActivityUserDefinedVariableTypesItem

data FloodlightActivityUserDefinedVariableTypesItem Source

Constructors

FAUDVTIU1
U1
FAUDVTIU10
U10
FAUDVTIU11
U11
FAUDVTIU12
U12
FAUDVTIU13
U13
FAUDVTIU14
U14
FAUDVTIU15
U15
FAUDVTIU16
U16
FAUDVTIU17
U17
FAUDVTIU18
U18
FAUDVTIU19
U19
FAUDVTIU2
U2
FAUDVTIU20
U20
FAUDVTIU3
U3
FAUDVTIU4
U4
FAUDVTIU5
U5
FAUDVTIU6
U6
FAUDVTIU7
U7
FAUDVTIU8
U8
FAUDVTIU9
U9

Instances

EventTagSiteFilterType

data EventTagSiteFilterType Source

Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.

Constructors

BlackList
BLACKLIST
WhiteList
WHITELIST

Instances

ReportFormat

data ReportFormat Source

The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.

Constructors

RFCSV
CSV
RFExcel
EXCEL

Instances

PlacementGroupPlacementGroupType

data PlacementGroupPlacementGroupType Source

Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.

Constructors

PGPGTPlacementPackage
PLACEMENT_PACKAGE
PGPGTPlacementRoadblock
PLACEMENT_ROADBLOCK

Instances

DirectorySitesListResponse

data DirectorySitesListResponse Source

Directory Site List Response

See: directorySitesListResponse smart constructor.

Instances

directorySitesListResponse :: DirectorySitesListResponse Source

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

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

dslrNextPageToken :: Lens' DirectorySitesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

dslrKind :: Lens' DirectorySitesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".

dslrDirectorySites :: Lens' DirectorySitesListResponse [DirectorySite] Source

Directory site collection.

PricingPricingType

data PricingPricingType Source

Pricing type of this inventory item.

Constructors

PlanningPlacementPricingTypeClicks
PLANNING_PLACEMENT_PRICING_TYPE_CLICKS
PlanningPlacementPricingTypeCpa
PLANNING_PLACEMENT_PRICING_TYPE_CPA
PlanningPlacementPricingTypeCpc
PLANNING_PLACEMENT_PRICING_TYPE_CPC
PlanningPlacementPricingTypeCpm
PLANNING_PLACEMENT_PRICING_TYPE_CPM
PlanningPlacementPricingTypeFlatRateClicks
PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS
PlanningPlacementPricingTypeFlatRateImpressions
PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS
PlanningPlacementPricingTypeImpressions
PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS

Instances

PricingSchedulePricingPeriod

data PricingSchedulePricingPeriod Source

Pricing Period

See: pricingSchedulePricingPeriod smart constructor.

Instances

pricingSchedulePricingPeriod :: PricingSchedulePricingPeriod Source

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

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

psppEndDate :: Lens' PricingSchedulePricingPeriod (Maybe Day) Source

Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.

psppRateOrCostNanos :: Lens' PricingSchedulePricingPeriod (Maybe Int64) Source

Rate or cost of this pricing period.

psppStartDate :: Lens' PricingSchedulePricingPeriod (Maybe Day) Source

Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.

psppUnits :: Lens' PricingSchedulePricingPeriod (Maybe Int64) Source

Units of this pricing period.

psppPricingComment :: Lens' PricingSchedulePricingPeriod (Maybe Text) Source

Comments for this pricing period.

SubAccountsListSortOrder

data SubAccountsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

SALSOAscending
ASCENDING
SALSODescending
DESCENDING

Instances

DirectorySiteContactsListResponse

data DirectorySiteContactsListResponse Source

Directory Site Contact List Response

See: directorySiteContactsListResponse smart constructor.

Instances

directorySiteContactsListResponse :: DirectorySiteContactsListResponse Source

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

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

dsclrNextPageToken :: Lens' DirectorySiteContactsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

dsclrKind :: Lens' DirectorySiteContactsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".

dsclrDirectorySiteContacts :: Lens' DirectorySiteContactsListResponse [DirectorySiteContact] Source

Directory site contact collection

Region

data Region Source

Contains information about a region that can be targeted by ads.

See: region smart constructor.

Instances

region :: Region Source

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

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

regRegionCode :: Lens' Region (Maybe Text) Source

Region code.

regKind :: Lens' Region Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".

regName :: Lens' Region (Maybe Text) Source

Name of this region.

regCountryCode :: Lens' Region (Maybe Text) Source

Country code of the country to which this region belongs.

regCountryDartId :: Lens' Region (Maybe Int64) Source

DART ID of the country to which this region belongs.

regDartId :: Lens' Region (Maybe Int64) Source

DART ID of this region.

AdvertiserGroupsListResponse

data AdvertiserGroupsListResponse Source

Advertiser Group List Response

See: advertiserGroupsListResponse smart constructor.

Instances

advertiserGroupsListResponse :: AdvertiserGroupsListResponse Source

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

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

aglrNextPageToken :: Lens' AdvertiserGroupsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

aglrKind :: Lens' AdvertiserGroupsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".

aglrAdvertiserGroups :: Lens' AdvertiserGroupsListResponse [AdvertiserGroup] Source

Advertiser group collection.

AdsListSortOrder

data AdsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

ADSAscending
ASCENDING
ADSDescending
DESCENDING

Instances

ProjectsListSortOrder

data ProjectsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

PLSOAscending
ASCENDING
PLSODescending
DESCENDING

Instances

CreativeAssignment

data CreativeAssignment Source

Creative Assignment.

See: creativeAssignment smart constructor.

Instances

creativeAssignment :: CreativeAssignment Source

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

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

caCreativeGroupAssignments :: Lens' CreativeAssignment [CreativeGroupAssignment] Source

Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.

caStartTime :: Lens' CreativeAssignment (Maybe UTCTime) Source

Date and time that the assigned creative should start serving.

caWeight :: Lens' CreativeAssignment (Maybe Int32) Source

Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.

caRichMediaExitOverrides :: Lens' CreativeAssignment [RichMediaExitOverride] Source

Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - ADVANCED_BANNER - VPAID_LINEAR - VPAID_NON_LINEAR

caSSLCompliant :: Lens' CreativeAssignment (Maybe Bool) Source

Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.

caCreativeId :: Lens' CreativeAssignment (Maybe Int64) Source

ID of the creative to be assigned. This is a required field.

caClickThroughURL :: Lens' CreativeAssignment (Maybe ClickThroughURL) Source

Click-through URL of the creative assignment.

caApplyEventTags :: Lens' CreativeAssignment (Maybe Bool) Source

Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.

caActive :: Lens' CreativeAssignment (Maybe Bool) Source

Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.

caSequence :: Lens' CreativeAssignment (Maybe Int32) Source

Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.

caEndTime :: Lens' CreativeAssignment (Maybe UTCTime) Source

Date and time that the assigned creative should stop serving. Must be later than the start time.

caCompanionCreativeOverrides :: Lens' CreativeAssignment [CompanionClickThroughOverride] Source

Companion creative overrides for this creative assignment. Applicable to video ads.

caCreativeIdDimensionValue :: Lens' CreativeAssignment (Maybe DimensionValue) Source

Dimension value for the ID of the creative. This is a read-only, auto-generated field.

DimensionFilter

data DimensionFilter Source

Represents a dimension filter.

See: dimensionFilter smart constructor.

Instances

dimensionFilter :: DimensionFilter Source

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

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

dfKind :: Lens' DimensionFilter Text Source

The kind of resource this is, in this case dfareporting#dimensionFilter.

dfValue :: Lens' DimensionFilter (Maybe Text) Source

The value of the dimension to filter.

dfDimensionName :: Lens' DimensionFilter (Maybe Text) Source

The name of the dimension to filter.

UserProFileList

data UserProFileList Source

Represents the list of user profiles.

See: userProFileList smart constructor.

Instances

userProFileList :: UserProFileList Source

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

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

upflEtag :: Lens' UserProFileList (Maybe Text) Source

The eTag of this response for caching purposes.

upflKind :: Lens' UserProFileList Text Source

The kind of list this is, in this case dfareporting#userProfileList.

upflItems :: Lens' UserProFileList [UserProFile] Source

The user profiles returned in this response.

RemarketingListsListSortField

data RemarketingListsListSortField Source

Field by which to sort the list.

Constructors

RLLSFID
ID
RLLSFName
NAME

Instances

FloodlightConfiguration

data FloodlightConfiguration Source

Contains properties of a Floodlight configuration.

See: floodlightConfiguration smart constructor.

Instances

floodlightConfiguration :: FloodlightConfiguration Source

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

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

fcTagSettings :: Lens' FloodlightConfiguration (Maybe TagSettings) Source

Configuration settings for dynamic and image floodlight tags.

fcExposureToConversionEnabled :: Lens' FloodlightConfiguration (Maybe Bool) Source

Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.

fcInAppAttributionTrackingEnabled :: Lens' FloodlightConfiguration (Maybe Bool) Source

Whether in-app attribution tracking is enabled.

fcThirdPartyAuthenticationTokens :: Lens' FloodlightConfiguration [ThirdPartyAuthenticationToken] Source

List of third-party authentication tokens enabled for this configuration.

fcKind :: Lens' FloodlightConfiguration Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".

fcAdvertiserId :: Lens' FloodlightConfiguration (Maybe Int64) Source

Advertiser ID of the parent advertiser of this floodlight configuration.

fcAnalyticsDataSharingEnabled :: Lens' FloodlightConfiguration (Maybe Bool) Source

Whether advertiser data is shared with Google Analytics.

fcAdvertiserIdDimensionValue :: Lens' FloodlightConfiguration (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

fcIdDimensionValue :: Lens' FloodlightConfiguration (Maybe DimensionValue) Source

Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.

fcLookbackConfiguration :: Lens' FloodlightConfiguration (Maybe LookbackConfiguration) Source

Lookback window settings for this floodlight configuration.

fcAccountId :: Lens' FloodlightConfiguration (Maybe Int64) Source

Account ID of this floodlight configuration. This is a read-only field that can be left blank.

fcId :: Lens' FloodlightConfiguration (Maybe Int64) Source

ID of this floodlight configuration. This is a read-only, auto-generated field.

fcSSLRequired :: Lens' FloodlightConfiguration (Maybe Bool) Source

Whether floodlight activities owned by this configuration are required to be SSL-compliant.

fcNATuralSearchConversionAttributionOption :: Lens' FloodlightConfiguration (Maybe FloodlightConfigurationNATuralSearchConversionAttributionOption) Source

Types of attribution options for natural search conversions.

fcUserDefinedVariableConfigurations :: Lens' FloodlightConfiguration [UserDefinedVariableConfiguration] Source

List of user defined variables enabled for this configuration.

fcSubAccountId :: Lens' FloodlightConfiguration (Maybe Int64) Source

Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.

fcFirstDayOfWeek :: Lens' FloodlightConfiguration (Maybe FloodlightConfigurationFirstDayOfWeek) Source

Day that will be counted as the first day of the week in reports. This is a required field.

fcOmnitureSettings :: Lens' FloodlightConfiguration (Maybe OmnitureSettings) Source

Settings for DCM Omniture integration.

fcStandardVariableTypes :: Lens' FloodlightConfiguration [FloodlightConfigurationStandardVariableTypesItem] Source

List of standard variables enabled for this configuration. Acceptable values are: - "ORD" - "NUM"

ReportScheduleRepeatsOnWeekDaysItem

data ReportScheduleRepeatsOnWeekDaysItem Source

Constructors

RSROWDIFriday
FRIDAY
RSROWDIMonday
MONDAY
RSROWDISaturday
SATURDAY
RSROWDISunday
SUNDAY
RSROWDIThursday
THURSDAY
RSROWDITuesday
TUESDAY
RSROWDIWednesday
WEDNESDAY

Instances

FloodlightActivityGroupsListResponse

data FloodlightActivityGroupsListResponse Source

Floodlight Activity Group List Response

See: floodlightActivityGroupsListResponse smart constructor.

Instances

floodlightActivityGroupsListResponse :: FloodlightActivityGroupsListResponse Source

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

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

faglrNextPageToken :: Lens' FloodlightActivityGroupsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

faglrKind :: Lens' FloodlightActivityGroupsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".

faglrFloodlightActivityGroups :: Lens' FloodlightActivityGroupsListResponse [FloodlightActivityGroup] Source

Floodlight activity group collection.

CreativeGroupAssignmentCreativeGroupNumber

data CreativeGroupAssignmentCreativeGroupNumber Source

Creative group number of the creative group assignment.

Constructors

CreativeGroupOne
CREATIVE_GROUP_ONE
CreativeGroupTwo
CREATIVE_GROUP_TWO

Instances

CreativeFieldValuesListResponse

data CreativeFieldValuesListResponse Source

Creative Field Value List Response

See: creativeFieldValuesListResponse smart constructor.

Instances

creativeFieldValuesListResponse :: CreativeFieldValuesListResponse Source

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

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

cfvlrNextPageToken :: Lens' CreativeFieldValuesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

cfvlrKind :: Lens' CreativeFieldValuesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".

cfvlrCreativeFieldValues :: Lens' CreativeFieldValuesListResponse [CreativeFieldValue] Source

Creative field value collection.

AccountsListSortField

data AccountsListSortField Source

Field by which to sort the list.

Constructors

AID
ID
AName
NAME

Instances

RichMediaExitOverride

data RichMediaExitOverride Source

Rich Media Exit Override.

See: richMediaExitOverride smart constructor.

Instances

richMediaExitOverride :: RichMediaExitOverride Source

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

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

rmeoUseCustomExitURL :: Lens' RichMediaExitOverride (Maybe Bool) Source

Whether to use the custom exit URL.

rmeoExitId :: Lens' RichMediaExitOverride (Maybe Int64) Source

ID for the override to refer to a specific exit in the creative.

rmeoCustomExitURL :: Lens' RichMediaExitOverride (Maybe Text) Source

Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.

AdvertisersListStatus

data AdvertisersListStatus Source

Select only advertisers with the specified status.

Constructors

Approved
APPROVED
OnHold
ON_HOLD

Instances

DimensionValueMatchType

data DimensionValueMatchType Source

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.

Constructors

BeginsWith
BEGINS_WITH
Contains
CONTAINS
Exact
EXACT
WildcardExpression
WILDCARD_EXPRESSION

Instances

SortedDimension

data SortedDimension Source

Represents a sorted dimension.

See: sortedDimension smart constructor.

Instances

sortedDimension :: SortedDimension Source

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

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

sdKind :: Lens' SortedDimension Text Source

The kind of resource this is, in this case dfareporting#sortedDimension.

sdSortOrder :: Lens' SortedDimension (Maybe SortedDimensionSortOrder) Source

An optional sort order for the dimension column.

sdName :: Lens' SortedDimension (Maybe Text) Source

The name of the dimension.

PlacementGroupsListSortOrder

data PlacementGroupsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

PGLSOAscending
ASCENDING
PGLSODescending
DESCENDING

Instances

CreativeFieldsListResponse

data CreativeFieldsListResponse Source

Creative Field List Response

See: creativeFieldsListResponse smart constructor.

Instances

creativeFieldsListResponse :: CreativeFieldsListResponse Source

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

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

cflrNextPageToken :: Lens' CreativeFieldsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

cflrKind :: Lens' CreativeFieldsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".

cflrCreativeFields :: Lens' CreativeFieldsListResponse [CreativeField] Source

Creative field collection.

PlacementsGenerateTagsResponse

data PlacementsGenerateTagsResponse Source

Placement GenerateTags Response

See: placementsGenerateTagsResponse smart constructor.

Instances

placementsGenerateTagsResponse :: PlacementsGenerateTagsResponse Source

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

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

pgtrKind :: Lens' PlacementsGenerateTagsResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".

pgtrPlacementTags :: Lens' PlacementsGenerateTagsResponse [PlacementTag] Source

Set of generated tags for the specified placements.

CreativeAsset

data CreativeAsset Source

Creative Asset.

See: creativeAsset smart constructor.

Instances

creativeAsset :: CreativeAsset Source

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

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

caaZIndex :: Lens' CreativeAsset (Maybe Int32) Source

zIndex value of an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.

caaPushdown :: Lens' CreativeAsset (Maybe Bool) Source

Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.

caaVideoDuration :: Lens' CreativeAsset (Maybe Double) Source

Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

caaOriginalBackup :: Lens' CreativeAsset (Maybe Bool) Source

Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.

caaWindowMode :: Lens' CreativeAsset (Maybe CreativeAssetWindowMode) Source

Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.

caaFlashVersion :: Lens' CreativeAsset (Maybe Int32) Source

Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.

caaPushdownDuration :: Lens' CreativeAsset (Maybe Double) Source

Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.

caaSize :: Lens' CreativeAsset (Maybe Size) Source

Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE creatives, if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.

caaVerticallyLocked :: Lens' CreativeAsset (Maybe Bool) Source

Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

caaOffSet :: Lens' CreativeAsset (Maybe OffSetPosition) Source

Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.

caaStreamingServingURL :: Lens' CreativeAsset (Maybe Text) Source

Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

caaZipFilesize :: Lens' CreativeAsset (Maybe Text) Source

Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

caaTransparency :: Lens' CreativeAsset (Maybe Bool) Source

Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.

caaHideSelectionBoxes :: Lens' CreativeAsset (Maybe Bool) Source

Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.

caaSSLCompliant :: Lens' CreativeAsset (Maybe Bool) Source

Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

caaFileSize :: Lens' CreativeAsset (Maybe Int64) Source

File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

caaAssetIdentifier :: Lens' CreativeAsset (Maybe CreativeAssetId) Source

Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

caaDurationType :: Lens' CreativeAsset (Maybe CreativeAssetDurationType) Source

Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.

caaProgressiveServingURL :: Lens' CreativeAsset (Maybe Text) Source

Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

caaActive :: Lens' CreativeAsset (Maybe Bool) Source

Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

caaRole :: Lens' CreativeAsset (Maybe CreativeAssetRole) Source

Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives. TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives. ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM. For VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR creative.

caaMimeType :: Lens' CreativeAsset (Maybe Text) Source

Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

caaPositionTopUnit :: Lens' CreativeAsset (Maybe CreativeAssetPositionTopUnit) Source

Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.

caaPositionLeftUnit :: Lens' CreativeAsset (Maybe CreativeAssetPositionLeftUnit) Source

Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

caaAlignment :: Lens' CreativeAsset (Maybe CreativeAssetAlignment) Source

Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.

caaExpandedDimension :: Lens' CreativeAsset (Maybe Size) Source

Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

caaZipFilename :: Lens' CreativeAsset (Maybe Text) Source

File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

caaActionScript3 :: Lens' CreativeAsset (Maybe Bool) Source

Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER.

caaDisplayType :: Lens' CreativeAsset (Maybe CreativeAssetDisplayType) Source

Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

caaChildAssetType :: Lens' CreativeAsset (Maybe CreativeAssetChildAssetType) Source

Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.

caaCollapsedSize :: Lens' CreativeAsset (Maybe Size) Source

Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.

caaId :: Lens' CreativeAsset (Maybe Int64) Source

Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

caaBitRate :: Lens' CreativeAsset (Maybe Int32) Source

Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

caaCustomStartTimeValue :: Lens' CreativeAsset (Maybe Int32) Source

Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.

caaStartTimeType :: Lens' CreativeAsset (Maybe CreativeAssetStartTimeType) Source

Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.

caaDuration :: Lens' CreativeAsset (Maybe Int32) Source

Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.

caaArtworkType :: Lens' CreativeAsset (Maybe CreativeAssetArtworkType) Source

Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

caaHideFlashObjects :: Lens' CreativeAsset (Maybe Bool) Source

Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.

caaDetectedFeatures :: Lens' CreativeAsset [CreativeAssetDetectedFeaturesItem] Source

List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: ENHANCED_BANNER and HTML5_BANNER.

caaBackupImageExit :: Lens' CreativeAsset (Maybe CreativeCustomEvent) Source

Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.

caaPosition :: Lens' CreativeAsset (Maybe OffSetPosition) Source

Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.

caaHorizontallyLocked :: Lens' CreativeAsset (Maybe Bool) Source

Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

AdCompatibility

data AdCompatibility Source

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_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.

Constructors

ACApp
APP
ACAppInterstitial
APP_INTERSTITIAL
ACInStreamVideo
IN_STREAM_VIDEO
ACWeb
WEB
ACWebInterstitial
WEB_INTERSTITIAL

Instances

CreativeFieldValuesListSortField

data CreativeFieldValuesListSortField Source

Field by which to sort the list.

Constructors

CFVLSFID
ID
CFVLSFValue
VALUE

Instances

PlacementsListResponse

data PlacementsListResponse Source

Placement List Response

See: placementsListResponse smart constructor.

Instances

placementsListResponse :: PlacementsListResponse Source

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

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

plaNextPageToken :: Lens' PlacementsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

plaKind :: Lens' PlacementsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".

plaPlacements :: Lens' PlacementsListResponse [Placement] Source

Placement collection.

FloodlightActivityGroupsListSortField

data FloodlightActivityGroupsListSortField Source

Field by which to sort the list.

Constructors

FAGLSFID
ID
FAGLSFName
NAME

Instances

OrdersListSortOrder

data OrdersListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

OLSOAscending
ASCENDING
OLSODescending
DESCENDING

Instances

ReportSchedule

data ReportSchedule Source

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

See: reportSchedule smart constructor.

Instances

reportSchedule :: ReportSchedule Source

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

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

rsEvery :: Lens' ReportSchedule (Maybe Int32) Source

Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".

rsActive :: Lens' ReportSchedule (Maybe Bool) Source

Whether the schedule is active or not. Must be set to either true or false.

rsRepeats :: Lens' ReportSchedule (Maybe Text) Source

The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.

rsStartDate :: Lens' ReportSchedule (Maybe Day) Source

Start date of date range for which scheduled reports should be run.

rsExpirationDate :: Lens' ReportSchedule (Maybe Day) Source

The expiration date when the scheduled report stops running.

rsRunsOnDayOfMonth :: Lens' ReportSchedule (Maybe ReportScheduleRunsOnDayOfMonth) Source

Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.

rsRepeatsOnWeekDays :: Lens' ReportSchedule [ReportScheduleRepeatsOnWeekDaysItem] Source

List of week days "WEEKLY" on which scheduled reports should run.

ReportPathToConversionCriteria

data ReportPathToConversionCriteria Source

The report criteria for a report of type "PATH_TO_CONVERSION".

See: reportPathToConversionCriteria smart constructor.

Instances

reportPathToConversionCriteria :: ReportPathToConversionCriteria Source

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

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

rptccReportProperties :: Lens' ReportPathToConversionCriteria (Maybe ReportPathToConversionCriteriaReportProperties) Source

The properties of the report.

rptccMetricNames :: Lens' ReportPathToConversionCriteria [Text] Source

The list of names of metrics the report should include.

rptccCustomRichMediaEvents :: Lens' ReportPathToConversionCriteria [DimensionValue] Source

The list of custom rich media events to include.

rptccDateRange :: Lens' ReportPathToConversionCriteria (Maybe DateRange) Source

The date range this report should be run for.

rptccConversionDimensions :: Lens' ReportPathToConversionCriteria [SortedDimension] Source

The list of conversion dimensions the report should include.

rptccCustomFloodlightVariables :: Lens' ReportPathToConversionCriteria [SortedDimension] Source

The list of custom floodlight variables the report should include.

rptccFloodlightConfigId :: Lens' ReportPathToConversionCriteria (Maybe DimensionValue) Source

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

rptccActivityFilters :: Lens' ReportPathToConversionCriteria [DimensionValue] Source

The list of 'dfa:activity' values to filter on.

rptccPerInteractionDimensions :: Lens' ReportPathToConversionCriteria [SortedDimension] Source

The list of per interaction dimensions the report should include.

MetrosListResponse

data MetrosListResponse Source

Metro List Response

See: metrosListResponse smart constructor.

Instances

metrosListResponse :: MetrosListResponse Source

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

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

mlrKind :: Lens' MetrosListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".

mlrMetros :: Lens' MetrosListResponse [Metro] Source

Metro collection.

AccountAccountProFile

data AccountAccountProFile Source

Profile for this account. This is a read-only field that can be left blank.

Constructors

AccountProFileBasic
ACCOUNT_PROFILE_BASIC
AccountProFileStandard
ACCOUNT_PROFILE_STANDARD

Instances

OrderDocumentsListResponse

data OrderDocumentsListResponse Source

Order document List Response

See: orderDocumentsListResponse smart constructor.

Instances

orderDocumentsListResponse :: OrderDocumentsListResponse Source

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

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

odlrNextPageToken :: Lens' OrderDocumentsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

odlrKind :: Lens' OrderDocumentsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".

odlrOrderDocuments :: Lens' OrderDocumentsListResponse [OrderDocument] Source

Order document collection

Recipient

data Recipient Source

Represents a recipient.

See: recipient smart constructor.

Instances

recipient :: Recipient Source

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

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

recEmail :: Lens' Recipient (Maybe Text) Source

The email address of the recipient.

recKind :: Lens' Recipient Text Source

The kind of resource this is, in this case dfareporting#recipient.

recDeliveryType :: Lens' Recipient (Maybe RecipientDeliveryType) Source

The delivery type for the recipient.

CreativeType

data CreativeType Source

Type of this creative.This is a required field. Applicable to all creative types.

Constructors

CTBrandSafeDefaultInstreamVideo
BRAND_SAFE_DEFAULT_INSTREAM_VIDEO
CTCustomInpage
CUSTOM_INPAGE
CTCustomInterstitial
CUSTOM_INTERSTITIAL
CTEnhancedBanner
ENHANCED_BANNER
CTEnhancedImage
ENHANCED_IMAGE
CTFlashInpage
FLASH_INPAGE
CTHTML5Banner
HTML5_BANNER
CTImage
IMAGE
CTInstreamVideo
INSTREAM_VIDEO
CTInternalRedirect
INTERNAL_REDIRECT
CTInterstitialInternalRedirect
INTERSTITIAL_INTERNAL_REDIRECT
CTRedirect
REDIRECT
CTRichMediaExpanding
RICH_MEDIA_EXPANDING
CTRichMediaImExpand
RICH_MEDIA_IM_EXPAND
CTRichMediaInpage
RICH_MEDIA_INPAGE
CTRichMediaInpageFloating
RICH_MEDIA_INPAGE_FLOATING
CTRichMediaInterstitialFloat
RICH_MEDIA_INTERSTITIAL_FLOAT
CTRichMediaMobileInApp
RICH_MEDIA_MOBILE_IN_APP
CTRichMediaMultiFloating
RICH_MEDIA_MULTI_FLOATING
CTRichMediaPeelDown
RICH_MEDIA_PEEL_DOWN
CTTrackingText
TRACKING_TEXT
CTVastRedirect
VAST_REDIRECT
CTVpaidLinear
VPAID_LINEAR
CTVpaidNonLinear
VPAID_NON_LINEAR

Instances

FilesListSortOrder

data FilesListSortOrder Source

Order of sorted results, default is 'DESCENDING'.

Constructors

FLSOAscending

ASCENDING Ascending order.

FLSODescending

DESCENDING Descending order.

Instances

AdvertiserGroupsListSortField

data AdvertiserGroupsListSortField Source

Field by which to sort the list.

Constructors

AGLSFID
ID
AGLSFName
NAME

Instances

TargetWindowTargetWindowOption

data TargetWindowTargetWindowOption Source

Type of browser window for which the backup image of the flash creative can be displayed.

Constructors

CurrentWindow
CURRENT_WINDOW
Custom
CUSTOM
NewWindow
NEW_WINDOW

Instances

DirectorySiteContactsListSortField

data DirectorySiteContactsListSortField Source

Field by which to sort the list.

Constructors

DSCLSFID
ID
DSCLSFName
NAME

Instances

PlacementsListPricingTypes

data PlacementsListPricingTypes Source

Select only placements with these pricing types.

Constructors

PLPTPricingTypeCpa
PRICING_TYPE_CPA
PLPTPricingTypeCpc
PRICING_TYPE_CPC
PLPTPricingTypeCpm
PRICING_TYPE_CPM
PLPTPricingTypeFlatRateClicks
PRICING_TYPE_FLAT_RATE_CLICKS
PLPTPricingTypeFlatRateImpressions
PRICING_TYPE_FLAT_RATE_IMPRESSIONS

Instances

EventTagsListSortOrder

data EventTagsListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

ETLSOAscending
ASCENDING
ETLSODescending
DESCENDING

Instances

DirectorySitesListSortField

data DirectorySitesListSortField Source

Field by which to sort the list.

Constructors

DSLSFID
ID
DSLSFName
NAME

Instances

Site

data Site Source

Contains properties of a site.

See: site smart constructor.

Instances

site :: Site Source

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

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

ssKind :: Lens' Site Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".

ssKeyName :: Lens' Site (Maybe Text) Source

Key name of this site. This is a read-only, auto-generated field.

ssSiteContacts :: Lens' Site [SiteContact] Source

Site contacts.

ssSiteSettings :: Lens' Site (Maybe SiteSettings) Source

Site-wide settings.

ssIdDimensionValue :: Lens' Site (Maybe DimensionValue) Source

Dimension value for the ID of this site. This is a read-only, auto-generated field.

ssDirectorySiteIdDimensionValue :: Lens' Site (Maybe DimensionValue) Source

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.

ssAccountId :: Lens' Site (Maybe Int64) Source

Account ID of this site. This is a read-only field that can be left blank.

ssName :: Lens' Site (Maybe Text) Source

Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.

ssDirectorySiteId :: Lens' Site (Maybe Int64) Source

Directory site associated with this site. This is a required field that is read-only after insertion.

ssId :: Lens' Site (Maybe Int64) Source

ID of this site. This is a read-only, auto-generated field.

ssSubAccountId :: Lens' Site (Maybe Int64) Source

Subaccount ID of this site. This is a read-only field that can be left blank.

ssApproved :: Lens' Site (Maybe Bool) Source

Whether this site is approved.

ReportCrossDimensionReachCriteriaDimension

data ReportCrossDimensionReachCriteriaDimension Source

The dimension option.

Constructors

RCDRCDAdvertiser
ADVERTISER
RCDRCDCampaign
CAMPAIGN
RCDRCDSiteByAdvertiser
SITE_BY_ADVERTISER
RCDRCDSiteByCampaign
SITE_BY_CAMPAIGN

Instances

SitesListSortOrder

data SitesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

SLSOAscending
ASCENDING
SLSODescending
DESCENDING

Instances

UserDefinedVariableConfiguration

data UserDefinedVariableConfiguration Source

User Defined Variable configuration.

See: userDefinedVariableConfiguration smart constructor.

Instances

userDefinedVariableConfiguration :: UserDefinedVariableConfiguration Source

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

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

udvcReportName :: Lens' UserDefinedVariableConfiguration (Maybe Text) Source

User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".

udvcDataType :: Lens' UserDefinedVariableConfiguration (Maybe UserDefinedVariableConfigurationDataType) Source

Data type for the variable. This is a required field.

udvcVariableType :: Lens' UserDefinedVariableConfiguration (Maybe UserDefinedVariableConfigurationVariableType) Source

Variable name in the tag. This is a required field.

ReportCrossDimensionReachCriteria

data ReportCrossDimensionReachCriteria Source

The report criteria for a report of type "CROSS_DIMENSION_REACH".

See: reportCrossDimensionReachCriteria smart constructor.

Instances

reportCrossDimensionReachCriteria :: ReportCrossDimensionReachCriteria Source

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

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

rcdrcPivoted :: Lens' ReportCrossDimensionReachCriteria (Maybe Bool) Source

Whether the report is pivoted or not. Defaults to true.

rcdrcBreakdown :: Lens' ReportCrossDimensionReachCriteria [SortedDimension] Source

The list of dimensions the report should include.

rcdrcDimension :: Lens' ReportCrossDimensionReachCriteria (Maybe ReportCrossDimensionReachCriteriaDimension) Source

The dimension option.

rcdrcMetricNames :: Lens' ReportCrossDimensionReachCriteria [Text] Source

The list of names of metrics the report should include.

rcdrcDimensionFilters :: Lens' ReportCrossDimensionReachCriteria [DimensionValue] Source

The list of filters on which dimensions are filtered.

rcdrcDateRange :: Lens' ReportCrossDimensionReachCriteria (Maybe DateRange) Source

The date range this report should be run for.

rcdrcOverlapMetricNames :: Lens' ReportCrossDimensionReachCriteria [Text] Source

The list of names of overlap metrics the report should include.

FileURLs

data FileURLs Source

The URLs where the completed report file can be downloaded.

See: fileURLs smart constructor.

Instances

fileURLs :: FileURLs Source

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

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

fuBrowserURL :: Lens' FileURLs (Maybe Text) Source

The URL for downloading the report data through a browser.

fuAPIURL :: Lens' FileURLs (Maybe Text) Source

The URL for downloading the report data through the API.

CampaignCreativeAssociationsListResponse

data CampaignCreativeAssociationsListResponse Source

Campaign Creative Association List Response

See: campaignCreativeAssociationsListResponse smart constructor.

Instances

campaignCreativeAssociationsListResponse :: CampaignCreativeAssociationsListResponse Source

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

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

ccalrCampaignCreativeAssociations :: Lens' CampaignCreativeAssociationsListResponse [CampaignCreativeAssociation] Source

Campaign creative association collection

ccalrNextPageToken :: Lens' CampaignCreativeAssociationsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

ccalrKind :: Lens' CampaignCreativeAssociationsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".

PlacementTagFormatsItem

data PlacementTagFormatsItem Source

Constructors

PTFIPlacementTagClickCommands
PLACEMENT_TAG_CLICK_COMMANDS
PTFIPlacementTagIframeIlayer
PLACEMENT_TAG_IFRAME_ILAYER
PTFIPlacementTagIframeJavascript
PLACEMENT_TAG_IFRAME_JAVASCRIPT
PTFIPlacementTagIframeJavascriptLegacy
PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY
PTFIPlacementTagInstreamVideoPrefetch
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH
PTFIPlacementTagInstreamVideoPrefetchVast3
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3
PTFIPlacementTagInternalRedirect
PLACEMENT_TAG_INTERNAL_REDIRECT
PTFIPlacementTagInterstitialIframeJavascript
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT
PTFIPlacementTagInterstitialIframeJavascriptLegacy
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY
PTFIPlacementTagInterstitialInternalRedirect
PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT
PTFIPlacementTagInterstitialJavascript
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT
PTFIPlacementTagInterstitialJavascriptLegacy
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY
PTFIPlacementTagJavascript
PLACEMENT_TAG_JAVASCRIPT
PTFIPlacementTagJavascriptLegacy
PLACEMENT_TAG_JAVASCRIPT_LEGACY
PTFIPlacementTagStandard
PLACEMENT_TAG_STANDARD
PTFIPlacementTagTracking
PLACEMENT_TAG_TRACKING
PTFIPlacementTagTrackingIframe
PLACEMENT_TAG_TRACKING_IFRAME
PTFIPlacementTagTrackingJavascript
PLACEMENT_TAG_TRACKING_JAVASCRIPT

Instances

Order

data Order Source

Describes properties of a DoubleClick Planning order.

See: order smart constructor.

Instances

order :: Order Source

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

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

oSellerOrderId :: Lens' Order (Maybe Text) Source

Seller order ID associated with this order.

oSellerOrganizationName :: Lens' Order (Maybe Text) Source

Name of the seller organization.

oKind :: Lens' Order Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".

oAdvertiserId :: Lens' Order (Maybe Int64) Source

Advertiser ID of this order.

oPlanningTermId :: Lens' Order (Maybe Int64) Source

ID of the terms and conditions template used in this order.

oAccountId :: Lens' Order (Maybe Int64) Source

Account ID of this order.

oName :: Lens' Order (Maybe Text) Source

Name of this order.

oSiteNames :: Lens' Order [Text] Source

Free-form site names this order is associated with.

oLastModifiedInfo :: Lens' Order (Maybe LastModifiedInfo) Source

Information about the most recent modification of this order.

oBuyerOrganizationName :: Lens' Order (Maybe Text) Source

Name of the buyer organization.

oId :: Lens' Order (Maybe Int64) Source

ID of this order. This is a read-only, auto-generated field.

oBuyerInvoiceId :: Lens' Order (Maybe Text) Source

Buyer invoice ID associated with this order.

oComments :: Lens' Order (Maybe Text) Source

Comments in this order.

oProjectId :: Lens' Order (Maybe Int64) Source

Project ID of this order.

oSubAccountId :: Lens' Order (Maybe Int64) Source

Subaccount ID of this order.

oNotes :: Lens' Order (Maybe Text) Source

Notes of this order.

oContacts :: Lens' Order [OrderContact] Source

Contacts for this order.

oSiteId :: Lens' Order [Int64] Source

Site IDs this order is associated with.

oTermsAndConditions :: Lens' Order (Maybe Text) Source

Terms and conditions of this order.

oApproverUserProFileIds :: Lens' Order [Int64] Source

IDs for users that have to approve documents created for this order.

CreativeAssetId

data CreativeAssetId Source

Creative Asset ID.

See: creativeAssetId smart constructor.

Instances

creativeAssetId :: CreativeAssetId Source

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

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

caiName :: Lens' CreativeAssetId (Maybe Text) Source

Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.

caiType :: Lens' CreativeAssetId (Maybe CreativeAssetIdType) Source

Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.

FrequencyCap

data FrequencyCap Source

Frequency Cap.

See: frequencyCap smart constructor.

Instances

frequencyCap :: FrequencyCap Source

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

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

fcImpressions :: Lens' FrequencyCap (Maybe Int64) Source

Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.

fcDuration :: Lens' FrequencyCap (Maybe Int64) Source

Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.

File

data File Source

Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".

See: file smart constructor.

Instances

file :: File Source

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

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

filStatus :: Lens' File (Maybe FileStatus) Source

The status of the report file.

filEtag :: Lens' File (Maybe Text) Source

The eTag of this response for caching purposes.

filKind :: Lens' File Text Source

The kind of resource this is, in this case dfareporting#file.

filURLs :: Lens' File (Maybe FileURLs) Source

The URLs where the completed report file can be downloaded.

filReportId :: Lens' File (Maybe Int64) Source

The ID of the report this file was generated from.

filDateRange :: Lens' File (Maybe DateRange) Source

The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.

filFormat :: Lens' File (Maybe FileFormat) Source

The output format of the report. Only available once the file is available.

filLastModifiedTime :: Lens' File (Maybe Int64) Source

The timestamp in milliseconds since epoch when this file was last modified.

filId :: Lens' File (Maybe Int64) Source

The unique ID of this report file.

filFileName :: Lens' File (Maybe Text) Source

The filename of the file.

CreativeSettings

data CreativeSettings Source

Creative Settings

See: creativeSettings smart constructor.

Instances

creativeSettings :: CreativeSettings Source

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

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

csIFrameHeader :: Lens' CreativeSettings (Maybe Text) Source

Header text for iFrames for this site. Must be less than or equal to 2000 characters long.

csIFrameFooter :: Lens' CreativeSettings (Maybe Text) Source

Header text for iFrames for this site. Must be less than or equal to 2000 characters long.

ReportType

data ReportType Source

The type of the report.

Constructors

RTCrossDimensionReach
CROSS_DIMENSION_REACH
RTFloodlight
FLOODLIGHT
RTPathToConversion
PATH_TO_CONVERSION
RTReach
REACH
RTStandard
STANDARD

Instances

CreativeAssetMetadataWarnedValidationRulesItem

data CreativeAssetMetadataWarnedValidationRulesItem Source

Constructors

ADMobReferenced
ADMOB_REFERENCED
AssetFormatUnsupportedDcm
ASSET_FORMAT_UNSUPPORTED_DCM
AssetInvalid
ASSET_INVALID
ClickTagInvalid
CLICK_TAG_INVALID
ClickTagMissing
CLICK_TAG_MISSING
ClickTagMoreThanOne
CLICK_TAG_MORE_THAN_ONE
ClickTagNonTopLevel
CLICK_TAG_NON_TOP_LEVEL
ComponentUnsupportedDcm
COMPONENT_UNSUPPORTED_DCM
EnablerUnsupportedMethodDcm
ENABLER_UNSUPPORTED_METHOD_DCM
ExternalFileReferenced
EXTERNAL_FILE_REFERENCED
FileDetailEmpty
FILE_DETAIL_EMPTY
FileTypeInvalid
FILE_TYPE_INVALID
GwdPropertiesInvalid
GWD_PROPERTIES_INVALID
HTML5FeatureUnsupported
HTML5_FEATURE_UNSUPPORTED
LinkedFileNotFound
LINKED_FILE_NOT_FOUND
MaxFlashVersion11
MAX_FLASH_VERSION_11
MraidReferenced
MRAID_REFERENCED
NotSSLCompliant
NOT_SSL_COMPLIANT
OrphanedAsset
ORPHANED_ASSET
PrimaryHTMLMissing
PRIMARY_HTML_MISSING
ZipInvalid
ZIP_INVALID

Instances

CreativeGroupsListResponse

data CreativeGroupsListResponse Source

Creative Group List Response

See: creativeGroupsListResponse smart constructor.

Instances

creativeGroupsListResponse :: CreativeGroupsListResponse Source

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

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

cglrCreativeGroups :: Lens' CreativeGroupsListResponse [CreativeGroup] Source

Creative group collection.

cglrNextPageToken :: Lens' CreativeGroupsListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

cglrKind :: Lens' CreativeGroupsListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".

AdSlotPaymentSourceType

data AdSlotPaymentSourceType Source

Payment source type of this ad slot.

Constructors

PlanningPaymentSourceTypeAgencyPaid
PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID
PlanningPaymentSourceTypePublisherPaid
PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID

Instances

MobileCarriersListResponse

data MobileCarriersListResponse Source

Mobile Carrier List Response

See: mobileCarriersListResponse smart constructor.

Instances

mobileCarriersListResponse :: MobileCarriersListResponse Source

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

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

mclrMobileCarriers :: Lens' MobileCarriersListResponse [MobileCarrier] Source

Mobile carrier collection.

mclrKind :: Lens' MobileCarriersListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".

LandingPagesListResponse

data LandingPagesListResponse Source

Landing Page List Response

See: landingPagesListResponse smart constructor.

Instances

landingPagesListResponse :: LandingPagesListResponse Source

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

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

lplrLandingPages :: Lens' LandingPagesListResponse [LandingPage] Source

Landing page collection

lplrKind :: Lens' LandingPagesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".

AccountPermissionAccountProFilesItem

data AccountPermissionAccountProFilesItem Source

Constructors

APAPFIAccountProFileBasic
ACCOUNT_PROFILE_BASIC
APAPFIAccountProFileStandard
ACCOUNT_PROFILE_STANDARD

Instances

CreativeAssetMetadata

data CreativeAssetMetadata Source

CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.

See: creativeAssetMetadata smart constructor.

Instances

creativeAssetMetadata :: CreativeAssetMetadata Source

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

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

camaKind :: Lens' CreativeAssetMetadata Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".

camaAssetIdentifier :: Lens' CreativeAssetMetadata (Maybe CreativeAssetId) Source

ID of the creative asset. This is a required field.

camaClickTags :: Lens' CreativeAssetMetadata [ClickTag] Source

List of detected click tags for assets. This is a read-only auto-generated field.

camaWarnedValidationRules :: Lens' CreativeAssetMetadata [CreativeAssetMetadataWarnedValidationRulesItem] Source

Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "CLICK_TAG_NON_TOP_LEVEL" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_INVALID" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "EXTERNAL_FILE_REFERENCED" - "MRAID_REFERENCED" - "ADMOB_REFERENCED" - "FILE_TYPE_INVALID" - "ZIP_INVALID" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "NOT_SSL_COMPLIANT" - "FILE_DETAIL_EMPTY" - "ASSET_INVALID" - "GWD_PROPERTIES_INVALID" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "COMPONENT_UNSUPPORTED_DCM" - "HTML5_FEATURE_UNSUPPORTED' "

camaDetectedFeatures :: Lens' CreativeAssetMetadata [CreativeAssetMetadataDetectedFeaturesItem] Source

List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.

OmnitureSettings

data OmnitureSettings Source

Omniture Integration Settings.

See: omnitureSettings smart constructor.

Instances

omnitureSettings :: OmnitureSettings Source

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

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

osOmnitureCostDataEnabled :: Lens' OmnitureSettings (Maybe Bool) Source

Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.

osOmnitureIntegrationEnabled :: Lens' OmnitureSettings (Maybe Bool) Source

Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.

ConnectionType

data ConnectionType Source

Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.

See: connectionType smart constructor.

Instances

connectionType :: ConnectionType Source

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

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

cttKind :: Lens' ConnectionType Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".

cttName :: Lens' ConnectionType (Maybe Text) Source

Name of this connection type.

cttId :: Lens' ConnectionType (Maybe Int64) Source

ID of this connection type.

CreativeCustomEventAdvertiserCustomEventType

data CreativeCustomEventAdvertiserCustomEventType Source

Type of the event. This is a read-only field.

Constructors

AdvertiserEventCounter
ADVERTISER_EVENT_COUNTER
AdvertiserEventExit
ADVERTISER_EVENT_EXIT
AdvertiserEventTimer
ADVERTISER_EVENT_TIMER

Instances

PlacementGroup

data PlacementGroup Source

Contains properties of a package or roadblock.

See: placementGroup smart constructor.

Instances

placementGroup :: PlacementGroup Source

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

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

plalPlacementStrategyId :: Lens' PlacementGroup (Maybe Int64) Source

ID of the placement strategy assigned to this placement group.

plalSiteIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) Source

Dimension value for the ID of the site. This is a read-only, auto-generated field.

plalPricingSchedule :: Lens' PlacementGroup (Maybe PricingSchedule) Source

Pricing schedule of this placement group. This field is required on insertion.

plalKind :: Lens' PlacementGroup Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".

plalCampaignIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) Source

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

plalAdvertiserId :: Lens' PlacementGroup (Maybe Int64) Source

Advertiser ID of this placement group. This is a required field on insertion.

plalAdvertiserIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

plalCampaignId :: Lens' PlacementGroup (Maybe Int64) Source

Campaign ID of this placement group. This field is required on insertion.

plalIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) Source

Dimension value for the ID of this placement group. This is a read-only, auto-generated field.

plalPlacementGroupType :: Lens' PlacementGroup (Maybe PlacementGroupPlacementGroupType) Source

Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.

plalContentCategoryId :: Lens' PlacementGroup (Maybe Int64) Source

ID of the content category assigned to this placement group.

plalDirectorySiteIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) Source

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.

plalAccountId :: Lens' PlacementGroup (Maybe Int64) Source

Account ID of this placement group. This is a read-only field that can be left blank.

plalName :: Lens' PlacementGroup (Maybe Text) Source

Name of this placement group. This is a required field and must be less than 256 characters long.

plalDirectorySiteId :: Lens' PlacementGroup (Maybe Int64) Source

Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.

plalCreateInfo :: Lens' PlacementGroup (Maybe LastModifiedInfo) Source

Information about the creation of this placement group. This is a read-only field.

plalChildPlacementIds :: Lens' PlacementGroup [Int64] Source

IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.

plalLastModifiedInfo :: Lens' PlacementGroup (Maybe LastModifiedInfo) Source

Information about the most recent modification of this placement group. This is a read-only field.

plalId :: Lens' PlacementGroup (Maybe Int64) Source

ID of this placement group. This is a read-only, auto-generated field.

plalPrimaryPlacementId :: Lens' PlacementGroup (Maybe Int64) Source

ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.

plalSubAccountId :: Lens' PlacementGroup (Maybe Int64) Source

Subaccount ID of this placement group. This is a read-only field that can be left blank.

plalExternalId :: Lens' PlacementGroup (Maybe Text) Source

External ID for this placement.

plalComment :: Lens' PlacementGroup (Maybe Text) Source

Comments for this placement group.

plalPrimaryPlacementIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) Source

Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.

plalSiteId :: Lens' PlacementGroup (Maybe Int64) Source

Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.

plalArchived :: Lens' PlacementGroup (Maybe Bool) Source

Whether this placement group is archived.

EventTag

data EventTag Source

Contains properties of an event tag.

See: eventTag smart constructor.

Instances

eventTag :: EventTag Source

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

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

etStatus :: Lens' EventTag (Maybe EventTagStatus) Source

Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.

etExcludeFromAdxRequests :: Lens' EventTag (Maybe Bool) Source

Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.

etEnabledByDefault :: Lens' EventTag (Maybe Bool) Source

Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.

etKind :: Lens' EventTag Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".

etCampaignIdDimensionValue :: Lens' EventTag (Maybe DimensionValue) Source

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

etAdvertiserId :: Lens' EventTag (Maybe Int64) Source

Advertiser ID of this event tag. This field or the campaignId field is required on insertion.

etURL :: Lens' EventTag (Maybe Text) Source

Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.

etAdvertiserIdDimensionValue :: Lens' EventTag (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

etSSLCompliant :: Lens' EventTag (Maybe Bool) Source

Whether this tag is SSL-compliant or not. This is a read-only field.

etCampaignId :: Lens' EventTag (Maybe Int64) Source

Campaign ID of this event tag. This field or the advertiserId field is required on insertion.

etAccountId :: Lens' EventTag (Maybe Int64) Source

Account ID of this event tag. This is a read-only field that can be left blank.

etName :: Lens' EventTag (Maybe Text) Source

Name of this event tag. This is a required field and must be less than 256 characters long.

etURLEscapeLevels :: Lens' EventTag (Maybe Int32) Source

Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.

etSiteIds :: Lens' EventTag [Int64] Source

Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.

etId :: Lens' EventTag (Maybe Int64) Source

ID of this event tag. This is a read-only, auto-generated field.

etSubAccountId :: Lens' EventTag (Maybe Int64) Source

Subaccount ID of this event tag. This is a read-only field that can be left blank.

etType :: Lens' EventTag (Maybe EventTagType) Source

Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.

etSiteFilterType :: Lens' EventTag (Maybe EventTagSiteFilterType) Source

Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.

UserRolePermission

data UserRolePermission Source

Contains properties of a user role permission.

See: userRolePermission smart constructor.

Instances

userRolePermission :: UserRolePermission Source

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

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

useKind :: Lens' UserRolePermission Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".

useAvailability :: Lens' UserRolePermission (Maybe UserRolePermissionAvailability) Source

Levels of availability for a user role permission.

useName :: Lens' UserRolePermission (Maybe Text) Source

Name of this user role permission.

useId :: Lens' UserRolePermission (Maybe Int64) Source

ID of this user role permission.

usePermissionGroupId :: Lens' UserRolePermission (Maybe Int64) Source

ID of the permission group that this user role permission belongs to.

ChangeLogsListObjectType

data ChangeLogsListObjectType Source

Select only change logs with the specified object type.

Constructors

ObjectAccount
OBJECT_ACCOUNT
ObjectAccountBillingFeature
OBJECT_ACCOUNT_BILLING_FEATURE
ObjectAd
OBJECT_AD
ObjectAdvertiser
OBJECT_ADVERTISER
ObjectAdvertiserGroup
OBJECT_ADVERTISER_GROUP
ObjectBillingAccountGroup
OBJECT_BILLING_ACCOUNT_GROUP
ObjectBillingFeature
OBJECT_BILLING_FEATURE
ObjectBillingMinimumFee
OBJECT_BILLING_MINIMUM_FEE
ObjectBillingProFile
OBJECT_BILLING_PROFILE
ObjectCampaign
OBJECT_CAMPAIGN
ObjectContentCategory
OBJECT_CONTENT_CATEGORY
ObjectCreative
OBJECT_CREATIVE
ObjectCreativeAsset
OBJECT_CREATIVE_ASSET
ObjectCreativeBundle
OBJECT_CREATIVE_BUNDLE
ObjectCreativeField
OBJECT_CREATIVE_FIELD
ObjectCreativeGroup
OBJECT_CREATIVE_GROUP
ObjectDfaSite
OBJECT_DFA_SITE
ObjectEventTag
OBJECT_EVENT_TAG
ObjectFloodlightActivityGroup
OBJECT_FLOODLIGHT_ACTIVITY_GROUP
ObjectFloodlightActvity
OBJECT_FLOODLIGHT_ACTVITY
ObjectFloodlightConfiguration
OBJECT_FLOODLIGHT_CONFIGURATION
ObjectInstreamCreative
OBJECT_INSTREAM_CREATIVE
ObjectLandingPage
OBJECT_LANDING_PAGE
ObjectMediaOrder
OBJECT_MEDIA_ORDER
ObjectPlacement
OBJECT_PLACEMENT
ObjectPlacementStrategy
OBJECT_PLACEMENT_STRATEGY
ObjectProvidedListClient
OBJECT_PROVIDED_LIST_CLIENT
ObjectRateCard
OBJECT_RATE_CARD
ObjectRemarketingList
OBJECT_REMARKETING_LIST
ObjectRichmediaCreative
OBJECT_RICHMEDIA_CREATIVE
ObjectSdSite
OBJECT_SD_SITE
ObjectSize
OBJECT_SIZE
ObjectSubAccount
OBJECT_SUBACCOUNT
ObjectUserProFile
OBJECT_USER_PROFILE
ObjectUserProFileFilter
OBJECT_USER_PROFILE_FILTER
ObjectUserRole
OBJECT_USER_ROLE

Instances

OrderContact

data OrderContact Source

Contact of an order.

See: orderContact smart constructor.

Instances

orderContact :: OrderContact Source

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

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

ocSignatureUserProFileId :: Lens' OrderContact (Maybe Int64) Source

ID of the user profile containing the signature that will be embedded into order documents.

ocContactName :: Lens' OrderContact (Maybe Text) Source

Name of this contact.

ocContactTitle :: Lens' OrderContact (Maybe Text) Source

Title of this contact.

ocContactType :: Lens' OrderContact (Maybe OrderContactContactType) Source

Type of this contact.

ocContactInfo :: Lens' OrderContact (Maybe Text) Source

Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.

FloodlightActivitiesGenerateTagResponse

data FloodlightActivitiesGenerateTagResponse Source

Floodlight Activity GenerateTag Response

See: floodlightActivitiesGenerateTagResponse smart constructor.

Instances

floodlightActivitiesGenerateTagResponse :: FloodlightActivitiesGenerateTagResponse Source

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

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

fagtrFloodlightActivityTag :: Lens' FloodlightActivitiesGenerateTagResponse (Maybe Text) Source

Generated tag for this floodlight activity.

fagtrKind :: Lens' FloodlightActivitiesGenerateTagResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".

DirectorySiteContactAssignment

data DirectorySiteContactAssignment Source

Directory Site Contact Assignment

See: directorySiteContactAssignment smart constructor.

Instances

directorySiteContactAssignment :: DirectorySiteContactAssignment Source

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

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

dscaVisibility :: Lens' DirectorySiteContactAssignment (Maybe DirectorySiteContactAssignmentVisibility) Source

Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site.

dscaContactId :: Lens' DirectorySiteContactAssignment (Maybe Int64) Source

ID of this directory site contact. This is a read-only, auto-generated field.

AdSlot

data AdSlot Source

Ad Slot

See: adSlot smart constructor.

Instances

adSlot :: AdSlot Source

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

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

assHeight :: Lens' AdSlot (Maybe Int64) Source

Height of this ad slot.

assPaymentSourceType :: Lens' AdSlot (Maybe AdSlotPaymentSourceType) Source

Payment source type of this ad slot.

assLinkedPlacementId :: Lens' AdSlot (Maybe Int64) Source

ID of the placement from an external platform that is linked to this ad slot.

assWidth :: Lens' AdSlot (Maybe Int64) Source

Width of this ad slot.

assPrimary :: Lens' AdSlot (Maybe Bool) Source

Primary ad slot of a roadblock inventory item.

assName :: Lens' AdSlot (Maybe Text) Source

Name of this ad slot.

assComment :: Lens' AdSlot (Maybe Text) Source

Comment for this ad slot.

assCompatibility :: Lens' AdSlot (Maybe AdSlotCompatibility) Source

Ad slot compatibility. WEB and WEB_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 in in-stream video ads developed with the VAST standard.

ThirdPartyTrackingURL

data ThirdPartyTrackingURL Source

Third-party Tracking URL.

See: thirdPartyTrackingURL smart constructor.

Instances

thirdPartyTrackingURL :: ThirdPartyTrackingURL Source

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

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

tptuURL :: Lens' ThirdPartyTrackingURL (Maybe Text) Source

URL for the specified third-party URL type.

tptuThirdPartyURLType :: Lens' ThirdPartyTrackingURL (Maybe ThirdPartyTrackingURLThirdPartyURLType) Source

Third-party URL type for in-stream video creatives.

PricingCapCostType

data PricingCapCostType Source

Cap cost type of this inventory item.

Constructors

PlanningPlacementCapCostTypeCumulative
PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE
PlanningPlacementCapCostTypeMonthly
PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY
PlanningPlacementCapCostTypeNone
PLANNING_PLACEMENT_CAP_COST_TYPE_NONE

Instances

OrderDocument

data OrderDocument Source

Contains properties of a DoubleClick Planning order document.

See: orderDocument smart constructor.

Instances

orderDocument :: OrderDocument Source

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

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

odSigned :: Lens' OrderDocument (Maybe Bool) Source

Whether this order document has been signed.

odKind :: Lens' OrderDocument Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".

odAdvertiserId :: Lens' OrderDocument (Maybe Int64) Source

Advertiser ID of this order document.

odLastSentTime :: Lens' OrderDocument (Maybe UTCTime) Source

Timestamp of the last email sent with this order document.

odAmendedOrderDocumentId :: Lens' OrderDocument (Maybe Int64) Source

The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.

odLastSentRecipients :: Lens' OrderDocument [Text] Source

List of email addresses that received the last sent document.

odEffectiveDate :: Lens' OrderDocument (Maybe Day) Source

Effective date of this order document.

odApprovedByUserProFileIds :: Lens' OrderDocument [Int64] Source

IDs of users who have approved this order document.

odAccountId :: Lens' OrderDocument (Maybe Int64) Source

Account ID of this order document.

odId :: Lens' OrderDocument (Maybe Int64) Source

ID of this order document.

odProjectId :: Lens' OrderDocument (Maybe Int64) Source

Project ID of this order document.

odTitle :: Lens' OrderDocument (Maybe Text) Source

Title of this order document.

odSubAccountId :: Lens' OrderDocument (Maybe Int64) Source

Subaccount ID of this order document.

odType :: Lens' OrderDocument (Maybe OrderDocumentType) Source

Type of this order document

odOrderId :: Lens' OrderDocument (Maybe Int64) Source

ID of the order from which this order document is created.

odCancelled :: Lens' OrderDocument (Maybe Bool) Source

Whether this order document is cancelled.

odCreatedInfo :: Lens' OrderDocument (Maybe LastModifiedInfo) Source

Information about the creation of this order document.

Metro

data Metro Source

Contains information about a metro region that can be targeted by ads.

See: metro smart constructor.

Instances

metro :: Metro Source

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

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

metMetroCode :: Lens' Metro (Maybe Text) Source

Metro code of this metro region. This is equivalent to dma_id.

metKind :: Lens' Metro Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".

metName :: Lens' Metro (Maybe Text) Source

Name of this metro region.

metCountryCode :: Lens' Metro (Maybe Text) Source

Country code of the country to which this metro region belongs.

metDmaId :: Lens' Metro (Maybe Int64) Source

DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.

metCountryDartId :: Lens' Metro (Maybe Int64) Source

DART ID of the country to which this metro region belongs.

metDartId :: Lens' Metro (Maybe Int64) Source

DART ID of this metro region.

CreativeAssetDisplayType

data CreativeAssetDisplayType Source

Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

Constructors

AssetDisplayTypeExpanding
ASSET_DISPLAY_TYPE_EXPANDING
AssetDisplayTypeFlashInFlash
ASSET_DISPLAY_TYPE_FLASH_IN_FLASH
AssetDisplayTypeFlashInFlashExpanding
ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING
AssetDisplayTypeFloating
ASSET_DISPLAY_TYPE_FLOATING
AssetDisplayTypeInpage
ASSET_DISPLAY_TYPE_INPAGE
AssetDisplayTypeOverlay
ASSET_DISPLAY_TYPE_OVERLAY
AssetDisplayTypePeelDown
ASSET_DISPLAY_TYPE_PEEL_DOWN
AssetDisplayTypeVpaidLinear
ASSET_DISPLAY_TYPE_VPAID_LINEAR
AssetDisplayTypeVpaidNonLinear
ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR

Instances

Placement

data Placement Source

Contains properties of a placement.

See: placement smart constructor.

Instances

placement :: Placement Source

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

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

p1Status :: Lens' Placement (Maybe PlacementStatus) Source

Third-party placement status.

p1PlacementStrategyId :: Lens' Placement (Maybe Int64) Source

ID of the placement strategy assigned to this placement.

p1TagFormats :: Lens' Placement [PlacementTagFormatsItem] Source

Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"

p1SiteIdDimensionValue :: Lens' Placement (Maybe DimensionValue) Source

Dimension value for the ID of the site. This is a read-only, auto-generated field.

p1PricingSchedule :: Lens' Placement (Maybe PricingSchedule) Source

Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.

p1Size :: Lens' Placement (Maybe Size) Source

Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.

p1Kind :: Lens' Placement Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".

p1KeyName :: Lens' Placement (Maybe Text) Source

Key name of this placement. This is a read-only, auto-generated field.

p1CampaignIdDimensionValue :: Lens' Placement (Maybe DimensionValue) Source

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

p1AdvertiserId :: Lens' Placement (Maybe Int64) Source

Advertiser ID of this placement. This field can be left blank.

p1AdvertiserIdDimensionValue :: Lens' Placement (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

p1CampaignId :: Lens' Placement (Maybe Int64) Source

Campaign ID of this placement. This field is a required field on insertion.

p1IdDimensionValue :: Lens' Placement (Maybe DimensionValue) Source

Dimension value for the ID of this placement. This is a read-only, auto-generated field.

p1Primary :: Lens' Placement (Maybe Bool) Source

Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.

p1LookbackConfiguration :: Lens' Placement (Maybe LookbackConfiguration) Source

Lookback window settings for this placement.

p1TagSetting :: Lens' Placement (Maybe TagSetting) Source

Tag settings for this placement.

p1ContentCategoryId :: Lens' Placement (Maybe Int64) Source

ID of the content category assigned to this placement.

p1DirectorySiteIdDimensionValue :: Lens' Placement (Maybe DimensionValue) Source

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.

p1AccountId :: Lens' Placement (Maybe Int64) Source

Account ID of this placement. This field can be left blank.

p1PaymentSource :: Lens' Placement (Maybe PlacementPaymentSource) Source

Payment source for this placement. This is a required field that is read-only after insertion.

p1Name :: Lens' Placement (Maybe Text) Source

Name of this placement.This is a required field and must be less than 256 characters long.

p1DirectorySiteId :: Lens' Placement (Maybe Int64) Source

Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.

p1CreateInfo :: Lens' Placement (Maybe LastModifiedInfo) Source

Information about the creation of this placement. This is a read-only field.

p1LastModifiedInfo :: Lens' Placement (Maybe LastModifiedInfo) Source

Information about the most recent modification of this placement. This is a read-only field.

p1Id :: Lens' Placement (Maybe Int64) Source

ID of this placement. This is a read-only, auto-generated field.

p1SSLRequired :: Lens' Placement (Maybe Bool) Source

Whether creatives assigned to this placement must be SSL-compliant.

p1SubAccountId :: Lens' Placement (Maybe Int64) Source

Subaccount ID of this placement. This field can be left blank.

p1PlacementGroupIdDimensionValue :: Lens' Placement (Maybe DimensionValue) Source

Dimension value for the ID of the placement group. This is a read-only, auto-generated field.

p1ExternalId :: Lens' Placement (Maybe Text) Source

External ID for this placement.

p1PlacementGroupId :: Lens' Placement (Maybe Int64) Source

ID of this placement's group, if applicable.

p1Comment :: Lens' Placement (Maybe Text) Source

Comments for this placement.

p1SiteId :: Lens' Placement (Maybe Int64) Source

Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.

p1Compatibility :: Lens' Placement (Maybe PlacementCompatibility) Source

Placement compatibility. WEB and WEB_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 in in-stream video ads developed with the VAST standard. This field is required on insertion.

p1Archived :: Lens' Placement (Maybe Bool) Source

Whether this placement is archived.

p1PaymentApproved :: Lens' Placement (Maybe Bool) Source

Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.

p1PublisherUpdateInfo :: Lens' Placement (Maybe LastModifiedInfo) Source

Information about the last publisher update. This is a read-only field.

FloodlightActivityCountingMethod

data FloodlightActivityCountingMethod Source

Counting method for conversions for this floodlight activity. This is a required field.

Constructors

ItemsSoldCounting
ITEMS_SOLD_COUNTING
SessionCounting
SESSION_COUNTING
StandardCounting
STANDARD_COUNTING
TransactionsCounting
TRANSACTIONS_COUNTING
UniqueCounting
UNIQUE_COUNTING

Instances

SitesListResponse

data SitesListResponse Source

Site List Response

See: sitesListResponse smart constructor.

Instances

sitesListResponse :: SitesListResponse Source

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

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

sitNextPageToken :: Lens' SitesListResponse (Maybe Text) Source

Pagination token to be used for the next list operation.

sitKind :: Lens' SitesListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".

sitSites :: Lens' SitesListResponse [Site] Source

Site collection.

ContentCategoriesListSortOrder

data ContentCategoriesListSortOrder Source

Order of sorted results, default is ASCENDING.

Constructors

CCLSOAscending
ASCENDING
CCLSODescending
DESCENDING

Instances

CreativeField

data CreativeField Source

Contains properties of a creative field.

See: creativeField smart constructor.

Instances

creativeField :: CreativeField Source

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

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

cffKind :: Lens' CreativeField Text Source

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".

cffAdvertiserId :: Lens' CreativeField (Maybe Int64) Source

Advertiser ID of this creative field. This is a required field on insertion.

cffAdvertiserIdDimensionValue :: Lens' CreativeField (Maybe DimensionValue) Source

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

cffAccountId :: Lens' CreativeField (Maybe Int64) Source

Account ID of this creative field. This is a read-only field that can be left blank.

cffName :: Lens' CreativeField (Maybe Text) Source

Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.

cffId :: Lens' CreativeField (Maybe Int64) Source

ID of this creative field. This is a read-only, auto-generated field.

cffSubAccountId :: Lens' CreativeField (Maybe Int64) Source

Subaccount ID of this creative field. This is a read-only field that can be left blank.

AdvertiserStatus

data AdvertiserStatus Source

Status of this advertiser.

Constructors

ASApproved
APPROVED
ASOnHold
ON_HOLD

Instances

DefaultClickThroughEventTagProperties

data DefaultClickThroughEventTagProperties Source

Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.

See: defaultClickThroughEventTagProperties smart constructor.

Instances

defaultClickThroughEventTagProperties :: DefaultClickThroughEventTagProperties Source

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

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

dctetpOverrideInheritedEventTag :: Lens' DefaultClickThroughEventTagProperties (Maybe Bool) Source

Whether this entity should override the inherited default click-through event tag with its own defined value.

dctetpDefaultClickThroughEventTagId :: Lens' DefaultClickThroughEventTagProperties (Maybe Int64) Source

ID of the click-through event tag to apply to all ads in this entity's scope.

ListTargetingExpression

data ListTargetingExpression Source

Remarketing List Targeting Expression.

See: listTargetingExpression smart constructor.

Instances

listTargetingExpression :: ListTargetingExpression Source

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

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

lteExpression :: Lens' ListTargetingExpression (Maybe Text) Source

Expression describing which lists are being targeted by the ad.