Module google_dfareporting3d3::api [−][src]
Structs
Contains properties of a Campaign Manager account.
Gets a summary of active ads in an account.
Gets the account’s active ad summary by account ID.
A builder providing access to all methods supported on accountActiveAdSummary resources.
It is not used directly, but through the Dfareporting hub.
Gets one account by ID.
Retrieves the list of accounts, possibly filtered. This method supports paging.
A builder providing access to all methods supported on account resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing account. This method supports patch semantics.
AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
Gets one account permission by ID.
AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
Gets one account permission group by ID.
Retrieves the list of account permission groups.
A builder providing access to all methods supported on accountPermissionGroup resources.
It is not used directly, but through the Dfareporting hub.
Account Permission Group List Response
Retrieves the list of account permissions.
A builder providing access to all methods supported on accountPermission resources.
It is not used directly, but through the Dfareporting hub.
Account Permission List Response
Updates an existing account.
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
Gets one account user profile by ID.
Inserts a new account user profile.
Retrieves a list of account user profiles, possibly filtered. This method supports paging.
A builder providing access to all methods supported on accountUserProfile resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing account user profile. This method supports patch semantics.
Updates an existing account user profile.
Account User Profile List Response
Account List Response
Represents an activity group.
Contains properties of a Campaign Manager ad.
Campaign ad blocking settings.
Gets one ad by ID.
Inserts a new ad.
Retrieves a list of ads, possibly filtered. This method supports paging.
A builder providing access to all methods supported on ad resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing ad. This method supports patch semantics.
Ad Slot
Updates an existing ad.
Ad List Response
Contains properties of a Campaign Manager advertiser.
Gets one advertiser by ID.
Groups advertisers together so that reports can be generated for the entire group at once.
Deletes an existing advertiser group.
Gets one advertiser group by ID.
Inserts a new advertiser group.
Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
A builder providing access to all methods supported on advertiserGroup resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing advertiser group. This method supports patch semantics.
Updates an existing advertiser group.
Advertiser Group List Response
Inserts a new advertiser.
Gets one landing page by ID.
Inserts a new landing page.
Retrieves a list of landing pages.
A builder providing access to all methods supported on advertiserLandingPage resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing advertiser landing page. This method supports patch semantics.
Updates an existing landing page.
Landing Page List Response
Retrieves a list of advertisers, possibly filtered. This method supports paging.
A builder providing access to all methods supported on advertiser resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing advertiser. This method supports patch semantics.
Updates an existing advertiser.
Advertiser List Response
Audience Segment.
Audience Segment Group.
Contains information about a browser that can be targeted by ads.
Retrieves a list of browsers.
A builder providing access to all methods supported on browser resources.
It is not used directly, but through the Dfareporting hub.
Browser List Response
Contains properties of a Campaign Manager campaign.
Identifies a creative which has been associated with a given campaign.
Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
A builder providing access to all methods supported on campaignCreativeAssociation resources.
It is not used directly, but through the Dfareporting hub.
Campaign Creative Association List Response
Gets one campaign by ID.
Inserts a new campaign.
Retrieves a list of campaigns, possibly filtered. This method supports paging.
A builder providing access to all methods supported on campaign resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing campaign. This method supports patch semantics.
Updates an existing campaign.
Campaign List Response
Describes a change that a user has made to a resource.
Gets one change log by ID.
Retrieves a list of change logs. This method supports paging.
A builder providing access to all methods supported on changeLog resources.
It is not used directly, but through the Dfareporting hub.
Change Log List Response
City List Response
Contains information about a city that can be targeted by ads.
Retrieves a list of cities, possibly filtered.
A builder providing access to all methods supported on city resources.
It is not used directly, but through the Dfareporting hub.
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.
Gets one connection type by ID.
Retrieves a list of connection types.
A builder providing access to all methods supported on connectionType resources.
It is not used directly, but through the Dfareporting hub.
Connection Type List Response
Content Category List Response
Organizes placements according to the contents of their associated webpages.
Deletes an existing content category.
Gets one content category by ID.
Inserts a new content category.
Retrieves a list of content categories, possibly filtered. This method supports paging.
A builder providing access to all methods supported on contentCategory resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing content category. This method supports patch semantics.
Updates an existing content category.
A Conversion represents when a user successfully performs a desired action after seeing an ad.
Inserts conversions.
Updates existing conversions.
The error code and description for a conversion that failed to insert or update.
A builder providing access to all methods supported on conversion resources.
It is not used directly, but through the Dfareporting hub.
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.
Gets one country by ID.
Retrieves a list of countries.
A builder providing access to all methods supported on country resources.
It is not used directly, but through the Dfareporting hub.
Contains properties of a Creative.
Creative Asset.
Creative Asset ID.
Inserts a new creative asset.
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.
A builder providing access to all methods supported on creativeAsset resources.
It is not used directly, but through the Dfareporting hub.
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.
Deletes an existing creative field.
Gets one creative field by ID.
Inserts a new creative field.
Retrieves a list of creative fields, possibly filtered. This method supports paging.
A builder providing access to all methods supported on creativeField resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing creative field. This method supports patch semantics.
Updates an existing creative field.
Contains properties of a creative field value.
Deletes an existing creative field value.
Gets one creative field value by ID.
Inserts a new creative field value.
Retrieves a list of creative field values, possibly filtered. This method supports paging.
A builder providing access to all methods supported on creativeFieldValue resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing creative field value. This method supports patch semantics.
Updates an existing creative field value.
Creative Field Value List Response
Creative Field List Response
Gets one creative by ID.
Contains properties of a creative group.
Creative Group Assignment.
Gets one creative group by ID.
Inserts a new creative group.
Retrieves a list of creative groups, possibly filtered. This method supports paging.
A builder providing access to all methods supported on creativeGroup resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing creative group. This method supports patch semantics.
Updates an existing creative group.
Creative Group List Response
Inserts a new creative.
Retrieves a list of creatives, possibly filtered. This method supports paging.
A builder providing access to all methods supported on creative resources.
It is not used directly, but through the Dfareporting hub.
Creative optimization settings.
Updates an existing creative. This method supports patch semantics.
Creative Rotation.
Updates an existing creative.
Creative List Response
Represents fields that are compatible to be selected for a report of type “CROSS_DIMENSION_REACH”.
A custom floodlight variable.
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.
Central instance to access all Dfareporting related resource activities
Google Ad Manager Settings
Represents a dimension.
Represents a dimension filter.
Represents a DimensionValue resource.
Represents the list of DimensionValue resources.
A builder providing access to all methods supported on dimensionValue resources.
It is not used directly, but through the Dfareporting hub.
Retrieves list of report dimension values for a list of filters.
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.
Gets one directory site by ID.
Inserts a new directory site.
Retrieves a list of directory sites, possibly filtered. This method supports paging.
A builder providing access to all methods supported on directorySite resources.
It is not used directly, but through the Dfareporting hub.
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.
Deletes an existing dynamic targeting key.
Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser’s ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
Retrieves a list of dynamic targeting keys.
A builder providing access to all methods supported on dynamicTargetingKey resources.
It is not used directly, but through the Dfareporting hub.
Dynamic Targeting Key List Response
A description of how user IDs are encrypted.
Contains properties of an event tag.
Deletes an existing event tag.
Gets one event tag by ID.
Inserts a new event tag.
Retrieves a list of event tags, possibly filtered.
A builder providing access to all methods supported on eventTag resources.
It is not used directly, but through the Dfareporting hub.
Event tag override information.
Updates an existing event tag. This method supports patch semantics.
Updates an existing event tag.
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”.
Retrieves a report file by its report ID and file ID. This method supports media download.
List of files for a report.
Lists files for a user profile.
A builder providing access to all methods supported on file resources.
It is not used directly, but through the Dfareporting hub.
The URLs where the completed report file can be downloaded.
Flight
Floodlight Activity GenerateTag Response
Floodlight Activity List Response
Contains properties of a Floodlight activity.
Deletes an existing floodlight activity.
Dynamic Tag
Generates a tag for a floodlight activity.
Gets one floodlight activity by ID.
Contains properties of a Floodlight activity group.
Gets one floodlight activity group by ID.
Inserts a new floodlight activity group.
Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
A builder providing access to all methods supported on floodlightActivityGroup resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing floodlight activity group. This method supports patch semantics.
Updates an existing floodlight activity group.
Floodlight Activity Group List Response
Inserts a new floodlight activity.
Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
A builder providing access to all methods supported on floodlightActivity resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing floodlight activity. This method supports patch semantics.
Publisher Dynamic Tag
Updates an existing floodlight activity.
Contains properties of a Floodlight configuration.
Gets one floodlight configuration by ID.
Retrieves a list of floodlight configurations, possibly filtered.
A builder providing access to all methods supported on floodlightConfiguration resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing floodlight configuration. This method supports patch semantics.
Updates an existing 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.
Gets one inventory item by ID.
Retrieves a list of inventory items, possibly filtered. This method supports paging.
A builder providing access to all methods supported on inventoryItem resources.
It is not used directly, but through the Dfareporting hub.
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.
Retrieves a list of languages.
A builder providing access to all methods supported on language resources.
It is not used directly, but through the Dfareporting hub.
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.
Retrieves a list of metros.
A builder providing access to all methods supported on metro resources.
It is not used directly, but through the Dfareporting hub.
Metro List Response
Contains information about a mobile app. Used as a landing page deep link.
Gets one mobile app by ID.
Retrieves list of available mobile apps.
A builder providing access to all methods supported on mobileApp resources.
It is not used directly, but through the Dfareporting hub.
Mobile app List Response
Contains information about a mobile carrier that can be targeted by ads.
Gets one mobile carrier by ID.
Retrieves a list of mobile carriers.
A builder providing access to all methods supported on mobileCarrier resources.
It is not used directly, but through the Dfareporting hub.
Mobile Carrier List Response
Object Filter.
Offset Position.
Omniture Integration Settings.
Contains information about an operating system that can be targeted by ads.
Gets one operating system by DART ID.
Retrieves a list of operating systems.
A builder providing access to all methods supported on operatingSystem resources.
It is not used directly, but through the Dfareporting hub.
Contains information about a particular version of an operating system that can be targeted by ads.
Gets one operating system version by ID.
Retrieves a list of operating system versions.
A builder providing access to all methods supported on operatingSystemVersion resources.
It is not used directly, but through the Dfareporting hub.
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.
Gets one order document by ID.
Retrieves a list of order documents, possibly filtered. This method supports paging.
A builder providing access to all methods supported on orderDocument resources.
It is not used directly, but through the Dfareporting hub.
Order document List Response
Gets one order by ID.
Retrieves a list of orders, possibly filtered. This method supports paging.
A builder providing access to all methods supported on order resources.
It is not used directly, but through the Dfareporting hub.
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.
Generates tags for a placement.
Gets one placement by ID.
Contains properties of a package or roadblock.
Gets one placement group by ID.
Inserts a new placement group.
Retrieves a list of placement groups, possibly filtered. This method supports paging.
A builder providing access to all methods supported on placementGroup resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing placement group. This method supports patch semantics.
Updates an existing placement group.
Placement Group List Response
Inserts a new placement.
Retrieves a list of placements, possibly filtered. This method supports paging.
A builder providing access to all methods supported on placement resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing placement. This method supports patch semantics.
Placement Strategy List Response
Contains properties of a placement strategy.
Deletes an existing placement strategy.
Gets one placement strategy by ID.
Inserts a new placement strategy.
Retrieves a list of placement strategies, possibly filtered. This method supports paging.
A builder providing access to all methods supported on placementStrategy resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing placement strategy. This method supports patch semantics.
Updates an existing placement strategy.
Placement Tag
Updates an existing placement.
Placement GenerateTags Response
Placement List Response
Contains information about a platform type that can be targeted by ads.
Gets one platform type by ID.
Retrieves a list of platform types.
A builder providing access to all methods supported on platformType resources.
It is not used directly, but through the Dfareporting hub.
Platform Type List Response
Popup Window Properties.
Contains information about a postal code that can be targeted by ads.
Gets one postal code by ID.
Retrieves a list of postal codes.
A builder providing access to all methods supported on postalCode resources.
It is not used directly, but through the Dfareporting hub.
Postal Code List Response
Pricing Information
Pricing Schedule
Pricing Period
Contains properties of a Planning project.
Gets one project by ID.
Retrieves a list of projects, possibly filtered. This method supports paging .
A builder providing access to all methods supported on project resources.
It is not used directly, but through the Dfareporting hub.
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.
Retrieves a list of regions.
A builder providing access to all methods supported on region resources.
It is not used directly, but through the Dfareporting hub.
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.
Gets one remarketing list by ID.
Inserts a new remarketing list.
Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
A builder providing access to all methods supported on remarketingList resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing remarketing list. This method supports patch semantics.
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.
Gets one remarketing list share by remarketing list ID.
A builder providing access to all methods supported on remarketingListShare resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing remarketing list share. This method supports patch semantics.
Updates an existing remarketing list share.
Updates an existing remarketing list.
Remarketing list response
Represents a Report resource.
Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
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”.
Deletes a report by its ID.
The report’s email delivery settings.
Retrieves a report file by its report ID and file ID. This method supports media download.
Lists files for a report.
The report criteria for a report of type “FLOODLIGHT”.
The properties of the report.
Retrieves a report by its ID.
Creates a report.
Represents the list of reports.
Retrieves list of reports.
A builder providing access to all methods supported on report resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing report. This method supports patch semantics.
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”.
Runs a report.
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”.
Updates a report.
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
Gets one site by ID.
Inserts a new site.
Retrieves a list of sites, possibly filtered. This method supports paging.
A builder providing access to all methods supported on site resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing site. This method supports patch semantics.
Site Settings
Skippable Settings
Transcode Settings
Updates an existing site.
Video Settings
Site List Response
Represents the dimensions of ads, placements, creatives, or creative assets.
Gets one size by ID.
Inserts a new size.
Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.
A builder providing access to all methods supported on size resources.
It is not used directly, but through the Dfareporting hub.
Size List Response
Skippable Settings
Represents a sorted dimension.
Contains properties of a Campaign Manager subaccount.
Gets one subaccount by ID.
Inserts a new subaccount.
Gets a list of subaccounts, possibly filtered. This method supports paging.
A builder providing access to all methods supported on subaccount resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing subaccount. This method supports patch semantics.
Updates an existing 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.
Gets one remarketing list by ID.
Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
A builder providing access to all methods supported on targetableRemarketingList resources.
It is not used directly, but through the Dfareporting hub.
Targetable remarketing list response
Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
Gets one targeting template by ID.
Inserts a new targeting template.
Retrieves a list of targeting templates, optionally filtered. This method supports paging.
A builder providing access to all methods supported on targetingTemplate resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing targeting template. This method supports patch semantics.
Updates an existing targeting template.
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.
Gets one user profile by ID.
Represents the list of user profiles.
Retrieves list of user profiles for a user.
A builder providing access to all methods supported on userProfile resources.
It is not used directly, but through the Dfareporting hub.
Contains properties of auser role, which is used to manage user access.
Deletes an existing user role.
Gets one user role by ID.
Inserts a new user role.
Retrieves a list of user roles, possibly filtered. This method supports paging.
A builder providing access to all methods supported on userRole resources.
It is not used directly, but through the Dfareporting hub.
Updates an existing user role. This method supports patch semantics.
Contains properties of a user role permission.
Gets one user role permission by ID.
Represents a grouping of related user role permissions.
Gets one user role permission group by ID.
Gets a list of all supported user role permission groups.
A builder providing access to all methods supported on userRolePermissionGroup resources.
It is not used directly, but through the Dfareporting hub.
User Role Permission Group List Response
Gets a list of user role permissions, possibly filtered.
A builder providing access to all methods supported on userRolePermission resources.
It is not used directly, but through the Dfareporting hub.
User Role Permission List Response
Updates an existing user role.
User Role List Response
Contains information about supported video formats.
Gets one video format by ID.
Lists available video formats.
A builder providing access to all methods supported on videoFormat resources.
It is not used directly, but through the Dfareporting hub.
Video Format List Response
Video Offset
Video Settings
Enums
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.