API Reference google_api_dfa_reporting v0.31.0
View SourceModules
API client metadata for GoogleApi.DFAReporting.V33.
API calls for all endpoints tagged AccountActiveAdSummaries.
API calls for all endpoints tagged AccountPermissionGroups.
API calls for all endpoints tagged AccountPermissions.
API calls for all endpoints tagged AccountUserProfiles.
API calls for all endpoints tagged Accounts.
API calls for all endpoints tagged Ads.
API calls for all endpoints tagged AdvertiserGroups.
API calls for all endpoints tagged AdvertiserLandingPages.
API calls for all endpoints tagged Advertisers.
API calls for all endpoints tagged Browsers.
API calls for all endpoints tagged CampaignCreativeAssociations.
API calls for all endpoints tagged Campaigns.
API calls for all endpoints tagged ChangeLogs.
API calls for all endpoints tagged Cities.
API calls for all endpoints tagged ConnectionTypes.
API calls for all endpoints tagged ContentCategories.
API calls for all endpoints tagged Conversions.
API calls for all endpoints tagged Countries.
API calls for all endpoints tagged CreativeAssets.
API calls for all endpoints tagged CreativeFieldValues.
API calls for all endpoints tagged CreativeFields.
API calls for all endpoints tagged CreativeGroups.
API calls for all endpoints tagged Creatives.
API calls for all endpoints tagged DimensionValues.
API calls for all endpoints tagged DirectorySites.
API calls for all endpoints tagged DynamicTargetingKeys.
API calls for all endpoints tagged EventTags.
API calls for all endpoints tagged Files.
API calls for all endpoints tagged FloodlightActivities.
API calls for all endpoints tagged FloodlightActivityGroups.
API calls for all endpoints tagged FloodlightConfigurations.
API calls for all endpoints tagged InventoryItems.
API calls for all endpoints tagged Languages.
API calls for all endpoints tagged Metros.
API calls for all endpoints tagged MobileApps.
API calls for all endpoints tagged MobileCarriers.
API calls for all endpoints tagged OperatingSystemVersions.
API calls for all endpoints tagged OperatingSystems.
API calls for all endpoints tagged OrderDocuments.
API calls for all endpoints tagged Orders.
API calls for all endpoints tagged PlacementGroups.
API calls for all endpoints tagged PlacementStrategies.
API calls for all endpoints tagged Placements.
API calls for all endpoints tagged PlatformTypes.
API calls for all endpoints tagged PostalCodes.
API calls for all endpoints tagged Projects.
API calls for all endpoints tagged Regions.
API calls for all endpoints tagged RemarketingListShares.
API calls for all endpoints tagged RemarketingLists.
API calls for all endpoints tagged Reports.
API calls for all endpoints tagged Sites.
API calls for all endpoints tagged Sizes.
API calls for all endpoints tagged Subaccounts.
API calls for all endpoints tagged TargetableRemarketingLists.
API calls for all endpoints tagged TargetingTemplates.
API calls for all endpoints tagged UserProfiles.
API calls for all endpoints tagged UserRolePermissionGroups.
API calls for all endpoints tagged UserRolePermissions.
API calls for all endpoints tagged UserRoles.
API calls for all endpoints tagged VideoFormats.
Handle Tesla connections for GoogleApi.DFAReporting.V33.
Contains properties of a Campaign Manager account.
Gets a summary of active ads in an account.
AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
Account Permission Group List Response
Account Permission List Response
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
Account User Profile List Response
Account List Response
Represents an activity group.
Contains properties of a Campaign Manager ad.
Campaign ad blocking settings.
Ad List Response
Contains properties of a Campaign Manager advertiser.
Groups advertisers together so that reports can be generated for the entire group at once.
Advertiser Group List Response
Landing Page List Response
Advertiser List Response
Audience Segment.
Audience Segment Group.
Contains information about a browser that can be targeted by ads.
Browser List Response
Contains properties of a Campaign Manager campaign.
Identifies a creative which has been associated with a given campaign.
Campaign Creative Association List Response
Campaign List Response
Describes a change that a user has made to a resource.
Change Log List Response
City List Response
Contains information about a city that can be targeted by ads.
Creative Click Tag.
Click-through URL
Click Through URL Suffix settings.
Companion Click-through override.
Companion Settings
Represents a response to the queryCompatibleFields method.
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.
Connection Type List Response
Content Category List Response
Organizes placements according to the contents of their associated webpages.
A Conversion represents when a user successfully performs a desired action after seeing an ad.
The error code and description for a conversion that failed to insert or update.
The original conversion that was inserted or updated and whether there were any errors.
Insert Conversions Request.
Insert Conversions Response.
Update Conversions Request.
Update Conversions Response.
Country List Response
Contains information about a country that can be targeted by ads.
Contains properties of a Creative.
Creative Asset.
Creative Asset ID.
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.
Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.
Creative Assignment.
Click-through URL
Creative Custom Event.
Contains properties of a creative field.
Creative Field Assignment.
Contains properties of a creative field value.
Creative Field Value List Response
Creative Field List Response
Contains properties of a creative group.
Creative Group Assignment.
Creative Group List Response
Creative optimization settings.
Creative Rotation.
Creative List Response
Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
Represents a Custom Rich Media Events group.
Custom Viewability Metric
The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.
Represents a date range.
Day Part Targeting.
Contains information about a landing page deep link.
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.
Delivery Schedule.
Google Ad Manager Settings
Represents a dimension.
Represents a dimension filter.
Represents a DimensionValue resource.
Represents the list of DimensionValue resources.
Represents a DimensionValuesRequest.
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.
Directory Site Settings
Directory Site List Response
Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
Dynamic Targeting Key List Response
A description of how user IDs are encrypted.
Contains properties of an event tag.
Event tag override information.
Event Tag List Response
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".
List of files for a report.
The URLs where the completed report file can be downloaded.
Floodlight Activity GenerateTag Response
Floodlight Activity List Response
Contains properties of a Floodlight activity.
Contains properties of a Floodlight activity group.
Floodlight Activity Group List Response
Publisher Dynamic Tag
Contains properties of a Floodlight configuration.
Floodlight Configuration List Response
Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".
Frequency Cap.
FsCommand.
Geographical Targeting.
Represents a buy from the Planning inventory store.
Inventory item List Response
Key Value Targeting Expression.
Contains information about where a user's browser is taken after the user clicks an ad.
Contains information about a language that can be targeted by ads.
Language Targeting.
Language List Response
Modification timestamp.
A group clause made up of list population terms representing constraints joined by ORs.
Remarketing List Population Rule.
Remarketing List Population Rule Term.
Remarketing List Targeting Expression.
Lookback configuration settings.
Represents a metric.
Contains information about a metro region that can be targeted by ads.
Metro List Response
Contains information about a mobile app. Used as a landing page deep link.
Mobile app List Response
Contains information about a mobile carrier that can be targeted by ads.
Mobile Carrier List Response
Object Filter.
Offset Position.
Omniture Integration Settings.
Contains information about an operating system that can be targeted by ads.
Contains information about a particular version of an operating system that can be targeted by ads.
Operating System Version List Response
Operating System List Response
Creative optimization activity.
Describes properties of a Planning order.
Contact of an order.
Contains properties of a Planning order document.
Order document List Response
Order List Response
Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
Contains properties of a placement.
Placement Assignment.
Contains properties of a package or roadblock.
Placement Group List Response
Placement Strategy List Response
Contains properties of a placement strategy.
Placement Tag
Placement GenerateTags Response
Placement List Response
Contains information about a platform type that can be targeted by ads.
Platform Type List Response
Popup Window Properties.
Contains information about a postal code that can be targeted by ads.
Postal Code List Response
Pricing Information
Pricing Schedule
Contains properties of a Planning project.
Project List Response
Represents fields that are compatible to be selected for a report of type "REACH".
Represents a recipient.
Contains information about a region that can be targeted by ads.
Region List Response
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.
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.
Remarketing list response
Represents a Report resource.
Represents fields that are compatible to be selected for a report of type "STANDARD".
The report criteria for a report of type "STANDARD".
The report criteria for a report of type "CROSS_DIMENSION_REACH".
The report's email delivery settings.
The report criteria for a report of type "FLOODLIGHT".
The properties of the report.
Represents the list of reports.
The report criteria for a report of type "PATH_TO_CONVERSION".
The properties of the report.
The report criteria for a report of type "REACH".
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".
Reporting Configuration
Rich Media Exit Override.
A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
Contains properties of a site.
Companion Settings
Site Contact
Site Settings
Skippable Settings
Transcode Settings
Video Settings
Site List Response
Represents the dimensions of ads, placements, creatives, or creative assets.
Size List Response
Skippable Settings
Represents a sorted dimension.
Contains properties of a Campaign Manager subaccount.
Subaccount List Response
Placement Tag Data
Tag Settings
Dynamic and Image Tag Settings.
Target Window.
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.
Targetable remarketing list response
Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
Targeting Template List Response
Technology Targeting.
Third Party Authentication Token
Third-party Tracking URL.
Transcode Settings
A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.
User Defined Variable configuration.
A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests.
Represents the list of user profiles.
Contains properties of auser role, which is used to manage user access.
Contains properties of a user role permission.
Represents a grouping of related user role permissions.
User Role Permission Group List Response
User Role Permission List Response
User Role List Response
Contains information about supported video formats.
Video Format List Response
Video Offset
Video Settings
API client metadata for GoogleApi.DFAReporting.V34.
API calls for all endpoints tagged AccountActiveAdSummaries.
API calls for all endpoints tagged AccountPermissionGroups.
API calls for all endpoints tagged AccountPermissions.
API calls for all endpoints tagged AccountUserProfiles.
API calls for all endpoints tagged Accounts.
API calls for all endpoints tagged Ads.
API calls for all endpoints tagged AdvertiserGroups.
API calls for all endpoints tagged AdvertiserLandingPages.
API calls for all endpoints tagged Advertisers.
API calls for all endpoints tagged Browsers.
API calls for all endpoints tagged CampaignCreativeAssociations.
API calls for all endpoints tagged Campaigns.
API calls for all endpoints tagged ChangeLogs.
API calls for all endpoints tagged Cities.
API calls for all endpoints tagged ConnectionTypes.
API calls for all endpoints tagged ContentCategories.
API calls for all endpoints tagged Conversions.
API calls for all endpoints tagged Countries.
API calls for all endpoints tagged CreativeAssets.
API calls for all endpoints tagged CreativeFieldValues.
API calls for all endpoints tagged CreativeFields.
API calls for all endpoints tagged CreativeGroups.
API calls for all endpoints tagged Creatives.
API calls for all endpoints tagged CustomEvents.
API calls for all endpoints tagged DimensionValues.
API calls for all endpoints tagged DirectorySites.
API calls for all endpoints tagged DynamicTargetingKeys.
API calls for all endpoints tagged EventTags.
API calls for all endpoints tagged Files.
API calls for all endpoints tagged FloodlightActivities.
API calls for all endpoints tagged FloodlightActivityGroups.
API calls for all endpoints tagged FloodlightConfigurations.
API calls for all endpoints tagged InventoryItems.
API calls for all endpoints tagged Languages.
API calls for all endpoints tagged Metros.
API calls for all endpoints tagged MobileApps.
API calls for all endpoints tagged MobileCarriers.
API calls for all endpoints tagged OperatingSystemVersions.
API calls for all endpoints tagged OperatingSystems.
API calls for all endpoints tagged OrderDocuments.
API calls for all endpoints tagged Orders.
API calls for all endpoints tagged PlacementGroups.
API calls for all endpoints tagged PlacementStrategies.
API calls for all endpoints tagged Placements.
API calls for all endpoints tagged PlatformTypes.
API calls for all endpoints tagged PostalCodes.
API calls for all endpoints tagged Projects.
API calls for all endpoints tagged Regions.
API calls for all endpoints tagged RemarketingListShares.
API calls for all endpoints tagged RemarketingLists.
API calls for all endpoints tagged Reports.
API calls for all endpoints tagged Sites.
API calls for all endpoints tagged Sizes.
API calls for all endpoints tagged Subaccounts.
API calls for all endpoints tagged TargetableRemarketingLists.
API calls for all endpoints tagged TargetingTemplates.
API calls for all endpoints tagged UserProfiles.
API calls for all endpoints tagged UserRolePermissionGroups.
API calls for all endpoints tagged UserRolePermissions.
API calls for all endpoints tagged UserRoles.
API calls for all endpoints tagged VideoFormats.
Handle Tesla connections for GoogleApi.DFAReporting.V34.
Contains properties of a Campaign Manager account.
Gets a summary of active ads in an account.
AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
Account Permission Group List Response
Account Permission List Response
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
Account User Profile List Response
Account List Response
Represents an activity group.
Contains properties of a Campaign Manager ad.
Campaign ad blocking settings.
Ad List Response
Contains properties of a Campaign Manager advertiser.
Groups advertisers together so that reports can be generated for the entire group at once.
Advertiser Group List Response
Landing Page List Response
Advertiser List Response
Audience Segment.
Audience Segment Group.
Contains information about a browser that can be targeted by ads.
Browser List Response
Contains properties of a Campaign Manager campaign.
Identifies a creative which has been associated with a given campaign.
Campaign Creative Association List Response
Campaign Manager IDs related to the custom event.
Campaign List Response
Describes a change that a user has made to a resource.
Change Log List Response
Represents a DfaReporting channel grouping.
Represents a DfaReporting channel grouping rule.
City List Response
Contains information about a city that can be targeted by ads.
Creative Click Tag.
Click-through URL
Click Through URL Suffix settings.
Companion Click-through override.
Companion Settings
Represents a response to the queryCompatibleFields method.
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.
Connection Type List Response
Content Category List Response
Organizes placements according to the contents of their associated webpages.
A Conversion represents when a user successfully performs a desired action after seeing an ad.
The error code and description for a conversion that failed to insert or update.
The original conversion that was inserted or updated and whether there were any errors.
Insert Conversions Request.
Insert Conversions Response.
Update Conversions Request.
Update Conversions Response.
Country List Response
Contains information about a country that can be targeted by ads.
Contains properties of a Creative.
Creative Asset.
Creative Asset ID.
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.
Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.
Creative Assignment.
Click-through URL
Creative Custom Event.
Contains properties of a creative field.
Creative Field Assignment.
Contains properties of a creative field value.
Creative Field Value List Response
Creative Field List Response
Contains properties of a creative group.
Creative Group Assignment.
Creative Group List Response
Creative optimization settings.
Creative Rotation.
Creative List Response
Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
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.
Annotate a click event.
The error code and description for a custom event that failed to insert.
Annotate an impression.
Custom event to be inserted.
The original custom event that was inserted and whether there were any errors.
Insert Custom Events Request.
Insert Custom Events Response.
A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
Represents a Custom Rich Media Events group.
Custom variable.
Custom Viewability Metric
The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.
DV360 IDs related to the custom event.
Represents a date range.
Day Part Targeting.
Contains information about a landing page deep link.
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.
Delivery Schedule.
Google Ad Manager Settings
Represents a dimension.
Represents a dimension filter.
Represents a DimensionValue resource.
Represents the list of DimensionValue resources.
Represents a DimensionValuesRequest.
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.
Directory Site Settings
Directory Site List Response
Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
Dynamic Targeting Key List Response
A description of how user IDs are encrypted.
Represents a DfaReporting event filter.
Contains properties of an event tag.
Event tag override information.
Event Tag List Response
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".
List of files for a report.
The URLs where the completed report file can be downloaded.
Floodlight Activity GenerateTag Response
Floodlight Activity List Response
Contains properties of a Floodlight activity.
Contains properties of a Floodlight activity group.
Floodlight Activity Group List Response
Publisher Dynamic Tag
Contains properties of a Floodlight configuration.
Floodlight Configuration List Response
Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".
Frequency Cap.
FsCommand.
Geographical Targeting.
Represents a buy from the Planning inventory store.
Inventory item List Response
Key Value Targeting Expression.
Contains information about where a user's browser is taken after the user clicks an ad.
Contains information about a language that can be targeted by ads.
Language Targeting.
Language List Response
Modification timestamp.
A group clause made up of list population terms representing constraints joined by ORs.
Remarketing List Population Rule.
Remarketing List Population Rule Term.
Remarketing List Targeting Expression.
Lookback configuration settings.
Represents a metric.
Contains information about a metro region that can be targeted by ads.
Metro List Response
Contains information about a mobile app. Used as a landing page deep link.
Mobile app List Response
Contains information about a mobile carrier that can be targeted by ads.
Mobile Carrier List Response
Online Behavioral Advertiser icon.
Object Filter.
Offset Position.
Omniture Integration Settings.
Contains information about an operating system that can be targeted by ads.
Contains information about a particular version of an operating system that can be targeted by ads.
Operating System Version List Response
Operating System List Response
Creative optimization activity.
Describes properties of a Planning order.
Contact of an order.
Contains properties of a Planning order document.
Order document List Response
Order List Response
Represents a DfaReporting path filter.
Represents fields that are compatible to be selected for a report of type "PATH".
Represents a PathReportDimensionValue resource.
Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
Contains properties of a placement.
Placement Assignment.
Contains properties of a package or roadblock.
Placement Group List Response
Placement Strategy List Response
Contains properties of a placement strategy.
Placement Tag
Placement GenerateTags Response
Placement List Response
Contains information about a platform type that can be targeted by ads.
Platform Type List Response
Popup Window Properties.
Contains information about a postal code that can be targeted by ads.
Postal Code List Response
Pricing Information
Pricing Schedule
Contains properties of a Planning project.
Project List Response
Represents fields that are compatible to be selected for a report of type "REACH".
Represents a recipient.
Contains information about a region that can be targeted by ads.
Region List Response
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.
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.
Remarketing list response
Represents a Report resource.
Represents fields that are compatible to be selected for a report of type "STANDARD".
The report criteria for a report of type "STANDARD".
The report criteria for a report of type "CROSS_DIMENSION_REACH".
The report's email delivery settings.
The report criteria for a report of type "FLOODLIGHT".
The properties of the report.
Represents the list of reports.
The report criteria for a report of type "PATH_ATTRIBUTION".
The report criteria for a report of type "PATH".
The report criteria for a report of type "PATH_TO_CONVERSION".
The properties of the report.
The report criteria for a report of type "REACH".
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".
Reporting Configuration
Rich Media Exit Override.
A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
Contains properties of a site.
Companion Settings
Site Contact
Site Settings
Skippable Settings
Transcode Settings
Video Settings
Site List Response
Represents the dimensions of ads, placements, creatives, or creative assets.
Size List Response
Skippable Settings
Represents a sorted dimension.
Contains properties of a Campaign Manager subaccount.
Subaccount List Response
Placement Tag Data
Tag Settings
Dynamic and Image Tag Settings.
Target Window.
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.
Targetable remarketing list response
Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
Targeting Template List Response
Technology Targeting.
Third Party Authentication Token
Third-party Tracking URL.
Transcode Settings
A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.
User Defined Variable configuration.
A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests.
Represents the list of user profiles.
Contains properties of auser role, which is used to manage user access.
Contains properties of a user role permission.
Represents a grouping of related user role permissions.
User Role Permission Group List Response
User Role Permission List Response
User Role List Response
Contains information about supported video formats.
Video Format List Response
Video Offset
Video Settings
API client metadata for GoogleApi.DFAReporting.V35.
API calls for all endpoints tagged Media.
Handle Tesla connections for GoogleApi.DFAReporting.V35.
Creative Click Tag.
Creative Asset ID.
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.
Click-through URL
Creative Custom Event.
Represents a DimensionValue resource.
Offset Position.
Popup Window Properties.
Represents the dimensions of ads, placements, creatives, or creative assets.
API client metadata for GoogleApi.DFAReporting.V4.
API calls for all endpoints tagged AccountActiveAdSummaries.
API calls for all endpoints tagged AccountPermissionGroups.
API calls for all endpoints tagged AccountPermissions.
API calls for all endpoints tagged AccountUserProfiles.
API calls for all endpoints tagged Accounts.
API calls for all endpoints tagged Ads.
API calls for all endpoints tagged AdvertiserGroups.
API calls for all endpoints tagged AdvertiserInvoices.
API calls for all endpoints tagged AdvertiserLandingPages.
API calls for all endpoints tagged Advertisers.
API calls for all endpoints tagged BillingAssignments.
API calls for all endpoints tagged BillingProfiles.
API calls for all endpoints tagged BillingRates.
API calls for all endpoints tagged Browsers.
API calls for all endpoints tagged CampaignCreativeAssociations.
API calls for all endpoints tagged Campaigns.
API calls for all endpoints tagged ChangeLogs.
API calls for all endpoints tagged Cities.
API calls for all endpoints tagged ConnectionTypes.
API calls for all endpoints tagged ContentCategories.
API calls for all endpoints tagged Conversions.
API calls for all endpoints tagged Countries.
API calls for all endpoints tagged CreativeAssets.
API calls for all endpoints tagged CreativeFieldValues.
API calls for all endpoints tagged CreativeFields.
API calls for all endpoints tagged CreativeGroups.
API calls for all endpoints tagged Creatives.
API calls for all endpoints tagged DimensionValues.
API calls for all endpoints tagged DirectorySites.
API calls for all endpoints tagged DynamicTargetingKeys.
API calls for all endpoints tagged EventTags.
API calls for all endpoints tagged Files.
API calls for all endpoints tagged FloodlightActivities.
API calls for all endpoints tagged FloodlightActivityGroups.
API calls for all endpoints tagged FloodlightConfigurations.
API calls for all endpoints tagged InventoryItems.
API calls for all endpoints tagged Languages.
API calls for all endpoints tagged Metros.
API calls for all endpoints tagged MobileApps.
API calls for all endpoints tagged MobileCarriers.
API calls for all endpoints tagged OperatingSystemVersions.
API calls for all endpoints tagged OperatingSystems.
API calls for all endpoints tagged Orders.
API calls for all endpoints tagged PlacementGroups.
API calls for all endpoints tagged PlacementStrategies.
API calls for all endpoints tagged Placements.
API calls for all endpoints tagged PlatformTypes.
API calls for all endpoints tagged PostalCodes.
API calls for all endpoints tagged Projects.
API calls for all endpoints tagged Regions.
API calls for all endpoints tagged RemarketingListShares.
API calls for all endpoints tagged RemarketingLists.
API calls for all endpoints tagged Reports.
API calls for all endpoints tagged Sites.
API calls for all endpoints tagged Sizes.
API calls for all endpoints tagged Subaccounts.
API calls for all endpoints tagged TargetableRemarketingLists.
API calls for all endpoints tagged TargetingTemplates.
API calls for all endpoints tagged TvCampaignDetails.
API calls for all endpoints tagged TvCampaignSummaries.
API calls for all endpoints tagged UserProfiles.
API calls for all endpoints tagged UserRolePermissionGroups.
API calls for all endpoints tagged UserRolePermissions.
API calls for all endpoints tagged UserRoles.
API calls for all endpoints tagged VideoFormats.
Handle Tesla connections for GoogleApi.DFAReporting.V4.
Contains properties of a Campaign Manager account.
Gets a summary of active ads in an account.
AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
Account Permission Group List Response
Account Permission List Response
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
Account User Profile List Response
Account List Response
Represents an activity group.
Contains properties of a Campaign Manager ad.
Campaign ad blocking settings.
Ad List Response
Contains properties of a Campaign Manager advertiser.
Groups advertisers together so that reports can be generated for the entire group at once.
Advertiser Group List Response
Invoice List Response
Landing Page List Response
Advertiser List Response
Audience Segment.
Audience Segment Group.
List account, subaccount, advertiser, and campaign associated with a given Billing Profile.
Billing assignment List Response
Contains properties of a Campaign Manager Billing Profile.
Billing profile List Response
Attributes
-
currencyCode(type:String.t, default:nil) - Billing currency code in ISO 4217 format. -
endDate(type:String.t, default:nil) - End date of this billing rate. -
id(type:String.t, default:nil) - ID of this billing rate. -
name(type:String.t, default:nil) - Name of this billing rate. This must be less than 256 characters long. -
rateInMicros(type:String.t, default:nil) - Flat rate in micros of this billing rate. This cannot co-exist with tiered rate. -
startDate(type:String.t, default:nil) - Start date of this billing rate. -
tieredRates(type:list(GoogleApi.DFAReporting.V4.Model.BillingRateTieredRate.t), default:nil) - Tiered rate of this billing rate. This cannot co-exist with flat rate. -
type(type:String.t, default:nil) - Type of this billing rate. -
unitOfMeasure(type:String.t, default:nil) - Unit of measure for this billing rate.
Billing Rate List Response
Contains information about a browser that can be targeted by ads.
Browser List Response
Contains properties of a Campaign Manager campaign.
Identifies a creative which has been associated with a given campaign.
Campaign Creative Association List Response
Represents a summarized campaign information associated with this invoice.
Campaign List Response
Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate.
Contains data of the items purchased.
Describes a change that a user has made to a resource.
Change Log List Response
City List Response
Contains information about a city that can be targeted by ads.
Creative Click Tag.
Click-through URL
Click Through URL Suffix settings.
Companion Click-through override.
Companion Settings
Represents a response to the queryCompatibleFields method. Next ID: 10
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.
Connection Type List Response
Content Category List Response
Attributes
-
accountId(type:String.t, default:nil) - Account ID of this content category. This is a read-only field that can be left blank. -
id(type:String.t, default:nil) - ID of this content category. This is a read-only, auto-generated field. -
kind(type:String.t, default:nil) - Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". -
name(type:String.t, default:nil) - 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.
A Conversion represents when a user successfully performs a desired action after seeing an ad.
The error code and description for a conversion that failed to insert or update.
The original conversion that was inserted or updated and whether there were any errors.
Insert Conversions Request.
Insert Conversions Response.
Update Conversions Request.
Update Conversions Response.
Country List Response
Contains information about a country that can be targeted by ads.
Contains properties of a Creative.
Creative Asset.
Creative Asset ID.
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.
Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.
Creative Assignment.
Click-through URL
Creative Custom Event.
Contains properties of a creative field.
Creative Field Assignment.
Contains properties of a creative field value.
Creative Field Value List Response
Creative Field List Response
Contains properties of a creative group.
Creative Group Assignment.
Creative Group List Response
Creative optimization settings.
Creative Rotation.
Creative List Response
Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
Represents fields that are compatible to be selected for a report of type "CROSS_MEDIA_REACH".
A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
Represents a Custom Rich Media Events group.
Custom Viewability Metric
The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.
Represents a date range.
Day Part Targeting.
Contains information about a landing page deep link.
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.
Delivery Schedule.
Google Ad Manager Settings
Represents a dimension.
Represents a dimension filter.
Represents a DimensionValue resource.
Represents the list of DimensionValue resources.
Represents a DimensionValuesRequest.
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.
Directory Site Settings
Directory Site List Response
Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
Dynamic Targeting Key List Response
A description of how user IDs are encrypted.
Contains properties of an event tag.
Event tag override information.
Event Tag List Response
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".
List of files for a report.
The URLs where the completed report file can be downloaded.
Floodlight Activity GenerateTag Response
Floodlight Activity List Response
Contains properties of a Floodlight activity.
Contains properties of a Floodlight activity group.
Floodlight Activity Group List Response
Publisher Dynamic Tag
Contains properties of a Floodlight configuration.
Floodlight Configuration List Response
Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".
Frequency Cap.
FsCommand.
Geographical Targeting.
Represents a buy from the Planning inventory store.
Inventory item List Response
Contains information about a single invoice
Key Value Targeting Expression.
Contains information about where a user's browser is taken after the user clicks an ad.
Contains information about a language that can be targeted by ads.
Language Targeting.
Language List Response
Modification timestamp.
A group clause made up of list population terms representing constraints joined by ORs.
Remarketing List Population Rule.
Remarketing List Population Rule Term.
Remarketing List Targeting Expression.
Lookback configuration settings.
Placement tag wrapping
Represents a metric.
Contains information about a metro region that can be targeted by ads.
Metro List Response
Contains information about a mobile app. Used as a landing page deep link.
Mobile app List Response
Contains information about a mobile carrier that can be targeted by ads.
Mobile Carrier List Response
Online Behavioral Advertiser icon.
Object Filter.
Identify a user by name and address.
Offset Position.
Omniture Integration Settings.
Contains information about an operating system that can be targeted by ads.
Contains information about a particular version of an operating system that can be targeted by ads.
Operating System Version List Response
Operating System List Response
Creative optimization activity.
Describes properties of a Planning order.
Contact of an order.
Order List Response
Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
Contains properties of a placement.
Placement Assignment.
Contains properties of a package or roadblock.
Placement Group List Response
Placement Strategy List Response
Contains properties of a placement strategy.
Placement Tag
Placement GenerateTags Response
Placement List Response
Contains information about a platform type that can be targeted by ads.
Platform Type List Response
Popup Window Properties.
Contains information about a postal code that can be targeted by ads.
Postal Code List Response
Attributes
-
capCostType(type:String.t, default:nil) - Cap cost type of this inventory item. -
endDate(type:Date.t, default:nil) - -
flights(type:list(GoogleApi.DFAReporting.V4.Model.Flight.t), default:nil) - Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. -
groupType(type:String.t, default:nil) - 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. -
pricingType(type:String.t, default:nil) - Pricing type of this inventory item. -
startDate(type:Date.t, default:nil) -
Pricing Schedule
Pricing Period
Contains properties of a Planning project.
Project List Response
Represents fields that are compatible to be selected for a report of type "REACH".
Represents a recipient.
Contains information about a region that can be targeted by ads.
Region List Response
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.
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.
Remarketing list response
Represents a Report resource.
Represents fields that are compatible to be selected for a report of type "STANDARD".
The report criteria for a report of type "STANDARD".
The report criteria for a report of type "CROSS_DIMENSION_REACH".
Optional. The report criteria for a report of type "CROSS_MEDIA_REACH".
The report's email delivery settings.
The report criteria for a report of type "FLOODLIGHT".
The properties of the report.
Represents the list of reports.
The report criteria for a report of type "PATH_TO_CONVERSION".
The properties of the report.
The report criteria for a report of type "REACH".
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".
Reporting Configuration
Rich Media Exit Override.
A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
Contains properties of a site.
Companion Settings
Site Contact
Site Settings
Skippable Settings
Transcode Settings
Video Settings
Site List Response
Represents the dimensions of ads, placements, creatives, or creative assets.
Size List Response
Skippable Settings
Represents a sorted dimension.
Contains properties of a Campaign Manager subaccount.
Subaccount List Response
Placement Tag Data
Tag Settings
Dynamic and Image Tag Settings.
Target Window.
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 facilitate 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.
Targetable remarketing list response
Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
Targeting Template List Response
Technology Targeting.
Third Party Authentication Token
Third-party Tracking URL.
Transcode Settings
TvCampaignDetail contains data from a TV campaign for specific start dates and date windows.
Response message for TvCampaignSummariesService.List.
TvCampaignSummary contains aggregate data from a TV campaign.
A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window.
A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.
User Defined Variable configuration.
User identifying information. Exactly one type of identifier must be specified.
A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests.
Represents the list of user profiles.
Contains properties of auser role, which is used to manage user access.
Contains properties of a user role permission.
Represents a grouping of related user role permissions.
User Role Permission Group List Response
User Role Permission List Response
User Role List Response
Contains information about supported video formats.
Video Format List Response
Video Offset
Video Settings