googleapis

/** * Copyright 2015 Google Inc. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { AxiosPromise } from 'axios'; import { GoogleApis } from '../..'; import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api'; /** * DCM/DFA Reporting And Trafficking API * * Manages your DoubleClick Campaign Manager ad campaigns and reports. * * @example * const google = require('googleapis'); * const dfareporting = google.dfareporting('v2.8'); * * @namespace dfareporting * @type {Function} * @version v2.8 * @variation v2.8 * @param {object=} options Options for Dfareporting */ export declare class Dfareporting { _options: GlobalOptions; google: GoogleApis; root: this; accountActiveAdSummaries: Resource$Accountactiveadsummaries; accountPermissionGroups: Resource$Accountpermissiongroups; accountPermissions: Resource$Accountpermissions; accounts: Resource$Accounts; accountUserProfiles: Resource$Accountuserprofiles; ads: Resource$Ads; advertiserGroups: Resource$Advertisergroups; 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; directorySiteContacts: Resource$Directorysitecontacts; directorySites: Resource$Directorysites; dynamicTargetingKeys: Resource$Dynamictargetingkeys; eventTags: Resource$Eventtags; files: Resource$Files; floodlightActivities: Resource$Floodlightactivities; floodlightActivityGroups: Resource$Floodlightactivitygroups; floodlightConfigurations: Resource$Floodlightconfigurations; inventoryItems: Resource$Inventoryitems; landingPages: Resource$Landingpages; languages: Resource$Languages; metros: Resource$Metros; 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: GoogleApis); getRoot(): this; } /** * Contains properties of a DCM account. */ export interface Schema$Account { /** * Account permissions assigned to this account. */ accountPermissionIds: string[]; /** * Profile for this account. This is a read-only field that can be left blank. */ accountProfile: string; /** * Whether this account is active. */ active: boolean; /** * Maximum number of active ads allowed for this account. */ activeAdsLimitTier: string; /** * Whether to serve creatives with Active View tags. If disabled, viewability * data will not be available for any impressions. */ activeViewOptOut: boolean; /** * User role permissions available to the user roles of this account. */ availablePermissionIds: string[]; /** * ID of the country associated with this account. */ countryId: string; /** * 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 - "27" for MXP - "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 */ currencyId: string; /** * Default placement dimensions for this account. */ defaultCreativeSizeId: string; /** * Description of this account. */ description: string; /** * ID of this account. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#account". */ kind: string; /** * 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; /** * Maximum image size allowed for this account, in kilobytes. Value must be * greater than or equal to 1. */ maximumImageSize: string; /** * Name of this account. This is a required field, and must be less than 128 * characters long and be globally unique. */ name: string; /** * Whether campaigns created in this account will be enabled for Nielsen OCR * reach ratings by default. */ nielsenOcrEnabled: boolean; /** * Reporting configuration of this account. */ reportsConfiguration: Schema$ReportsConfiguration; /** * Share Path to Conversion reports with Twitter. */ shareReportsWithTwitter: boolean; /** * File size limit in kilobytes of Rich Media teaser creatives. Acceptable * values are 1 to 10240, inclusive. */ teaserSizeLimit: string; } /** * Gets a summary of active ads in an account. */ export interface Schema$AccountActiveAdSummary { /** * ID of the account. */ accountId: string; /** * Ads that have been activated for the account */ activeAds: string; /** * Maximum number of active ads allowed for the account. */ activeAdsLimitTier: string; /** * Ads that can be activated for the account. */ availableAds: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#accountActiveAdSummary". */ kind: string; } /** * AccountPermissions contains information about a particular account * permission. Some features of DCM 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[]; /** * ID of this account permission. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#accountPermission". */ kind: string; /** * Administrative level required to enable this account permission. */ level: string; /** * Name of this account permission. */ name: string; /** * Permission group of this account permission. */ permissionGroupId: string; } /** * 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; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#accountPermissionGroup". */ kind: string; /** * Name of this account permission group. */ name: string; } /** * 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; } /** * 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; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * AccountUserProfiles contains properties of a DCM 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; /** * 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; /** * 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; /** * 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; /** * ID of the user profile. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#accountUserProfile". */ kind: string; /** * 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; /** * 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; /** * 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; /** * Trafficker type of this user profile. */ traffickerType: string; /** * User type of the user profile. This is a read-only field that can be left * blank. */ userAccessType: string; /** * 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; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * 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; /** * List of names of floodlight activity metrics. */ metricNames: string[]; } /** * Contains properties of a DCM ad. */ export interface Schema$Ad { /** * Account ID of this ad. This is a read-only field that can be left blank. */ accountId: string; /** * Whether this ad is active. When true, archived must be false. */ active: boolean; /** * Advertiser ID of this ad. This is a required field on insertion. */ advertiserId: string; /** * 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; /** * Audience segment ID that is being targeted for this ad. Applicable when * type is AD_SERVING_STANDARD_AD. */ audienceSegmentId: string; /** * Campaign ID of this ad. This is a required field on insertion. */ campaignId: string; /** * 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; /** * 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; /** * 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; /** * Date and time that this ad should stop serving. Must be later than the * start time. This is a required field on insertion. */ endTime: string; /** * 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; /** * 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; /** * 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; /** * 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; /** * Whether this ad requires ssl. This is a read-only field that is * auto-generated when the ad is inserted or updated. */ sslRequired: boolean; /** * Date and time that this ad should start serving. If creating an ad, this * field must be a time in the future. This is a required field on insertion. */ startTime: string; /** * Subaccount ID of this ad. This is a read-only field that can be left blank. */ subaccountId: string; /** * 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; /** * 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; } /** * 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; /** * 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; /** * 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; /** * 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; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Ad Slot */ export interface Schema$AdSlot { /** * Comment for this ad slot. */ comment: string; /** * 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; /** * Height of this ad slot. */ height: string; /** * ID of the placement from an external platform that is linked to this ad * slot. */ linkedPlacementId: string; /** * Name of this ad slot. */ name: string; /** * Payment source type of this ad slot. */ paymentSourceType: string; /** * Primary ad slot of a roadblock inventory item. */ primary: boolean; /** * Width of this ad slot. */ width: string; } /** * Contains properties of a DCM advertiser. */ export interface Schema$Advertiser { /** * Account ID of this advertiser.This is a read-only field that can be left * blank. */ accountId: string; /** * 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; /** * Suffix added to click-through URL of ad creative associations under this * advertiser. Must be less than 129 characters long. */ clickThroughUrlSuffix: string; /** * ID of the click-through event tag to apply by default to the landing pages * of this advertiser's campaigns. */ defaultClickThroughEventTagId: string; /** * Default email address used in sender field for tag emails. */ defaultEmail: string; /** * 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; /** * 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; /** * 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; /** * 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; /** * 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; /** * Status of this advertiser. */ status: string; /** * Subaccount ID of this advertiser.This is a read-only field that can be left * blank. */ subaccountId: string; /** * Suspension status of this advertiser. */ suspended: boolean; } /** * 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; /** * ID of this advertiser group. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#advertiserGroup". */ kind: string; /** * 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; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * 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; /** * ID of this audience segment. This is a read-only, auto-generated field. */ id: string; /** * Name of this audience segment. This is a required field and must be less * than 65 characters long. */ name: string; } /** * 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; /** * Name of this audience segment group. This is a required field and must be * less than 65 characters long. */ name: string; } /** * 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; /** * DART ID of this browser. This is the ID used when generating reports. */ dartId: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#browser". */ kind: string; /** * 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; /** * 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; /** * Name of this browser. */ name: string; } /** * 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; } /** * Contains properties of a DCM campaign. */ export interface Schema$Campaign { /** * Account ID of this campaign. This is a read-only field that can be left * blank. */ accountId: string; /** * 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; /** * Advertiser ID of this campaign. This is a required field. */ advertiserId: string; /** * 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; /** * Audience segment groups assigned to this campaign. Cannot have more than * 300 segment groups. */ audienceSegmentGroups: Schema$AudienceSegmentGroup[]; /** * Billing invoice code included in the DCM client billing invoices associated * with the campaign. */ billingInvoiceCode: string; /** * 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; /** * 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[]; /** * Creative optimization configuration for the campaign. */ creativeOptimizationConfiguration: Schema$CreativeOptimizationConfiguration; /** * Click-through event tag ID override properties for this campaign. */ defaultClickThroughEventTagProperties: Schema$DefaultClickThroughEventTagProperties; /** * Date on which the campaign will stop running. On insert, the end date must * be today or a future date. The end date must be later than or be the same * as the start date. If, for example, you set 6/25/2015 as both the start and * end dates, the effective campaign run date is just that day only, * 6/25/2015. The hours, minutes, and seconds of the end date should not be * set, as doing so will result in an error. This is a required field. */ endDate: string; /** * Overrides that can be used to activate or deactivate advertiser event tags. */ eventTagOverrides: Schema$EventTagOverride[]; /** * External ID for this campaign. */ externalId: string; /** * ID of this campaign. This is a read-only auto-generated field. */ id: string; /** * 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; /** * Information about the most recent modification of this campaign. This is a * read-only field. */ lastModifiedInfo: Schema$LastModifiedInfo; /** * Lookback window settings for the campaign. */ lookbackConfiguration: Schema$LookbackConfiguration; /** * 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; /** * Whether Nielsen reports are enabled for this campaign. */ nielsenOcrEnabled: boolean; /** * Date on which the campaign starts running. The start date can be any date. * The hours, minutes, and seconds of the start date should not be set, as * doing so will result in an error. This is a required field. */ startDate: string; /** * Subaccount ID of this campaign. This is a read-only field that can be left * blank. */ subaccountId: string; /** * Campaign trafficker contact emails. */ traffickerEmails: string[]; } /** * 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; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#campaignCreativeAssociation". */ kind: string; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Describes a change that a user has made to a resource. */ export interface Schema$ChangeLog { /** * Account ID of the modified object. */ accountId: string; /** * Action which caused the change. */ action: string; /** * Time when the object was modified. */ changeTime: string; /** * Field name of the object which changed. */ fieldName: string; /** * ID of this change log. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#changeLog". */ kind: string; /** * New value of the object field. */ newValue: string; /** * ID of the object of this change log. The object could be a campaign, * placement, ad, or other type. */ objectId: string; /** * Object type of the change log. */ objectType: string; /** * Old value of the object field. */ oldValue: string; /** * Subaccount ID of the modified object. */ subaccountId: string; /** * 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; /** * ID of the user who modified the object. */ userProfileId: string; /** * User profile name of the user who modified the object. */ userProfileName: string; } /** * 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; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * 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; } /** * 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; /** * DART ID of the country to which this city belongs. */ countryDartId: string; /** * DART ID of this city. This is the ID used for targeting and generating * reports. */ dartId: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#city". */ kind: string; /** * Metro region code of the metro region (DMA) to which this city belongs. */ metroCode: string; /** * ID of the metro region (DMA) to which this city belongs. */ metroDmaId: string; /** * Name of this city. */ name: string; /** * Region code of the region to which this city belongs. */ regionCode: string; /** * DART ID of the region to which this city belongs. */ regionDartId: string; } /** * Creative Click Tag. */ export interface Schema$ClickTag { /** * 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; /** * 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; /** * Parameter value for the specified click tag. This field contains a * click-through url. */ value: string; } /** * 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; /** * Custom click-through URL. Applicable if the defaultLandingPage field is set * to false and the landingPageId field is left unset. */ customClickThroughUrl: string; /** * Whether the campaign default landing page is used. */ defaultLandingPage: boolean; /** * ID of the landing page for the click-through URL. Applicable if the * defaultLandingPage field is set to false. */ landingPageId: string; } /** * 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; /** * Whether this entity should override the inherited click-through URL suffix * with its own defined value. */ overrideInheritedSuffix: boolean; } /** * Companion Click-through override. */ export interface Schema$CompanionClickThroughOverride { /** * Click-through URL of this companion click-through override. */ clickThroughUrl: Schema$ClickThroughUrl; /** * ID of the creative for this companion click-through override. */ creativeId: string; } /** * Companion Settings */ export interface Schema$CompanionSetting { /** * Whether companions are disabled for this placement. */ companionsDisabled: boolean; /** * Whitelist of companion sizes to be served to this placement. Set this list * to null or empty to serve all companion sizes. */ enabledSizes: Schema$Size[]; /** * Whether to serve only static images as companions. */ imageOnly: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#companionSetting". */ kind: string; } /** * Represents a response to the queryCompatibleFields method. */ export interface Schema$CompatibleFields { /** * Contains items that are compatible to be selected for a report of type * "CROSS_DIMENSION_REACH". */ crossDimensionReachReportCompatibleFields: Schema$CrossDimensionReachReportCompatibleFields; /** * Contains items that are compatible to be selected for a report of type * "FLOODLIGHT". */ floodlightReportCompatibleFields: Schema$FloodlightReportCompatibleFields; /** * The kind of resource this is, in this case dfareporting#compatibleFields. */ kind: string; /** * Contains items that are compatible to be selected for a report of type * "PATH_TO_CONVERSION". */ pathToConversionReportCompatibleFields: Schema$PathToConversionReportCompatibleFields; /** * Contains items that are compatible to be selected for a report of type * "REACH". */ reachReportCompatibleFields: Schema$ReachReportCompatibleFields; /** * Contains items that are compatible to be selected for a report of type * "STANDARD". */ reportCompatibleFields: Schema$ReportCompatibleFields; } /** * 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. */ export interface Schema$ConnectionType { /** * ID of this connection type. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#connectionType". */ kind: string; /** * Name of this connection type. */ name: string; } /** * Connection Type List Response */ export interface Schema$ConnectionTypesListResponse { /** * Collection of connection types such as broadband and mobile. */ connectionTypes: Schema$ConnectionType[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#connectionTypesListResponse". */ kind: string; } /** * Content Category List Response */ export interface Schema$ContentCategoriesListResponse { /** * Content category collection. */ contentCategories: Schema$ContentCategory[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#contentCategoriesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Organizes placements according to the contents of their associated webpages. */ export interface Schema$ContentCategory { /** * Account ID of this content category. This is a read-only field that can be * left blank. */ accountId: string; /** * ID of this content category. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#contentCategory". */ kind: string; /** * Name of this content category.