googleapis
Version:
Google APIs Client Library for Node.js
1,219 lines • 1.18 MB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace dfareporting_v3_3 {
export interface Options extends GlobalOptions {
version: 'v3.3';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Campaign Manager 360 API
*
* Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.
*
* @example
* ```js
* const {google} = require('googleapis');
* const dfareporting = google.dfareporting('v3.3');
* ```
*/
export class Dfareporting {
context: APIRequestContext;
accountActiveAdSummaries: Resource$Accountactiveadsummaries;
accountPermissionGroups: Resource$Accountpermissiongroups;
accountPermissions: Resource$Accountpermissions;
accounts: Resource$Accounts;
accountUserProfiles: Resource$Accountuserprofiles;
ads: Resource$Ads;
advertiserGroups: Resource$Advertisergroups;
advertiserLandingPages: Resource$Advertiserlandingpages;
advertisers: Resource$Advertisers;
browsers: Resource$Browsers;
campaignCreativeAssociations: Resource$Campaigncreativeassociations;
campaigns: Resource$Campaigns;
changeLogs: Resource$Changelogs;
cities: Resource$Cities;
connectionTypes: Resource$Connectiontypes;
contentCategories: Resource$Contentcategories;
conversions: Resource$Conversions;
countries: Resource$Countries;
creativeAssets: Resource$Creativeassets;
creativeFields: Resource$Creativefields;
creativeFieldValues: Resource$Creativefieldvalues;
creativeGroups: Resource$Creativegroups;
creatives: Resource$Creatives;
dimensionValues: Resource$Dimensionvalues;
directorySites: Resource$Directorysites;
dynamicTargetingKeys: Resource$Dynamictargetingkeys;
eventTags: Resource$Eventtags;
files: Resource$Files;
floodlightActivities: Resource$Floodlightactivities;
floodlightActivityGroups: Resource$Floodlightactivitygroups;
floodlightConfigurations: Resource$Floodlightconfigurations;
inventoryItems: Resource$Inventoryitems;
languages: Resource$Languages;
metros: Resource$Metros;
mobileApps: Resource$Mobileapps;
mobileCarriers: Resource$Mobilecarriers;
operatingSystems: Resource$Operatingsystems;
operatingSystemVersions: Resource$Operatingsystemversions;
orderDocuments: Resource$Orderdocuments;
orders: Resource$Orders;
placementGroups: Resource$Placementgroups;
placements: Resource$Placements;
placementStrategies: Resource$Placementstrategies;
platformTypes: Resource$Platformtypes;
postalCodes: Resource$Postalcodes;
projects: Resource$Projects;
regions: Resource$Regions;
remarketingLists: Resource$Remarketinglists;
remarketingListShares: Resource$Remarketinglistshares;
reports: Resource$Reports;
sites: Resource$Sites;
sizes: Resource$Sizes;
subaccounts: Resource$Subaccounts;
targetableRemarketingLists: Resource$Targetableremarketinglists;
targetingTemplates: Resource$Targetingtemplates;
userProfiles: Resource$Userprofiles;
userRolePermissionGroups: Resource$Userrolepermissiongroups;
userRolePermissions: Resource$Userrolepermissions;
userRoles: Resource$Userroles;
videoFormats: Resource$Videoformats;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Contains properties of a Campaign Manager account.
*/
export interface Schema$Account {
/**
* Account permissions assigned to this account.
*/
accountPermissionIds?: string[] | null;
/**
* Profile for this account. This is a read-only field that can be left blank.
*/
accountProfile?: string | null;
/**
* Whether this account is active.
*/
active?: boolean | null;
/**
* Maximum number of active ads allowed for this account.
*/
activeAdsLimitTier?: string | null;
/**
* Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
*/
activeViewOptOut?: boolean | null;
/**
* User role permissions available to the user roles of this account.
*/
availablePermissionIds?: string[] | null;
/**
* ID of the country associated with this account.
*/
countryId?: string | null;
/**
* ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP
*/
currencyId?: string | null;
/**
* Default placement dimensions for this account.
*/
defaultCreativeSizeId?: string | null;
/**
* Description of this account.
*/
description?: string | null;
/**
* ID of this account. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
*/
kind?: string | null;
/**
* Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
*/
locale?: string | null;
/**
* Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
*/
maximumImageSize?: string | null;
/**
* Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
*/
name?: string | null;
/**
* Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
*/
nielsenOcrEnabled?: boolean | null;
/**
* Reporting configuration of this account.
*/
reportsConfiguration?: Schema$ReportsConfiguration;
/**
* Share Path to Conversion reports with Twitter.
*/
shareReportsWithTwitter?: boolean | null;
/**
* File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
*/
teaserSizeLimit?: string | null;
}
/**
* Gets a summary of active ads in an account.
*/
export interface Schema$AccountActiveAdSummary {
/**
* ID of the account.
*/
accountId?: string | null;
/**
* Ads that have been activated for the account
*/
activeAds?: string | null;
/**
* Maximum number of active ads allowed for the account.
*/
activeAdsLimitTier?: string | null;
/**
* Ads that can be activated for the account.
*/
availableAds?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
*/
kind?: string | null;
}
/**
* AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
*/
export interface Schema$AccountPermission {
/**
* Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD"
*/
accountProfiles?: string[] | null;
/**
* ID of this account permission.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
*/
kind?: string | null;
/**
* Administrative level required to enable this account permission.
*/
level?: string | null;
/**
* Name of this account permission.
*/
name?: string | null;
/**
* Permission group of this account permission.
*/
permissionGroupId?: string | null;
}
/**
* AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
*/
export interface Schema$AccountPermissionGroup {
/**
* ID of this account permission group.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
*/
kind?: string | null;
/**
* Name of this account permission group.
*/
name?: string | null;
}
/**
* Account Permission Group List Response
*/
export interface Schema$AccountPermissionGroupsListResponse {
/**
* Account permission group collection.
*/
accountPermissionGroups?: Schema$AccountPermissionGroup[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
*/
kind?: string | null;
}
/**
* Account Permission List Response
*/
export interface Schema$AccountPermissionsListResponse {
/**
* Account permission collection.
*/
accountPermissions?: Schema$AccountPermission[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
*/
kind?: string | null;
}
/**
* Account List Response
*/
export interface Schema$AccountsListResponse {
/**
* Account collection.
*/
accounts?: Schema$Account[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
*/
export interface Schema$AccountUserProfile {
/**
* Account ID of the user profile. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
*/
active?: boolean | null;
/**
* Filter that describes which advertisers are visible to the user profile.
*/
advertiserFilter?: Schema$ObjectFilter;
/**
* Filter that describes which campaigns are visible to the user profile.
*/
campaignFilter?: Schema$ObjectFilter;
/**
* Comments for this user profile.
*/
comments?: string | null;
/**
* Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
*/
email?: string | null;
/**
* ID of the user profile. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
*/
kind?: string | null;
/**
* Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
*/
locale?: string | null;
/**
* Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<\>"#%,".
*/
name?: string | null;
/**
* Filter that describes which sites are visible to the user profile.
*/
siteFilter?: Schema$ObjectFilter;
/**
* Subaccount ID of the user profile. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Trafficker type of this user profile. This is a read-only field.
*/
traffickerType?: string | null;
/**
* User type of the user profile. This is a read-only field that can be left blank.
*/
userAccessType?: string | null;
/**
* Filter that describes which user roles are visible to the user profile.
*/
userRoleFilter?: Schema$ObjectFilter;
/**
* User role ID of the user profile. This is a required field.
*/
userRoleId?: string | null;
}
/**
* Account User Profile List Response
*/
export interface Schema$AccountUserProfilesListResponse {
/**
* Account user profile collection.
*/
accountUserProfiles?: Schema$AccountUserProfile[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Represents an activity group.
*/
export interface Schema$Activities {
/**
* List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
*/
filters?: Schema$DimensionValue[];
/**
* The kind of resource this is, in this case dfareporting#activities.
*/
kind?: string | null;
/**
* List of names of floodlight activity metrics.
*/
metricNames?: string[] | null;
}
/**
* Contains properties of a Campaign Manager ad.
*/
export interface Schema$Ad {
/**
* Account ID of this ad. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Whether this ad is active. When true, archived must be false.
*/
active?: boolean | null;
/**
* Advertiser ID of this ad. This is a required field on insertion.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this ad is archived. When true, active must be false.
*/
archived?: boolean | null;
/**
* Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
*/
audienceSegmentId?: string | null;
/**
* Campaign ID of this ad. This is a required field on insertion.
*/
campaignId?: string | null;
/**
* Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
*/
campaignIdDimensionValue?: Schema$DimensionValue;
/**
* Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
*/
clickThroughUrl?: Schema$ClickThroughUrl;
/**
* Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
*/
clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties;
/**
* Comments for this ad.
*/
comments?: string | null;
/**
* Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
*/
compatibility?: string | null;
/**
* Information about the creation of this ad. This is a read-only field.
*/
createInfo?: Schema$LastModifiedInfo;
/**
* Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
*/
creativeGroupAssignments?: Schema$CreativeGroupAssignment[];
/**
* Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
*/
creativeRotation?: Schema$CreativeRotation;
/**
* Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
dayPartTargeting?: Schema$DayPartTargeting;
/**
* Default click-through event tag properties for this ad.
*/
defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties;
/**
* Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
*/
deliverySchedule?: Schema$DeliverySchedule;
/**
* Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
*/
dynamicClickTracker?: boolean | null;
endTime?: string | null;
/**
* Event tag overrides for this ad.
*/
eventTagOverrides?: Schema$EventTagOverride[];
/**
* Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
geoTargeting?: Schema$GeoTargeting;
/**
* ID of this ad. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this ad. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
keyValueTargetingExpression?: Schema$KeyValueTargetingExpression;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
*/
kind?: string | null;
/**
* Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
languageTargeting?: Schema$LanguageTargeting;
/**
* Information about the most recent modification of this ad. This is a read-only field.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this ad. This is a required field and must be less than 256 characters long.
*/
name?: string | null;
/**
* Placement assignments for this ad.
*/
placementAssignments?: Schema$PlacementAssignment[];
/**
* Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
remarketingListExpression?: Schema$ListTargetingExpression;
/**
* Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
*/
size?: Schema$Size;
/**
* Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
*/
sslCompliant?: boolean | null;
/**
* Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
*/
sslRequired?: boolean | null;
startTime?: string | null;
/**
* Subaccount ID of this ad. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
*/
targetingTemplateId?: string | null;
/**
* Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
technologyTargeting?: Schema$TechnologyTargeting;
/**
* Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
*/
type?: string | null;
}
/**
* Campaign ad blocking settings.
*/
export interface Schema$AdBlockingConfiguration {
/**
* Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
*/
clickThroughUrl?: string | null;
/**
* ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.
*/
creativeBundleId?: string | null;
/**
* Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
*/
enabled?: boolean | null;
/**
* Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.
*/
overrideClickThroughUrl?: boolean | null;
}
/**
* Ad List Response
*/
export interface Schema$AdsListResponse {
/**
* Ad collection.
*/
ads?: Schema$Ad[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Ad Slot
*/
export interface Schema$AdSlot {
/**
* Comment for this ad slot.
*/
comment?: string | null;
/**
* Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
*/
compatibility?: string | null;
/**
* Height of this ad slot.
*/
height?: string | null;
/**
* ID of the placement from an external platform that is linked to this ad slot.
*/
linkedPlacementId?: string | null;
/**
* Name of this ad slot.
*/
name?: string | null;
/**
* Payment source type of this ad slot.
*/
paymentSourceType?: string | null;
/**
* Primary ad slot of a roadblock inventory item.
*/
primary?: boolean | null;
/**
* Width of this ad slot.
*/
width?: string | null;
}
/**
* Contains properties of a Campaign Manager advertiser.
*/
export interface Schema$Advertiser {
/**
* Account ID of this advertiser.This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
*/
advertiserGroupId?: string | null;
/**
* Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
*/
clickThroughUrlSuffix?: string | null;
/**
* ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
*/
defaultClickThroughEventTagId?: string | null;
/**
* Default email address used in sender field for tag emails.
*/
defaultEmail?: string | null;
/**
* Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
*/
floodlightConfigurationId?: string | null;
/**
* Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
*/
floodlightConfigurationIdDimensionValue?: Schema$DimensionValue;
/**
* ID of this advertiser. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
*/
kind?: string | null;
/**
* Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
*/
name?: string | null;
/**
* Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
*/
originalFloodlightConfigurationId?: string | null;
/**
* Status of this advertiser.
*/
status?: string | null;
/**
* Subaccount ID of this advertiser.This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Suspension status of this advertiser.
*/
suspended?: boolean | null;
}
/**
* Groups advertisers together so that reports can be generated for the entire group at once.
*/
export interface Schema$AdvertiserGroup {
/**
* Account ID of this advertiser group. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* ID of this advertiser group. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
*/
kind?: string | null;
/**
* Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
*/
name?: string | null;
}
/**
* Advertiser Group List Response
*/
export interface Schema$AdvertiserGroupsListResponse {
/**
* Advertiser group collection.
*/
advertiserGroups?: Schema$AdvertiserGroup[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Landing Page List Response
*/
export interface Schema$AdvertiserLandingPagesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse".
*/
kind?: string | null;
/**
* Landing page collection
*/
landingPages?: Schema$LandingPage[];
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Advertiser List Response
*/
export interface Schema$AdvertisersListResponse {
/**
* Advertiser collection.
*/
advertisers?: Schema$Advertiser[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Audience Segment.
*/
export interface Schema$AudienceSegment {
/**
* Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
*/
allocation?: number | null;
/**
* ID of this audience segment. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Name of this audience segment. This is a required field and must be less than 65 characters long.
*/
name?: string | null;
}
/**
* Audience Segment Group.
*/
export interface Schema$AudienceSegmentGroup {
/**
* Audience segments assigned to this group. The number of segments must be between 2 and 100.
*/
audienceSegments?: Schema$AudienceSegment[];
/**
* ID of this audience segment group. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Name of this audience segment group. This is a required field and must be less than 65 characters long.
*/
name?: string | null;
}
/**
* Contains information about a browser that can be targeted by ads.
*/
export interface Schema$Browser {
/**
* ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
*/
browserVersionId?: string | null;
/**
* DART ID of this browser. This is the ID used when generating reports.
*/
dartId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
*/
kind?: string | null;
/**
* Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
*/
majorVersion?: string | null;
/**
* Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
*/
minorVersion?: string | null;
/**
* Name of this browser.
*/
name?: string | null;
}
/**
* Browser List Response
*/
export interface Schema$BrowsersListResponse {
/**
* Browser collection.
*/
browsers?: Schema$Browser[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
*/
kind?: string | null;
}
/**
* Contains properties of a Campaign Manager campaign.
*/
export interface Schema$Campaign {
/**
* Account ID of this campaign. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Ad blocking settings for this campaign.
*/
adBlockingConfiguration?: Schema$AdBlockingConfiguration;
/**
* Additional creative optimization configurations for the campaign.
*/
additionalCreativeOptimizationConfigurations?: Schema$CreativeOptimizationConfiguration[];
/**
* Advertiser group ID of the associated advertiser.
*/
advertiserGroupId?: string | null;
/**
* Advertiser ID of this campaign. This is a required field.
*/
advertiserId?: string | null;
/**
* Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this campaign has been archived.
*/
archived?: boolean | null;
/**
* Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
*/
audienceSegmentGroups?: Schema$AudienceSegmentGroup[];
/**
* Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
*/
billingInvoiceCode?: string | null;
/**
* Click-through URL suffix override properties for this campaign.
*/
clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties;
/**
* Arbitrary comments about this campaign. Must be less than 256 characters long.
*/
comment?: string | null;
/**
* Information about the creation of this campaign. This is a read-only field.
*/
createInfo?: Schema$LastModifiedInfo;
/**
* List of creative group IDs that are assigned to the campaign.
*/
creativeGroupIds?: string[] | null;
/**
* Creative optimization configuration for the campaign.
*/
creativeOptimizationConfiguration?: Schema$CreativeOptimizationConfiguration;
/**
* Click-through event tag ID override properties for this campaign.
*/
defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties;
/**
* The default landing page ID for this campaign.
*/
defaultLandingPageId?: string | null;
endDate?: string | null;
/**
* Overrides that can be used to activate or deactivate advertiser event tags.
*/
eventTagOverrides?: Schema$EventTagOverride[];
/**
* External ID for this campaign.
*/
externalId?: string | null;
/**
* ID of this campaign. This is a read-only auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
*/
kind?: string | null;
/**
* Information about the most recent modification of this campaign. This is a read-only field.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
*/
name?: string | null;
/**
* Whether Nielsen reports are enabled for this campaign.
*/
nielsenOcrEnabled?: boolean | null;
startDate?: string | null;
/**
* Subaccount ID of this campaign. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Campaign trafficker contact emails.
*/
traffickerEmails?: string[] | null;
}
/**
* Identifies a creative which has been associated with a given campaign.
*/
export interface Schema$CampaignCreativeAssociation {
/**
* ID of the creative associated with the campaign. This is a required field.
*/
creativeId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
*/
kind?: string | null;
}
/**
* Campaign Creative Association List Response
*/
export interface Schema$CampaignCreativeAssociationsListResponse {
/**
* Campaign creative association collection
*/
campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Campaign List Response
*/
export interface Schema$CampaignsListResponse {
/**
* Campaign collection.
*/
campaigns?: Schema$Campaign[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Describes a change that a user has made to a resource.
*/
export interface Schema$ChangeLog {
/**
* Account ID of the modified object.
*/
accountId?: string | null;
/**
* Action which caused the change.
*/
action?: string | null;
changeTime?: string | null;
/**
* Field name of the object which changed.
*/
fieldName?: string | null;
/**
* ID of this change log.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
*/
kind?: string | null;
/**
* New value of the object field.
*/
newValue?: string | null;
/**
* ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
*/
objectId?: string | null;
/**
* Object type of the change log.
*/
objectType?: string | null;
/**
* Old value of the object field.
*/
oldValue?: string | null;
/**
* Subaccount ID of the modified object.
*/
subaccountId?: string | null;
/**
* Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
*/
transactionId?: string | null;
/**
* ID of the user who modified the object.
*/
userProfileId?: string | null;
/**
* User profile name of the user who modified the object.
*/
userProfileName?: string | null;
}
/**
* Change Log List Response
*/
export interface Schema$ChangeLogsListResponse {
/**
* Change log collection.
*/
changeLogs?: Schema$ChangeLog[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* City List Response
*/
export interface Schema$CitiesListResponse {
/**
* City collection.
*/
cities?: Schema$City[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
*/
kind?: string | null;
}
/**
* Contains information about a city that can be targeted by ads.
*/
export interface Schema$City {
/**
* Country code of the country to which this city belongs.
*/
countryCode?: string | null;
/**
* DART ID of the country to which this city belongs.
*/
countryDartId?: string | null;
/**
* DART ID of this city. This is the ID used for targeting and generating reports.
*/
dartId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
*/
kind?: string | null;
/**
* Metro region code of the metro region (DMA) to which this city belongs.
*/
metroCode?: string | null;
/**
* ID of the metro region (DMA) to which this city belongs.
*/
metroDmaId?: string | null;
/**
* Name of this city.
*/
name?: string | null;
/**
* Region code of the region to which this city belongs.
*/
regionCode?: string | null;
/**
* DART ID of the region to which this city belongs.
*/
regionDartId?: string | null;
}
/**
* Creative Click Tag.
*/
export interface Schema$ClickTag {
/**
* Parameter value for the specified click tag. This field contains a click-through url.
*/
clickThroughUrl?: Schema$CreativeClickThroughUrl;
/**
* Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
eventName?: string | null;
/**
* Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
*/
name?: string | null;
}
/**
* Click-through URL
*/
export interface Schema$ClickThroughUrl {
/**
* Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
*/
computedClickThroughUrl?: string | null;
/**
* Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
*/
customClickThroughUrl?: string | null;
/**
* Whether the campaign default landing page is used.
*/
defaultLandingPage?: boolean | null;
/**
* ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
*/
landingPageId?: string | null;
}
/**
* Click Through URL Suffix settings.
*/
export interface Schema$ClickThroughUrlSuffixProperties {
/**
* Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
*/
clickThroughUrlSuffix?: string | null;
/**
* Whether this entity should override the inherited click-through URL suffix with its own defined value.
*/
overrideInheritedSuffix?: boolean | null;
}
/**
* Companion Click-through override.
*/
export interface Schema$CompanionClickThroughOverride {
/**
* Click-through URL of this companion click-through override.
*/
clickThroughUrl?: Schema$C