Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

§Classes

dfareporting

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

GoogleAuth

§Variables

auth

§Interfaces

Account

Contains properties of a Campaign Manager account.

AccountActiveAdSummary

Gets a summary of active ads in an account.

AccountPermission

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

AccountPermissionGroup

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

AccountPermissionGroupsListResponse

Account Permission Group List Response

AccountPermissionsListResponse

Account Permission List Response

AccountsListOptions

Additional options for dfareporting#accountsList.

AccountsListResponse

Account List Response

AccountsPatchOptions

Additional options for dfareporting#accountsPatch.

AccountUserProfile

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

AccountUserProfilesListOptions

Additional options for dfareporting#accountUserProfilesList.

AccountUserProfilesListResponse

Account User Profile List Response

AccountUserProfilesPatchOptions

Additional options for dfareporting#accountUserProfilesPatch.

Activities

Represents an activity group.

Ad

Contains properties of a Campaign Manager ad.

AdBlockingConfiguration

Campaign ad blocking settings.

AdsListOptions

Additional options for dfareporting#adsList.

AdsListResponse

Ad List Response

AdSlot

Ad Slot

AdsPatchOptions

Additional options for dfareporting#adsPatch.

Advertiser

Contains properties of a Campaign Manager advertiser.

AdvertiserGroup

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

AdvertiserGroupsListOptions

Additional options for dfareporting#advertiserGroupsList.

AdvertiserGroupsListResponse

Advertiser Group List Response

AdvertiserGroupsPatchOptions

Additional options for dfareporting#advertiserGroupsPatch.

AdvertiserInvoicesListOptions

Additional options for dfareporting#advertiserInvoicesList.

AdvertiserInvoicesListResponse

Invoice List Response

AdvertiserLandingPagesListOptions

Additional options for dfareporting#advertiserLandingPagesList.

AdvertiserLandingPagesListResponse

Landing Page List Response

AdvertiserLandingPagesPatchOptions

Additional options for dfareporting#advertiserLandingPagesPatch.

AdvertisersListOptions

Additional options for dfareporting#advertisersList.

AdvertisersListResponse

Advertiser List Response

AdvertisersPatchOptions

Additional options for dfareporting#advertisersPatch.

AudienceSegment

Audience Segment.

AudienceSegmentGroup

Audience Segment Group.

BillingAssignment

List account, subaccount, advertiser, and campaign associated with a given Billing Profile.

BillingAssignmentsListResponse

Billing assignment List Response

BillingProfile

Contains properties of a Campaign Manager Billing Profile.

BillingProfilesListOptions

Additional options for dfareporting#billingProfilesList.

BillingProfilesListResponse

Billing profile List Response

BillingRate
BillingRatesListResponse

Billing Rate List Response

BillingRateTieredRate
Browser

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

BrowsersListResponse

Browser List Response

Campaign

Contains properties of a Campaign Manager campaign.

CampaignCreativeAssociation

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

CampaignCreativeAssociationsListOptions

Additional options for dfareporting#campaignCreativeAssociationsList.

CampaignCreativeAssociationsListResponse

Campaign Creative Association List Response

CampaignsListOptions

Additional options for dfareporting#campaignsList.

CampaignsListResponse

Campaign List Response

CampaignsPatchOptions

Additional options for dfareporting#campaignsPatch.

CampaignSummary

Represents a summarized campaign information associated with this invoice.

ChangeLog

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

ChangeLogsListOptions

Additional options for dfareporting#changeLogsList.

ChangeLogsListResponse

Change Log List Response

ChannelGrouping

Represents a DfaReporting channel grouping.

ChannelGroupingRule

Represents a DfaReporting channel grouping rule.

CitiesListOptions

Additional options for dfareporting#citiesList.

CitiesListResponse

City List Response

City

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

ClickTag

Creative Click Tag.

ClickThroughUrl

Click-through URL

ClickThroughUrlSuffixProperties

Click Through URL Suffix settings.

CompanionClickThroughOverride

Companion Click-through override.

CompanionSetting

Companion Settings

CompatibleFields

Represents a response to the queryCompatibleFields method.

ConnectionType

Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.

ConnectionTypesListResponse

Connection Type List Response

ContentCategoriesListOptions

Additional options for dfareporting#contentCategoriesList.

ContentCategoriesListResponse

Content Category List Response

ContentCategoriesPatchOptions

Additional options for dfareporting#contentCategoriesPatch.

ContentCategory
Conversion

A Conversion represents when a user successfully performs a desired action after seeing an ad.

ConversionError

The error code and description for a conversion that failed to insert or update.

ConversionsBatchInsertRequest

Insert Conversions Request.

ConversionsBatchInsertResponse

Insert Conversions Response.

ConversionsBatchUpdateRequest

Update Conversions Request.

ConversionsBatchUpdateResponse

Update Conversions Response.

ConversionStatus

The original conversion that was inserted or updated and whether there were any errors.

CountriesListResponse

Country List Response

Country

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

Creative

Contains properties of a Creative.

CreativeAsset

Creative Asset.

CreativeAssetId

Creative Asset ID.

CreativeAssetMetadata

CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.

CreativeAssetSelection

Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.

CreativeAssignment

Creative Assignment.

CreativeClickThroughUrl

Click-through URL

CreativeCustomEvent

Creative Custom Event.

CreativeField

Contains properties of a creative field.

CreativeFieldAssignment

Creative Field Assignment.

CreativeFieldsListOptions

Additional options for dfareporting#creativeFieldsList.

CreativeFieldsListResponse

Creative Field List Response

CreativeFieldsPatchOptions

Additional options for dfareporting#creativeFieldsPatch.

CreativeFieldValue

Contains properties of a creative field value.

CreativeFieldValuesListOptions

Additional options for dfareporting#creativeFieldValuesList.

CreativeFieldValuesListResponse

Creative Field Value List Response

CreativeFieldValuesPatchOptions

Additional options for dfareporting#creativeFieldValuesPatch.

CreativeGroup

Contains properties of a creative group.

CreativeGroupAssignment

Creative Group Assignment.

CreativeGroupsListOptions

Additional options for dfareporting#creativeGroupsList.

CreativeGroupsListResponse

Creative Group List Response

CreativeGroupsPatchOptions

Additional options for dfareporting#creativeGroupsPatch.

CreativeOptimizationConfiguration

Creative optimization settings.

CreativeRotation

Creative Rotation.

CreativesListOptions

Additional options for dfareporting#creativesList.

CreativesListResponse

Creative List Response

CreativesPatchOptions

Additional options for dfareporting#creativesPatch.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

CrossDimensionReachReportCompatibleFields

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

CustomFloodlightVariable

A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.

CustomRichMediaEvents

Represents a Custom Rich Media Events group.

CustomViewabilityMetric

Custom Viewability Metric

CustomViewabilityMetricConfiguration

The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.

DateRange

Represents a date range.

DayPartTargeting

Day Part Targeting.

DeepLink

Contains information about a landing page deep link.

DefaultClickThroughEventTagProperties

Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.

DeliverySchedule

Delivery Schedule.

DfpSettings

Google Ad Manager Settings

Dimension

Represents a dimension.

DimensionFilter

Represents a dimension filter.

DimensionValue

Represents a DimensionValue resource.

DimensionValueList

Represents the list of DimensionValue resources.

DimensionValueRequest

Represents a DimensionValuesRequest.

DimensionValuesQueryOptions

Additional options for dfareporting#dimensionValuesQuery.

DirectorySite

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

DirectorySiteSettings

Directory Site Settings

DirectorySitesListOptions

Additional options for dfareporting#directorySitesList.

DirectorySitesListResponse

Directory Site List Response

DisjunctiveMatchStatement

Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.

DynamicTargetingKey

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.

DynamicTargetingKeysDeleteOptions

Additional options for dfareporting#dynamicTargetingKeysDelete.

DynamicTargetingKeysListOptions

Additional options for dfareporting#dynamicTargetingKeysList.

DynamicTargetingKeysListResponse

Dynamic Targeting Key List Response

EncryptionInfo

A description of how user IDs are encrypted.

EventFilter

Represents a DfaReporting event filter.

EventTag

Contains properties of an event tag.

EventTagOverride

Event tag override information.

EventTagsListOptions

Additional options for dfareporting#eventTagsList.

EventTagsListResponse

Event Tag List Response

EventTagsPatchOptions

Additional options for dfareporting#eventTagsPatch.

File

Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".

FileList

List of files for a report.

FilesListOptions

Additional options for dfareporting#filesList.

Flight

Flight

FloodlightActivitiesGeneratetagOptions

Additional options for dfareporting#floodlightActivitiesGeneratetag.

FloodlightActivitiesGenerateTagResponse

Floodlight Activity GenerateTag Response

FloodlightActivitiesListOptions

Additional options for dfareporting#floodlightActivitiesList.

FloodlightActivitiesListResponse

Floodlight Activity List Response

FloodlightActivitiesPatchOptions

Additional options for dfareporting#floodlightActivitiesPatch.

FloodlightActivity

Contains properties of a Floodlight activity.

FloodlightActivityDynamicTag

Dynamic Tag

FloodlightActivityGroup

Contains properties of a Floodlight activity group.

FloodlightActivityGroupsListOptions

Additional options for dfareporting#floodlightActivityGroupsList.

FloodlightActivityGroupsListResponse

Floodlight Activity Group List Response

FloodlightActivityGroupsPatchOptions

Additional options for dfareporting#floodlightActivityGroupsPatch.

FloodlightActivityPublisherDynamicTag

Publisher Dynamic Tag

FloodlightConfiguration

Contains properties of a Floodlight configuration.

FloodlightConfigurationsListOptions

Additional options for dfareporting#floodlightConfigurationsList.

FloodlightConfigurationsListResponse

Floodlight Configuration List Response

FloodlightConfigurationsPatchOptions

Additional options for dfareporting#floodlightConfigurationsPatch.

FloodlightReportCompatibleFields

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

FrequencyCap

Frequency Cap.

FsCommand

FsCommand.

GeoTargeting

Geographical Targeting.

InventoryItem

Represents a buy from the Planning inventory store.

InventoryItemsListOptions

Additional options for dfareporting#inventoryItemsList.

InventoryItemsListResponse

Inventory item List Response

Invoice

Contains information about a single invoice

KeyValueTargetingExpression

Key Value Targeting Expression.

LandingPage

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

Language

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

LanguagesListResponse

Language List Response

LanguageTargeting

Language Targeting.

LastModifiedInfo

Modification timestamp.

ListPopulationClause

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

ListPopulationRule

Remarketing List Population Rule.

ListPopulationTerm

Remarketing List Population Rule Term.

ListTargetingExpression

Remarketing List Targeting Expression.

LookbackConfiguration

Lookback configuration settings.

MeasurementPartnerAdvertiserLink
MeasurementPartnerCampaignLink
MeasurementPartnerWrappingData

Placement tag wrapping

Metric

Represents a metric.

Metro

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

MetrosListResponse

Metro List Response

MobileApp

Contains information about a mobile app. Used as a landing page deep link.

MobileAppsListOptions

Additional options for dfareporting#mobileAppsList.

MobileAppsListResponse

Mobile app List Response

MobileCarrier

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

MobileCarriersListResponse

Mobile Carrier List Response

ObaIcon

Online Behavioral Advertiser icon.

ObjectFilter

Object Filter.

OfflineUserAddressInfo

Identify a user by name and address.

OffsetPosition

Offset Position.

OmnitureSettings

Omniture Integration Settings.

OperatingSystem

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

OperatingSystemsListResponse

Operating System List Response

OperatingSystemVersion

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

OperatingSystemVersionsListResponse

Operating System Version List Response

OptimizationActivity

Creative optimization activity.

Order

Describes properties of a Planning order.

OrderContact

Contact of an order.

OrdersListOptions

Additional options for dfareporting#ordersList.

OrdersListResponse

Order List Response

PathFilter

Represents a DfaReporting path filter.

PathReportCompatibleFields

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

PathReportDimensionValue

Represents a PathReportDimensionValue resource.

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.

PlacementConversionDomainOverride
PlacementGroup

Contains properties of a package or roadblock.

PlacementGroupsListOptions

Additional options for dfareporting#placementGroupsList.

PlacementGroupsListResponse

Placement Group List Response

PlacementGroupsPatchOptions

Additional options for dfareporting#placementGroupsPatch.

PlacementsGeneratetagsOptions

Additional options for dfareporting#placementsGeneratetags.

PlacementsGenerateTagsResponse

Placement GenerateTags Response

PlacementSingleConversionDomain
PlacementsListOptions

Additional options for dfareporting#placementsList.

PlacementsListResponse

Placement List Response

PlacementsPatchOptions

Additional options for dfareporting#placementsPatch.

PlacementStrategiesListOptions

Additional options for dfareporting#placementStrategiesList.

PlacementStrategiesListResponse

Placement Strategy List Response

PlacementStrategiesPatchOptions

Additional options for dfareporting#placementStrategiesPatch.

PlacementStrategy

Contains properties of a placement strategy.

PlacementTag

Placement Tag

PlatformType

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

PlatformTypesListResponse

Platform Type List Response

PopupWindowProperties

Popup Window Properties.

PostalCode

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

PostalCodesListResponse

Postal Code List Response

Pricing
PricingSchedule

Pricing Schedule

PricingSchedulePricingPeriod

Pricing Period

Project

Contains properties of a Planning project.

ProjectsListOptions

Additional options for dfareporting#projectsList.

ProjectsListResponse

Project List Response

ReachReportCompatibleFields

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

Recipient

Represents a recipient.

Region

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

RegionsListResponse

Region List Response

RemarketingList

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

RemarketingListShare

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

RemarketingListSharesPatchOptions

Additional options for dfareporting#remarketingListSharesPatch.

RemarketingListsListOptions

Additional options for dfareporting#remarketingListsList.

RemarketingListsListResponse

Remarketing list response

RemarketingListsPatchOptions

Additional options for dfareporting#remarketingListsPatch.

Report

Represents a Report resource.

ReportCompatibleFields

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

ReportList

Represents the list of reports.

ReportsConfiguration

Reporting Configuration

ReportsFilesListOptions

Additional options for dfareporting#reportsFilesList.

ReportsListOptions

Additional options for dfareporting#reportsList.

ReportsRunOptions

Additional options for dfareporting#reportsRun.

RichMediaExitOverride

Rich Media Exit Override.

Rule

A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.

Site

Contains properties of a site.

SiteCompanionSetting

Companion Settings

SiteContact

Site Contact

SiteSettings

Site Settings

SiteSkippableSetting

Skippable Settings

SitesListOptions

Additional options for dfareporting#sitesList.

SitesListResponse

Site List Response

SitesPatchOptions

Additional options for dfareporting#sitesPatch.

SiteTranscodeSetting

Transcode Settings

SiteVideoSettings

Video Settings

Size

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

SizesListOptions

Additional options for dfareporting#sizesList.

SizesListResponse

Size List Response

SkippableSetting

Skippable Settings

SortedDimension

Represents a sorted dimension.

Subaccount

Contains properties of a Campaign Manager subaccount.

SubaccountsListOptions

Additional options for dfareporting#subaccountsList.

SubaccountsListResponse

Subaccount List Response

SubaccountsPatchOptions

Additional options for dfareporting#subaccountsPatch.

TagData

Placement Tag Data

TagSetting

Tag Settings

TagSettings

Dynamic and Image Tag Settings.

TargetableRemarketingList

Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to 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.

TargetableRemarketingListsListOptions

Additional options for dfareporting#targetableRemarketingListsList.

TargetableRemarketingListsListResponse

Targetable remarketing list response

TargetingTemplate

Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.

TargetingTemplatesListOptions

Additional options for dfareporting#targetingTemplatesList.

TargetingTemplatesListResponse

Targeting Template List Response

TargetingTemplatesPatchOptions

Additional options for dfareporting#targetingTemplatesPatch.

TargetWindow

Target Window.

TechnologyTargeting

Technology Targeting.

ThirdPartyAuthenticationToken

Third Party Authentication Token

ThirdPartyTrackingUrl

Third-party Tracking URL.

TranscodeSetting

Transcode Settings

UniversalAdId

A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.

UserDefinedVariableConfiguration

User Defined Variable configuration.

UserIdentifier

User identifying information. Exactly one type of identifier must be specified.

UserProfile

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.

UserProfileList

Represents the list of user profiles.

UserRole

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

UserRolePermission

Contains properties of a user role permission.

UserRolePermissionGroup

Represents a grouping of related user role permissions.

UserRolePermissionGroupsListResponse

User Role Permission Group List Response

UserRolePermissionsListOptions

Additional options for dfareporting#userRolePermissionsList.

UserRolePermissionsListResponse

User Role Permission List Response

UserRolesListOptions

Additional options for dfareporting#userRolesList.

UserRolesListResponse

User Role List Response

UserRolesPatchOptions

Additional options for dfareporting#userRolesPatch.

UvarFilter

Defines the filtering on a single uvar.

VideoFormat

Contains information about supported video formats.

VideoFormatsListResponse

Video Format List Response

VideoOffset

Video Offset

VideoSettings

Video Settings