/** * 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('v3.0'); * * @namespace dfareporting * @type {Function} * @version v3.0 * @variation v3.0 * @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; 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; 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; 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; } /** * Landing Page List Response */ export interface Schema$AdvertiserLandingPagesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#advertiserLandingPagesListResponse". */ kind: string; /** * Landing page collection */ landingPages: Schema$LandingPage[]; /** * 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; /** * The default landing page ID for this campaign. */ defaultLandingPageId: string; /** * 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 { /** * 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; /** * 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; } /** * 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. This is a required field and must be less * than 256 characters long and unique among content categories of the same * account. */ name: string; } /** * A Conversion represents when a user successfully performs a desired action * after seeing an ad. */ export interface Schema$Conversion { /** * Whether the conversion was directed toward children. */ childDirectedTreatment: boolean; /** * Custom floodlight variables. */ customVariables: Schema$CustomFloodlightVariable[]; /** * The alphanumeric encrypted user ID. When set, encryptionInfo should also be * specified. This field is mutually exclusive with * encryptedUserIdCandidates[], mobileDeviceId and gclid. This or * encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. */ encryptedUserId: string; /** * A list of the alphanumeric encrypted user IDs. Any user ID with exposure * prior to the conversion timestamp will be used in the inserted conversion. * If no such user ID is found then the conversion will be rejected with * NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be * specified. This field may only be used when calling batchinsert; it is not * supported by batchupdate. This field is mutually exclusive with * encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or * mobileDeviceId or gclid is a required field. */ encryptedUserIdCandidates: string[]; /** * Floodlight Activity ID of this conversion. This is a required field. */ floodlightActivityId: string; /** * Floodlight Configuration ID of this conversion. This is a required field. */ floodlightConfigurationId: string; /** * The Google click ID. This field is mutually exclusive with encryptedUserId, * encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or * encryptedUserIdCandidates[] or mobileDeviceId is a required field. */ gclid: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#conversion". */ kind: string; /** * Whether Limit Ad Tracking is enabled. When set to true, the conversion will * be used for reporting but not targeting. This will prevent remarketing. */ limitAdTracking: boolean; /** * The mobile device ID. This field is mutually exclusive with * encryptedUserId, encryptedUserIdCandidates[] and gclid. This or * encryptedUserId or encryptedUserIdCandidates[] or gclid is a required * field. */ mobileDeviceId: string; /** * The ordinal of the conversion. Use this field to control how conversions of * the same user and day are de-duplicated. This is a required field. */ ordinal: string; /** * The quantity of the conversion. */ quantity: string; /** * The timestamp of conversion, in Unix epoch micros. This is a required * field. */ timestampMicros: string; /** * The value of the conversion. */ value: number; } /** * The error code and description for a conversion that failed to insert or * update. */ export interface Schema$ConversionError { /** * The error code. */ code: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#conversionError". */ kind: string; /** * A description of the error. */ message: string; } /** * Insert Conversions Request. */ export interface Schema$ConversionsBatchInsertRequest { /** * The set of conversions to insert. */ conversions: Schema$Conversion[]; /** * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. * This is a required field if encryptedUserId or encryptedUserIdCandidates[] * is used. */ encryptionInfo: Schema$EncryptionInfo; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#conversionsBatchInsertRequest". */ kind: string; } /** * Insert Conversions Response. */ export interface Schema$ConversionsBatchInsertResponse { /** * Indicates that some or all conversions failed to insert. */ hasFailures: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#conversionsBatchInsertResponse". */ kind: string; /** * The insert status of each conversion. Statuses are returned in the same * order that conversions are inserted. */ status: Schema$ConversionStatus[]; } /** * Update Conversions Request. */ export interface Schema$ConversionsBatchUpdateRequest { /** * The set of conversions to update. */ conversions: Schema$Conversion[]; /** * Describes how encryptedUserId is encrypted. This is a required field if * encryptedUserId is used. */ encryptionInfo: Schema$EncryptionInfo; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#conversionsBatchUpdateRequest". */ kind: string; } /** * Update Conversions Response. */ export interface Schema$ConversionsBatchUpdateResponse { /** * Indicates that some or all conversions failed to update. */ hasFailures: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#conversionsBatchUpdateResponse". */ kind: string; /** * The update status of each conversion. Statuses are returned in the same * order that conversions are updated. */ status: Schema$ConversionStatus[]; } /** * The original conversion that was inserted or updated and whether there were * any errors. */ export interface Schema$ConversionStatus { /** * The original conversion that was inserted or updated. */ conversion: Schema$Conversion; /** * A list of errors related to this conversion. */ errors: Schema$ConversionError[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#conversionStatus". */ kind: string; } /** * Country List Response */ export interface Schema$CountriesListResponse { /** * Country collection. */ countries: Schema$Country[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#countriesListResponse". */ kind: string; } /** * Contains information about a country that can be targeted by ads. */ export interface Schema$Country { /** * Country code. */ countryCode: string; /** * DART ID of this country. This is the ID used for targeting and generating * reports. */ dartId: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#country". */ kind: string; /** * Name of this country. */ name: string; /** * Whether ad serving supports secure servers in this country. */ sslEnabled: boolean; } /** * Contains properties of a Creative. */ export interface Schema$Creative { /** * Account ID of this creative. This field, if left unset, will be * auto-generated for both insert and update operations. Applicable to all * creative types. */ accountId: string; /** * Whether the creative is active. Applicable to all creative types. */ active: boolean; /** * Ad parameters user for VPAID creative. This is a read-only field. * Applicable to the following creative types: all VPAID. */ adParameters: string; /** * Keywords for a Rich Media creative. Keywords let you customize the creative * settings of a Rich Media ad running on your site without having to contact * the advertiser. You can use keywords to dynamically change the look or * functionality of a creative. Applicable to the following creative types: * all RICH_MEDIA, and all VPAID. */ adTagKeys: string[]; /** * Advertiser ID of this creative. This is a required field. Applicable to all * creative types. */ advertiserId: string; /** * Whether script access is allowed for this creative. This is a read-only and * deprecated field which will automatically be set to true on update. * Applicable to the following creative types: FLASH_INPAGE. */ allowScriptAccess: boolean; /** * Whether the creative is archived. Applicable to all creative types. */ archived: boolean; /** * Type of artwork used for the creative. This is a read-only field. * Applicable to the following creative types: all RICH_MEDIA, and all VPAID. */ artworkType: string; /** * Source application where creative was authored. Presently, only DBM * authored creatives will have this field set. Applicable to all creative * types. */ authoringSource: string; /** * Authoring tool for HTML5 banner creatives. This is a read-only field. * Applicable to the following creative types: HTML5_BANNER. */ authoringTool: string; /** * Whether images are automatically advanced for image gallery creatives. * Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. */ autoAdvanceImages: boolean; /** * The 6-character HTML color code, beginning with #, for the background of * the window area where the Flash file is displayed. Default is white. * Applicable to the following creative types: FLASH_INPAGE. */ backgroundColor: string; /** * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the * primary asset type is not HTML_IMAGE. */ backupImageClickThroughUrl: Schema$CreativeClickThroughUrl; /** * List of feature dependencies that will cause a backup image to be served if * the browser that serves the ad does not support them. Feature dependencies * are features that a browser must be able to support in order to render your * HTML5 creative asset correctly. This field is initially auto-generated to * contain all features detected by DCM for all the assets of this creative * and can then be modified by the client. To reset this field, copy over all * the creativeAssets' detected features. Applicable to the following * creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset * type is not HTML_IMAGE. */ backupImageFeatures: string[]; /** * Reporting label used for HTML5 banner backup image. Applicable to the * following creative types: DISPLAY when the primary asset type is not * HTML_IMAGE. */ backupImageReportingLabel: string; /** * Target window for backup image. Applicable to the following creative types: * FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset * type is not HTML_IMAGE. */ backupImageTargetWindow: Schema$TargetWindow; /** * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER * creatives, this is a subset of detected click tags for the assets * associated with this creative. After creating a flash asset, detected click * tags will be returned in the creativeAssetMetadata. When inserting the * creative, populate the creative clickTags field using the * creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, * there should be exactly one entry in this list for each image creative * asset. A click tag is matched with a corresponding creative asset by * matching the clickTag.name field with the * creativeAsset.assetIdentifier.name field. Applicable to the following * creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ clickTags: Schema$ClickTag[]; /** * Industry standard ID assigned to creative for reach and frequency. * Applicable to INSTREAM_VIDEO_REDIRECT creatives. */ commercialId: string; /** * List of companion creatives assigned to an in-Stream videocreative. * Acceptable values include IDs of existing flash and image creatives. * Applicable to the following creative types: all VPAID and all * INSTREAM_VIDEO with dynamicAssetSelection set to false. */ companionCreatives: string[]; /** * Compatibilities associated with this creative. This is a read-only field. * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on * mobile devices or in mobile apps for regular or interstitial ads, * respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. * Only pre-existing creatives may have these compatibilities since new * creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. * IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with * the VAST standard. Applicable to all creative types. Acceptable values * are: - "APP" - "APP_INTERSTITIAL" - * "IN_STREAM_VIDEO" - "DISPLAY" - * "DISPLAY_INTERSTITIAL" */ compatibility: string[]; /** * Whether Flash assets associated with the creative need to be automatically * converted to HTML5. This flag is enabled by default and users can choose to * disable it if they don't want the system to generate and use HTML5 * asset for this creative. Applicable to the following creative type: * FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not * HTML_IMAGE. */ convertFlashToHtml5: boolean; /** * List of counter events configured for the creative. For * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated * from clickTags. Applicable to the following creative types: * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. */ counterCustomEvents: Schema$CreativeCustomEvent[]; /** * Assets associated with a creative. Applicable to all but the following * creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and * REDIRECT */ creativeAssets: Schema$CreativeAsset[]; /** * Required if dynamicAssetSelection is true. */ creativeAssetSelection: Schema$CreativeAssetSelection; /** * Creative field assignments for this creative. Applicable to all creative * types. */ creativeFieldAssignments: Schema$CreativeFieldAssignment[]; /** * Custom key-values for a Rich Media creative. Key-values let you customize * the creative settings of a Rich Media ad running on your site without * having to contact the advertiser. You can use key-values to dynamically * change the look or functionality of a creative. Applicable to the following * creative types: all RICH_MEDIA, and all VPAID. */ customKeyValues: string[]; /** * Set this to true to enable the use of rules to target individual assets in * this creative. When set to true creativeAssetSelection must be set. This * also controls asset-level companions. When this is true, companion * creatives should be assigned to creative assets. Learn more. Applicable to * INSTREAM_VIDEO creatives. */ dynamicAssetSelection: boolean; /** * List of exit events configured for the creative. For DISPLAY and * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated * from clickTags, For DISPLAY, an event is also created from the * backupImageReportingLabel. Applicable to the following creative types: * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY * when the primary asset type is not HTML_IMAGE. */ exitCustomEvents: Schema$CreativeCustomEvent[]; /** * OpenWindow FSCommand of this creative. This lets the SWF file communicate * with either Flash Player or the program hosting Flash Player, such as a web * browser. This is only triggered if allowScriptAccess field is true. * Applicable to the following creative types: FLASH_INPAGE. */ fsCommand: Schema$FsCommand; /** * HTML code for the creative. This is a required field when applicable. This * field is ignored if htmlCodeLocked is true. Applicable to the following * creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all * RICH_MEDIA. */ htmlCode: string; /** * Whether HTML code is DCM-generated or manually entered. Set to true to * ignore changes to htmlCode. Applicable to the following creative types: * FLASH_INPAGE and HTML5_BANNER. */ htmlCodeLocked: boolean; /** * ID of this creative. This is a read-only, auto-generated field. Applicable * to all creative types. */ id: string; /** * Dimension value for the ID of this creative. This is a read-only field. * Applicable to all creative types. */ idDimensionValue: Schema$DimensionValue; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creative". */ kind: string; /** * Creative last modification information. This is a read-only field. * Applicable to all creative types. */ lastModifiedInfo: Schema$LastModifiedInfo; /** * Latest Studio trafficked creative ID associated with rich media and VPAID * creatives. This is a read-only field. Applicable to the following creative * types: all RICH_MEDIA, and all VPAID. */ latestTraffickedCreativeId: string; /** * Name of the creative. This is a required field and must be less than 256 * characters long. Applicable to all creative types. */ name: string; /** * Override CSS value for rich media creatives. Applicable to the following * creative types: all RICH_MEDIA. */ overrideCss: string; /** * The asset ID of the polite load image asset. Applicable to the creative * type: DISPLAY. */ politeLoadAssetId: string; /** * Amount of time to play the video before counting a view. Applicable to the * following creative types: all INSTREAM_VIDEO. */ progressOffset: Schema$VideoOffset; /** * URL of hosted image or hosted video or another ad tag. For * INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. * The standard for a VAST (Video Ad Serving Template) ad response allows for * a redirect link to another VAST 2.0 or 3.0 call. This is a required field * when applicable. Applicable to the following creative types: * DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and * INSTREAM_VIDEO_REDIRECT */ redirectUrl: string; /** * ID of current rendering version. This is a read-only field. Applicable to * all creative types. */ renderingId: string; /** * Dimension value for the rendering ID of this creative. This is a read-only * field. Applicable to all creative types. */ renderingIdDimensionValue: Schema$DimensionValue; /** * The minimum required Flash plugin version for this creative. For * example, 11.2.202.235. This is a read-only field. Applicable to the * following creative types: all RICH_MEDIA, and all VPAID. */ requiredFlashPluginVersion: string; /** * The internal Flash version for this creative as calculated by DoubleClick * Studio. This is a read-only field. Applicable to the following creative * types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY * when the primary asset type is not HTML_IMAGE. */ requiredFlashVersion: number; /** * Size associated with this creative. When inserting or updating a creative * either the size ID field or size width and height fields can be used. This * is a required field when applicable; however for IMAGE, FLASH_INPAGE * creatives, and for DISPLAY creatives with a primary asset of type * HTML_IMAGE, if left blank, this field will be automatically set using the * actual size of the associated image assets. Applicable to the following * creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, * IMAGE, and all RICH_MEDIA. */ size: Schema$Size; /** * Amount of time to play the video before the skip button appears. Applicable * to the following creative types: all INSTREAM_VIDEO. */ skipOffset: Schema$VideoOffset; /** * Whether the user can choose to skip the creative. Applicable to the * following creative types: all INSTREAM_VIDEO and all VPAID. */ skippable: boolean; /** * Whether the creative is SSL-compliant. This is a read-only field. * Applicable to all creative types. */ sslCompliant: boolean; /** * Whether creative should be treated as SSL compliant even if the system scan * shows it's not. Applicable to all creative types. */ sslOverride: boolean; /** * Studio advertiser ID associated with rich media and VPAID creatives. This * is a read-only field. Applicable to the following creative types: all * RICH_MEDIA, and all VPAID. */ studioAdvertiserId: string; /** * Studio creative ID associated with rich media and VPAID creatives. This is * a read-only field. Applicable to the following creative types: all * RICH_MEDIA, and all VPAID. */ studioCreativeId: string; /** * Studio trafficked creative ID associated with rich media and VPAID * creatives. This is a read-only field. Applicable to the following creative * types: all RICH_MEDIA, and all VPAID. */ studioTraffickedCreativeId: string; /** * Subaccount ID of this creative. This field, if left unset, will be * auto-generated for both insert and update operations. Applicable to all * creative types. */ subaccountId: string; /** * Third-party URL used to record backup image impressions. Applicable to the * following creative types: all RICH_MEDIA. */ thirdPartyBackupImageImpressionsUrl: string; /** * Third-party URL used to record rich media impressions. Applicable to the * following creative types: all RICH_MEDIA. */ thirdPartyRichMediaImpressionsUrl: string; /** * Third-party URLs for tracking in-stream video creative events. Applicable * to the following creative types: all INSTREAM_VIDEO and all VPAID. */ thirdPartyUrls: Schema$ThirdPartyTrackingUrl[]; /** * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY * creatives, these are read-only and auto-generated from clickTags. * Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all * RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is * not HTML_IMAGE. */ timerCustomEvents: Schema$CreativeCustomEvent[]; /** * Combined size of all creative assets. This is a read-only field. Applicable * to the following creative types: all RICH_MEDIA, and all VPAID. */ totalFileSize: string; /** * Type of this creative. This is a required field. Applicable to all creative * types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for * existing creatives. New creatives should use DISPLAY as a replacement for * these types. */ type: string; /** * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following * creative types: INSTREAM_VIDEO and VPAID. */ universalAdId: Schema$UniversalAdId; /** * The version number helps you keep track of multiple versions of your * creative in your reports. The version number will always be auto-generated * during insert operations to start at 1. For tracking creatives the version * cannot be incremented and will always remain at 1. For all other creative * types the version can be incremented only by 1 during update operations. In * addition, the version will be automatically incremented by 1 when * undergoing Rich Media creative merging. Applicable to all creative types. */ version: number; /** * Description of the video ad. Applicable to the following creative types: * all INSTREAM_VIDEO and all VPAID. */ videoDescription: string; /** * Creative video duration in seconds. This is a read-only field. Applicable * to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all * VPAID. */ videoDuration: number; } /** * Creative Asset. */ export interface Schema$CreativeAsset { /** * Whether ActionScript3 is enabled for the flash asset. This is a read-only * field. Applicable to the following creative type: FLASH_INPAGE. Applicable * to DISPLAY when the primary asset type is not HTML_IMAGE. */ actionScript3: boolean; /** * Whether the video asset is active. This is a read-only field for * VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: * INSTREAM_VIDEO and all VPAID. */ active: boolean; /** * Possible alignments for an asset. This is a read-only field. Applicable to * the following creative types: * RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. */ alignment: string; /** * Artwork type of rich media creative. This is a read-only field. Applicable * to the following creative types: all RICH_MEDIA. */ artworkType: string; /** * Identifier of this asset. This is the same identifier returned during * creative asset insert operation. This is a required field. Applicable to * all but the following creative types: all REDIRECT and TRACKING_TEXT. */ assetIdentifier: Schema$CreativeAssetId; /** * Exit event configured for the backup image. Applicable to the following * creative types: all RICH_MEDIA. */ backupImageExit: Schema$CreativeCustomEvent; /** * Detected bit-rate for video asset. This is a read-only field. Applicable to * the following creative types: INSTREAM_VIDEO and all VPAID. */ bitRate: number; /** * Rich media child asset type. This is a read-only field. Applicable to the * following creative types: all VPAID. */ childAssetType: string; /** * Size of an asset when collapsed. This is a read-only field. Applicable to * the following creative types: all RICH_MEDIA and all VPAID. Additionally, * applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or * ASSET_DISPLAY_TYPE_PEEL_DOWN. */ collapsedSize: Schema$Size; /** * List of companion creatives assigned to an in-stream video creative asset. * Acceptable values include IDs of existing flash and image creatives. * Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set * to true. */ companionCreativeIds: string[]; /** * Custom start time in seconds for making the asset visible. Applicable to * the following creative types: all RICH_MEDIA. Value must be greater than or * equal to 0. */ customStartTimeValue: number; /** * List of feature dependencies for the creative asset that are detected by * DCM. Feature dependencies are features that a browser must be able to * support in order to render your HTML5 creative correctly. This is a * read-only, auto-generated field. Applicable to the following creative * types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is * not HTML_IMAGE. */ detectedFeatures: string[]; /** * Type of rich media asset. This is a read-only field. Applicable to the * following creative types: all RICH_MEDIA. */ displayType: string; /** * Duration in seconds for which an asset will be displayed. Applicable to the * following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must * be greater than or equal to 1. */ duration: number; /** * Duration type for which an asset will be displayed. Applicable to the * following creative types: all RICH_MEDIA. */ durationType: string; /** * Detected expanded dimension for video asset. This is a read-only field. * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ expandedDimension: Schema$Size; /** * File size associated with this creative asset. This is a read-only field. * Applicable to all but the following creative types: all REDIRECT and * TRACKING_TEXT. */ fileSize: string; /** * Flash version of the asset. This is a read-only field. Applicable to the * following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. */ flashVersion: number; /** * Whether to hide Flash objects flag for an asset. Applicable to the * following creative types: all RICH_MEDIA. */ hideFlashObjects: boolean; /** * Whether to hide selection boxes flag for an asset. Applicable to the * following creative types: all RICH_MEDIA. */ hideSelectionBoxes: boolean; /** * Whether the asset is horizontally locked. This is a read-only field. * Applicable to the following creative types: all RICH_MEDIA. */ horizontallyLocked: boolean; /** * Numeric ID of this creative asset. This is a required field and should not * be modified. Applicable to all but the following creative types: all * REDIRECT and TRACKING_TEXT. */ id: string; /** * Dimension value for the ID of the asset. This is a read-only, * auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Detected MIME type for video asset. This is a read-only field. Applicable * to the following creative types: INSTREAM_VIDEO and all VPAID. */ mimeType: string; /** * Offset position for an asset in collapsed mode. This is a read-only field. * Applicable to the following creative types: all RICH_MEDIA and all VPAID. * Additionally, only applicable to assets whose displayType is * ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. */ offset: Schema$OffsetPosition; /** * Orientation of video asset. This is a read-only, auto-generated field. */ orientation: string; /** * Whether the backup asset is original or changed by the user in DCM. * Applicable to the following creative types: all RICH_MEDIA. */ originalBackup: boolean; /** * Offset position for an asset. Applicable to the following creative types: * all RICH_MEDIA. */ position: Schema$OffsetPosition; /** * Offset left unit for an asset. This is a read-only field. Applicable to the * following creative types: all RICH_MEDIA. */ positionLeftUnit: string; /** * Offset top unit for an asset. This is a read-only field if the asset * displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following * creative types: all RICH_MEDIA. */ positionTopUnit: string; /** * Progressive URL for video asset. This is a read-only field. Applicable to * the following creative types: INSTREAM_VIDEO and all VPAID. */ progressiveServingUrl: string; /** * Whether the asset pushes down other content. Applicable to the following * creative types: all RICH_MEDIA. Additionally, only applicable when the * asset offsets are 0, the collapsedSize.width matches size.width, and the * collapsedSize.height is less than size.height. */ pushdown: boolean; /** * Pushdown duration in seconds for an asset. Applicable to the following * creative types: all RICH_MEDIA.Additionally, only applicable when the asset * pushdown field is true, the offsets are 0, the collapsedSize.width matches * size.width, and the collapsedSize.height is less than size.height. * Acceptable values are 0 to 9.99, inclusive. */ pushdownDuration: number; /** * Role of the asset in relation to creative. Applicable to all but the * following creative types: all REDIRECT and TRACKING_TEXT. This is a * required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, * IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple * primary assets), and all VPAID creatives. BACKUP_IMAGE applies to * FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. * ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. * OTHER refers to assets from sources other than DCM, such as Studio uploaded * assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO * refers to videos uploaded by the user in DCM and is applicable to * INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to * videos transcoded by DCM from PARENT_VIDEO assets and is applicable to * INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to * the DCM representation of child asset videos from Studio, and is applicable * to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within * DCM. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and * ALTERNATE_VIDEO assets that are marked active serve as backup in case the * VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or * removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. */ role: string; /** * Size associated with this creative asset. This is a required field when * applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, * this field will be automatically set using the actual size of the * associated image asset. Applicable to the following creative types: * DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all * RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not * HTML_IMAGE. */ size: Schema$Size; /** * Whether the asset is SSL-compliant. This is a read-only field. Applicable * to all but the following creative types: all REDIRECT and TRACKING_TEXT. */ sslCompliant: boolean; /** * Initial wait time type before making the asset visible. Applicable to the * following creative types: all RICH_MEDIA. */ startTimeType: string; /** * Streaming URL for video asset. This is a read-only field. Applicable to the * following creative types: INSTREAM_VIDEO and all VPAID. */ streamingServingUrl: string; /** * Whether the asset is transparent. Applicable to the following creative * types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. */ transparency: boolean; /** * Whether the asset is vertically locked. This is a read-only field. * Applicable to the following creative types: all RICH_MEDIA. */ verticallyLocked: boolean; /** * Detected video duration for video asset. This is a read-only field. * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */ videoDuration: number; /** * Window mode options for flash assets. Applicable to the following creative * types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, * RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. */ windowMode: string; /** * zIndex value of an asset. Applicable to the following creative types: all * RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT * one of the following types: ASSET_DISPLAY_TYPE_INPAGE or * ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, * inclusive. */ zIndex: number; /** * File name of zip file. This is a read-only field. Applicable to the * following creative types: HTML5_BANNER. */ zipFilename: string; /** * Size of zip file. This is a read-only field. Applicable to the following * creative types: HTML5_BANNER. */ zipFilesize: string; } /** * Creative Asset ID. */ export interface Schema$CreativeAssetId { /** * Name of the creative asset. This is a required field while inserting an * asset. After insertion, this assetIdentifier is used to identify the * uploaded asset. Characters in the name must be alphanumeric or one of the * following: ".-_ ". Spaces are allowed. */ name: string; /** * Type of asset to upload. This is a required field. FLASH and IMAGE are no * longer supported for new uploads. All image assets should use HTML_IMAGE. */ type: string; } /** * 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. */ export interface Schema$CreativeAssetMetadata { /** * ID of the creative asset. This is a required field. */ assetIdentifier: Schema$CreativeAssetId; /** * List of detected click tags for assets. This is a read-only auto-generated * field. */ clickTags: Schema$ClickTag[]; /** * List of feature dependencies for the creative asset that are detected by * DCM. Feature dependencies are features that a browser must be able to * support in order to render your HTML5 creative correctly. This is a * read-only, auto-generated field. */ detectedFeatures: string[]; /** * Numeric ID of the asset. This is a read-only, auto-generated field. */ id: string; /** * Dimension value for the numeric ID of the asset. This is a read-only, * auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativeAssetMetadata". */ kind: string; /** * Rules validated during code generation that generated a warning. This is a * read-only, auto-generated field. Possible values are: - * "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - * "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - * "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - * "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - * "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" * - "ENABLER_UNSUPPORTED_METHOD_DCM" - * "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - * "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - * "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - * "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - * "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - * "PRIMARY_HTML_MISSING" - "SVG_INVALID" - * "ZIP_INVALID" */ warnedValidationRules: string[]; } /** * Encapsulates the list of rules for asset selection and a default asset in * case none of the rules match. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$CreativeAssetSelection { /** * A creativeAssets[].id. This should refer to one of the parent assets in * this creative, and will be served if none of the rules match. This is a * required field. */ defaultAssetId: string; /** * Rules determine which asset will be served to a viewer. Rules will be * evaluated in the order in which they are stored in this list. This list * must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. */ rules: Schema$Rule[]; } /** * Creative Assignment. */ export interface Schema$CreativeAssignment { /** * Whether this creative assignment is active. When true, the creative will be * included in the ad's rotation. */ active: boolean; /** * Whether applicable event tags should fire when this creative assignment is * rendered. If this value is unset when the ad is inserted or updated, it * will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, * INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. */ applyEventTags: boolean; /** * Click-through URL of the creative assignment. */ clickThroughUrl: Schema$ClickThroughUrl; /** * Companion creative overrides for this creative assignment. Applicable to * video ads. */ companionCreativeOverrides: Schema$CompanionClickThroughOverride[]; /** * Creative group assignments for this creative assignment. Only one * assignment per creative group number is allowed for a maximum of two * assignments. */ creativeGroupAssignments: Schema$CreativeGroupAssignment[]; /** * ID of the creative to be assigned. This is a required field. */ creativeId: string; /** * Dimension value for the ID of the creative. This is a read-only, * auto-generated field. */ creativeIdDimensionValue: Schema$DimensionValue; /** * Date and time that the assigned creative should stop serving. Must be later * than the start time. */ endTime: string; /** * Rich media exit overrides for this creative assignment. Applicable when the * creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - * RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - * RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - * RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - * VPAID_NON_LINEAR */ richMediaExitOverrides: Schema$RichMediaExitOverride[]; /** * Sequence number of the creative assignment, applicable when the rotation * type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to * 65535, inclusive. */ sequence: number; /** * Whether the creative to be assigned is SSL-compliant. This is a read-only * field that is auto-generated when the ad is inserted or updated. */ sslCompliant: boolean; /** * Date and time that the assigned creative should start serving. */ startTime: string; /** * Weight of the creative assignment, applicable when the rotation type is * CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. */ weight: number; } /** * Click-through URL */ export interface Schema$CreativeClickThroughUrl { /** * Read-only convenience field representing the actual URL that will be used * for this click-through. The URL is computed as follows: - If landingPageId * is specified then that landing page's URL is assigned to this field. - * Otherwise, the customClickThroughUrl is assigned to this field. */ computedClickThroughUrl: string; /** * Custom click-through URL. Applicable if the landingPageId field is left * unset. */ customClickThroughUrl: string; /** * ID of the landing page for the click-through URL. */ landingPageId: string; } /** * Creative Custom Event. */ export interface Schema$CreativeCustomEvent { /** * Unique ID of this event used by DDM Reporting and Data Transfer. This is a * read-only field. */ advertiserCustomEventId: string; /** * User-entered name for the event. */ advertiserCustomEventName: string; /** * Type of the event. This is a read-only field. */ advertiserCustomEventType: string; /** * Artwork label column, used to link events in DCM back to events in Studio. * This is a required field and should not be modified after insertion. */ artworkLabel: string; /** * Artwork type used by the creative.This is a read-only field. */ artworkType: string; /** * Exit click-through URL for the event. This field is used only for exit * events. */ exitClickThroughUrl: Schema$CreativeClickThroughUrl; /** * ID of this event. This is a required field and should not be modified after * insertion. */ id: string; /** * Properties for rich media popup windows. This field is used only for exit * events. */ popupWindowProperties: Schema$PopupWindowProperties; /** * Target type used by the event. */ targetType: string; /** * Video reporting ID, used to differentiate multiple videos in a single * creative. This is a read-only field. */ videoReportingId: string; } /** * Contains properties of a creative field. */ export interface Schema$CreativeField { /** * Account ID of this creative field. This is a read-only field that can be * left blank. */ accountId: string; /** * Advertiser ID of this creative field. 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; /** * ID of this creative field. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativeField". */ kind: string; /** * Name of this creative field. This is a required field and must be less than * 256 characters long and unique among creative fields of the same * advertiser. */ name: string; /** * Subaccount ID of this creative field. This is a read-only field that can be * left blank. */ subaccountId: string; } /** * Creative Field Assignment. */ export interface Schema$CreativeFieldAssignment { /** * ID of the creative field. */ creativeFieldId: string; /** * ID of the creative field value. */ creativeFieldValueId: string; } /** * Creative Field List Response */ export interface Schema$CreativeFieldsListResponse { /** * Creative field collection. */ creativeFields: Schema$CreativeField[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativeFieldsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Contains properties of a creative field value. */ export interface Schema$CreativeFieldValue { /** * ID of this creative field value. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativeFieldValue". */ kind: string; /** * Value of this creative field value. It needs to be less than 256 characters * in length and unique per creative field. */ value: string; } /** * Creative Field Value List Response */ export interface Schema$CreativeFieldValuesListResponse { /** * Creative field value collection. */ creativeFieldValues: Schema$CreativeFieldValue[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativeFieldValuesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Contains properties of a creative group. */ export interface Schema$CreativeGroup { /** * Account ID of this creative group. This is a read-only field that can be * left blank. */ accountId: string; /** * Advertiser ID of this creative group. 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; /** * Subgroup of the creative group. Assign your creative groups to a subgroup * in order to filter or manage them more easily. This field is required on * insertion and is read-only after insertion. Acceptable values are 1 to 2, * inclusive. */ groupNumber: number; /** * ID of this creative group. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativeGroup". */ kind: string; /** * Name of this creative group. This is a required field and must be less than * 256 characters long and unique among creative groups of the same * advertiser. */ name: string; /** * Subaccount ID of this creative group. This is a read-only field that can be * left blank. */ subaccountId: string; } /** * Creative Group Assignment. */ export interface Schema$CreativeGroupAssignment { /** * ID of the creative group to be assigned. */ creativeGroupId: string; /** * Creative group number of the creative group assignment. */ creativeGroupNumber: string; } /** * Creative Group List Response */ export interface Schema$CreativeGroupsListResponse { /** * Creative group collection. */ creativeGroups: Schema$CreativeGroup[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativeGroupsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Creative optimization settings. */ export interface Schema$CreativeOptimizationConfiguration { /** * ID of this creative optimization config. This field is auto-generated when * the campaign is inserted or updated. It can be null for existing campaigns. */ id: string; /** * Name of this creative optimization config. This is a required field and * must be less than 129 characters long. */ name: string; /** * List of optimization activities associated with this configuration. */ optimizationActivitys: Schema$OptimizationActivity[]; /** * Optimization model for this configuration. */ optimizationModel: string; } /** * Creative Rotation. */ export interface Schema$CreativeRotation { /** * Creative assignments in this creative rotation. */ creativeAssignments: Schema$CreativeAssignment[]; /** * Creative optimization configuration that is used by this ad. It should * refer to one of the existing optimization configurations in the ad's * campaign. If it is unset or set to 0, then the campaign's default * optimization configuration will be used for this ad. */ creativeOptimizationConfigurationId: string; /** * Type of creative rotation. Can be used to specify whether to use sequential * or random rotation. */ type: string; /** * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */ weightCalculationStrategy: string; } /** * Creative Settings */ export interface Schema$CreativeSettings { /** * Header text for iFrames for this site. Must be less than or equal to 2000 * characters long. */ iFrameFooter: string; /** * Header text for iFrames for this site. Must be less than or equal to 2000 * characters long. */ iFrameHeader: string; } /** * Creative List Response */ export interface Schema$CreativesListResponse { /** * Creative collection. */ creatives: Schema$Creative[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#creativesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Represents fields that are compatible to be selected for a report of type * "CROSS_DIMENSION_REACH". */ export interface Schema$CrossDimensionReachReportCompatibleFields { /** * Dimensions which are compatible to be selected in the "breakdown" * section of the report. */ breakdown: Schema$Dimension[]; /** * Dimensions which are compatible to be selected in the * "dimensionFilters" section of the report. */ dimensionFilters: Schema$Dimension[]; /** * The kind of resource this is, in this case * dfareporting#crossDimensionReachReportCompatibleFields. */ kind: string; /** * Metrics which are compatible to be selected in the "metricNames" * section of the report. */ metrics: Schema$Metric[]; /** * Metrics which are compatible to be selected in the * "overlapMetricNames" section of the report. */ overlapMetrics: Schema$Metric[]; } /** * A custom floodlight variable. */ export interface Schema$CustomFloodlightVariable { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#customFloodlightVariable". */ kind: string; /** * The type of custom floodlight variable to supply a value for. These map to * the "u[1-20]=" in the tags. */ type: string; /** * The value of the custom floodlight variable. The length of string must not * exceed 50 characters. */ value: string; } /** * Represents a Custom Rich Media Events group. */ export interface Schema$CustomRichMediaEvents { /** * List of custom rich media event IDs. Dimension values must be all of type * dfa:richMediaEventTypeIdAndName. */ filteredEventIds: Schema$DimensionValue[]; /** * The kind of resource this is, in this case * dfareporting#customRichMediaEvents. */ kind: string; } /** * Represents a date range. */ export interface Schema$DateRange { /** * The end date of the date range, inclusive. A string of the format: * "yyyy-MM-dd". */ endDate: string; /** * The kind of resource this is, in this case dfareporting#dateRange. */ kind: string; /** * The date range relative to the date of when the report is run. */ relativeDateRange: string; /** * The start date of the date range, inclusive. A string of the format: * "yyyy-MM-dd". */ startDate: string; } /** * Day Part Targeting. */ export interface Schema$DayPartTargeting { /** * Days of the week when the ad will serve. Acceptable values are: - * "SUNDAY" - "MONDAY" - "TUESDAY" - * "WEDNESDAY" - "THURSDAY" - "FRIDAY" - * "SATURDAY" */ daysOfWeek: string[]; /** * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 * is 11 PM to midnight. Can be specified with days of week, in which case the * ad would serve during these hours on the specified days. For example if * Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm * (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, * and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. */ hoursOfDay: number[]; /** * Whether or not to use the user's local time. If false, the America/New * York time zone applies. */ userLocalTime: boolean; } /** * 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. */ export interface Schema$DefaultClickThroughEventTagProperties { /** * ID of the click-through event tag to apply to all ads in this entity's * scope. */ defaultClickThroughEventTagId: string; /** * Whether this entity should override the inherited default click-through * event tag with its own defined value. */ overrideInheritedEventTag: boolean; } /** * Delivery Schedule. */ export interface Schema$DeliverySchedule { /** * Limit on the number of times an individual user can be served the ad within * a specified period of time. */ frequencyCap: Schema$FrequencyCap; /** * Whether or not hard cutoff is enabled. If true, the ad will not serve after * the end date and time. Otherwise the ad will continue to be served until it * has reached its delivery goals. */ hardCutoff: boolean; /** * Impression ratio for this ad. This ratio determines how often each ad is * served relative to the others. For example, if ad A has an impression ratio * of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three * times as often as ad A. Acceptable values are 1 to 10, inclusive. */ impressionRatio: string; /** * Serving priority of an ad, with respect to other ads. The lower the * priority number, the greater the priority with which it is served. */ priority: string; } /** * DFP Settings */ export interface Schema$DfpSettings { /** * DFP network code for this directory site. */ dfpNetworkCode: string; /** * DFP network name for this directory site. */ dfpNetworkName: string; /** * Whether this directory site accepts programmatic placements. */ programmaticPlacementAccepted: boolean; /** * Whether this directory site is available only via DoubleClick Publisher * Portal. */ publisherPortalOnly: boolean; /** * Whether this directory site accepts publisher-paid tags. */ pubPaidPlacementAccepted: boolean; } /** * Represents a dimension. */ export interface Schema$Dimension { /** * The kind of resource this is, in this case dfareporting#dimension. */ kind: string; /** * The dimension name, e.g. dfa:advertiser */ name: string; } /** * Represents a dimension filter. */ export interface Schema$DimensionFilter { /** * The name of the dimension to filter. */ dimensionName: string; /** * The kind of resource this is, in this case dfareporting#dimensionFilter. */ kind: string; /** * The value of the dimension to filter. */ value: string; } /** * Represents a DimensionValue resource. */ export interface Schema$DimensionValue { /** * The name of the dimension. */ dimensionName: string; /** * The eTag of this response for caching purposes. */ etag: string; /** * The ID associated with the value if available. */ id: string; /** * The kind of resource this is, in this case dfareporting#dimensionValue. */ kind: string; /** * Determines how the 'value' field is matched when filtering. If not * specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is * allowed as a placeholder for variable length character sequences, and it * can be escaped with a backslash. Note, only paid search dimensions * ('dfa:paidSearch*') allow a matchType other than EXACT. */ matchType: string; /** * The value of the dimension. */ value: string; } /** * Represents the list of DimensionValue resources. */ export interface Schema$DimensionValueList { /** * The eTag of this response for caching purposes. */ etag: string; /** * The dimension values returned in this response. */ items: Schema$DimensionValue[]; /** * The kind of list this is, in this case dfareporting#dimensionValueList. */ kind: string; /** * Continuation token used to page through dimension values. To retrieve the * next page of results, set the next request's "pageToken" to * the value of this field. The page token is only valid for a limited amount * of time and should not be persisted. */ nextPageToken: string; } /** * Represents a DimensionValuesRequest. */ export interface Schema$DimensionValueRequest { /** * The name of the dimension for which values should be requested. */ dimensionName: string; /** * The end date of the date range for which to retrieve dimension values. A * string of the format "yyyy-MM-dd". */ endDate: string; /** * The list of filters by which to filter values. The filters are ANDed. */ filters: Schema$DimensionFilter[]; /** * The kind of request this is, in this case * dfareporting#dimensionValueRequest. */ kind: string; /** * The start date of the date range for which to retrieve dimension values. A * string of the format "yyyy-MM-dd". */ startDate: string; } /** * 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. */ export interface Schema$DirectorySite { /** * Whether this directory site is active. */ active: boolean; /** * Directory site contacts. */ contactAssignments: Schema$DirectorySiteContactAssignment[]; /** * Country ID of this directory site. This is a read-only field. */ countryId: string; /** * Currency ID of this directory site. This is a read-only field. Possible * 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; /** * Description of this directory site. This is a read-only field. */ description: string; /** * ID of this directory site. This is a read-only, auto-generated field. */ id: string; /** * Dimension value for the ID of this directory site. This is a read-only, * auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Tag types for regular placements. Acceptable values are: - * "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - * "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" */ inpageTagFormats: string[]; /** * Tag types for interstitial placements. Acceptable values are: - * "IFRAME_JAVASCRIPT_INTERSTITIAL" - * "INTERNAL_REDIRECT_INTERSTITIAL" - * "JAVASCRIPT_INTERSTITIAL" */ interstitialTagFormats: string[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#directorySite". */ kind: string; /** * Name of this directory site. */ name: string; /** * Parent directory site ID. */ parentId: string; /** * Directory site settings. */ settings: Schema$DirectorySiteSettings; /** * URL of this directory site. */ url: string; } /** * Contains properties of a Site Directory contact. */ export interface Schema$DirectorySiteContact { /** * Address of this directory site contact. */ address: string; /** * Email address of this directory site contact. */ email: string; /** * First name of this directory site contact. */ firstName: string; /** * ID of this directory site contact. This is a read-only, auto-generated * field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#directorySiteContact". */ kind: string; /** * Last name of this directory site contact. */ lastName: string; /** * Phone number of this directory site contact. */ phone: string; /** * Directory site contact role. */ role: string; /** * Title or designation of this directory site contact. */ title: string; /** * Directory site contact type. */ type: string; } /** * Directory Site Contact Assignment */ export interface Schema$DirectorySiteContactAssignment { /** * ID of this directory site contact. This is a read-only, auto-generated * field. */ contactId: string; /** * Visibility of this directory site contact assignment. When set to PUBLIC * this contact assignment is visible to all account and agency users; when * set to PRIVATE it is visible only to the site. */ visibility: string; } /** * Directory Site Contact List Response */ export interface Schema$DirectorySiteContactsListResponse { /** * Directory site contact collection */ directorySiteContacts: Schema$DirectorySiteContact[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#directorySiteContactsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Directory Site Settings */ export interface Schema$DirectorySiteSettings { /** * Whether this directory site has disabled active view creatives. */ activeViewOptOut: boolean; /** * Directory site DFP settings. */ dfpSettings: Schema$DfpSettings; /** * Whether this site accepts in-stream video ads. */ instreamVideoPlacementAccepted: boolean; /** * Whether this site accepts interstitial ads. */ interstitialPlacementAccepted: boolean; /** * Whether this directory site has disabled Nielsen OCR reach ratings. */ nielsenOcrOptOut: boolean; /** * Whether this directory site has disabled generation of Verification ins * tags. */ verificationTagOptOut: boolean; /** * Whether this directory site has disabled active view for in-stream video * creatives. This is a read-only field. */ videoActiveViewOptOut: boolean; } /** * Directory Site List Response */ export interface Schema$DirectorySitesListResponse { /** * Directory site collection. */ directorySites: Schema$DirectorySite[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#directorySitesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * 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 * DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM * IDs (such as placement IDs) to save time and avoid errors in your dynamic * feeds. */ export interface Schema$DynamicTargetingKey { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#dynamicTargetingKey". */ kind: string; /** * Name of this dynamic targeting key. This is a required field. Must be less * than 256 characters long and cannot contain commas. All characters are * converted to lowercase. */ name: string; /** * ID of the object of this dynamic targeting key. This is a required field. */ objectId: string; /** * Type of the object of this dynamic targeting key. This is a required field. */ objectType: string; } /** * Dynamic Targeting Key List Response */ export interface Schema$DynamicTargetingKeysListResponse { /** * Dynamic targeting key collection. */ dynamicTargetingKeys: Schema$DynamicTargetingKey[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#dynamicTargetingKeysListResponse". */ kind: string; } /** * A description of how user IDs are encrypted. */ export interface Schema$EncryptionInfo { /** * The encryption entity ID. This should match the encryption configuration * for ad serving or Data Transfer. */ encryptionEntityId: string; /** * The encryption entity type. This should match the encryption configuration * for ad serving or Data Transfer. */ encryptionEntityType: string; /** * Describes whether the encrypted cookie was received from ad serving (the %m * macro) or from Data Transfer. */ encryptionSource: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#encryptionInfo". */ kind: string; } /** * Contains properties of an event tag. */ export interface Schema$EventTag { /** * Account ID of this event tag. This is a read-only field that can be left * blank. */ accountId: string; /** * Advertiser ID of this event tag. This field or the campaignId field is * required on insertion. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. This is a read-only, * auto-generated field. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Campaign ID of this event tag. This field or the advertiserId field is * required on insertion. */ campaignId: string; /** * Dimension value for the ID of the campaign. This is a read-only, * auto-generated field. */ campaignIdDimensionValue: Schema$DimensionValue; /** * Whether this event tag should be automatically enabled for all of the * advertiser's campaigns and ads. */ enabledByDefault: boolean; /** * Whether to remove this event tag from ads that are trafficked through * DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag * uses a pixel that is unapproved for Ad Exchange bids on one or more * networks, such as the Google Display Network. */ excludeFromAdxRequests: boolean; /** * ID of this event tag. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#eventTag". */ kind: string; /** * Name of this event tag. This is a required field and must be less than 256 * characters long. */ name: string; /** * Site filter type for this event tag. If no type is specified then the event * tag will be applied to all sites. */ siteFilterType: string; /** * Filter list of site IDs associated with this event tag. The siteFilterType * determines whether this is a whitelist or blacklist filter. */ siteIds: string[]; /** * Whether this tag is SSL-compliant or not. This is a read-only field. */ sslCompliant: boolean; /** * Status of this event tag. Must be ENABLED for this event tag to fire. This * is a required field. */ status: string; /** * Subaccount ID of this event tag. This is a read-only field that can be left * blank. */ subaccountId: string; /** * Event tag type. Can be used to specify whether to use a third-party pixel, * a third-party JavaScript URL, or a third-party click-through URL for either * impression or click tracking. This is a required field. */ type: string; /** * Payload URL for this event tag. The URL on a click-through event tag should * have a landing page URL appended to the end of it. This field is required * on insertion. */ url: string; /** * Number of times the landing page URL should be URL-escaped before being * appended to the click-through event tag URL. Only applies to click-through * event tags as specified by the event tag type. */ urlEscapeLevels: number; } /** * Event tag override information. */ export interface Schema$EventTagOverride { /** * Whether this override is enabled. */ enabled: boolean; /** * ID of this event tag override. This is a read-only, auto-generated field. */ id: string; } /** * Event Tag List Response */ export interface Schema$EventTagsListResponse { /** * Event tag collection. */ eventTags: Schema$EventTag[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#eventTagsListResponse". */ kind: string; } /** * 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". */ export interface Schema$File { /** * The date range for which the file has report data. The date range will * always be the absolute date range for which the report is run. */ dateRange: Schema$DateRange; /** * The eTag of this response for caching purposes. */ etag: string; /** * The filename of the file. */ fileName: string; /** * The output format of the report. Only available once the file is available. */ format: string; /** * The unique ID of this report file. */ id: string; /** * The kind of resource this is, in this case dfareporting#file. */ kind: string; /** * The timestamp in milliseconds since epoch when this file was last modified. */ lastModifiedTime: string; /** * The ID of the report this file was generated from. */ reportId: string; /** * The status of the report file. */ status: string; /** * The URLs where the completed report file can be downloaded. */ urls: any; } /** * Represents the list of File resources. */ export interface Schema$FileList { /** * The eTag of this response for caching purposes. */ etag: string; /** * The files returned in this response. */ items: Schema$File[]; /** * The kind of list this is, in this case dfareporting#fileList. */ kind: string; /** * Continuation token used to page through files. To retrieve the next page of * results, set the next request's "pageToken" to the value of * this field. The page token is only valid for a limited amount of time and * should not be persisted. */ nextPageToken: string; } /** * Flight */ export interface Schema$Flight { /** * Inventory item flight end date. */ endDate: string; /** * Rate or cost of this flight. */ rateOrCost: string; /** * Inventory item flight start date. */ startDate: string; /** * Units of this flight. */ units: string; } /** * Floodlight Activity GenerateTag Response */ export interface Schema$FloodlightActivitiesGenerateTagResponse { /** * Generated tag for this Floodlight activity. For global site tags, this is * the event snippet. */ floodlightActivityTag: string; /** * The global snippet section of a global site tag. The global site tag sets * new cookies on your domain, which will store a unique identifier for a user * or the ad click that brought the user to your site. Learn more. */ globalSiteTagGlobalSnippet: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#floodlightActivitiesGenerateTagResponse". */ kind: string; } /** * Floodlight Activity List Response */ export interface Schema$FloodlightActivitiesListResponse { /** * Floodlight activity collection. */ floodlightActivities: Schema$FloodlightActivity[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#floodlightActivitiesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Contains properties of a Floodlight activity. */ export interface Schema$FloodlightActivity { /** * Account ID of this floodlight activity. This is a read-only field that can * be left blank. */ accountId: string; /** * Advertiser ID of this floodlight activity. If this field is left blank, the * value will be copied over either from the activity group's advertiser * or the existing activity's advertiser. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. This is a read-only, * auto-generated field. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Code type used for cache busting in the generated tag. Applicable only when * floodlightActivityGroupType is COUNTER and countingMethod is * STANDARD_COUNTING or UNIQUE_COUNTING. */ cacheBustingType: string; /** * Counting method for conversions for this floodlight activity. This is a * required field. */ countingMethod: string; /** * Dynamic floodlight tags. */ defaultTags: Schema$FloodlightActivityDynamicTag[]; /** * URL where this tag will be deployed. If specified, must be less than 256 * characters long. */ expectedUrl: string; /** * Floodlight activity group ID of this floodlight activity. This is a * required field. */ floodlightActivityGroupId: string; /** * Name of the associated floodlight activity group. This is a read-only * field. */ floodlightActivityGroupName: string; /** * Tag string of the associated floodlight activity group. This is a read-only * field. */ floodlightActivityGroupTagString: string; /** * Type of the associated floodlight activity group. This is a read-only * field. */ floodlightActivityGroupType: string; /** * Floodlight configuration ID of this floodlight activity. If this field is * left blank, the value will be copied over either from the activity * group's floodlight configuration or from the existing activity's * floodlight configuration. */ floodlightConfigurationId: string; /** * Dimension value for the ID of the floodlight configuration. This is a * read-only, auto-generated field. */ floodlightConfigurationIdDimensionValue: Schema$DimensionValue; /** * The type of Floodlight tag this activity will generate. This is a required * field. */ floodlightTagType: string; /** * Whether this activity is archived. */ hidden: boolean; /** * ID of this floodlight activity. This is a read-only, auto-generated field. */ id: string; /** * Dimension value for the ID of this floodlight activity. This is a * read-only, auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#floodlightActivity". */ kind: string; /** * Name of this floodlight activity. This is a required field. Must be less * than 129 characters long and cannot contain quotes. */ name: string; /** * General notes or implementation instructions for the tag. */ notes: string; /** * Publisher dynamic floodlight tags. */ publisherTags: Schema$FloodlightActivityPublisherDynamicTag[]; /** * Whether this tag should use SSL. */ secure: boolean; /** * Whether the floodlight activity is SSL-compliant. This is a read-only * field, its value detected by the system from the floodlight tags. */ sslCompliant: boolean; /** * Whether this floodlight activity must be SSL-compliant. */ sslRequired: boolean; /** * Subaccount ID of this floodlight activity. This is a read-only field that * can be left blank. */ subaccountId: string; /** * Tag format type for the floodlight activity. If left blank, the tag format * will default to HTML. */ tagFormat: string; /** * Value of the cat= parameter in the floodlight tag, which the ad servers use * to identify the activity. This is optional: if empty, a new tag string will * be generated for you. This string must be 1 to 8 characters long, with * valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also * be unique among activities of the same activity group. This field is * read-only after insertion. */ tagString: string; /** * List of the user-defined variables used by this conversion tag. These map * to the "u[1-100]=" in the tags. Each of these can have a user * defined type. Acceptable values are U1 to U100, inclusive. */ userDefinedVariableTypes: string[]; } /** * Dynamic Tag */ export interface Schema$FloodlightActivityDynamicTag { /** * ID of this dynamic tag. This is a read-only, auto-generated field. */ id: string; /** * Name of this tag. */ name: string; /** * Tag code. */ tag: string; } /** * Contains properties of a Floodlight activity group. */ export interface Schema$FloodlightActivityGroup { /** * Account ID of this floodlight activity group. This is a read-only field * that can be left blank. */ accountId: string; /** * Advertiser ID of this floodlight activity group. If this field is left * blank, the value will be copied over either from the floodlight * configuration's advertiser or from the existing activity group's * advertiser. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. This is a read-only, * auto-generated field. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Floodlight configuration ID of this floodlight activity group. This is a * required field. */ 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 floodlight activity group. This is a read-only, auto-generated * field. */ id: string; /** * Dimension value for the ID of this floodlight activity group. This is a * read-only, auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#floodlightActivityGroup". */ kind: string; /** * Name of this floodlight activity group. This is a required field. Must be * less than 65 characters long and cannot contain quotes. */ name: string; /** * Subaccount ID of this floodlight activity group. This is a read-only field * that can be left blank. */ subaccountId: string; /** * Value of the type= parameter in the floodlight tag, which the ad servers * use to identify the activity group that the activity belongs to. This is * optional: if empty, a new tag string will be generated for you. This string * must be 1 to 8 characters long, with valid characters being * [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity * groups of the same floodlight configuration. This field is read-only after * insertion. */ tagString: string; /** * Type of the floodlight activity group. This is a required field that is * read-only after insertion. */ type: string; } /** * Floodlight Activity Group List Response */ export interface Schema$FloodlightActivityGroupsListResponse { /** * Floodlight activity group collection. */ floodlightActivityGroups: Schema$FloodlightActivityGroup[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#floodlightActivityGroupsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Publisher Dynamic Tag */ export interface Schema$FloodlightActivityPublisherDynamicTag { /** * Whether this tag is applicable only for click-throughs. */ clickThrough: boolean; /** * Directory site ID of this dynamic tag. This is a write-only field that can * be used as an alternative to the siteId field. When this resource is * retrieved, only the siteId field will be populated. */ directorySiteId: string; /** * Dynamic floodlight tag. */ dynamicTag: Schema$FloodlightActivityDynamicTag; /** * Site ID of this dynamic tag. */ siteId: string; /** * Dimension value for the ID of the site. This is a read-only, auto-generated * field. */ siteIdDimensionValue: Schema$DimensionValue; /** * Whether this tag is applicable only for view-throughs. */ viewThrough: boolean; } /** * Contains properties of a Floodlight configuration. */ export interface Schema$FloodlightConfiguration { /** * Account ID of this floodlight configuration. This is a read-only field that * can be left blank. */ accountId: string; /** * Advertiser ID of the parent advertiser of this floodlight configuration. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. This is a read-only, * auto-generated field. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Whether advertiser data is shared with Google Analytics. */ analyticsDataSharingEnabled: boolean; /** * Whether the exposure-to-conversion report is enabled. This report shows * detailed pathway information on up to 10 of the most recent ad exposures * seen by a user before converting. */ exposureToConversionEnabled: boolean; /** * Day that will be counted as the first day of the week in reports. This is a * required field. */ firstDayOfWeek: string; /** * ID of this floodlight configuration. This is a read-only, auto-generated * field. */ id: string; /** * Dimension value for the ID of this floodlight configuration. This is a * read-only, auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Whether in-app attribution tracking is enabled. */ inAppAttributionTrackingEnabled: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#floodlightConfiguration". */ kind: string; /** * Lookback window settings for this floodlight configuration. */ lookbackConfiguration: Schema$LookbackConfiguration; /** * Types of attribution options for natural search conversions. */ naturalSearchConversionAttributionOption: string; /** * Settings for DCM Omniture integration. */ omnitureSettings: Schema$OmnitureSettings; /** * Subaccount ID of this floodlight configuration. This is a read-only field * that can be left blank. */ subaccountId: string; /** * Configuration settings for dynamic and image floodlight tags. */ tagSettings: Schema$TagSettings; /** * List of third-party authentication tokens enabled for this configuration. */ thirdPartyAuthenticationTokens: Schema$ThirdPartyAuthenticationToken[]; /** * List of user defined variables enabled for this configuration. */ userDefinedVariableConfigurations: Schema$UserDefinedVariableConfiguration[]; } /** * Floodlight Configuration List Response */ export interface Schema$FloodlightConfigurationsListResponse { /** * Floodlight configuration collection. */ floodlightConfigurations: Schema$FloodlightConfiguration[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#floodlightConfigurationsListResponse". */ kind: string; } /** * Represents fields that are compatible to be selected for a report of type * "FlOODLIGHT". */ export interface Schema$FloodlightReportCompatibleFields { /** * Dimensions which are compatible to be selected in the * "dimensionFilters" section of the report. */ dimensionFilters: Schema$Dimension[]; /** * Dimensions which are compatible to be selected in the * "dimensions" section of the report. */ dimensions: Schema$Dimension[]; /** * The kind of resource this is, in this case * dfareporting#floodlightReportCompatibleFields. */ kind: string; /** * Metrics which are compatible to be selected in the "metricNames" * section of the report. */ metrics: Schema$Metric[]; } /** * Frequency Cap. */ export interface Schema$FrequencyCap { /** * Duration of time, in seconds, for this frequency cap. The maximum duration * is 90 days. Acceptable values are 1 to 7776000, inclusive. */ duration: string; /** * Number of times an individual user can be served the ad within the * specified duration. Acceptable values are 1 to 15, inclusive. */ impressions: string; } /** * FsCommand. */ export interface Schema$FsCommand { /** * Distance from the left of the browser.Applicable when positionOption is * DISTANCE_FROM_TOP_LEFT_CORNER. */ left: number; /** * Position in the browser where the window will open. */ positionOption: string; /** * Distance from the top of the browser. Applicable when positionOption is * DISTANCE_FROM_TOP_LEFT_CORNER. */ top: number; /** * Height of the window. */ windowHeight: number; /** * Width of the window. */ windowWidth: number; } /** * Geographical Targeting. */ export interface Schema$GeoTargeting { /** * Cities to be targeted. For each city only dartId is required. The other * fields are populated automatically when the ad is inserted or updated. If * targeting a city, do not target or exclude the country of the city, and do * not target the metro or region of the city. */ cities: Schema$City[]; /** * Countries to be targeted or excluded from targeting, depending on the * setting of the excludeCountries field. For each country only dartId is * required. The other fields are populated automatically when the ad is * inserted or updated. If targeting or excluding a country, do not target * regions, cities, metros, or postal codes in the same country. */ countries: Schema$Country[]; /** * Whether or not to exclude the countries in the countries field from * targeting. If false, the countries field refers to countries which will be * targeted by the ad. */ excludeCountries: boolean; /** * Metros to be targeted. For each metro only dmaId is required. The other * fields are populated automatically when the ad is inserted or updated. If * targeting a metro, do not target or exclude the country of the metro. */ metros: Schema$Metro[]; /** * Postal codes to be targeted. For each postal code only id is required. The * other fields are populated automatically when the ad is inserted or * updated. If targeting a postal code, do not target or exclude the country * of the postal code. */ postalCodes: Schema$PostalCode[]; /** * Regions to be targeted. For each region only dartId is required. The other * fields are populated automatically when the ad is inserted or updated. If * targeting a region, do not target or exclude the country of the region. */ regions: Schema$Region[]; } /** * Represents a buy from the DoubleClick Planning inventory store. */ export interface Schema$InventoryItem { /** * Account ID of this inventory item. */ accountId: string; /** * Ad slots of this inventory item. If this inventory item represents a * standalone placement, there will be exactly one ad slot. If this inventory * item represents a placement group, there will be more than one ad slot, * each representing one child placement in that placement group. */ adSlots: Schema$AdSlot[]; /** * Advertiser ID of this inventory item. */ advertiserId: string; /** * Content category ID of this inventory item. */ contentCategoryId: string; /** * Estimated click-through rate of this inventory item. */ estimatedClickThroughRate: string; /** * Estimated conversion rate of this inventory item. */ estimatedConversionRate: string; /** * ID of this inventory item. */ id: string; /** * Whether this inventory item is in plan. */ inPlan: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#inventoryItem". */ kind: string; /** * Information about the most recent modification of this inventory item. */ lastModifiedInfo: Schema$LastModifiedInfo; /** * Name of this inventory item. For standalone inventory items, this is the * same name as that of its only ad slot. For group inventory items, this can * differ from the name of any of its ad slots. */ name: string; /** * Negotiation channel ID of this inventory item. */ negotiationChannelId: string; /** * Order ID of this inventory item. */ orderId: string; /** * Placement strategy ID of this inventory item. */ placementStrategyId: string; /** * Pricing of this inventory item. */ pricing: Schema$Pricing; /** * Project ID of this inventory item. */ projectId: string; /** * RFP ID of this inventory item. */ rfpId: string; /** * ID of the site this inventory item is associated with. */ siteId: string; /** * Subaccount ID of this inventory item. */ subaccountId: string; /** * Type of inventory item. */ type: string; } /** * Inventory item List Response */ export interface Schema$InventoryItemsListResponse { /** * Inventory item collection */ inventoryItems: Schema$InventoryItem[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#inventoryItemsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; } /** * Key Value Targeting Expression. */ export interface Schema$KeyValueTargetingExpression { /** * Keyword expression being targeted by the ad. */ expression: string; } /** * Contains information about where a user's browser is taken after the user * clicks an ad. */ export interface Schema$LandingPage { /** * Advertiser ID of this landing page. This is a required field. */ advertiserId: string; /** * Whether this landing page has been archived. */ archived: boolean; /** * ID of this landing page. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#landingPage". */ kind: string; /** * Name of this landing page. This is a required field. It must be less than * 256 characters long. */ name: string; /** * URL of this landing page. This is a required field. */ url: string; } /** * Contains information about a language that can be targeted by ads. */ export interface Schema$Language { /** * Language ID of this language. This is the ID used for targeting and * generating reports. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#language". */ kind: string; /** * Format of language code is an ISO 639 two-letter language code optionally * followed by an underscore followed by an ISO 3166 code. Examples are * "en" for English or "zh_CN" for Simplified Chinese. */ languageCode: string; /** * Name of this language. */ name: string; } /** * Language List Response */ export interface Schema$LanguagesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#languagesListResponse". */ kind: string; /** * Language collection. */ languages: Schema$Language[]; } /** * Language Targeting. */ export interface Schema$LanguageTargeting { /** * Languages that this ad targets. For each language only languageId is * required. The other fields are populated automatically when the ad is * inserted or updated. */ languages: Schema$Language[]; } /** * Modification timestamp. */ export interface Schema$LastModifiedInfo { /** * Timestamp of the last change in milliseconds since epoch. */ time: string; } /** * A group clause made up of list population terms representing constraints * joined by ORs. */ export interface Schema$ListPopulationClause { /** * Terms of this list population clause. Each clause is made up of list * population terms representing constraints and are joined by ORs. */ terms: Schema$ListPopulationTerm[]; } /** * Remarketing List Population Rule. */ export interface Schema$ListPopulationRule { /** * Floodlight activity ID associated with this rule. This field can be left * blank. */ floodlightActivityId: string; /** * Name of floodlight activity associated with this rule. This is a read-only, * auto-generated field. */ floodlightActivityName: string; /** * Clauses that make up this list population rule. Clauses are joined by ANDs, * and the clauses themselves are made up of list population terms which are * joined by ORs. */ listPopulationClauses: Schema$ListPopulationClause[]; } /** * Remarketing List Population Rule Term. */ export interface Schema$ListPopulationTerm { /** * Will be true if the term should check if the user is in the list and false * if the term should check if the user is not in the list. This field is only * relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. */ contains: boolean; /** * Whether to negate the comparison result of this term during rule * evaluation. This field is only relevant when type is left unset or set to * CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ negation: boolean; /** * Comparison operator of this term. This field is only relevant when type is * left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ operator: string; /** * ID of the list in question. This field is only relevant when type is set to * LIST_MEMBERSHIP_TERM. */ remarketingListId: string; /** * List population term type determines the applicable fields in this object. * If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, * variableFriendlyName, operator, value, and negation are applicable. If set * to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. * If set to REFERRER_TERM then operator, value, and negation are applicable. */ type: string; /** * Literal to compare the variable to. This field is only relevant when type * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. */ value: string; /** * Friendly name of this term's variable. This is a read-only, * auto-generated field. This field is only relevant when type is left unset * or set to CUSTOM_VARIABLE_TERM. */ variableFriendlyName: string; /** * Name of the variable (U1, U2, etc.) being compared in this term. This field * is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or * REFERRER_TERM. */ variableName: string; } /** * Remarketing List Targeting Expression. */ export interface Schema$ListTargetingExpression { /** * Expression describing which lists are being targeted by the ad. */ expression: string; } /** * Lookback configuration settings. */ export interface Schema$LookbackConfiguration { /** * Lookback window, in days, from the last time a given user clicked on one of * your ads. If you enter 0, clicks will not be considered as triggering * events for floodlight tracking. If you leave this field blank, the default * value for your account will be used. Acceptable values are 0 to 90, * inclusive. */ clickDuration: number; /** * Lookback window, in days, from the last time a given user viewed one of * your ads. If you enter 0, impressions will not be considered as triggering * events for floodlight tracking. If you leave this field blank, the default * value for your account will be used. Acceptable values are 0 to 90, * inclusive. */ postImpressionActivitiesDuration: number; } /** * Represents a metric. */ export interface Schema$Metric { /** * The kind of resource this is, in this case dfareporting#metric. */ kind: string; /** * The metric name, e.g. dfa:impressions */ name: string; } /** * Contains information about a metro region that can be targeted by ads. */ export interface Schema$Metro { /** * Country code of the country to which this metro region belongs. */ countryCode: string; /** * DART ID of the country to which this metro region belongs. */ countryDartId: string; /** * DART ID of this metro region. */ dartId: string; /** * DMA ID of this metro region. This is the ID used for targeting and * generating reports, and is equivalent to metro_code. */ dmaId: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#metro". */ kind: string; /** * Metro code of this metro region. This is equivalent to dma_id. */ metroCode: string; /** * Name of this metro region. */ name: string; } /** * Metro List Response */ export interface Schema$MetrosListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#metrosListResponse". */ kind: string; /** * Metro collection. */ metros: Schema$Metro[]; } /** * Contains information about a mobile carrier that can be targeted by ads. */ export interface Schema$MobileCarrier { /** * Country code of the country to which this mobile carrier belongs. */ countryCode: string; /** * DART ID of the country to which this mobile carrier belongs. */ countryDartId: string; /** * ID of this mobile carrier. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#mobileCarrier". */ kind: string; /** * Name of this mobile carrier. */ name: string; } /** * Mobile Carrier List Response */ export interface Schema$MobileCarriersListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#mobileCarriersListResponse". */ kind: string; /** * Mobile carrier collection. */ mobileCarriers: Schema$MobileCarrier[]; } /** * Object Filter. */ export interface Schema$ObjectFilter { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#objectFilter". */ kind: string; /** * Applicable when status is ASSIGNED. The user has access to objects with * these object IDs. */ objectIds: string[]; /** * Status of the filter. NONE means the user has access to none of the * objects. ALL means the user has access to all objects. ASSIGNED means the * user has access to the objects with IDs in the objectIds list. */ status: string; } /** * Offset Position. */ export interface Schema$OffsetPosition { /** * Offset distance from left side of an asset or a window. */ left: number; /** * Offset distance from top side of an asset or a window. */ top: number; } /** * Omniture Integration Settings. */ export interface Schema$OmnitureSettings { /** * Whether placement cost data will be sent to Omniture. This property can be * enabled only if omnitureIntegrationEnabled is true. */ omnitureCostDataEnabled: boolean; /** * Whether Omniture integration is enabled. This property can be enabled only * when the "Advanced Ad Serving" account setting is enabled. */ omnitureIntegrationEnabled: boolean; } /** * Contains information about an operating system that can be targeted by ads. */ export interface Schema$OperatingSystem { /** * DART ID of this operating system. This is the ID used for targeting. */ dartId: string; /** * Whether this operating system is for desktop. */ desktop: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#operatingSystem". */ kind: string; /** * Whether this operating system is for mobile. */ mobile: boolean; /** * Name of this operating system. */ name: string; } /** * Operating System List Response */ export interface Schema$OperatingSystemsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#operatingSystemsListResponse". */ kind: string; /** * Operating system collection. */ operatingSystems: Schema$OperatingSystem[]; } /** * Contains information about a particular version of an operating system that * can be targeted by ads. */ export interface Schema$OperatingSystemVersion { /** * ID of this operating system version. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#operatingSystemVersion". */ kind: string; /** * Major version (leftmost number) of this operating system version. */ majorVersion: string; /** * Minor version (number after the first dot) of this operating system * version. */ minorVersion: string; /** * Name of this operating system version. */ name: string; /** * Operating system of this operating system version. */ operatingSystem: Schema$OperatingSystem; } /** * Operating System Version List Response */ export interface Schema$OperatingSystemVersionsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#operatingSystemVersionsListResponse". */ kind: string; /** * Operating system version collection. */ operatingSystemVersions: Schema$OperatingSystemVersion[]; } /** * Creative optimization activity. */ export interface Schema$OptimizationActivity { /** * Floodlight activity ID of this optimization activity. This is a required * field. */ floodlightActivityId: string; /** * Dimension value for the ID of the floodlight activity. This is a read-only, * auto-generated field. */ floodlightActivityIdDimensionValue: Schema$DimensionValue; /** * Weight associated with this optimization. The weight assigned will be * understood in proportion to the weights assigned to the other optimization * activities. Value must be greater than or equal to 1. */ weight: number; } /** * Describes properties of a DoubleClick Planning order. */ export interface Schema$Order { /** * Account ID of this order. */ accountId: string; /** * Advertiser ID of this order. */ advertiserId: string; /** * IDs for users that have to approve documents created for this order. */ approverUserProfileIds: string[]; /** * Buyer invoice ID associated with this order. */ buyerInvoiceId: string; /** * Name of the buyer organization. */ buyerOrganizationName: string; /** * Comments in this order. */ comments: string; /** * Contacts for this order. */ contacts: Schema$OrderContact[]; /** * ID of this order. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#order". */ kind: string; /** * Information about the most recent modification of this order. */ lastModifiedInfo: Schema$LastModifiedInfo; /** * Name of this order. */ name: string; /** * Notes of this order. */ notes: string; /** * ID of the terms and conditions template used in this order. */ planningTermId: string; /** * Project ID of this order. */ projectId: string; /** * Seller order ID associated with this order. */ sellerOrderId: string; /** * Name of the seller organization. */ sellerOrganizationName: string; /** * Site IDs this order is associated with. */ siteId: string[]; /** * Free-form site names this order is associated with. */ siteNames: string[]; /** * Subaccount ID of this order. */ subaccountId: string; /** * Terms and conditions of this order. */ termsAndConditions: string; } /** * Contact of an order. */ export interface Schema$OrderContact { /** * Free-form information about this contact. It could be any information * related to this contact in addition to type, title, name, and signature * user profile ID. */ contactInfo: string; /** * Name of this contact. */ contactName: string; /** * Title of this contact. */ contactTitle: string; /** * Type of this contact. */ contactType: string; /** * ID of the user profile containing the signature that will be embedded into * order documents. */ signatureUserProfileId: string; } /** * Contains properties of a DoubleClick Planning order document. */ export interface Schema$OrderDocument { /** * Account ID of this order document. */ accountId: string; /** * Advertiser ID of this order document. */ advertiserId: string; /** * The amended order document ID of this order document. An order document can * be created by optionally amending another order document so that the change * history can be preserved. */ amendedOrderDocumentId: string; /** * IDs of users who have approved this order document. */ approvedByUserProfileIds: string[]; /** * Whether this order document is cancelled. */ cancelled: boolean; /** * Information about the creation of this order document. */ createdInfo: Schema$LastModifiedInfo; /** * Effective date of this order document. */ effectiveDate: string; /** * ID of this order document. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#orderDocument". */ kind: string; /** * List of email addresses that received the last sent document. */ lastSentRecipients: string[]; /** * Timestamp of the last email sent with this order document. */ lastSentTime: string; /** * ID of the order from which this order document is created. */ orderId: string; /** * Project ID of this order document. */ projectId: string; /** * Whether this order document has been signed. */ signed: boolean; /** * Subaccount ID of this order document. */ subaccountId: string; /** * Title of this order document. */ title: string; /** * Type of this order document */ type: string; } /** * Order document List Response */ export interface Schema$OrderDocumentsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#orderDocumentsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Order document collection */ orderDocuments: Schema$OrderDocument[]; } /** * Order List Response */ export interface Schema$OrdersListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#ordersListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Order collection. */ orders: Schema$Order[]; } /** * Represents fields that are compatible to be selected for a report of type * "PATH_TO_CONVERSION". */ export interface Schema$PathToConversionReportCompatibleFields { /** * Conversion dimensions which are compatible to be selected in the * "conversionDimensions" section of the report. */ conversionDimensions: Schema$Dimension[]; /** * Custom floodlight variables which are compatible to be selected in the * "customFloodlightVariables" section of the report. */ customFloodlightVariables: Schema$Dimension[]; /** * The kind of resource this is, in this case * dfareporting#pathToConversionReportCompatibleFields. */ kind: string; /** * Metrics which are compatible to be selected in the "metricNames" * section of the report. */ metrics: Schema$Metric[]; /** * Per-interaction dimensions which are compatible to be selected in the * "perInteractionDimensions" section of the report. */ perInteractionDimensions: Schema$Dimension[]; } /** * Contains properties of a placement. */ export interface Schema$Placement { /** * Account ID of this placement. This field can be left blank. */ accountId: string; /** * Whether this placement opts out of ad blocking. When true, ad blocking is * disabled for this placement. When false, the campaign and site settings * take effect. */ adBlockingOptOut: boolean; /** * Advertiser ID of this placement. This field can be left blank. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. This is a read-only, * auto-generated field. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Whether this placement is archived. */ archived: boolean; /** * Campaign ID of this placement. This field 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; /** * Comments for this placement. */ comment: string; /** * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to * rendering on desktop, on mobile devices or in mobile apps for regular or * interstitial ads respectively. APP and APP_INTERSTITIAL are no longer * allowed for new placement insertions. Instead, use DISPLAY or * DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream * video ads developed with the VAST standard. This field is required on * insertion. */ compatibility: string; /** * ID of the content category assigned to this placement. */ contentCategoryId: string; /** * Information about the creation of this placement. This is a read-only * field. */ createInfo: Schema$LastModifiedInfo; /** * Directory site ID of this placement. On insert, you must set either this * field or the siteId field to specify the site associated with this * placement. This is a required field that is read-only after insertion. */ directorySiteId: string; /** * Dimension value for the ID of the directory site. This is a read-only, * auto-generated field. */ directorySiteIdDimensionValue: Schema$DimensionValue; /** * External ID for this placement. */ externalId: string; /** * ID of this placement. This is a read-only, auto-generated field. */ id: string; /** * Dimension value for the ID of this placement. This is a read-only, * auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Key name of this placement. This is a read-only, auto-generated field. */ keyName: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#placement". */ kind: string; /** * Information about the most recent modification of this placement. This is a * read-only field. */ lastModifiedInfo: Schema$LastModifiedInfo; /** * Lookback window settings for this placement. */ lookbackConfiguration: Schema$LookbackConfiguration; /** * Name of this placement.This is a required field and must be less than 256 * characters long. */ name: string; /** * Whether payment was approved for this placement. This is a read-only field * relevant only to publisher-paid placements. */ paymentApproved: boolean; /** * Payment source for this placement. This is a required field that is * read-only after insertion. */ paymentSource: string; /** * ID of this placement's group, if applicable. */ placementGroupId: string; /** * Dimension value for the ID of the placement group. This is a read-only, * auto-generated field. */ placementGroupIdDimensionValue: Schema$DimensionValue; /** * ID of the placement strategy assigned to this placement. */ placementStrategyId: string; /** * Pricing schedule of this placement. This field is required on insertion, * specifically subfields startDate, endDate and pricingType. */ pricingSchedule: Schema$PricingSchedule; /** * Whether this placement is the primary placement of a roadblock (placement * group). You cannot change this field from true to false. Setting this field * to true will automatically set the primary field on the original primary * placement of the roadblock to false, and it will automatically set the * roadblock's primaryPlacementId field to the ID of this placement. */ primary: boolean; /** * Information about the last publisher update. This is a read-only field. */ publisherUpdateInfo: Schema$LastModifiedInfo; /** * Site ID associated with this placement. On insert, you must set either this * field or the directorySiteId field to specify the site associated with this * placement. This is a required field that is read-only after insertion. */ siteId: string; /** * Dimension value for the ID of the site. This is a read-only, auto-generated * field. */ siteIdDimensionValue: Schema$DimensionValue; /** * Size associated with this placement. When inserting or updating a * placement, only the size ID field is used. This field is required on * insertion. */ size: Schema$Size; /** * Whether creatives assigned to this placement must be SSL-compliant. */ sslRequired: boolean; /** * Third-party placement status. */ status: string; /** * Subaccount ID of this placement. This field can be left blank. */ subaccountId: string; /** * Tag formats to generate for this placement. This field is required on * insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - * "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - * "PLACEMENT_TAG_IFRAME_ILAYER" - * "PLACEMENT_TAG_INTERNAL_REDIRECT" - * "PLACEMENT_TAG_JAVASCRIPT" - * "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - * "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - * "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - * "PLACEMENT_TAG_CLICK_COMMANDS" - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - * "PLACEMENT_TAG_TRACKING" - * "PLACEMENT_TAG_TRACKING_IFRAME" - * "PLACEMENT_TAG_TRACKING_JAVASCRIPT" */ tagFormats: string[]; /** * Tag settings for this placement. */ tagSetting: Schema$TagSetting; /** * Whether Verification and ActiveView are disabled for in-stream video * creatives for this placement. The same setting videoActiveViewOptOut exists * on the site level -- the opt out occurs if either of these settings are * true. These settings are distinct from * DirectorySites.settings.activeViewOptOut or * Sites.siteSettings.activeViewOptOut which only apply to display ads. * However, Accounts.activeViewOptOut opts out both video traffic, as well as * display ads, from Verification and ActiveView. */ videoActiveViewOptOut: boolean; /** * A collection of settings which affect video creatives served through this * placement. Applicable to placements with IN_STREAM_VIDEO compatibility. */ videoSettings: Schema$VideoSettings; /** * VPAID adapter setting for this placement. Controls which VPAID format the * measurement adapter will use for in-stream video creatives assigned to this * placement. Note: Flash is no longer supported. This field now defaults to * HTML5 when the following values are provided: FLASH, BOTH. */ vpaidAdapterChoice: string; } /** * Placement Assignment. */ export interface Schema$PlacementAssignment { /** * Whether this placement assignment is active. When true, the placement will * be included in the ad's rotation. */ active: boolean; /** * ID of the placement to be assigned. This is a required field. */ placementId: string; /** * Dimension value for the ID of the placement. This is a read-only, * auto-generated field. */ placementIdDimensionValue: Schema$DimensionValue; /** * Whether the placement to be assigned requires SSL. This is a read-only * field that is auto-generated when the ad is inserted or updated. */ sslRequired: boolean; } /** * Contains properties of a package or roadblock. */ export interface Schema$PlacementGroup { /** * Account ID of this placement group. This is a read-only field that can be * left blank. */ accountId: string; /** * Advertiser ID of this placement group. 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 placement group is archived. */ archived: boolean; /** * Campaign ID of this placement group. This field is required on insertion. */ campaignId: string; /** * Dimension value for the ID of the campaign. This is a read-only, * auto-generated field. */ campaignIdDimensionValue: Schema$DimensionValue; /** * IDs of placements which are assigned to this placement group. This is a * read-only, auto-generated field. */ childPlacementIds: string[]; /** * Comments for this placement group. */ comment: string; /** * ID of the content category assigned to this placement group. */ contentCategoryId: string; /** * Information about the creation of this placement group. This is a read-only * field. */ createInfo: Schema$LastModifiedInfo; /** * Directory site ID associated with this placement group. On insert, you must * set either this field or the site_id field to specify the site associated * with this placement group. This is a required field that is read-only after * insertion. */ directorySiteId: string; /** * Dimension value for the ID of the directory site. This is a read-only, * auto-generated field. */ directorySiteIdDimensionValue: Schema$DimensionValue; /** * External ID for this placement. */ externalId: string; /** * ID of this placement group. This is a read-only, auto-generated field. */ id: string; /** * Dimension value for the ID of this placement group. This is a read-only, * auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#placementGroup". */ kind: string; /** * Information about the most recent modification of this placement group. * This is a read-only field. */ lastModifiedInfo: Schema$LastModifiedInfo; /** * Name of this placement group. This is a required field and must be less * than 256 characters long. */ name: string; /** * Type of this placement group. A package is a simple group of placements * that acts as a single pricing point for a group of tags. A roadblock is a * group of placements that not only acts as a single pricing point, but also * assumes that all the tags in it will be served at the same time. A * roadblock requires one of its assigned placements to be marked as primary * for reporting. This field is required on insertion. */ placementGroupType: string; /** * ID of the placement strategy assigned to this placement group. */ placementStrategyId: string; /** * Pricing schedule of this placement group. This field is required on * insertion. */ pricingSchedule: Schema$PricingSchedule; /** * ID of the primary placement, used to calculate the media cost of a * roadblock (placement group). Modifying this field will automatically modify * the primary field on all affected roadblock child placements. */ primaryPlacementId: string; /** * Dimension value for the ID of the primary placement. This is a read-only, * auto-generated field. */ primaryPlacementIdDimensionValue: Schema$DimensionValue; /** * Site ID associated with this placement group. On insert, you must set * either this field or the directorySiteId field to specify the site * associated with this placement group. This is a required field that is * read-only after insertion. */ siteId: string; /** * Dimension value for the ID of the site. This is a read-only, auto-generated * field. */ siteIdDimensionValue: Schema$DimensionValue; /** * Subaccount ID of this placement group. This is a read-only field that can * be left blank. */ subaccountId: string; } /** * Placement Group List Response */ export interface Schema$PlacementGroupsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#placementGroupsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Placement group collection. */ placementGroups: Schema$PlacementGroup[]; } /** * Placement GenerateTags Response */ export interface Schema$PlacementsGenerateTagsResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#placementsGenerateTagsResponse". */ kind: string; /** * Set of generated tags for the specified placements. */ placementTags: Schema$PlacementTag[]; } /** * Placement List Response */ export interface Schema$PlacementsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#placementsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Placement collection. */ placements: Schema$Placement[]; } /** * Placement Strategy List Response */ export interface Schema$PlacementStrategiesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#placementStrategiesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Placement strategy collection. */ placementStrategies: Schema$PlacementStrategy[]; } /** * Contains properties of a placement strategy. */ export interface Schema$PlacementStrategy { /** * Account ID of this placement strategy.This is a read-only field that can be * left blank. */ accountId: string; /** * ID of this placement strategy. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#placementStrategy". */ kind: string; /** * Name of this placement strategy. This is a required field. It must be less * than 256 characters long and unique among placement strategies of the same * account. */ name: string; } /** * Placement Tag */ export interface Schema$PlacementTag { /** * Placement ID */ placementId: string; /** * Tags generated for this placement. */ tagDatas: Schema$TagData[]; } /** * Contains information about a platform type that can be targeted by ads. */ export interface Schema$PlatformType { /** * ID of this platform type. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#platformType". */ kind: string; /** * Name of this platform type. */ name: string; } /** * Platform Type List Response */ export interface Schema$PlatformTypesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#platformTypesListResponse". */ kind: string; /** * Platform type collection. */ platformTypes: Schema$PlatformType[]; } /** * Popup Window Properties. */ export interface Schema$PopupWindowProperties { /** * Popup dimension for a creative. This is a read-only field. Applicable to * the following creative types: all RICH_MEDIA and all VPAID */ dimension: Schema$Size; /** * Upper-left corner coordinates of the popup window. Applicable if * positionType is COORDINATES. */ offset: Schema$OffsetPosition; /** * Popup window position either centered or at specific coordinate. */ positionType: string; /** * Whether to display the browser address bar. */ showAddressBar: boolean; /** * Whether to display the browser menu bar. */ showMenuBar: boolean; /** * Whether to display the browser scroll bar. */ showScrollBar: boolean; /** * Whether to display the browser status bar. */ showStatusBar: boolean; /** * Whether to display the browser tool bar. */ showToolBar: boolean; /** * Title of popup window. */ title: string; } /** * Contains information about a postal code that can be targeted by ads. */ export interface Schema$PostalCode { /** * Postal code. This is equivalent to the id field. */ code: string; /** * Country code of the country to which this postal code belongs. */ countryCode: string; /** * DART ID of the country to which this postal code belongs. */ countryDartId: string; /** * ID of this postal code. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#postalCode". */ kind: string; } /** * Postal Code List Response */ export interface Schema$PostalCodesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#postalCodesListResponse". */ kind: string; /** * Postal code collection. */ postalCodes: Schema$PostalCode[]; } /** * Pricing Information */ export interface Schema$Pricing { /** * Cap cost type of this inventory item. */ capCostType: string; /** * End date of this inventory item. */ endDate: string; /** * Flights of this inventory item. A flight (a.k.a. pricing period) represents * the inventory item pricing information for a specific period of time. */ flights: Schema$Flight[]; /** * Group type of this inventory item if it represents a placement group. Is * null otherwise. There are two type of placement groups: * PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items * that acts as a single pricing point for a group of tags. * PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that * not only acts as a single pricing point, but also assumes that all the tags * in it will be served at the same time. A roadblock requires one of its * assigned inventory items to be marked as primary. */ groupType: string; /** * Pricing type of this inventory item. */ pricingType: string; /** * Start date of this inventory item. */ startDate: string; } /** * Pricing Schedule */ export interface Schema$PricingSchedule { /** * Placement cap cost option. */ capCostOption: string; /** * Whether cap costs are ignored by ad serving. */ disregardOverdelivery: boolean; /** * Placement end date. This date must be later than, or the same day as, the * placement start date, but not later than the campaign end date. If, for * example, you set 6/25/2015 as both the start and end dates, the effective * placement 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 field is required on insertion. */ endDate: string; /** * Whether this placement is flighted. If true, pricing periods will be * computed automatically. */ flighted: boolean; /** * Floodlight activity ID associated with this placement. This field should be * set when placement pricing type is set to PRICING_TYPE_CPA. */ floodlightActivityId: string; /** * Pricing periods for this placement. */ pricingPeriods: Schema$PricingSchedulePricingPeriod[]; /** * Placement pricing type. This field is required on insertion. */ pricingType: string; /** * Placement start date. This date must be later than, or the same day as, the * campaign start date. The hours, minutes, and seconds of the start date * should not be set, as doing so will result in an error. This field is * required on insertion. */ startDate: string; /** * Testing start date of this placement. The hours, minutes, and seconds of * the start date should not be set, as doing so will result in an error. */ testingStartDate: string; } /** * Pricing Period */ export interface Schema$PricingSchedulePricingPeriod { /** * Pricing period end date. This date must be later than, or the same day as, * the pricing period start date, but not later than the placement end date. * The period end date can be the same date as the period start date. If, for * example, you set 6/25/2015 as both the start and end dates, the effective * pricing period 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. */ endDate: string; /** * Comments for this pricing period. */ pricingComment: string; /** * Rate or cost of this pricing period in nanos (i.e., multipled by * 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. */ rateOrCostNanos: string; /** * Pricing period start date. This date must be later than, or the same day * as, the placement start date. The hours, minutes, and seconds of the start * date should not be set, as doing so will result in an error. */ startDate: string; /** * Units of this pricing period. Acceptable values are 0 to 10000000000, * inclusive. */ units: string; } /** * Contains properties of a DoubleClick Planning project. */ export interface Schema$Project { /** * Account ID of this project. */ accountId: string; /** * Advertiser ID of this project. */ advertiserId: string; /** * Audience age group of this project. */ audienceAgeGroup: string; /** * Audience gender of this project. */ audienceGender: string; /** * Budget of this project in the currency specified by the current account. * The value stored in this field represents only the non-fractional amount. * For example, for USD, the smallest value that can be represented by this * field is 1 US dollar. */ budget: string; /** * Client billing code of this project. */ clientBillingCode: string; /** * Name of the project client. */ clientName: string; /** * End date of the project. */ endDate: string; /** * ID of this project. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#project". */ kind: string; /** * Information about the most recent modification of this project. */ lastModifiedInfo: Schema$LastModifiedInfo; /** * Name of this project. */ name: string; /** * Overview of this project. */ overview: string; /** * Start date of the project. */ startDate: string; /** * Subaccount ID of this project. */ subaccountId: string; /** * Number of clicks that the advertiser is targeting. */ targetClicks: string; /** * Number of conversions that the advertiser is targeting. */ targetConversions: string; /** * CPA that the advertiser is targeting. */ targetCpaNanos: string; /** * CPC that the advertiser is targeting. */ targetCpcNanos: string; /** * vCPM from Active View that the advertiser is targeting. */ targetCpmActiveViewNanos: string; /** * CPM that the advertiser is targeting. */ targetCpmNanos: string; /** * Number of impressions that the advertiser is targeting. */ targetImpressions: string; } /** * Project List Response */ export interface Schema$ProjectsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#projectsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Project collection. */ projects: Schema$Project[]; } /** * Represents fields that are compatible to be selected for a report of type * "REACH". */ export interface Schema$ReachReportCompatibleFields { /** * Dimensions which are compatible to be selected in the * "dimensionFilters" section of the report. */ dimensionFilters: Schema$Dimension[]; /** * Dimensions which are compatible to be selected in the * "dimensions" section of the report. */ dimensions: Schema$Dimension[]; /** * The kind of resource this is, in this case * dfareporting#reachReportCompatibleFields. */ kind: string; /** * Metrics which are compatible to be selected in the "metricNames" * section of the report. */ metrics: Schema$Metric[]; /** * Metrics which are compatible to be selected as activity metrics to pivot on * in the "activities" section of the report. */ pivotedActivityMetrics: Schema$Metric[]; /** * Metrics which are compatible to be selected in the * "reachByFrequencyMetricNames" section of the report. */ reachByFrequencyMetrics: Schema$Metric[]; } /** * Represents a recipient. */ export interface Schema$Recipient { /** * The delivery type for the recipient. */ deliveryType: string; /** * The email address of the recipient. */ email: string; /** * The kind of resource this is, in this case dfareporting#recipient. */ kind: string; } /** * Contains information about a region that can be targeted by ads. */ export interface Schema$Region { /** * Country code of the country to which this region belongs. */ countryCode: string; /** * DART ID of the country to which this region belongs. */ countryDartId: string; /** * DART ID of this region. */ dartId: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#region". */ kind: string; /** * Name of this region. */ name: string; /** * Region code. */ regionCode: string; } /** * Region List Response */ export interface Schema$RegionsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#regionsListResponse". */ kind: string; /** * Region collection. */ regions: Schema$Region[]; } /** * 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. */ export interface Schema$RemarketingList { /** * Account ID of this remarketing list. This is a read-only, auto-generated * field that is only returned in GET requests. */ accountId: string; /** * Whether this remarketing list is active. */ active: boolean; /** * Dimension value for the advertiser ID that owns this remarketing list. This * is a required field. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. This is a read-only, * auto-generated field. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Remarketing list description. */ description: string; /** * Remarketing list ID. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#remarketingList". */ kind: string; /** * Number of days that a user should remain in the remarketing list without an * impression. Acceptable values are 1 to 540, inclusive. */ lifeSpan: string; /** * Rule used to populate the remarketing list with users. */ listPopulationRule: Schema$ListPopulationRule; /** * Number of users currently in the list. This is a read-only field. */ listSize: string; /** * Product from which this remarketing list was originated. */ listSource: string; /** * Name of the remarketing list. This is a required field. Must be no greater * than 128 characters long. */ name: string; /** * Subaccount ID of this remarketing list. This is a read-only, auto-generated * field that is only returned in GET requests. */ subaccountId: string; } /** * 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. */ export interface Schema$RemarketingListShare { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#remarketingListShare". */ kind: string; /** * Remarketing list ID. This is a read-only, auto-generated field. */ remarketingListId: string; /** * Accounts that the remarketing list is shared with. */ sharedAccountIds: string[]; /** * Advertisers that the remarketing list is shared with. */ sharedAdvertiserIds: string[]; } /** * Remarketing list response */ export interface Schema$RemarketingListsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#remarketingListsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Remarketing list collection. */ remarketingLists: Schema$RemarketingList[]; } /** * Represents a Report resource. */ export interface Schema$Report { /** * The account ID to which this report belongs. */ accountId: string; /** * The report criteria for a report of type "STANDARD". */ criteria: any; /** * The report criteria for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachCriteria: any; /** * The report's email delivery settings. */ delivery: any; /** * The eTag of this response for caching purposes. */ etag: string; /** * The filename used when generating report files for this report. */ fileName: string; /** * The report criteria for a report of type "FLOODLIGHT". */ floodlightCriteria: any; /** * The output format of the report. If not specified, default format is * "CSV". Note that the actual format in the completed report file * might differ if for instance the report's size exceeds the format's * capabilities. "CSV" will then be the fallback format. */ format: string; /** * The unique ID identifying this report resource. */ id: string; /** * The kind of resource this is, in this case dfareporting#report. */ kind: string; /** * The timestamp (in milliseconds since epoch) of when this report was last * modified. */ lastModifiedTime: string; /** * The name of the report. */ name: string; /** * The user profile id of the owner of this report. */ ownerProfileId: string; /** * The report criteria for a report of type "PATH_TO_CONVERSION". */ pathToConversionCriteria: any; /** * The report criteria for a report of type "REACH". */ reachCriteria: any; /** * The report's schedule. Can only be set if the report's * 'dateRange' is a relative date range and the relative date range is * not "TODAY". */ schedule: any; /** * The subaccount ID to which this report belongs if applicable. */ subAccountId: string; /** * The type of the report. */ type: string; } /** * Represents fields that are compatible to be selected for a report of type * "STANDARD". */ export interface Schema$ReportCompatibleFields { /** * Dimensions which are compatible to be selected in the * "dimensionFilters" section of the report. */ dimensionFilters: Schema$Dimension[]; /** * Dimensions which are compatible to be selected in the * "dimensions" section of the report. */ dimensions: Schema$Dimension[]; /** * The kind of resource this is, in this case * dfareporting#reportCompatibleFields. */ kind: string; /** * Metrics which are compatible to be selected in the "metricNames" * section of the report. */ metrics: Schema$Metric[]; /** * Metrics which are compatible to be selected as activity metrics to pivot on * in the "activities" section of the report. */ pivotedActivityMetrics: Schema$Metric[]; } /** * Represents the list of reports. */ export interface Schema$ReportList { /** * The eTag of this response for caching purposes. */ etag: string; /** * The reports returned in this response. */ items: Schema$Report[]; /** * The kind of list this is, in this case dfareporting#reportList. */ kind: string; /** * Continuation token used to page through reports. To retrieve the next page * of results, set the next request's "pageToken" to the value * of this field. The page token is only valid for a limited amount of time * and should not be persisted. */ nextPageToken: string; } /** * Reporting Configuration */ export interface Schema$ReportsConfiguration { /** * Whether the exposure to conversion report is enabled. This report shows * detailed pathway information on up to 10 of the most recent ad exposures * seen by a user before converting. */ exposureToConversionEnabled: boolean; /** * Default lookback windows for new advertisers in this account. */ lookbackConfiguration: Schema$LookbackConfiguration; /** * Report generation time zone ID of this account. This is a required field * that can only be changed by a superuser. Acceptable values are: - * "1" for "America/New_York" - "2" for * "Europe/London" - "3" for "Europe/Paris" - * "4" for "Africa/Johannesburg" - "5" for * "Asia/Jerusalem" - "6" for "Asia/Shanghai" * - "7" for "Asia/Hong_Kong" - "8" for * "Asia/Tokyo" - "9" for "Australia/Sydney" - * "10" for "Asia/Dubai" - "11" for * "America/Los_Angeles" - "12" for * "Pacific/Auckland" - "13" for * "America/Sao_Paulo" */ reportGenerationTimeZoneId: string; } /** * Rich Media Exit Override. */ export interface Schema$RichMediaExitOverride { /** * Click-through URL of this rich media exit override. Applicable if the * enabled field is set to true. */ clickThroughUrl: Schema$ClickThroughUrl; /** * Whether to use the clickThroughUrl. If false, the creative-level exit will * be used. */ enabled: boolean; /** * ID for the override to refer to a specific exit in the creative. */ exitId: string; } /** * A rule associates an asset with a targeting template for asset-level * targeting. Applicable to INSTREAM_VIDEO creatives. */ export interface Schema$Rule { /** * A creativeAssets[].id. This should refer to one of the parent assets in * this creative. This is a required field. */ assetId: string; /** * A user-friendly name for this rule. This is a required field. */ name: string; /** * A targeting template ID. The targeting from the targeting template will be * used to determine whether this asset should be served. This is a required * field. */ targetingTemplateId: string; } /** * Contains properties of a site. */ export interface Schema$Site { /** * Account ID of this site. This is a read-only field that can be left blank. */ accountId: string; /** * Whether this site is approved. */ approved: boolean; /** * Directory site associated with this site. This is a required field that is * read-only after insertion. */ directorySiteId: string; /** * Dimension value for the ID of the directory site. This is a read-only, * auto-generated field. */ directorySiteIdDimensionValue: Schema$DimensionValue; /** * ID of this site. This is a read-only, auto-generated field. */ id: string; /** * Dimension value for the ID of this site. This is a read-only, * auto-generated field. */ idDimensionValue: Schema$DimensionValue; /** * Key name of this site. This is a read-only, auto-generated field. */ keyName: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#site". */ kind: string; /** * Name of this site.This is a required field. Must be less than 128 * characters long. If this site is under a subaccount, the name must be * unique among sites of the same subaccount. Otherwise, this site is a * top-level site, and the name must be unique among top-level sites of the * same account. */ name: string; /** * Site contacts. */ siteContacts: Schema$SiteContact[]; /** * Site-wide settings. */ siteSettings: Schema$SiteSettings; /** * Subaccount ID of this site. This is a read-only field that can be left * blank. */ subaccountId: string; } /** * Site Contact */ export interface Schema$SiteContact { /** * Address of this site contact. */ address: string; /** * Site contact type. */ contactType: string; /** * Email address of this site contact. This is a required field. */ email: string; /** * First name of this site contact. */ firstName: string; /** * ID of this site contact. This is a read-only, auto-generated field. */ id: string; /** * Last name of this site contact. */ lastName: string; /** * Primary phone number of this site contact. */ phone: string; /** * Title or designation of this site contact. */ title: string; } /** * Site Settings */ export interface Schema$SiteSettings { /** * Whether active view creatives are disabled for this site. */ activeViewOptOut: boolean; /** * Whether this site opts out of ad blocking. When true, ad blocking is * disabled for all placements under the site, regardless of the individual * placement settings. When false, the campaign and placement settings take * effect. */ adBlockingOptOut: boolean; /** * Site-wide creative settings. */ creativeSettings: Schema$CreativeSettings; /** * Whether new cookies are disabled for this site. */ disableNewCookie: boolean; /** * Lookback window settings for this site. */ lookbackConfiguration: Schema$LookbackConfiguration; /** * Configuration settings for dynamic and image floodlight tags. */ tagSetting: Schema$TagSetting; /** * Whether Verification and ActiveView for in-stream video creatives are * disabled by default for new placements created under this site. This value * will be used to populate the placement.videoActiveViewOptOut field, when no * value is specified for the new placement. */ videoActiveViewOptOutTemplate: boolean; /** * Default VPAID adapter setting for new placements created under this site. * This value will be used to populate the placements.vpaidAdapterChoice * field, when no value is specified for the new placement. Controls which * VPAID format the measurement adapter will use for in-stream video creatives * assigned to the placement. The publisher's specifications will * typically determine this setting. For VPAID creatives, the adapter format * will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). * Note: Flash is no longer supported. This field now defaults to HTML5 when * the following values are provided: FLASH, BOTH. */ vpaidAdapterChoiceTemplate: string; } /** * Site List Response */ export interface Schema$SitesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#sitesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Site collection. */ sites: Schema$Site[]; } /** * Represents the dimensions of ads, placements, creatives, or creative assets. */ export interface Schema$Size { /** * Height of this size. Acceptable values are 0 to 32767, inclusive. */ height: number; /** * IAB standard size. This is a read-only, auto-generated field. */ iab: boolean; /** * ID of this size. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#size". */ kind: string; /** * Width of this size. Acceptable values are 0 to 32767, inclusive. */ width: number; } /** * Size List Response */ export interface Schema$SizesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#sizesListResponse". */ kind: string; /** * Size collection. */ sizes: Schema$Size[]; } /** * Skippable Settings */ export interface Schema$SkippableSetting { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#skippableSetting". */ kind: string; /** * Amount of time to play videos served to this placement before counting a * view. Applicable when skippable is true. */ progressOffset: Schema$VideoOffset; /** * Amount of time to play videos served to this placement before the skip * button should appear. Applicable when skippable is true. */ skipOffset: Schema$VideoOffset; /** * Whether the user can skip creatives served to this placement. */ skippable: boolean; } /** * Represents a sorted dimension. */ export interface Schema$SortedDimension { /** * The kind of resource this is, in this case dfareporting#sortedDimension. */ kind: string; /** * The name of the dimension. */ name: string; /** * An optional sort order for the dimension column. */ sortOrder: string; } /** * Contains properties of a DCM subaccount. */ export interface Schema$Subaccount { /** * ID of the account that contains this subaccount. This is a read-only field * that can be left blank. */ accountId: string; /** * IDs of the available user role permissions for this subaccount. */ availablePermissionIds: string[]; /** * ID of this subaccount. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#subaccount". */ kind: string; /** * Name of this subaccount. This is a required field. Must be less than 128 * characters long and be unique among subaccounts of the same account. */ name: string; } /** * Subaccount List Response */ export interface Schema$SubaccountsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#subaccountsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Subaccount collection. */ subaccounts: Schema$Subaccount[]; } /** * Placement Tag Data */ export interface Schema$TagData { /** * Ad associated with this placement tag. Applicable only when format is * PLACEMENT_TAG_TRACKING. */ adId: string; /** * Tag string to record a click. */ clickTag: string; /** * Creative associated with this placement tag. Applicable only when format is * PLACEMENT_TAG_TRACKING. */ creativeId: string; /** * TagData tag format of this tag. */ format: string; /** * Tag string for serving an ad. */ impressionTag: string; } /** * Tag Settings */ export interface Schema$TagSetting { /** * Additional key-values to be included in tags. Each key-value pair must be * of the form key=value, and pairs must be separated by a semicolon (;). Keys * and values must not contain commas. For example, id=2;color=red is a valid * value for this field. */ additionalKeyValues: string; /** * Whether static landing page URLs should be included in the tags. This * setting applies only to placements. */ includeClickThroughUrls: boolean; /** * Whether click-tracking string should be included in the tags. */ includeClickTracking: boolean; /** * Option specifying how keywords are embedded in ad tags. This setting can be * used to specify whether keyword placeholders are inserted in placement tags * for this site. Publishers can then add keywords to those placeholders. */ keywordOption: string; } /** * Dynamic and Image Tag Settings. */ export interface Schema$TagSettings { /** * Whether dynamic floodlight tags are enabled. */ dynamicTagEnabled: boolean; /** * Whether image tags are enabled. */ imageTagEnabled: boolean; } /** * Contains properties of a targetable remarketing list. Remarketing enables you * to create lists of users who have performed specific actions on a site, then * target ads to members of those lists. This resource is a read-only view of a * remarketing list to be used to faciliate targeting ads to specific lists. * Remarketing lists that are owned by your advertisers and those that are * shared to your advertisers or account are accessible via this resource. To * manage remarketing lists that are owned by your advertisers, use the * RemarketingLists resource. */ export interface Schema$TargetableRemarketingList { /** * Account ID of this remarketing list. This is a read-only, auto-generated * field that is only returned in GET requests. */ accountId: string; /** * Whether this targetable remarketing list is active. */ active: boolean; /** * Dimension value for the advertiser ID that owns this targetable remarketing * list. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Targetable remarketing list description. */ description: string; /** * Targetable remarketing list ID. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#targetableRemarketingList". */ kind: string; /** * Number of days that a user should remain in the targetable remarketing list * without an impression. */ lifeSpan: string; /** * Number of users currently in the list. This is a read-only field. */ listSize: string; /** * Product from which this targetable remarketing list was originated. */ listSource: string; /** * Name of the targetable remarketing list. Is no greater than 128 characters * long. */ name: string; /** * Subaccount ID of this remarketing list. This is a read-only, auto-generated * field that is only returned in GET requests. */ subaccountId: string; } /** * Targetable remarketing list response */ export interface Schema$TargetableRemarketingListsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#targetableRemarketingListsListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Targetable remarketing list collection. */ targetableRemarketingLists: Schema$TargetableRemarketingList[]; } /** * Contains properties of a targeting template. A targeting template * encapsulates targeting information which can be reused across multiple ads. */ export interface Schema$TargetingTemplate { /** * Account ID of this targeting template. This field, if left unset, will be * auto-generated on insert and is read-only after insert. */ accountId: string; /** * Advertiser ID of this targeting template. This is a required field on * insert and is read-only after insert. */ advertiserId: string; /** * Dimension value for the ID of the advertiser. This is a read-only, * auto-generated field. */ advertiserIdDimensionValue: Schema$DimensionValue; /** * Time and day targeting criteria. */ dayPartTargeting: Schema$DayPartTargeting; /** * Geographical targeting criteria. */ geoTargeting: Schema$GeoTargeting; /** * ID of this targeting template. This is a read-only, auto-generated field. */ id: string; /** * Key-value targeting criteria. */ keyValueTargetingExpression: Schema$KeyValueTargetingExpression; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#targetingTemplate". */ kind: string; /** * Language targeting criteria. */ languageTargeting: Schema$LanguageTargeting; /** * Remarketing list targeting criteria. */ listTargetingExpression: Schema$ListTargetingExpression; /** * Name of this targeting template. This field is required. It must be less * than 256 characters long and unique within an advertiser. */ name: string; /** * Subaccount ID of this targeting template. This field, if left unset, will * be auto-generated on insert and is read-only after insert. */ subaccountId: string; /** * Technology platform targeting criteria. */ technologyTargeting: Schema$TechnologyTargeting; } /** * Targeting Template List Response */ export interface Schema$TargetingTemplatesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#targetingTemplatesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * Targeting template collection. */ targetingTemplates: Schema$TargetingTemplate[]; } /** * Target Window. */ export interface Schema$TargetWindow { /** * User-entered value. */ customHtml: string; /** * Type of browser window for which the backup image of the flash creative can * be displayed. */ targetWindowOption: string; } /** * Technology Targeting. */ export interface Schema$TechnologyTargeting { /** * Browsers that this ad targets. For each browser either set browserVersionId * or dartId along with the version numbers. If both are specified, only * browserVersionId will be used. The other fields are populated automatically * when the ad is inserted or updated. */ browsers: Schema$Browser[]; /** * Connection types that this ad targets. For each connection type only id is * required. The other fields are populated automatically when the ad is * inserted or updated. */ connectionTypes: Schema$ConnectionType[]; /** * Mobile carriers that this ad targets. For each mobile carrier only id is * required, and the other fields are populated automatically when the ad is * inserted or updated. If targeting a mobile carrier, do not set targeting * for any zip codes. */ mobileCarriers: Schema$MobileCarrier[]; /** * Operating systems that this ad targets. To target specific versions, use * operatingSystemVersions. For each operating system only dartId is required. * The other fields are populated automatically when the ad is inserted or * updated. If targeting an operating system, do not set targeting for * operating system versions for the same operating system. */ operatingSystems: Schema$OperatingSystem[]; /** * Operating system versions that this ad targets. To target all versions, use * operatingSystems. For each operating system version, only id is required. * The other fields are populated automatically when the ad is inserted or * updated. If targeting an operating system version, do not set targeting for * the corresponding operating system in operatingSystems. */ operatingSystemVersions: Schema$OperatingSystemVersion[]; /** * Platform types that this ad targets. For example, desktop, mobile, or * tablet. For each platform type, only id is required, and the other fields * are populated automatically when the ad is inserted or updated. */ platformTypes: Schema$PlatformType[]; } /** * Third Party Authentication Token */ export interface Schema$ThirdPartyAuthenticationToken { /** * Name of the third-party authentication token. */ name: string; /** * Value of the third-party authentication token. This is a read-only, * auto-generated field. */ value: string; } /** * Third-party Tracking URL. */ export interface Schema$ThirdPartyTrackingUrl { /** * Third-party URL type for in-stream video creatives. */ thirdPartyUrlType: string; /** * URL for the specified third-party URL type. */ url: string; } /** * Transcode Settings */ export interface Schema$TranscodeSetting { /** * Whitelist of video formats to be served to this placement. Set this list to * null or empty to serve all video formats. */ enabledVideoFormats: number[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#transcodeSetting". */ kind: string; } /** * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following * creative types: INSTREAM_VIDEO and VPAID. */ export interface Schema$UniversalAdId { /** * Registry used for the Ad ID value. */ registry: string; /** * ID value for this creative. Only alphanumeric characters and the following * symbols are valid: "_/\-". Maximum length is 64 characters. Read * only when registry is DCM. */ value: string; } /** * User Defined Variable configuration. */ export interface Schema$UserDefinedVariableConfiguration { /** * Data type for the variable. This is a required field. */ dataType: string; /** * User-friendly name for the variable which will appear in reports. This is a * required field, must be less than 64 characters long, and cannot contain * the following characters: ""<>". */ reportName: string; /** * Variable name in the tag. This is a required field. */ variableType: string; } /** * Represents a UserProfile resource. */ export interface Schema$UserProfile { /** * The account ID to which this profile belongs. */ accountId: string; /** * The account name this profile belongs to. */ accountName: string; /** * The eTag of this response for caching purposes. */ etag: string; /** * The kind of resource this is, in this case dfareporting#userProfile. */ kind: string; /** * The unique ID of the user profile. */ profileId: string; /** * The sub account ID this profile belongs to if applicable. */ subAccountId: string; /** * The sub account name this profile belongs to if applicable. */ subAccountName: string; /** * The user name. */ userName: string; } /** * Represents the list of user profiles. */ export interface Schema$UserProfileList { /** * The eTag of this response for caching purposes. */ etag: string; /** * The user profiles returned in this response. */ items: Schema$UserProfile[]; /** * The kind of list this is, in this case dfareporting#userProfileList. */ kind: string; } /** * Contains properties of auser role, which is used to manage user access. */ export interface Schema$UserRole { /** * Account ID of this user role. This is a read-only field that can be left * blank. */ accountId: string; /** * Whether this is a default user role. Default user roles are created by the * system for the account/subaccount and cannot be modified or deleted. Each * default user role comes with a basic set of preassigned permissions. */ defaultUserRole: boolean; /** * ID of this user role. This is a read-only, auto-generated field. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#userRole". */ kind: string; /** * Name of this user role. This is a required field. Must be less than 256 * characters long. If this user role is under a subaccount, the name must be * unique among sites of the same subaccount. Otherwise, this user role is a * top-level user role, and the name must be unique among top-level user roles * of the same account. */ name: string; /** * ID of the user role that this user role is based on or copied from. This is * a required field. */ parentUserRoleId: string; /** * List of permissions associated with this user role. */ permissions: Schema$UserRolePermission[]; /** * Subaccount ID of this user role. This is a read-only field that can be left * blank. */ subaccountId: string; } /** * Contains properties of a user role permission. */ export interface Schema$UserRolePermission { /** * Levels of availability for a user role permission. */ availability: string; /** * ID of this user role permission. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#userRolePermission". */ kind: string; /** * Name of this user role permission. */ name: string; /** * ID of the permission group that this user role permission belongs to. */ permissionGroupId: string; } /** * Represents a grouping of related user role permissions. */ export interface Schema$UserRolePermissionGroup { /** * ID of this user role permission. */ id: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#userRolePermissionGroup". */ kind: string; /** * Name of this user role permission group. */ name: string; } /** * User Role Permission Group List Response */ export interface Schema$UserRolePermissionGroupsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#userRolePermissionGroupsListResponse". */ kind: string; /** * User role permission group collection. */ userRolePermissionGroups: Schema$UserRolePermissionGroup[]; } /** * User Role Permission List Response */ export interface Schema$UserRolePermissionsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#userRolePermissionsListResponse". */ kind: string; /** * User role permission collection. */ userRolePermissions: Schema$UserRolePermission[]; } /** * User Role List Response */ export interface Schema$UserRolesListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#userRolesListResponse". */ kind: string; /** * Pagination token to be used for the next list operation. */ nextPageToken: string; /** * User role collection. */ userRoles: Schema$UserRole[]; } /** * Contains information about supported video formats. */ export interface Schema$VideoFormat { /** * File type of the video format. */ fileType: string; /** * ID of the video format. */ id: number; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#videoFormat". */ kind: string; /** * The resolution of this video format. */ resolution: Schema$Size; /** * The target bit rate of this video format. */ targetBitRate: number; } /** * Video Format List Response */ export interface Schema$VideoFormatsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#videoFormatsListResponse". */ kind: string; /** * Video format collection. */ videoFormats: Schema$VideoFormat[]; } /** * Video Offset */ export interface Schema$VideoOffset { /** * Duration, as a percentage of video duration. Do not set when offsetSeconds * is set. Acceptable values are 0 to 100, inclusive. */ offsetPercentage: number; /** * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable * values are 0 to 86399, inclusive. */ offsetSeconds: number; } /** * Video Settings */ export interface Schema$VideoSettings { /** * Settings for the companion creatives of video creatives served to this * placement. */ companionSettings: Schema$CompanionSetting; /** * Identifies what kind of resource this is. Value: the fixed string * "dfareporting#videoSettings". */ kind: string; /** * Orientation of a video placement. If this value is set, placement will * return assets matching the specified orientation. */ orientation: string; /** * Settings for the skippability of video creatives served to this placement. * If this object is provided, the creative-level skippable settings will be * overridden. */ skippableSettings: Schema$SkippableSetting; /** * Settings for the transcodes of video creatives served to this placement. If * this object is provided, the creative-level transcode settings will be * overridden. */ transcodeSettings: Schema$TranscodeSetting; } export declare class Resource$Accountactiveadsummaries { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.accountActiveAdSummaries.get * @desc Gets the account's active ad summary by account ID. * @alias dfareporting.accountActiveAdSummaries.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.summaryAccountId Account ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Accountpermissiongroups { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.accountPermissionGroups.get * @desc Gets one account permission group by ID. * @alias dfareporting.accountPermissionGroups.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Account permission group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accountPermissionGroups.list * @desc Retrieves the list of account permission groups. * @alias dfareporting.accountPermissionGroups.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Accountpermissions { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.accountPermissions.get * @desc Gets one account permission by ID. * @alias dfareporting.accountPermissions.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Account permission ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accountPermissions.list * @desc Retrieves the list of account permissions. * @alias dfareporting.accountPermissions.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Accounts { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.accounts.get * @desc Gets one account by ID. * @alias dfareporting.accounts.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Account ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accounts.list * @desc Retrieves the list of accounts, possibly filtered. This method * supports paging. * @alias dfareporting.accounts.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.active Select only active accounts. Don't set this field to select both active and non-active accounts. * @param {string=} params.ids Select only accounts with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accounts.patch * @desc Updates an existing account. This method supports patch semantics. * @alias dfareporting.accounts.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Account ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Account} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accounts.update * @desc Updates an existing account. * @alias dfareporting.accounts.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Account} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Accountuserprofiles { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.accountUserProfiles.get * @desc Gets one account user profile by ID. * @alias dfareporting.accountUserProfiles.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id User profile ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accountUserProfiles.insert * @desc Inserts a new account user profile. * @alias dfareporting.accountUserProfiles.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().AccountUserProfile} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accountUserProfiles.list * @desc Retrieves a list of account user profiles, possibly filtered. This * method supports paging. * @alias dfareporting.accountUserProfiles.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.active Select only active user profiles. * @param {string=} params.ids Select only user profiles with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.subaccountId Select only user profiles with the specified subaccount ID. * @param {string=} params.userRoleId Select only user profiles with the specified user role ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accountUserProfiles.patch * @desc Updates an existing account user profile. This method supports patch * semantics. * @alias dfareporting.accountUserProfiles.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id User profile ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().AccountUserProfile} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.accountUserProfiles.update * @desc Updates an existing account user profile. * @alias dfareporting.accountUserProfiles.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().AccountUserProfile} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Ads { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.ads.get * @desc Gets one ad by ID. * @alias dfareporting.ads.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Ad ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.ads.insert * @desc Inserts a new ad. * @alias dfareporting.ads.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Ad} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.ads.list * @desc Retrieves a list of ads, possibly filtered. This method supports * paging. * @alias dfareporting.ads.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.active Select only active ads. * @param {string=} params.advertiserId Select only ads with this advertiser ID. * @param {boolean=} params.archived Select only archived ads. * @param {string=} params.audienceSegmentIds Select only ads with these audience segment IDs. * @param {string=} params.campaignIds Select only ads with these campaign IDs. * @param {string=} params.compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. * @param {string=} params.creativeIds Select only ads with these creative IDs assigned. * @param {string=} params.creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs. * @param {boolean=} params.dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. * @param {string=} params.ids Select only ads with these IDs. * @param {string=} params.landingPageIds Select only ads with these landing page IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.overriddenEventTagId Select only ads with this event tag override ID. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string=} params.placementIds Select only ads with these placement IDs assigned. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". * @param {string=} params.sizeIds Select only ads with these size IDs. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {boolean=} params.sslCompliant Select only ads that are SSL-compliant. * @param {boolean=} params.sslRequired Select only ads that require SSL. * @param {string=} params.type Select only ads with these types. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.ads.patch * @desc Updates an existing ad. This method supports patch semantics. * @alias dfareporting.ads.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Ad ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Ad} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.ads.update * @desc Updates an existing ad. * @alias dfareporting.ads.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Ad} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Advertisergroups { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.advertiserGroups.delete * @desc Deletes an existing advertiser group. * @alias dfareporting.advertiserGroups.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Advertiser group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserGroups.get * @desc Gets one advertiser group by ID. * @alias dfareporting.advertiserGroups.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Advertiser group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserGroups.insert * @desc Inserts a new advertiser group. * @alias dfareporting.advertiserGroups.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().AdvertiserGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserGroups.list * @desc Retrieves a list of advertiser groups, possibly filtered. This method * supports paging. * @alias dfareporting.advertiserGroups.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Select only advertiser groups with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserGroups.patch * @desc Updates an existing advertiser group. This method supports patch * semantics. * @alias dfareporting.advertiserGroups.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Advertiser group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().AdvertiserGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserGroups.update * @desc Updates an existing advertiser group. * @alias dfareporting.advertiserGroups.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().AdvertiserGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Advertiserlandingpages { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.advertiserLandingPages.get * @desc Gets one landing page by ID. * @alias dfareporting.advertiserLandingPages.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Landing page ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserLandingPages.insert * @desc Inserts a new landing page. * @alias dfareporting.advertiserLandingPages.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().LandingPage} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserLandingPages.list * @desc Retrieves a list of landing pages. * @alias dfareporting.advertiserLandingPages.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserIds Select only landing pages that belong to these advertisers. * @param {boolean=} params.archived Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. * @param {string=} params.ids Select only landing pages with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.subaccountId Select only landing pages that belong to this subaccount. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserLandingPages.patch * @desc Updates an existing landing page. This method supports patch * semantics. * @alias dfareporting.advertiserLandingPages.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Landing page ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().LandingPage} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertiserLandingPages.update * @desc Updates an existing landing page. * @alias dfareporting.advertiserLandingPages.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().LandingPage} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Advertisers { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.advertisers.get * @desc Gets one advertiser by ID. * @alias dfareporting.advertisers.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Advertiser ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertisers.insert * @desc Inserts a new advertiser. * @alias dfareporting.advertisers.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Advertiser} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertisers.list * @desc Retrieves a list of advertisers, possibly filtered. This method * supports paging. * @alias dfareporting.advertisers.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserGroupIds Select only advertisers with these advertiser group IDs. * @param {string=} params.floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs. * @param {string=} params.ids Select only advertisers with these IDs. * @param {boolean=} params.includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group. * @param {integer=} params.maxResults Maximum number of results to return. * @param {boolean=} params.onlyParent Select only advertisers which use another advertiser's floodlight configuration. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.status Select only advertisers with the specified status. * @param {string=} params.subaccountId Select only advertisers with these subaccount IDs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertisers.patch * @desc Updates an existing advertiser. This method supports patch semantics. * @alias dfareporting.advertisers.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Advertiser ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Advertiser} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.advertisers.update * @desc Updates an existing advertiser. * @alias dfareporting.advertisers.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Advertiser} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Browsers { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.browsers.list * @desc Retrieves a list of browsers. * @alias dfareporting.browsers.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Campaigncreativeassociations { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.campaignCreativeAssociations.insert * @desc Associates a creative with the specified campaign. This method * creates a default ad with dimensions matching the creative in the campaign * if such a default ad does not exist already. * @alias dfareporting.campaignCreativeAssociations.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.campaignId Campaign ID in this association. * @param {string} params.profileId User profile ID associated with this request. * @param {().CampaignCreativeAssociation} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.campaignCreativeAssociations.list * @desc Retrieves the list of creative IDs associated with the specified * campaign. This method supports paging. * @alias dfareporting.campaignCreativeAssociations.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.campaignId Campaign ID in this association. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Campaigns { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.campaigns.get * @desc Gets one campaign by ID. * @alias dfareporting.campaigns.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Campaign ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.campaigns.insert * @desc Inserts a new campaign. * @alias dfareporting.campaigns.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Campaign} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.campaigns.list * @desc Retrieves a list of campaigns, possibly filtered. This method * supports paging. * @alias dfareporting.campaigns.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups. * @param {string=} params.advertiserIds Select only campaigns that belong to these advertisers. * @param {boolean=} params.archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. * @param {boolean=} params.atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity. * @param {string=} params.excludedIds Exclude campaigns with these IDs. * @param {string=} params.ids Select only campaigns with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.overriddenEventTagId Select only campaigns that have overridden this event tag ID. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.subaccountId Select only campaigns that belong to this subaccount. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.campaigns.patch * @desc Updates an existing campaign. This method supports patch semantics. * @alias dfareporting.campaigns.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Campaign ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Campaign} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.campaigns.update * @desc Updates an existing campaign. * @alias dfareporting.campaigns.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Campaign} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Changelogs { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.changeLogs.get * @desc Gets one change log by ID. * @alias dfareporting.changeLogs.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Change log ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.changeLogs.list * @desc Retrieves a list of change logs. This method supports paging. * @alias dfareporting.changeLogs.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.action Select only change logs with the specified action. * @param {string=} params.ids Select only change logs with these IDs. * @param {string=} params.maxChangeTime Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.minChangeTime Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. * @param {string=} params.objectIds Select only change logs with these object IDs. * @param {string=} params.objectType Select only change logs with the specified object type. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Select only change logs whose object ID, user name, old or new values match the search string. * @param {string=} params.userProfileIds Select only change logs with these user profile IDs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Cities { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.cities.list * @desc Retrieves a list of cities, possibly filtered. * @alias dfareporting.cities.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.countryDartIds Select only cities from these countries. * @param {string=} params.dartIds Select only cities with these DART IDs. * @param {string=} params.namePrefix Select only cities with names starting with this prefix. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.regionDartIds Select only cities from these regions. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Connectiontypes { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.connectionTypes.get * @desc Gets one connection type by ID. * @alias dfareporting.connectionTypes.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Connection type ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.connectionTypes.list * @desc Retrieves a list of connection types. * @alias dfareporting.connectionTypes.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Contentcategories { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.contentCategories.delete * @desc Deletes an existing content category. * @alias dfareporting.contentCategories.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Content category ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.contentCategories.get * @desc Gets one content category by ID. * @alias dfareporting.contentCategories.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Content category ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.contentCategories.insert * @desc Inserts a new content category. * @alias dfareporting.contentCategories.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().ContentCategory} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.contentCategories.list * @desc Retrieves a list of content categories, possibly filtered. This * method supports paging. * @alias dfareporting.contentCategories.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Select only content categories with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.contentCategories.patch * @desc Updates an existing content category. This method supports patch * semantics. * @alias dfareporting.contentCategories.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Content category ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().ContentCategory} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.contentCategories.update * @desc Updates an existing content category. * @alias dfareporting.contentCategories.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().ContentCategory} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Conversions { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.conversions.batchinsert * @desc Inserts conversions. * @alias dfareporting.conversions.batchinsert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().ConversionsBatchInsertRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ batchinsert(params?: any, options?: MethodOptions): AxiosPromise; batchinsert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.conversions.batchupdate * @desc Updates existing conversions. * @alias dfareporting.conversions.batchupdate * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().ConversionsBatchUpdateRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ batchupdate(params?: any, options?: MethodOptions): AxiosPromise; batchupdate(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Countries { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.countries.get * @desc Gets one country by ID. * @alias dfareporting.countries.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.dartId Country DART ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.countries.list * @desc Retrieves a list of countries. * @alias dfareporting.countries.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Creativeassets { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.creativeAssets.insert * @desc Inserts a new creative asset. * @alias dfareporting.creativeAssets.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.advertiserId Advertiser ID of this creative. This is a required field. * @param {string} params.profileId User profile ID associated with this request. * @param {object} params.resource Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Creativefields { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.creativeFields.delete * @desc Deletes an existing creative field. * @alias dfareporting.creativeFields.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Creative Field ID * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFields.get * @desc Gets one creative field by ID. * @alias dfareporting.creativeFields.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Creative Field ID * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFields.insert * @desc Inserts a new creative field. * @alias dfareporting.creativeFields.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeField} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFields.list * @desc Retrieves a list of creative fields, possibly filtered. This method * supports paging. * @alias dfareporting.creativeFields.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserIds Select only creative fields that belong to these advertisers. * @param {string=} params.ids Select only creative fields with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFields.patch * @desc Updates an existing creative field. This method supports patch * semantics. * @alias dfareporting.creativeFields.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Creative Field ID * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeField} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFields.update * @desc Updates an existing creative field. * @alias dfareporting.creativeFields.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeField} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Creativefieldvalues { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.creativeFieldValues.delete * @desc Deletes an existing creative field value. * @alias dfareporting.creativeFieldValues.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.creativeFieldId Creative field ID for this creative field value. * @param {string} params.id Creative Field Value ID * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFieldValues.get * @desc Gets one creative field value by ID. * @alias dfareporting.creativeFieldValues.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.creativeFieldId Creative field ID for this creative field value. * @param {string} params.id Creative Field Value ID * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFieldValues.insert * @desc Inserts a new creative field value. * @alias dfareporting.creativeFieldValues.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.creativeFieldId Creative field ID for this creative field value. * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeFieldValue} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFieldValues.list * @desc Retrieves a list of creative field values, possibly filtered. This * method supports paging. * @alias dfareporting.creativeFieldValues.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.creativeFieldId Creative field ID for this creative field value. * @param {string=} params.ids Select only creative field values with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFieldValues.patch * @desc Updates an existing creative field value. This method supports patch * semantics. * @alias dfareporting.creativeFieldValues.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.creativeFieldId Creative field ID for this creative field value. * @param {string} params.id Creative Field Value ID * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeFieldValue} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeFieldValues.update * @desc Updates an existing creative field value. * @alias dfareporting.creativeFieldValues.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.creativeFieldId Creative field ID for this creative field value. * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeFieldValue} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Creativegroups { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.creativeGroups.get * @desc Gets one creative group by ID. * @alias dfareporting.creativeGroups.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Creative group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeGroups.insert * @desc Inserts a new creative group. * @alias dfareporting.creativeGroups.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeGroups.list * @desc Retrieves a list of creative groups, possibly filtered. This method * supports paging. * @alias dfareporting.creativeGroups.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserIds Select only creative groups that belong to these advertisers. * @param {integer=} params.groupNumber Select only creative groups that belong to this subgroup. * @param {string=} params.ids Select only creative groups with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeGroups.patch * @desc Updates an existing creative group. This method supports patch * semantics. * @alias dfareporting.creativeGroups.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Creative group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creativeGroups.update * @desc Updates an existing creative group. * @alias dfareporting.creativeGroups.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().CreativeGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Creatives { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.creatives.get * @desc Gets one creative by ID. * @alias dfareporting.creatives.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Creative ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creatives.insert * @desc Inserts a new creative. * @alias dfareporting.creatives.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Creative} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creatives.list * @desc Retrieves a list of creatives, possibly filtered. This method * supports paging. * @alias dfareporting.creatives.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.active Select only active creatives. Leave blank to select active and inactive creatives. * @param {string=} params.advertiserId Select only creatives with this advertiser ID. * @param {boolean=} params.archived Select only archived creatives. Leave blank to select archived and unarchived creatives. * @param {string=} params.campaignId Select only creatives with this campaign ID. * @param {string=} params.companionCreativeIds Select only in-stream video creatives with these companion IDs. * @param {string=} params.creativeFieldIds Select only creatives with these creative field IDs. * @param {string=} params.ids Select only creatives with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.renderingIds Select only creatives with these rendering IDs. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". * @param {string=} params.sizeIds Select only creatives with these size IDs. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.studioCreativeId Select only creatives corresponding to this Studio creative ID. * @param {string=} params.types Select only creatives with these creative types. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creatives.patch * @desc Updates an existing creative. This method supports patch semantics. * @alias dfareporting.creatives.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Creative ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Creative} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.creatives.update * @desc Updates an existing creative. * @alias dfareporting.creatives.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Creative} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Dimensionvalues { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.dimensionValues.query * @desc Retrieves list of report dimension values for a list of filters. * @alias dfareporting.dimensionValues.query * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken The value of the nextToken from the previous result page. * @param {string} params.profileId The DFA user profile ID. * @param {().DimensionValueRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ query(params?: any, options?: MethodOptions): AxiosPromise; query(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Directorysitecontacts { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.directorySiteContacts.get * @desc Gets one directory site contact by ID. * @alias dfareporting.directorySiteContacts.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Directory site contact ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.directorySiteContacts.list * @desc Retrieves a list of directory site contacts, possibly filtered. This * method supports paging. * @alias dfareporting.directorySiteContacts.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.directorySiteIds Select only directory site contacts with these directory site IDs. This is a required field. * @param {string=} params.ids Select only directory site contacts with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Directorysites { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.directorySites.get * @desc Gets one directory site by ID. * @alias dfareporting.directorySites.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Directory site ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.directorySites.insert * @desc Inserts a new directory site. * @alias dfareporting.directorySites.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().DirectorySite} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.directorySites.list * @desc Retrieves a list of directory sites, possibly filtered. This method * supports paging. * @alias dfareporting.directorySites.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. * @param {boolean=} params.acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank. * @param {boolean=} params.active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. * @param {string=} params.countryId Select only directory sites with this country ID. * @param {string=} params.dfpNetworkCode Select only directory sites with this DFP network code. * @param {string=} params.ids Select only directory sites with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string=} params.parentId Select only directory sites with this parent ID. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Dynamictargetingkeys { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.dynamicTargetingKeys.delete * @desc Deletes an existing dynamic targeting key. * @alias dfareporting.dynamicTargetingKeys.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. * @param {string} params.objectId ID of the object of this dynamic targeting key. This is a required field. * @param {string} params.objectType Type of the object of this dynamic targeting key. This is a required field. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.dynamicTargetingKeys.insert * @desc Inserts a new dynamic targeting key. Keys must be created at the * advertiser level before being assigned to the advertiser's ads, creatives, * or placements. There is a maximum of 1000 keys per advertiser, out of which * a maximum of 20 keys can be assigned per ad, creative, or placement. * @alias dfareporting.dynamicTargetingKeys.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().DynamicTargetingKey} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.dynamicTargetingKeys.list * @desc Retrieves a list of dynamic targeting keys. * @alias dfareporting.dynamicTargetingKeys.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserId Select only dynamic targeting keys whose object has this advertiser ID. * @param {string=} params.names Select only dynamic targeting keys exactly matching these names. * @param {string=} params.objectId Select only dynamic targeting keys with this object ID. * @param {string=} params.objectType Select only dynamic targeting keys with this object type. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Eventtags { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.eventTags.delete * @desc Deletes an existing event tag. * @alias dfareporting.eventTags.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Event tag ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.eventTags.get * @desc Gets one event tag by ID. * @alias dfareporting.eventTags.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Event tag ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.eventTags.insert * @desc Inserts a new event tag. * @alias dfareporting.eventTags.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().EventTag} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.eventTags.list * @desc Retrieves a list of event tags, possibly filtered. * @alias dfareporting.eventTags.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.adId Select only event tags that belong to this ad. * @param {string=} params.advertiserId Select only event tags that belong to this advertiser. * @param {string=} params.campaignId Select only event tags that belong to this campaign. * @param {boolean=} params.definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. * @param {boolean=} params.enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. * @param {string=} params.eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. * @param {string=} params.ids Select only event tags with these IDs. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.eventTags.patch * @desc Updates an existing event tag. This method supports patch semantics. * @alias dfareporting.eventTags.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Event tag ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().EventTag} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.eventTags.update * @desc Updates an existing event tag. * @alias dfareporting.eventTags.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().EventTag} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Files { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.files.get * @desc Retrieves a report file by its report ID and file ID. This method * supports media download. * @alias dfareporting.files.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the report file. * @param {string} params.reportId The ID of the report. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.files.list * @desc Lists files for a user profile. * @alias dfareporting.files.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken The value of the nextToken from the previous result page. * @param {string} params.profileId The DFA profile ID. * @param {string=} params.scope The scope that defines which results are returned. * @param {string=} params.sortField The field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Floodlightactivities { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.floodlightActivities.delete * @desc Deletes an existing floodlight activity. * @alias dfareporting.floodlightActivities.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Floodlight activity ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivities.generatetag * @desc Generates a tag for a floodlight activity. * @alias dfareporting.floodlightActivities.generatetag * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.floodlightActivityId Floodlight activity ID for which we want to generate a tag. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ generatetag(params?: any, options?: MethodOptions): AxiosPromise; generatetag(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivities.get * @desc Gets one floodlight activity by ID. * @alias dfareporting.floodlightActivities.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Floodlight activity ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivities.insert * @desc Inserts a new floodlight activity. * @alias dfareporting.floodlightActivities.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightActivity} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivities.list * @desc Retrieves a list of floodlight activities, possibly filtered. This * method supports paging. * @alias dfareporting.floodlightActivities.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. * @param {string=} params.floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs. * @param {string=} params.floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name. * @param {string=} params.floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string. * @param {string=} params.floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type. * @param {string=} params.floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. * @param {string=} params.ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.tagString Select only floodlight activities with the specified tag string. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivities.patch * @desc Updates an existing floodlight activity. This method supports patch * semantics. * @alias dfareporting.floodlightActivities.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Floodlight activity ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightActivity} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivities.update * @desc Updates an existing floodlight activity. * @alias dfareporting.floodlightActivities.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightActivity} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Floodlightactivitygroups { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.floodlightActivityGroups.get * @desc Gets one floodlight activity group by ID. * @alias dfareporting.floodlightActivityGroups.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Floodlight activity Group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivityGroups.insert * @desc Inserts a new floodlight activity group. * @alias dfareporting.floodlightActivityGroups.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightActivityGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivityGroups.list * @desc Retrieves a list of floodlight activity groups, possibly filtered. * This method supports paging. * @alias dfareporting.floodlightActivityGroups.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. * @param {string=} params.floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. * @param {string=} params.ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.type Select only floodlight activity groups with the specified floodlight activity group type. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivityGroups.patch * @desc Updates an existing floodlight activity group. This method supports * patch semantics. * @alias dfareporting.floodlightActivityGroups.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Floodlight activity Group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightActivityGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightActivityGroups.update * @desc Updates an existing floodlight activity group. * @alias dfareporting.floodlightActivityGroups.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightActivityGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Floodlightconfigurations { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.floodlightConfigurations.get * @desc Gets one floodlight configuration by ID. * @alias dfareporting.floodlightConfigurations.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Floodlight configuration ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightConfigurations.list * @desc Retrieves a list of floodlight configurations, possibly filtered. * @alias dfareporting.floodlightConfigurations.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightConfigurations.patch * @desc Updates an existing floodlight configuration. This method supports * patch semantics. * @alias dfareporting.floodlightConfigurations.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Floodlight configuration ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightConfiguration} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.floodlightConfigurations.update * @desc Updates an existing floodlight configuration. * @alias dfareporting.floodlightConfigurations.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().FloodlightConfiguration} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Inventoryitems { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.inventoryItems.get * @desc Gets one inventory item by ID. * @alias dfareporting.inventoryItems.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Inventory item ID. * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.projectId Project ID for order documents. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.inventoryItems.list * @desc Retrieves a list of inventory items, possibly filtered. This method * supports paging. * @alias dfareporting.inventoryItems.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Select only inventory items with these IDs. * @param {boolean=} params.inPlan Select only inventory items that are in plan. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.orderId Select only inventory items that belong to specified orders. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.projectId Project ID for order documents. * @param {string=} params.siteId Select only inventory items that are associated with these sites. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.type Select only inventory items with this type. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Languages { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.languages.list * @desc Retrieves a list of languages. * @alias dfareporting.languages.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Metros { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.metros.list * @desc Retrieves a list of metros. * @alias dfareporting.metros.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Mobilecarriers { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.mobileCarriers.get * @desc Gets one mobile carrier by ID. * @alias dfareporting.mobileCarriers.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Mobile carrier ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.mobileCarriers.list * @desc Retrieves a list of mobile carriers. * @alias dfareporting.mobileCarriers.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Operatingsystems { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.operatingSystems.get * @desc Gets one operating system by DART ID. * @alias dfareporting.operatingSystems.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.dartId Operating system DART ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.operatingSystems.list * @desc Retrieves a list of operating systems. * @alias dfareporting.operatingSystems.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Operatingsystemversions { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.operatingSystemVersions.get * @desc Gets one operating system version by ID. * @alias dfareporting.operatingSystemVersions.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Operating system version ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.operatingSystemVersions.list * @desc Retrieves a list of operating system versions. * @alias dfareporting.operatingSystemVersions.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Orderdocuments { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.orderDocuments.get * @desc Gets one order document by ID. * @alias dfareporting.orderDocuments.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Order document ID. * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.projectId Project ID for order documents. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.orderDocuments.list * @desc Retrieves a list of order documents, possibly filtered. This method * supports paging. * @alias dfareporting.orderDocuments.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.approved Select only order documents that have been approved by at least one user. * @param {string=} params.ids Select only order documents with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.orderId Select only order documents for specified orders. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.projectId Project ID for order documents. * @param {string=} params.searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". * @param {string=} params.siteId Select only order documents that are associated with these sites. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Orders { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.orders.get * @desc Gets one order by ID. * @alias dfareporting.orders.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Order ID. * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.projectId Project ID for orders. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.orders.list * @desc Retrieves a list of orders, possibly filtered. This method supports * paging. * @alias dfareporting.orders.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Select only orders with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.projectId Project ID for orders. * @param {string=} params.searchString Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". * @param {string=} params.siteId Select only orders that are associated with these site IDs. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Placementgroups { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.placementGroups.get * @desc Gets one placement group by ID. * @alias dfareporting.placementGroups.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Placement group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementGroups.insert * @desc Inserts a new placement group. * @alias dfareporting.placementGroups.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().PlacementGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementGroups.list * @desc Retrieves a list of placement groups, possibly filtered. This method * supports paging. * @alias dfareporting.placementGroups.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserIds Select only placement groups that belong to these advertisers. * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. * @param {string=} params.campaignIds Select only placement groups that belong to these campaigns. * @param {string=} params.contentCategoryIds Select only placement groups that are associated with these content categories. * @param {string=} params.directorySiteIds Select only placement groups that are associated with these directory sites. * @param {string=} params.ids Select only placement groups with these IDs. * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string=} params.placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. * @param {string=} params.placementStrategyIds Select only placement groups that are associated with these placement strategies. * @param {string=} params.pricingTypes Select only placement groups with these pricing types. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". * @param {string=} params.siteIds Select only placement groups that are associated with these sites. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementGroups.patch * @desc Updates an existing placement group. This method supports patch * semantics. * @alias dfareporting.placementGroups.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Placement group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().PlacementGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementGroups.update * @desc Updates an existing placement group. * @alias dfareporting.placementGroups.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().PlacementGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Placements { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.placements.generatetags * @desc Generates tags for a placement. * @alias dfareporting.placements.generatetags * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.campaignId Generate placements belonging to this campaign. This is a required field. * @param {string=} params.placementIds Generate tags for these placements. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ generatetags(params?: any, options?: MethodOptions): AxiosPromise; generatetags(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placements.get * @desc Gets one placement by ID. * @alias dfareporting.placements.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Placement ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placements.insert * @desc Inserts a new placement. * @alias dfareporting.placements.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Placement} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placements.list * @desc Retrieves a list of placements, possibly filtered. This method * supports paging. * @alias dfareporting.placements.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserIds Select only placements that belong to these advertisers. * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. * @param {string=} params.campaignIds Select only placements that belong to these campaigns. * @param {string=} params.compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices 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. * @param {string=} params.contentCategoryIds Select only placements that are associated with these content categories. * @param {string=} params.directorySiteIds Select only placements that are associated with these directory sites. * @param {string=} params.groupIds Select only placements that belong to these placement groups. * @param {string=} params.ids Select only placements with these IDs. * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string=} params.paymentSource Select only placements with this payment source. * @param {string=} params.placementStrategyIds Select only placements that are associated with these placement strategies. * @param {string=} params.pricingTypes Select only placements with these pricing types. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". * @param {string=} params.siteIds Select only placements that are associated with these sites. * @param {string=} params.sizeIds Select only placements that are associated with these sizes. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placements.patch * @desc Updates an existing placement. This method supports patch semantics. * @alias dfareporting.placements.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Placement ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Placement} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placements.update * @desc Updates an existing placement. * @alias dfareporting.placements.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Placement} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Placementstrategies { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.placementStrategies.delete * @desc Deletes an existing placement strategy. * @alias dfareporting.placementStrategies.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Placement strategy ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementStrategies.get * @desc Gets one placement strategy by ID. * @alias dfareporting.placementStrategies.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Placement strategy ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementStrategies.insert * @desc Inserts a new placement strategy. * @alias dfareporting.placementStrategies.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().PlacementStrategy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementStrategies.list * @desc Retrieves a list of placement strategies, possibly filtered. This * method supports paging. * @alias dfareporting.placementStrategies.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Select only placement strategies with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementStrategies.patch * @desc Updates an existing placement strategy. This method supports patch * semantics. * @alias dfareporting.placementStrategies.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Placement strategy ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().PlacementStrategy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.placementStrategies.update * @desc Updates an existing placement strategy. * @alias dfareporting.placementStrategies.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().PlacementStrategy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Platformtypes { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.platformTypes.get * @desc Gets one platform type by ID. * @alias dfareporting.platformTypes.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Platform type ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.platformTypes.list * @desc Retrieves a list of platform types. * @alias dfareporting.platformTypes.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Postalcodes { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.postalCodes.get * @desc Gets one postal code by ID. * @alias dfareporting.postalCodes.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.code Postal code ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.postalCodes.list * @desc Retrieves a list of postal codes. * @alias dfareporting.postalCodes.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Projects { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.projects.get * @desc Gets one project by ID. * @alias dfareporting.projects.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Project ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.projects.list * @desc Retrieves a list of projects, possibly filtered. This method supports * paging. * @alias dfareporting.projects.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserIds Select only projects with these advertiser IDs. * @param {string=} params.ids Select only projects with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Regions { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.regions.list * @desc Retrieves a list of regions. * @alias dfareporting.regions.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Remarketinglists { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.remarketingLists.get * @desc Gets one remarketing list by ID. * @alias dfareporting.remarketingLists.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Remarketing list ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.remarketingLists.insert * @desc Inserts a new remarketing list. * @alias dfareporting.remarketingLists.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().RemarketingList} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.remarketingLists.list * @desc Retrieves a list of remarketing lists, possibly filtered. This method * supports paging. * @alias dfareporting.remarketingLists.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.active Select only active or only inactive remarketing lists. * @param {string} params.advertiserId Select only remarketing lists owned by this advertiser. * @param {string=} params.floodlightActivityId Select only remarketing lists that have this floodlight activity ID. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.remarketingLists.patch * @desc Updates an existing remarketing list. This method supports patch * semantics. * @alias dfareporting.remarketingLists.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Remarketing list ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().RemarketingList} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.remarketingLists.update * @desc Updates an existing remarketing list. * @alias dfareporting.remarketingLists.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().RemarketingList} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Remarketinglistshares { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.remarketingListShares.get * @desc Gets one remarketing list share by remarketing list ID. * @alias dfareporting.remarketingListShares.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.remarketingListId Remarketing list ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.remarketingListShares.patch * @desc Updates an existing remarketing list share. This method supports * patch semantics. * @alias dfareporting.remarketingListShares.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {string} params.remarketingListId Remarketing list ID. * @param {().RemarketingListShare} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.remarketingListShares.update * @desc Updates an existing remarketing list share. * @alias dfareporting.remarketingListShares.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().RemarketingListShare} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Reports { root: Dfareporting; compatibleFields: Resource$Reports$Compatiblefields; files: Resource$Reports$Files; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.reports.delete * @desc Deletes a report by its ID. * @alias dfareporting.reports.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The DFA user profile ID. * @param {string} params.reportId The ID of the report. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.reports.get * @desc Retrieves a report by its ID. * @alias dfareporting.reports.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The DFA user profile ID. * @param {string} params.reportId The ID of the report. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.reports.insert * @desc Creates a report. * @alias dfareporting.reports.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The DFA user profile ID. * @param {().Report} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.reports.list * @desc Retrieves list of reports. * @alias dfareporting.reports.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken The value of the nextToken from the previous result page. * @param {string} params.profileId The DFA user profile ID. * @param {string=} params.scope The scope that defines which results are returned. * @param {string=} params.sortField The field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.reports.patch * @desc Updates a report. This method supports patch semantics. * @alias dfareporting.reports.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The DFA user profile ID. * @param {string} params.reportId The ID of the report. * @param {().Report} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.reports.run * @desc Runs a report. * @alias dfareporting.reports.run * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The DFA profile ID. * @param {string} params.reportId The ID of the report. * @param {boolean=} params.synchronous If set and true, tries to run the report synchronously. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ run(params?: any, options?: MethodOptions): AxiosPromise; run(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.reports.update * @desc Updates a report. * @alias dfareporting.reports.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The DFA user profile ID. * @param {string} params.reportId The ID of the report. * @param {().Report} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Reports$Compatiblefields { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.reports.compatibleFields.query * @desc Returns the fields that are compatible to be selected in the * respective sections of a report criteria, given the fields already selected * in the input report and user permissions. * @alias dfareporting.reports.compatibleFields.query * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The DFA user profile ID. * @param {().Report} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ query(params?: any, options?: MethodOptions): AxiosPromise; query(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Reports$Files { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.reports.files.get * @desc Retrieves a report file. This method supports media download. * @alias dfareporting.reports.files.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the report file. * @param {string} params.profileId The DFA profile ID. * @param {string} params.reportId The ID of the report. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.reports.files.list * @desc Lists files for a report. * @alias dfareporting.reports.files.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken The value of the nextToken from the previous result page. * @param {string} params.profileId The DFA profile ID. * @param {string} params.reportId The ID of the parent report. * @param {string=} params.sortField The field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Sites { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.sites.get * @desc Gets one site by ID. * @alias dfareporting.sites.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Site ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.sites.insert * @desc Inserts a new site. * @alias dfareporting.sites.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Site} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.sites.list * @desc Retrieves a list of sites, possibly filtered. This method supports * paging. * @alias dfareporting.sites.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. * @param {boolean=} params.acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements. * @param {boolean=} params.adWordsSite Select only AdWords sites. * @param {boolean=} params.approved Select only approved sites. * @param {string=} params.campaignIds Select only sites with these campaign IDs. * @param {string=} params.directorySiteIds Select only sites with these directory site IDs. * @param {string=} params.ids Select only sites with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.subaccountId Select only sites with this subaccount ID. * @param {boolean=} params.unmappedSite Select only sites that have not been mapped to a directory site. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.sites.patch * @desc Updates an existing site. This method supports patch semantics. * @alias dfareporting.sites.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Site ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Site} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.sites.update * @desc Updates an existing site. * @alias dfareporting.sites.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Site} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Sizes { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.sizes.get * @desc Gets one size by ID. * @alias dfareporting.sizes.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Size ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.sizes.insert * @desc Inserts a new size. * @alias dfareporting.sizes.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Size} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.sizes.list * @desc Retrieves a list of sizes, possibly filtered. * @alias dfareporting.sizes.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.height Select only sizes with this height. * @param {boolean=} params.iabStandard Select only IAB standard sizes. * @param {string=} params.ids Select only sizes with these IDs. * @param {string} params.profileId User profile ID associated with this request. * @param {integer=} params.width Select only sizes with this width. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Subaccounts { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.subaccounts.get * @desc Gets one subaccount by ID. * @alias dfareporting.subaccounts.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Subaccount ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.subaccounts.insert * @desc Inserts a new subaccount. * @alias dfareporting.subaccounts.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Subaccount} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.subaccounts.list * @desc Gets a list of subaccounts, possibly filtered. This method supports * paging. * @alias dfareporting.subaccounts.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Select only subaccounts with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.subaccounts.patch * @desc Updates an existing subaccount. This method supports patch semantics. * @alias dfareporting.subaccounts.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Subaccount ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().Subaccount} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.subaccounts.update * @desc Updates an existing subaccount. * @alias dfareporting.subaccounts.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().Subaccount} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Targetableremarketinglists { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.targetableRemarketingLists.get * @desc Gets one remarketing list by ID. * @alias dfareporting.targetableRemarketingLists.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Remarketing list ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.targetableRemarketingLists.list * @desc Retrieves a list of targetable remarketing lists, possibly filtered. * This method supports paging. * @alias dfareporting.targetableRemarketingLists.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.active Select only active or only inactive targetable remarketing lists. * @param {string} params.advertiserId Select only targetable remarketing lists targetable by these advertisers. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Targetingtemplates { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.targetingTemplates.get * @desc Gets one targeting template by ID. * @alias dfareporting.targetingTemplates.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Targeting template ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.targetingTemplates.insert * @desc Inserts a new targeting template. * @alias dfareporting.targetingTemplates.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().TargetingTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.targetingTemplates.list * @desc Retrieves a list of targeting templates, optionally filtered. This * method supports paging. * @alias dfareporting.targetingTemplates.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.advertiserId Select only targeting templates with this advertiser ID. * @param {string=} params.ids Select only targeting templates with these IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.targetingTemplates.patch * @desc Updates an existing targeting template. This method supports patch * semantics. * @alias dfareporting.targetingTemplates.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id Targeting template ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().TargetingTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.targetingTemplates.update * @desc Updates an existing targeting template. * @alias dfareporting.targetingTemplates.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().TargetingTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Userprofiles { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.userProfiles.get * @desc Gets one user profile by ID. * @alias dfareporting.userProfiles.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId The user profile ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userProfiles.list * @desc Retrieves list of user profiles for a user. * @alias dfareporting.userProfiles.list * @memberOf! () * * @param {object=} params Parameters for request * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Userrolepermissiongroups { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.userRolePermissionGroups.get * @desc Gets one user role permission group by ID. * @alias dfareporting.userRolePermissionGroups.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id User role permission group ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userRolePermissionGroups.list * @desc Gets a list of all supported user role permission groups. * @alias dfareporting.userRolePermissionGroups.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Userrolepermissions { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.userRolePermissions.get * @desc Gets one user role permission by ID. * @alias dfareporting.userRolePermissions.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id User role permission ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userRolePermissions.list * @desc Gets a list of user role permissions, possibly filtered. * @alias dfareporting.userRolePermissions.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.ids Select only user role permissions with these IDs. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Userroles { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.userRoles.delete * @desc Deletes an existing user role. * @alias dfareporting.userRoles.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id User role ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: any, options?: MethodOptions): AxiosPromise; delete(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userRoles.get * @desc Gets one user role by ID. * @alias dfareporting.userRoles.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id User role ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userRoles.insert * @desc Inserts a new user role. * @alias dfareporting.userRoles.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().UserRole} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert(params?: any, options?: MethodOptions): AxiosPromise; insert(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userRoles.list * @desc Retrieves a list of user roles, possibly filtered. This method * supports paging. * @alias dfareporting.userRoles.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.accountUserRoleOnly Select only account level user roles not associated with any specific subaccount. * @param {string=} params.ids Select only user roles with the specified IDs. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. * @param {string} params.profileId User profile ID associated with this request. * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". * @param {string=} params.sortField Field by which to sort the list. * @param {string=} params.sortOrder Order of sorted results. * @param {string=} params.subaccountId Select only user roles that belong to this subaccount. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userRoles.patch * @desc Updates an existing user role. This method supports patch semantics. * @alias dfareporting.userRoles.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id User role ID. * @param {string} params.profileId User profile ID associated with this request. * @param {().UserRole} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise; patch(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.userRoles.update * @desc Updates an existing user role. * @alias dfareporting.userRoles.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {().UserRole} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: any, options?: MethodOptions): AxiosPromise; update(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; } export declare class Resource$Videoformats { root: Dfareporting; constructor(root: Dfareporting); getRoot(): Dfareporting; /** * dfareporting.videoFormats.get * @desc Gets one video format by ID. * @alias dfareporting.videoFormats.get * @memberOf! () * * @param {object} params Parameters for request * @param {integer} params.id Video format ID. * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; /** * dfareporting.videoFormats.list * @desc Lists available video formats. * @alias dfareporting.videoFormats.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): AxiosPromise; list(params?: any, options?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback): void; }