dfareporting.v3_4 library Null safety

Campaign Manager 360 API - v3.4

Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.

For more information, see developers.google.com/doubleclick-advertisers/

Create an instance of DfareportingApi to access these resources:

Classes

Account
Contains properties of a Campaign Manager account.
AccountActiveAdSummariesResource
AccountPermissionGroupsListResponse
Account Permission Group List Response
AccountPermissionGroupsResource
AccountPermissionsListResponse
Account Permission List Response
AccountPermissionsResource
AccountsListResponse
Account List Response
AccountsResource
AccountUserProfile
AccountUserProfiles contains properties of a Campaign Manager user profile. [...]
AccountUserProfilesListResponse
Account User Profile List Response
AccountUserProfilesResource
Activities
Represents an activity group.
Contains properties of a Campaign Manager ad.
AdBlockingConfiguration
Campaign ad blocking settings.
AdsListResponse
Ad List Response
AdsResource
Advertiser
Contains properties of a Campaign Manager advertiser.
AdvertiserGroupsListResponse
Advertiser Group List Response
AdvertiserGroupsResource
AdvertiserLandingPagesListResponse
Landing Page List Response
AdvertiserLandingPagesResource
AdvertisersListResponse
Advertiser List Response
AdvertisersResource
AudienceSegmentGroup
Audience Segment Group.
BrowsersListResponse
Browser List Response
BrowsersResource
ByteRange
Specifies a range of media.
Campaign
Contains properties of a Campaign Manager campaign.
CampaignCreativeAssociationsListResponse
Campaign Creative Association List Response
CampaignCreativeAssociationsResource
CampaignManagerIds
Campaign Manager IDs related to the custom event.
CampaignsListResponse
Campaign List Response
CampaignsResource
ChangeLogsListResponse
Change Log List Response
ChangeLogsResource
ChannelGrouping
Represents a DfaReporting channel grouping.
ChannelGroupingRule
Represents a DfaReporting channel grouping rule.
CitiesListResponse
City List Response
CitiesResource
ClickTag
Creative Click Tag.
CompanionClickThroughOverride
Companion Click-through override.
CompanionSetting
Companion Settings
CompatibleFields
Represents a response to the queryCompatibleFields method.
ConnectionTypesListResponse
Connection Type List Response
ConnectionTypesResource
ContentCategoriesListResponse
Content Category List Response
ContentCategoriesResource
Conversion
A Conversion represents when a user successfully performs a desired action after seeing an ad.
ConversionsBatchInsertRequest
Insert Conversions Request.
ConversionsBatchInsertResponse
Insert Conversions Response.
ConversionsBatchUpdateRequest
Update Conversions Request.
ConversionsBatchUpdateResponse
Update Conversions Response.
ConversionsResource
ConversionStatus
The original conversion that was inserted or updated and whether there were any errors.
CountriesListResponse
Country List Response
CountriesResource
Creative
Contains properties of a Creative.
CreativeAsset
Creative Asset.
CreativeAssetMetadata
CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. [...]
CreativeAssetSelection
Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. [...]
CreativeAssetsResource
CreativeAssignment
Creative Assignment.
CreativeCustomEvent
Creative Custom Event.
CreativeField
Contains properties of a creative field.
CreativeFieldsListResponse
Creative Field List Response
CreativeFieldsResource
CreativeFieldValuesListResponse
Creative Field Value List Response
CreativeFieldValuesResource
CreativeGroup
Contains properties of a creative group.
CreativeGroupsListResponse
Creative Group List Response
CreativeGroupsResource
CreativeOptimizationConfiguration
Creative optimization settings.
CreativeRotation
Creative Rotation.
CreativesListResponse
Creative List Response
CreativesResource
CrossDimensionReachReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
CustomEvent
Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click.
CustomEventClickAnnotation
Annotate a click event.
CustomEventError
The error code and description for a custom event that failed to insert.
CustomEventImpressionAnnotation
Annotate an impression.
CustomEventInsert
Custom event to be inserted.
CustomEventsBatchInsertRequest
Insert Custom Events Request.
CustomEventsBatchInsertResponse
Insert Custom Events Response.
CustomEventsResource
CustomEventStatus
The original custom event that was inserted and whether there were any errors.
CustomRichMediaEvents
Represents a Custom Rich Media Events group.
CustomVariable
Custom variable.
CustomViewabilityMetric
Custom Viewability Metric
Contains information about a landing page deep link.
DeliverySchedule
Delivery Schedule.
DfareportingApi
Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.
DimensionValueList
Represents the list of DimensionValue resources.
DimensionValueRequest
Represents a DimensionValuesRequest.
DimensionValuesResource
DirectorySite
DirectorySites contains properties of a website from the Site Directory. [...]
DirectorySiteSettings
Directory Site Settings
DirectorySitesListResponse
Directory Site List Response
DirectorySitesResource
DisjunctiveMatchStatement
Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
DownloadOptions
Represents options for downloading media. [...]
DV3Ids
DV360 IDs related to the custom event.
DynamicTargetingKeysListResponse
Dynamic Targeting Key List Response
DynamicTargetingKeysResource
EventFilter
Represents a DfaReporting event filter.
EventTag
Contains properties of an event tag.
EventTagsListResponse
Event Tag List Response
EventTagsResource
File
Represents a File resource. [...]
FileList
List of files for a report.
FilesResource
FileUrls
The URLs where the completed report file can be downloaded.
FloodlightActivitiesListResponse
Floodlight Activity List Response
FloodlightActivitiesResource
FloodlightActivity
Contains properties of a Floodlight activity.
FloodlightActivityGroup
Contains properties of a Floodlight activity group.
FloodlightActivityGroupsListResponse
Floodlight Activity Group List Response
FloodlightActivityGroupsResource
FloodlightActivityPublisherDynamicTag
Publisher Dynamic Tag
FloodlightConfiguration
Contains properties of a Floodlight configuration.
FloodlightConfigurationsListResponse
Floodlight Configuration List Response
FloodlightConfigurationsResource
FloodlightReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".
GeoTargeting
Geographical Targeting.
InventoryItem
Represents a buy from the Planning inventory store.
InventoryItemsListResponse
Inventory item List Response
InventoryItemsResource
LandingPage
Contains information about where a user's browser is taken after the user clicks an ad.
LanguagesListResponse
Language List Response
LanguagesResource
LanguageTargeting
Language Targeting.
ListPopulationClause
A group clause made up of list population terms representing constraints joined by ORs.
ListPopulationRule
Remarketing List Population Rule.
Media
Represents a media consisting of a stream of bytes, a content type and a length.
MetrosListResponse
Metro List Response
MetrosResource
MobileAppsListResponse
Mobile app List Response
MobileAppsResource
MobileCarriersListResponse
Mobile Carrier List Response
MobileCarriersResource
ObaIcon
Online Behavioral Advertiser icon.
OperatingSystemsListResponse
Operating System List Response
OperatingSystemsResource
OperatingSystemVersion
Contains information about a particular version of an operating system that can be targeted by ads.
OperatingSystemVersionsListResponse
Operating System Version List Response
OperatingSystemVersionsResource
OptimizationActivity
Creative optimization activity.
Order
Describes properties of a Planning order.
OrderDocument
Contains properties of a Planning order document.
OrderDocumentsListResponse
Order document List Response
OrderDocumentsResource
OrdersListResponse
Order List Response
OrdersResource
PartialDownloadOptions
Options for downloading a Media.
PathFilter
Represents a DfaReporting path filter.
PathReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "PATH".
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
PlacementGroupsResource
PlacementsGenerateTagsResponse
Placement GenerateTags Response
PlacementsListResponse
Placement List Response
PlacementsResource
PlacementStrategiesListResponse
Placement Strategy List Response
PlacementStrategiesResource
PlacementTag
Placement Tag
PlatformTypesListResponse
Platform Type List Response
PlatformTypesResource
PopupWindowProperties
Popup Window Properties.
PostalCodesListResponse
Postal Code List Response
PostalCodesResource
Pricing
Pricing Information
PricingSchedule
Pricing Schedule
Project
Contains properties of a Planning project.
ProjectsListResponse
Project List Response
ProjectsResource
ReachReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "REACH".
RegionsListResponse
Region List Response
RegionsResource
RemarketingList
Contains properties of a remarketing list. [...]
RemarketingListSharesResource
RemarketingListsListResponse
Remarketing list response
RemarketingListsResource
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.
ReportPathAttributionCriteria
The report criteria for a report of type "PATH_ATTRIBUTION".
ReportPathCriteria
The report criteria for a report of type "PATH".
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. [...]
ReportsCompatibleFieldsResource
ReportsConfiguration
Reporting Configuration
ReportsFilesResource
ReportsResource
ResumableUploadOptions
Specifies options for resumable uploads.
RichMediaExitOverride
Rich Media Exit Override.
Site
Contains properties of a site.
SiteCompanionSetting
Companion Settings
SiteSettings
Site Settings
SiteSkippableSetting
Skippable Settings
SitesListResponse
Site List Response
SitesResource
SiteVideoSettings
Video Settings
SizesListResponse
Size List Response
SizesResource
SkippableSetting
Skippable Settings
SubaccountsListResponse
Subaccount List Response
SubaccountsResource
TargetableRemarketingList
Contains properties of a targetable remarketing list. [...]
TargetableRemarketingListsListResponse
Targetable remarketing list response
TargetableRemarketingListsResource
TargetingTemplate
Contains properties of a targeting template. [...]
TargetingTemplatesListResponse
Targeting Template List Response
TargetingTemplatesResource
TechnologyTargeting
Technology Targeting.
UploadOptions
Represents options for uploading a Media.
UserProfileList
Represents the list of user profiles.
UserProfilesResource
UserRole
Contains properties of auser role, which is used to manage user access.
UserRolePermissionGroupsListResponse
User Role Permission Group List Response
UserRolePermissionGroupsResource
UserRolePermissionsListResponse
User Role Permission List Response
UserRolePermissionsResource
UserRolesListResponse
User Role List Response
UserRolesResource
VideoFormat
Contains information about supported video formats.
VideoFormatsListResponse
Video Format List Response
VideoFormatsResource
VideoSettings
Video Settings

Typedefs

AccountActiveAdSummary = $AccountActiveAdSummary
Gets a summary of active ads in an account.
AccountPermission = $AccountPermission
AccountPermissions contains information about a particular account permission. [...]
AccountPermissionGroup = $AccountPermissionGroup
AccountPermissionGroups contains a mapping of permission group IDs to names. [...]
AdSlot = $AdSlot
Ad Slot
AdvertiserGroup = $AdvertiserGroup
Groups advertisers together so that reports can be generated for the entire group at once.
AudienceSegment = $AudienceSegment
Audience Segment.
Browser = $Browser
Contains information about a browser that can be targeted by ads.
CampaignCreativeAssociation = $CampaignCreativeAssociation
Identifies a creative which has been associated with a given campaign.
ChangeLog = $ChangeLog
Describes a change that a user has made to a resource.
City = $City
Contains information about a city that can be targeted by ads.
ClickThroughUrl = $ClickThroughUrl
Click-through URL
ClickThroughUrlSuffixProperties = $ClickThroughUrlSuffixProperties
Click Through URL Suffix settings.
ConnectionType = $ConnectionType
Contains information about an internet connection type that can be targeted by ads. [...]
ContentCategory = $ContentCategory
Organizes placements according to the contents of their associated webpages.
ConversionError = $ConversionError
The error code and description for a conversion that failed to insert or update.
Country = $Country
Contains information about a country that can be targeted by ads.
CreativeAssetId = $CreativeAssetId
Creative Asset ID.
CreativeClickThroughUrl = $CreativeClickThroughUrl
Click-through URL
CreativeFieldAssignment = $CreativeFieldAssignment
Creative Field Assignment.
CreativeFieldValue = $CreativeFieldValue
Contains properties of a creative field value.
CreativeGroupAssignment = $CreativeGroupAssignment
Creative Group Assignment.
CustomFloodlightVariable = $CustomFloodlightVariable
A custom floodlight variable.
CustomViewabilityMetricConfiguration = $CustomViewabilityMetricConfiguration
The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.
DateRange = $DateRange
Represents a date range.
DayPartTargeting = $DayPartTargeting
Day Part Targeting.
DefaultClickThroughEventTagProperties = $DefaultClickThroughEventTagProperties
Properties of inheriting and overriding the default click-through event tag. [...]
DfpSettings = $DfpSettings
Google Ad Manager Settings
Dimension = $Dimension
Represents a dimension.
DimensionFilter = $DimensionFilter
Represents a dimension filter.
DimensionValue = $DimensionValue
Represents a DimensionValue resource.
DynamicTargetingKey = $DynamicTargetingKey
Contains properties of a dynamic targeting key. [...]
EncryptionInfo = $EncryptionInfo
A description of how user IDs are encrypted.
EventTagOverride = $EventTagOverride
Event tag override information.
Flight = $Flight
Flight
FloodlightActivitiesGenerateTagResponse = $FloodlightActivitiesGenerateTagResponse
Floodlight Activity GenerateTag Response
FloodlightActivityDynamicTag = $FloodlightActivityDynamicTag
Dynamic Tag
FrequencyCap = $FrequencyCap
Frequency Cap.
FsCommand = $FsCommand
FsCommand.
KeyValueTargetingExpression = $KeyValueTargetingExpression
Key Value Targeting Expression.
Language = $Language
Contains information about a language that can be targeted by ads.
LastModifiedInfo = $LastModifiedInfo
Modification timestamp.
ListPopulationTerm = $ListPopulationTerm
Remarketing List Population Rule Term.
ListTargetingExpression = $ListTargetingExpression
Remarketing List Targeting Expression.
LookbackConfiguration = $LookbackConfiguration
Lookback configuration settings.
Metric = $Metric
Represents a metric.
Metro = $Metro
Contains information about a metro region that can be targeted by ads.
MobileApp = $MobileApp
Contains information about a mobile app. [...]
MobileCarrier = $MobileCarrier
Contains information about a mobile carrier that can be targeted by ads.
ObjectFilter = $ObjectFilter
Object Filter.
OffsetPosition = $OffsetPosition
Offset Position.
OmnitureSettings = $OmnitureSettings
Omniture Integration Settings.
OperatingSystem = $OperatingSystem
Contains information about an operating system that can be targeted by ads.
OrderContact = $OrderContact
Contact of an order.
PathReportDimensionValue = $PathReportDimensionValue
Represents a PathReportDimensionValue resource.
PlacementStrategy = $PlacementStrategy
Contains properties of a placement strategy.
PlatformType = $PlatformType
Contains information about a platform type that can be targeted by ads.
PostalCode = $PostalCode
Contains information about a postal code that can be targeted by ads.
PricingSchedulePricingPeriod = $PricingSchedulePricingPeriod
Pricing Period
Recipient = $Recipient
Represents a recipient.
Region = $Region
Contains information about a region that can be targeted by ads.
RemarketingListShare = $RemarketingListShare
Contains properties of a remarketing list's sharing information. [...]
Rule = $Rule
A rule associates an asset with a targeting template for asset-level targeting. [...]
SiteContact = $SiteContact
Site Contact
SiteTranscodeSetting = $SiteTranscodeSetting
Transcode Settings
Size = $Size
Represents the dimensions of ads, placements, creatives, or creative assets.
SortedDimension = $SortedDimension
Represents a sorted dimension.
Subaccount = $Subaccount
Contains properties of a Campaign Manager subaccount.
TagData = $TagData
Placement Tag Data
TagSetting = $TagSetting
Tag Settings
TagSettings = $TagSettings
Dynamic and Image Tag Settings.
TargetWindow = $TargetWindow
Target Window.
ThirdPartyAuthenticationToken = $ThirdPartyAuthenticationToken
Third Party Authentication Token
ThirdPartyTrackingUrl = $ThirdPartyTrackingUrl
Third-party Tracking URL.
TranscodeSetting = $TranscodeSetting
Transcode Settings
UniversalAdId = $UniversalAdId
A Universal Ad ID as per the VAST 4.0 spec. [...]
UserDefinedVariableConfiguration = $UserDefinedVariableConfiguration
User Defined Variable configuration.
UserProfile = $UserProfile
A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. [...]
UserRolePermission = $UserRolePermission
Contains properties of a user role permission.
UserRolePermissionGroup = $UserRolePermissionGroup
Represents a grouping of related user role permissions.
VideoOffset = $VideoOffset
Video Offset

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.