Constants

USER_AGENT → String

'dart-api-client dfareporting/v2.3'

Classes

Account

Contains properties of a DCM account.

AccountActiveAdSummariesResourceApi

AccountActiveAdSummary

Gets a summary of active ads in an account.

AccountPermission

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

AccountPermissionGroup

AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.

AccountPermissionGroupsListResponse

Account Permission Group List Response

AccountPermissionGroupsResourceApi

AccountPermissionsListResponse

Account Permission List Response

AccountPermissionsResourceApi

AccountsListResponse

Account List Response

AccountsResourceApi

AccountUserProfile

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

AccountUserProfilesListResponse

Account User Profile List Response

AccountUserProfilesResourceApi

Activities

Represents an activity group.

Contains properties of a DCM ad.

AdsListResponse

Ad List Response

AdSlot

Ad Slot

AdsResourceApi

Advertiser

Contains properties of a DCM advertiser.

AdvertiserGroup

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

AdvertiserGroupsListResponse

Advertiser Group List Response

AdvertiserGroupsResourceApi

AdvertisersListResponse

Advertiser List Response

AdvertisersResourceApi

AudienceSegment

Audience Segment.

AudienceSegmentGroup

Audience Segment Group.

Browser

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

BrowsersListResponse

Browser List Response

BrowsersResourceApi

ByteRange

Specifies a range of media.

Campaign

Contains properties of a DCM campaign.

CampaignCreativeAssociation

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

CampaignCreativeAssociationsListResponse

Campaign Creative Association List Response

CampaignCreativeAssociationsResourceApi

CampaignsListResponse

Campaign List Response

CampaignsResourceApi

ChangeLog

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

ChangeLogsListResponse

Change Log List Response

ChangeLogsResourceApi

CitiesListResponse

City List Response

CitiesResourceApi

City

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

ClickTag

Creative Click Tag.

ClickThroughUrl

Click-through URL

ClickThroughUrlSuffixProperties

Click Through URL Suffix settings.

CompanionClickThroughOverride

Companion Click-through override.

CompatibleFields

Represents a response to the queryCompatibleFields method.

ConnectionType

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.

ConnectionTypesListResponse

Connection Type List Response

ConnectionTypesResourceApi

ContentCategoriesListResponse

Content Category List Response

ContentCategoriesResourceApi

ContentCategory

Organizes placements according to the contents of their associated webpages.

CountriesListResponse

Country List Response

CountriesResourceApi

Country

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

Creative

Contains properties of a Creative.

CreativeAsset

Creative Asset.

CreativeAssetId

Creative Asset ID.

CreativeAssetMetadata

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.

CreativeAssetsResourceApi

CreativeAssignment

Creative Assignment.

CreativeCustomEvent

Creative Custom Event.

CreativeField

Contains properties of a creative field.

CreativeFieldAssignment

Creative Field Assignment.

CreativeFieldsListResponse

Creative Field List Response

CreativeFieldsResourceApi

CreativeFieldValue

Contains properties of a creative field value.

CreativeFieldValuesListResponse

Creative Field Value List Response

CreativeFieldValuesResourceApi

CreativeGroup

Contains properties of a creative group.

CreativeGroupAssignment

Creative Group Assignment.

CreativeGroupsListResponse

Creative Group List Response

CreativeGroupsResourceApi

CreativeOptimizationConfiguration

Creative optimization settings.

CreativeRotation

Creative Rotation.

CreativeSettings

Creative Settings

CreativesListResponse

Creative List Response

CreativesResourceApi

CrossDimensionReachReportCompatibleFields

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

CustomRichMediaEvents

Represents a Custom Rich Media Events group.

DateRange

Represents a date range.

DayPartTargeting

Day Part Targeting.

DefaultClickThroughEventTagProperties

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.

DeliverySchedule

Delivery Schedule.

DfareportingApi

Manage your DoubleClick Campaign Manager ad campaigns and reports.

DfpSettings

DFP Settings

Dimension

Represents a dimension.

DimensionFilter

Represents a dimension filter.

DimensionValue

Represents a DimensionValue resource.

DimensionValueList

Represents the list of DimensionValue resources.

DimensionValueRequest

Represents a DimensionValuesRequest.

DimensionValuesResourceApi

DirectorySite

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.

DirectorySiteContact

Contains properties of a Site Directory contact.

DirectorySiteContactAssignment

Directory Site Contact Assignment

DirectorySiteContactsListResponse

Directory Site Contact List Response

DirectorySiteContactsResourceApi

DirectorySiteSettings

Directory Site Settings

DirectorySitesListResponse

Directory Site List Response

DirectorySitesResourceApi

DownloadOptions

Represents options for downloading media.

EventTag

Contains properties of an event tag.

EventTagOverride

Event tag override information.

EventTagsListResponse

Event Tag List Response

EventTagsResourceApi

File

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".

FileList

Represents the list of File resources.

FilesResourceApi

FileUrls

The URLs where the completed report file can be downloaded.

Flight

Flight

FloodlightActivitiesGenerateTagResponse

Floodlight Activity GenerateTag Response

FloodlightActivitiesListResponse

Floodlight Activity List Response

FloodlightActivitiesResourceApi

FloodlightActivity

Contains properties of a Floodlight activity.

FloodlightActivityDynamicTag

Dynamic Tag

FloodlightActivityGroup

Contains properties of a Floodlight activity group.

FloodlightActivityGroupsListResponse

Floodlight Activity Group List Response

FloodlightActivityGroupsResourceApi

FloodlightActivityPublisherDynamicTag

Publisher Dynamic Tag

FloodlightConfiguration

Contains properties of a Floodlight configuration.

FloodlightConfigurationsListResponse

Floodlight Configuration List Response

FloodlightConfigurationsResourceApi

FloodlightReportCompatibleFields

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

FrequencyCap

Frequency Cap.

FsCommand

FsCommand.

GeoTargeting

Geographical Targeting.

InventoryItem

Represents a buy from the DoubleClick Planning inventory store.

InventoryItemsListResponse

Inventory item List Response

InventoryItemsResourceApi

KeyValueTargetingExpression

Key Value Targeting Expression.

LandingPage

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

LandingPagesListResponse

Landing Page List Response

LandingPagesResourceApi

LastModifiedInfo

Modification timestamp.

ListPopulationClause

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

ListPopulationRule

Remarketing List Population Rule.

ListPopulationTerm

Remarketing List Population Rule Term.

ListTargetingExpression

Remarketing List Targeting Expression.

LookbackConfiguration

Lookback configuration settings.

Media

Represents a media consisting of a stream of bytes, a content type and a length.

Metric

Represents a metric.

Metro

Contains information about a metro region that can be targeted by ads.

MetrosListResponse

Metro List Response

MetrosResourceApi

MobileCarrier

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

MobileCarriersListResponse

Mobile Carrier List Response

MobileCarriersResourceApi

ObjectFilter

Object Filter.

OffsetPosition

Offset Position.

OmnitureSettings

Omniture Integration Settings.

OperatingSystem

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

OperatingSystemsListResponse

Operating System List Response

OperatingSystemsResourceApi

OperatingSystemVersion

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

OperatingSystemVersionsListResponse

Operating System Version List Response

OperatingSystemVersionsResourceApi

OptimizationActivity

Creative optimization activity.

Order

Describes properties of a DoubleClick Planning order.

OrderContact

Contact of an order.

OrderDocument

Contains properties of a DoubleClick Planning order document.

OrderDocumentsListResponse

Order document List Response

OrderDocumentsResourceApi

OrdersListResponse

Order List Response

OrdersResourceApi

PartialDownloadOptions

Options for downloading a Media.

PathToConversionReportCompatibleFields

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

Placement

Contains properties of a placement.

PlacementAssignment

Placement Assignment.

PlacementGroup

Contains properties of a package or roadblock.

PlacementGroupsListResponse

Placement Group List Response

PlacementGroupsResourceApi

PlacementsGenerateTagsResponse

Placement GenerateTags Response

PlacementsListResponse

Placement List Response

PlacementsResourceApi

PlacementStrategiesListResponse

Placement Strategy List Response

PlacementStrategiesResourceApi

PlacementStrategy

Contains properties of a placement strategy.

PlacementTag

Placement Tag

PlatformType

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

PlatformTypesListResponse

Platform Type List Response

PlatformTypesResourceApi

PopupWindowProperties

Popup Window Properties.

PostalCode

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

PostalCodesListResponse

Postal Code List Response

PostalCodesResourceApi

Pricing

Pricing Information

PricingSchedule

Pricing Schedule

PricingSchedulePricingPeriod

Pricing Period

Project

Contains properties of a DoubleClick Planning project.

ProjectsListResponse

Project List Response

ProjectsResourceApi

ReachReportCompatibleFields

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

Recipient

Represents a recipient.

Region

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

RegionsListResponse

Region List Response

RegionsResourceApi

RemarketingList

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.

RemarketingListShare

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.

RemarketingListSharesResourceApi

RemarketingListsListResponse

Remarketing list response

RemarketingListsResourceApi

Report

Represents a Report resource.

ReportCompatibleFields

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

ReportCriteria

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

ReportCrossDimensionReachCriteria

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

ReportDelivery

The report's email delivery settings.

ReportFloodlightCriteria

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

ReportFloodlightCriteriaReportProperties

The properties of the report.

ReportList

Represents the list of reports.

ReportPathToConversionCriteria

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

ReportPathToConversionCriteriaReportProperties

The properties of the report.

ReportReachCriteria

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

ReportSchedule

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".

ReportsCompatibleFieldsResourceApi

ReportsConfiguration

Reporting Configuration

ReportsFilesResourceApi

ReportsResourceApi

ResumableUploadOptions

Specifies options for resumable uploads.

RichMediaExitOverride

Rich Media Exit Override.

Site

Contains properties of a site.

SiteContact

Site Contact

SiteSettings

Site Settings

SitesListResponse

Site List Response

SitesResourceApi

Size

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

SizesListResponse

Size List Response

SizesResourceApi

SortedDimension

Represents a sorted dimension.

Subaccount

Contains properties of a DCM subaccount.

SubaccountsListResponse

Subaccount List Response

SubaccountsResourceApi

TagData

Placement Tag Data

TagSetting

Tag Settings

TagSettings

Dynamic and Image Tag Settings.

TargetableRemarketingList

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.

TargetableRemarketingListsListResponse

Targetable remarketing list response

TargetableRemarketingListsResourceApi

TargetWindow

Target Window.

TechnologyTargeting

Technology Targeting.

ThirdPartyAuthenticationToken

Third Party Authentication Token

ThirdPartyTrackingUrl

Third-party Tracking URL.

UploadOptions

Represents options for uploading a Media.

UserDefinedVariableConfiguration

User Defined Variable configuration.

UserProfile

Represents a UserProfile resource.

UserProfileList

Represents the list of user profiles.

UserProfilesResourceApi

UserRole

Contains properties of auser role, which is used to manage user access.

UserRolePermission

Contains properties of a user role permission.

UserRolePermissionGroup

Represents a grouping of related user role permissions.

UserRolePermissionGroupsListResponse

User Role Permission Group List Response

UserRolePermissionGroupsResourceApi

UserRolePermissionsListResponse

User Role Permission List Response

UserRolePermissionsResourceApi

UserRolesListResponse

User Role List Response

UserRolesResourceApi

Exceptions / Errors

ApiRequestError

Represents a general error reported by the API endpoint.

DetailedApiRequestError

Represents a specific error reported by the API endpoint.