1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.ads.html">ads</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#get">get(profileId, id)</a></code></p> 79 <p class="firstline">Gets one ad by ID.</p> 80 <p class="toc_element"> 81 <code><a href="#insert">insert(profileId, body)</a></code></p> 82 <p class="firstline">Inserts a new ad.</p> 83 <p class="toc_element"> 84 <code><a href="#list">list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)</a></code></p> 85 <p class="firstline">Retrieves a list of ads, possibly filtered. This method supports paging.</p> 86 <p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88 <p class="firstline">Retrieves the next page of results.</p> 89 <p class="toc_element"> 90 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 91 <p class="firstline">Updates an existing ad. This method supports patch semantics.</p> 92 <p class="toc_element"> 93 <code><a href="#update">update(profileId, body)</a></code></p> 94 <p class="firstline">Updates an existing ad.</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="get">get(profileId, id)</code> 98 <pre>Gets one ad by ID. 99 100 Args: 101 profileId: string, User profile ID associated with this request. (required) 102 id: string, Ad ID. (required) 103 104 Returns: 105 An object of the form: 106 107 { # Contains properties of a DCM ad. 108 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 109 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 110 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 111 }, 112 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 113 "languageTargeting": { # Language Targeting. # 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. 114 "languages": [ # 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. 115 { # Contains information about a language that can be targeted by ads. 116 "languageCode": "A 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. 117 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 118 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 119 "name": "A String", # Name of this language. 120 }, 121 ], 122 }, 123 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 124 "geoTargeting": { # Geographical Targeting. # 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. 125 "countries": [ # 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. 126 { # Contains information about a country that can be targeted by ads. 127 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 128 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 129 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 130 "countryCode": "A String", # Country code. 131 "name": "A String", # Name of this country. 132 }, 133 ], 134 "excludeCountries": True or False, # 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. 135 "postalCodes": [ # 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. 136 { # Contains information about a postal code that can be targeted by ads. 137 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 138 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 139 "code": "A String", # Postal code. This is equivalent to the id field. 140 "id": "A String", # ID of this postal code. 141 "countryCode": "A String", # Country code of the country to which this postal code belongs. 142 }, 143 ], 144 "regions": [ # 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. 145 { # Contains information about a region that can be targeted by ads. 146 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 147 "countryDartId": "A String", # DART ID of the country to which this region belongs. 148 "name": "A String", # Name of this region. 149 "countryCode": "A String", # Country code of the country to which this region belongs. 150 "regionCode": "A String", # Region code. 151 "dartId": "A String", # DART ID of this region. 152 }, 153 ], 154 "cities": [ # 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. 155 { # Contains information about a city that can be targeted by ads. 156 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 157 "countryDartId": "A String", # DART ID of the country to which this city belongs. 158 "name": "A String", # Name of this city. 159 "countryCode": "A String", # Country code of the country to which this city belongs. 160 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 161 "regionCode": "A String", # Region code of the region to which this city belongs. 162 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 163 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 164 "regionDartId": "A String", # DART ID of the region to which this city belongs. 165 }, 166 ], 167 "metros": [ # 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. 168 { # Contains information about a metro region that can be targeted by ads. 169 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 170 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 171 "name": "A String", # Name of this metro region. 172 "countryCode": "A String", # Country code of the country to which this metro region belongs. 173 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 174 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 175 "dartId": "A String", # DART ID of this metro region. 176 }, 177 ], 178 }, 179 "creativeGroupAssignments": [ # 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. 180 { # Creative Group Assignment. 181 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 182 "creativeGroupId": "A String", # ID of the creative group to be assigned. 183 }, 184 ], 185 "deliverySchedule": { # Delivery Schedule. # 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. 186 "priority": "A 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. 187 "hardCutoff": True or False, # 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. 188 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 189 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 190 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 191 }, 192 "impressionRatio": "A String", # 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. 193 }, 194 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 195 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 196 "value": "A String", # The value of the dimension. 197 "dimensionName": "A String", # The name of the dimension. 198 "etag": "A String", # The eTag of this response for caching purposes. 199 "matchType": "A 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. 200 "id": "A String", # The ID associated with the value if available. 201 }, 202 "eventTagOverrides": [ # Event tag overrides for this ad. 203 { # Event tag override information. 204 "enabled": True or False, # Whether this override is enabled. 205 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 206 }, 207 ], 208 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 209 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 210 "archived": True or False, # Whether this ad is archived. When true, active must be false. 211 "targetingTemplateId": "A 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. 212 "technologyTargeting": { # Technology Targeting. # 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. 213 "platformTypes": [ # 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. 214 { # Contains information about a platform type that can be targeted by ads. 215 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 216 "id": "A String", # ID of this platform type. 217 "name": "A String", # Name of this platform type. 218 }, 219 ], 220 "operatingSystemVersions": [ # 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. 221 { # Contains information about a particular version of an operating system that can be targeted by ads. 222 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 223 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 224 "name": "A String", # Name of this operating system version. 225 "id": "A String", # ID of this operating system version. 226 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 227 "mobile": True or False, # Whether this operating system is for mobile. 228 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 229 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 230 "name": "A String", # Name of this operating system. 231 "desktop": True or False, # Whether this operating system is for desktop. 232 }, 233 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 234 }, 235 ], 236 "browsers": [ # 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. 237 { # Contains information about a browser that can be targeted by ads. 238 "majorVersion": "A 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. 239 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 240 "name": "A String", # Name of this browser. 241 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 242 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 243 "minorVersion": "A 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. 244 }, 245 ], 246 "operatingSystems": [ # 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. 247 { # Contains information about an operating system that can be targeted by ads. 248 "mobile": True or False, # Whether this operating system is for mobile. 249 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 250 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 251 "name": "A String", # Name of this operating system. 252 "desktop": True or False, # Whether this operating system is for desktop. 253 }, 254 ], 255 "mobileCarriers": [ # 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. 256 { # Contains information about a mobile carrier that can be targeted by ads. 257 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 258 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 259 "id": "A String", # ID of this mobile carrier. 260 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 261 "name": "A String", # Name of this mobile carrier. 262 }, 263 ], 264 "connectionTypes": [ # 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. 265 { # 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. 266 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 267 "id": "A String", # ID of this connection type. 268 "name": "A String", # Name of this connection type. 269 }, 270 ], 271 }, 272 "creativeRotation": { # Creative Rotation. # 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. 273 "creativeAssignments": [ # Creative assignments in this creative rotation. 274 { # Creative Assignment. 275 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 276 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 277 "applyEventTags": True or False, # 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. 278 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 279 # Applicable when the creative type is any of the following: 280 # - DISPLAY 281 # - RICH_MEDIA_INPAGE 282 # - RICH_MEDIA_INPAGE_FLOATING 283 # - RICH_MEDIA_IM_EXPAND 284 # - RICH_MEDIA_EXPANDING 285 # - RICH_MEDIA_INTERSTITIAL_FLOAT 286 # - RICH_MEDIA_MOBILE_IN_APP 287 # - RICH_MEDIA_MULTI_FLOATING 288 # - RICH_MEDIA_PEEL_DOWN 289 # - VPAID_LINEAR 290 # - VPAID_NON_LINEAR 291 { # Rich Media Exit Override. 292 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 293 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 294 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 295 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 296 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 297 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 298 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 299 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 300 }, 301 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 302 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 303 }, 304 ], 305 "sslCompliant": True or False, # 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. 306 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 307 { # Creative Group Assignment. 308 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 309 "creativeGroupId": "A String", # ID of the creative group to be assigned. 310 }, 311 ], 312 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 313 { # Companion Click-through override. 314 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 315 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 316 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 317 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 318 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 319 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 320 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 321 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 322 }, 323 "creativeId": "A String", # ID of the creative for this companion click-through override. 324 }, 325 ], 326 "startTime": "A String", # Date and time that the assigned creative should start serving. 327 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 328 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 329 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 330 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 331 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 332 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 333 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 334 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 335 }, 336 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 337 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 338 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 339 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 340 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 341 "value": "A String", # The value of the dimension. 342 "dimensionName": "A String", # The name of the dimension. 343 "etag": "A String", # The eTag of this response for caching purposes. 344 "matchType": "A 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. 345 "id": "A String", # The ID associated with the value if available. 346 }, 347 }, 348 ], 349 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 350 "creativeOptimizationConfigurationId": "A String", # 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. 351 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 352 }, 353 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 354 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 355 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 356 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 357 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 358 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 359 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 360 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 361 }, 362 "comments": "A String", # Comments for this ad. 363 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 364 "expression": "A String", # Expression describing which lists are being targeted by the ad. 365 }, 366 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 367 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 368 "value": "A String", # The value of the dimension. 369 "dimensionName": "A String", # The name of the dimension. 370 "etag": "A String", # The eTag of this response for caching purposes. 371 "matchType": "A 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. 372 "id": "A String", # The ID associated with the value if available. 373 }, 374 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 375 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 376 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 377 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 378 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 379 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 380 }, 381 "type": "A String", # 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). 382 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 383 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 384 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 385 "expression": "A String", # Keyword expression being targeted by the ad. 386 }, 387 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 388 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 389 "value": "A String", # The value of the dimension. 390 "dimensionName": "A String", # The name of the dimension. 391 "etag": "A String", # The eTag of this response for caching purposes. 392 "matchType": "A 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. 393 "id": "A String", # The ID associated with the value if available. 394 }, 395 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 396 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 397 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 398 }, 399 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 400 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 401 }, 402 "startTime": "A String", # 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. 403 "active": True or False, # Whether this ad is active. When true, archived must be false. 404 "compatibility": "A 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. 405 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 406 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 407 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 408 "dayPartTargeting": { # Day Part Targeting. # 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. 409 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 410 "hoursOfDay": [ # 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. 411 42, 412 ], 413 "daysOfWeek": [ # Days of the week when the ad will serve. 414 # 415 # Acceptable values are: 416 # - "SUNDAY" 417 # - "MONDAY" 418 # - "TUESDAY" 419 # - "WEDNESDAY" 420 # - "THURSDAY" 421 # - "FRIDAY" 422 # - "SATURDAY" 423 "A String", 424 ], 425 }, 426 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 427 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 428 }, 429 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 430 "placementAssignments": [ # Placement assignments for this ad. 431 { # Placement Assignment. 432 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 433 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 434 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 435 "value": "A String", # The value of the dimension. 436 "dimensionName": "A String", # The name of the dimension. 437 "etag": "A String", # The eTag of this response for caching purposes. 438 "matchType": "A 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. 439 "id": "A String", # The ID associated with the value if available. 440 }, 441 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 442 "sslRequired": True or False, # 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. 443 }, 444 ], 445 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 446 "dynamicClickTracker": True or False, # 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. 447 }</pre> 448 </div> 449 450 <div class="method"> 451 <code class="details" id="insert">insert(profileId, body)</code> 452 <pre>Inserts a new ad. 453 454 Args: 455 profileId: string, User profile ID associated with this request. (required) 456 body: object, The request body. (required) 457 The object takes the form of: 458 459 { # Contains properties of a DCM ad. 460 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 461 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 462 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 463 }, 464 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 465 "languageTargeting": { # Language Targeting. # 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. 466 "languages": [ # 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. 467 { # Contains information about a language that can be targeted by ads. 468 "languageCode": "A 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. 469 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 470 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 471 "name": "A String", # Name of this language. 472 }, 473 ], 474 }, 475 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 476 "geoTargeting": { # Geographical Targeting. # 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. 477 "countries": [ # 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. 478 { # Contains information about a country that can be targeted by ads. 479 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 480 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 481 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 482 "countryCode": "A String", # Country code. 483 "name": "A String", # Name of this country. 484 }, 485 ], 486 "excludeCountries": True or False, # 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. 487 "postalCodes": [ # 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. 488 { # Contains information about a postal code that can be targeted by ads. 489 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 490 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 491 "code": "A String", # Postal code. This is equivalent to the id field. 492 "id": "A String", # ID of this postal code. 493 "countryCode": "A String", # Country code of the country to which this postal code belongs. 494 }, 495 ], 496 "regions": [ # 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. 497 { # Contains information about a region that can be targeted by ads. 498 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 499 "countryDartId": "A String", # DART ID of the country to which this region belongs. 500 "name": "A String", # Name of this region. 501 "countryCode": "A String", # Country code of the country to which this region belongs. 502 "regionCode": "A String", # Region code. 503 "dartId": "A String", # DART ID of this region. 504 }, 505 ], 506 "cities": [ # 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. 507 { # Contains information about a city that can be targeted by ads. 508 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 509 "countryDartId": "A String", # DART ID of the country to which this city belongs. 510 "name": "A String", # Name of this city. 511 "countryCode": "A String", # Country code of the country to which this city belongs. 512 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 513 "regionCode": "A String", # Region code of the region to which this city belongs. 514 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 515 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 516 "regionDartId": "A String", # DART ID of the region to which this city belongs. 517 }, 518 ], 519 "metros": [ # 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. 520 { # Contains information about a metro region that can be targeted by ads. 521 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 522 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 523 "name": "A String", # Name of this metro region. 524 "countryCode": "A String", # Country code of the country to which this metro region belongs. 525 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 526 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 527 "dartId": "A String", # DART ID of this metro region. 528 }, 529 ], 530 }, 531 "creativeGroupAssignments": [ # 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. 532 { # Creative Group Assignment. 533 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 534 "creativeGroupId": "A String", # ID of the creative group to be assigned. 535 }, 536 ], 537 "deliverySchedule": { # Delivery Schedule. # 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. 538 "priority": "A 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. 539 "hardCutoff": True or False, # 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. 540 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 541 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 542 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 543 }, 544 "impressionRatio": "A String", # 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. 545 }, 546 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 547 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 548 "value": "A String", # The value of the dimension. 549 "dimensionName": "A String", # The name of the dimension. 550 "etag": "A String", # The eTag of this response for caching purposes. 551 "matchType": "A 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. 552 "id": "A String", # The ID associated with the value if available. 553 }, 554 "eventTagOverrides": [ # Event tag overrides for this ad. 555 { # Event tag override information. 556 "enabled": True or False, # Whether this override is enabled. 557 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 558 }, 559 ], 560 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 561 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 562 "archived": True or False, # Whether this ad is archived. When true, active must be false. 563 "targetingTemplateId": "A 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. 564 "technologyTargeting": { # Technology Targeting. # 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. 565 "platformTypes": [ # 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. 566 { # Contains information about a platform type that can be targeted by ads. 567 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 568 "id": "A String", # ID of this platform type. 569 "name": "A String", # Name of this platform type. 570 }, 571 ], 572 "operatingSystemVersions": [ # 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. 573 { # Contains information about a particular version of an operating system that can be targeted by ads. 574 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 575 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 576 "name": "A String", # Name of this operating system version. 577 "id": "A String", # ID of this operating system version. 578 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 579 "mobile": True or False, # Whether this operating system is for mobile. 580 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 581 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 582 "name": "A String", # Name of this operating system. 583 "desktop": True or False, # Whether this operating system is for desktop. 584 }, 585 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 586 }, 587 ], 588 "browsers": [ # 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. 589 { # Contains information about a browser that can be targeted by ads. 590 "majorVersion": "A 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. 591 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 592 "name": "A String", # Name of this browser. 593 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 594 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 595 "minorVersion": "A 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. 596 }, 597 ], 598 "operatingSystems": [ # 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. 599 { # Contains information about an operating system that can be targeted by ads. 600 "mobile": True or False, # Whether this operating system is for mobile. 601 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 602 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 603 "name": "A String", # Name of this operating system. 604 "desktop": True or False, # Whether this operating system is for desktop. 605 }, 606 ], 607 "mobileCarriers": [ # 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. 608 { # Contains information about a mobile carrier that can be targeted by ads. 609 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 610 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 611 "id": "A String", # ID of this mobile carrier. 612 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 613 "name": "A String", # Name of this mobile carrier. 614 }, 615 ], 616 "connectionTypes": [ # 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. 617 { # 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. 618 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 619 "id": "A String", # ID of this connection type. 620 "name": "A String", # Name of this connection type. 621 }, 622 ], 623 }, 624 "creativeRotation": { # Creative Rotation. # 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. 625 "creativeAssignments": [ # Creative assignments in this creative rotation. 626 { # Creative Assignment. 627 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 628 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 629 "applyEventTags": True or False, # 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. 630 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 631 # Applicable when the creative type is any of the following: 632 # - DISPLAY 633 # - RICH_MEDIA_INPAGE 634 # - RICH_MEDIA_INPAGE_FLOATING 635 # - RICH_MEDIA_IM_EXPAND 636 # - RICH_MEDIA_EXPANDING 637 # - RICH_MEDIA_INTERSTITIAL_FLOAT 638 # - RICH_MEDIA_MOBILE_IN_APP 639 # - RICH_MEDIA_MULTI_FLOATING 640 # - RICH_MEDIA_PEEL_DOWN 641 # - VPAID_LINEAR 642 # - VPAID_NON_LINEAR 643 { # Rich Media Exit Override. 644 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 645 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 646 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 647 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 648 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 649 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 650 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 651 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 652 }, 653 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 654 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 655 }, 656 ], 657 "sslCompliant": True or False, # 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. 658 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 659 { # Creative Group Assignment. 660 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 661 "creativeGroupId": "A String", # ID of the creative group to be assigned. 662 }, 663 ], 664 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 665 { # Companion Click-through override. 666 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 667 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 668 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 669 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 670 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 671 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 672 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 673 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 674 }, 675 "creativeId": "A String", # ID of the creative for this companion click-through override. 676 }, 677 ], 678 "startTime": "A String", # Date and time that the assigned creative should start serving. 679 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 680 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 681 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 682 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 683 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 684 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 685 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 686 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 687 }, 688 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 689 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 690 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 691 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 692 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 693 "value": "A String", # The value of the dimension. 694 "dimensionName": "A String", # The name of the dimension. 695 "etag": "A String", # The eTag of this response for caching purposes. 696 "matchType": "A 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. 697 "id": "A String", # The ID associated with the value if available. 698 }, 699 }, 700 ], 701 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 702 "creativeOptimizationConfigurationId": "A String", # 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. 703 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 704 }, 705 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 706 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 707 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 708 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 709 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 710 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 711 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 712 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 713 }, 714 "comments": "A String", # Comments for this ad. 715 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 716 "expression": "A String", # Expression describing which lists are being targeted by the ad. 717 }, 718 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 719 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 720 "value": "A String", # The value of the dimension. 721 "dimensionName": "A String", # The name of the dimension. 722 "etag": "A String", # The eTag of this response for caching purposes. 723 "matchType": "A 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. 724 "id": "A String", # The ID associated with the value if available. 725 }, 726 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 727 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 728 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 729 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 730 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 731 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 732 }, 733 "type": "A String", # 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). 734 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 735 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 736 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 737 "expression": "A String", # Keyword expression being targeted by the ad. 738 }, 739 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 740 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 741 "value": "A String", # The value of the dimension. 742 "dimensionName": "A String", # The name of the dimension. 743 "etag": "A String", # The eTag of this response for caching purposes. 744 "matchType": "A 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. 745 "id": "A String", # The ID associated with the value if available. 746 }, 747 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 748 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 749 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 750 }, 751 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 752 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 753 }, 754 "startTime": "A String", # 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. 755 "active": True or False, # Whether this ad is active. When true, archived must be false. 756 "compatibility": "A 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. 757 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 758 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 759 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 760 "dayPartTargeting": { # Day Part Targeting. # 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. 761 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 762 "hoursOfDay": [ # 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. 763 42, 764 ], 765 "daysOfWeek": [ # Days of the week when the ad will serve. 766 # 767 # Acceptable values are: 768 # - "SUNDAY" 769 # - "MONDAY" 770 # - "TUESDAY" 771 # - "WEDNESDAY" 772 # - "THURSDAY" 773 # - "FRIDAY" 774 # - "SATURDAY" 775 "A String", 776 ], 777 }, 778 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 779 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 780 }, 781 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 782 "placementAssignments": [ # Placement assignments for this ad. 783 { # Placement Assignment. 784 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 785 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 786 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 787 "value": "A String", # The value of the dimension. 788 "dimensionName": "A String", # The name of the dimension. 789 "etag": "A String", # The eTag of this response for caching purposes. 790 "matchType": "A 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. 791 "id": "A String", # The ID associated with the value if available. 792 }, 793 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 794 "sslRequired": True or False, # 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. 795 }, 796 ], 797 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 798 "dynamicClickTracker": True or False, # 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. 799 } 800 801 802 Returns: 803 An object of the form: 804 805 { # Contains properties of a DCM ad. 806 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 807 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 808 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 809 }, 810 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 811 "languageTargeting": { # Language Targeting. # 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. 812 "languages": [ # 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. 813 { # Contains information about a language that can be targeted by ads. 814 "languageCode": "A 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. 815 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 816 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 817 "name": "A String", # Name of this language. 818 }, 819 ], 820 }, 821 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 822 "geoTargeting": { # Geographical Targeting. # 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. 823 "countries": [ # 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. 824 { # Contains information about a country that can be targeted by ads. 825 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 826 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 827 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 828 "countryCode": "A String", # Country code. 829 "name": "A String", # Name of this country. 830 }, 831 ], 832 "excludeCountries": True or False, # 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. 833 "postalCodes": [ # 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. 834 { # Contains information about a postal code that can be targeted by ads. 835 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 836 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 837 "code": "A String", # Postal code. This is equivalent to the id field. 838 "id": "A String", # ID of this postal code. 839 "countryCode": "A String", # Country code of the country to which this postal code belongs. 840 }, 841 ], 842 "regions": [ # 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. 843 { # Contains information about a region that can be targeted by ads. 844 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 845 "countryDartId": "A String", # DART ID of the country to which this region belongs. 846 "name": "A String", # Name of this region. 847 "countryCode": "A String", # Country code of the country to which this region belongs. 848 "regionCode": "A String", # Region code. 849 "dartId": "A String", # DART ID of this region. 850 }, 851 ], 852 "cities": [ # 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. 853 { # Contains information about a city that can be targeted by ads. 854 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 855 "countryDartId": "A String", # DART ID of the country to which this city belongs. 856 "name": "A String", # Name of this city. 857 "countryCode": "A String", # Country code of the country to which this city belongs. 858 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 859 "regionCode": "A String", # Region code of the region to which this city belongs. 860 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 861 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 862 "regionDartId": "A String", # DART ID of the region to which this city belongs. 863 }, 864 ], 865 "metros": [ # 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. 866 { # Contains information about a metro region that can be targeted by ads. 867 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 868 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 869 "name": "A String", # Name of this metro region. 870 "countryCode": "A String", # Country code of the country to which this metro region belongs. 871 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 872 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 873 "dartId": "A String", # DART ID of this metro region. 874 }, 875 ], 876 }, 877 "creativeGroupAssignments": [ # 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. 878 { # Creative Group Assignment. 879 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 880 "creativeGroupId": "A String", # ID of the creative group to be assigned. 881 }, 882 ], 883 "deliverySchedule": { # Delivery Schedule. # 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. 884 "priority": "A 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. 885 "hardCutoff": True or False, # 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. 886 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 887 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 888 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 889 }, 890 "impressionRatio": "A String", # 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. 891 }, 892 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 893 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 894 "value": "A String", # The value of the dimension. 895 "dimensionName": "A String", # The name of the dimension. 896 "etag": "A String", # The eTag of this response for caching purposes. 897 "matchType": "A 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. 898 "id": "A String", # The ID associated with the value if available. 899 }, 900 "eventTagOverrides": [ # Event tag overrides for this ad. 901 { # Event tag override information. 902 "enabled": True or False, # Whether this override is enabled. 903 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 904 }, 905 ], 906 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 907 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 908 "archived": True or False, # Whether this ad is archived. When true, active must be false. 909 "targetingTemplateId": "A 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. 910 "technologyTargeting": { # Technology Targeting. # 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. 911 "platformTypes": [ # 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. 912 { # Contains information about a platform type that can be targeted by ads. 913 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 914 "id": "A String", # ID of this platform type. 915 "name": "A String", # Name of this platform type. 916 }, 917 ], 918 "operatingSystemVersions": [ # 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. 919 { # Contains information about a particular version of an operating system that can be targeted by ads. 920 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 921 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 922 "name": "A String", # Name of this operating system version. 923 "id": "A String", # ID of this operating system version. 924 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 925 "mobile": True or False, # Whether this operating system is for mobile. 926 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 927 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 928 "name": "A String", # Name of this operating system. 929 "desktop": True or False, # Whether this operating system is for desktop. 930 }, 931 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 932 }, 933 ], 934 "browsers": [ # 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. 935 { # Contains information about a browser that can be targeted by ads. 936 "majorVersion": "A 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. 937 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 938 "name": "A String", # Name of this browser. 939 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 940 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 941 "minorVersion": "A 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. 942 }, 943 ], 944 "operatingSystems": [ # 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. 945 { # Contains information about an operating system that can be targeted by ads. 946 "mobile": True or False, # Whether this operating system is for mobile. 947 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 948 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 949 "name": "A String", # Name of this operating system. 950 "desktop": True or False, # Whether this operating system is for desktop. 951 }, 952 ], 953 "mobileCarriers": [ # 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. 954 { # Contains information about a mobile carrier that can be targeted by ads. 955 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 956 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 957 "id": "A String", # ID of this mobile carrier. 958 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 959 "name": "A String", # Name of this mobile carrier. 960 }, 961 ], 962 "connectionTypes": [ # 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. 963 { # 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. 964 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 965 "id": "A String", # ID of this connection type. 966 "name": "A String", # Name of this connection type. 967 }, 968 ], 969 }, 970 "creativeRotation": { # Creative Rotation. # 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. 971 "creativeAssignments": [ # Creative assignments in this creative rotation. 972 { # Creative Assignment. 973 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 974 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 975 "applyEventTags": True or False, # 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. 976 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 977 # Applicable when the creative type is any of the following: 978 # - DISPLAY 979 # - RICH_MEDIA_INPAGE 980 # - RICH_MEDIA_INPAGE_FLOATING 981 # - RICH_MEDIA_IM_EXPAND 982 # - RICH_MEDIA_EXPANDING 983 # - RICH_MEDIA_INTERSTITIAL_FLOAT 984 # - RICH_MEDIA_MOBILE_IN_APP 985 # - RICH_MEDIA_MULTI_FLOATING 986 # - RICH_MEDIA_PEEL_DOWN 987 # - VPAID_LINEAR 988 # - VPAID_NON_LINEAR 989 { # Rich Media Exit Override. 990 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 991 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 992 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 993 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 994 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 995 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 996 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 997 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 998 }, 999 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 1000 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 1001 }, 1002 ], 1003 "sslCompliant": True or False, # 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. 1004 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 1005 { # Creative Group Assignment. 1006 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 1007 "creativeGroupId": "A String", # ID of the creative group to be assigned. 1008 }, 1009 ], 1010 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 1011 { # Companion Click-through override. 1012 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 1013 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1014 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1015 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1016 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1017 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1018 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1019 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1020 }, 1021 "creativeId": "A String", # ID of the creative for this companion click-through override. 1022 }, 1023 ], 1024 "startTime": "A String", # Date and time that the assigned creative should start serving. 1025 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 1026 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1027 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1028 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1029 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1030 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1031 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1032 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1033 }, 1034 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 1035 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 1036 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 1037 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 1038 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1039 "value": "A String", # The value of the dimension. 1040 "dimensionName": "A String", # The name of the dimension. 1041 "etag": "A String", # The eTag of this response for caching purposes. 1042 "matchType": "A 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. 1043 "id": "A String", # The ID associated with the value if available. 1044 }, 1045 }, 1046 ], 1047 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 1048 "creativeOptimizationConfigurationId": "A String", # 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. 1049 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 1050 }, 1051 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 1052 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1053 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1054 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1055 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1056 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1057 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1058 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1059 }, 1060 "comments": "A String", # Comments for this ad. 1061 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 1062 "expression": "A String", # Expression describing which lists are being targeted by the ad. 1063 }, 1064 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 1065 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1066 "value": "A String", # The value of the dimension. 1067 "dimensionName": "A String", # The name of the dimension. 1068 "etag": "A String", # The eTag of this response for caching purposes. 1069 "matchType": "A 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. 1070 "id": "A String", # The ID associated with the value if available. 1071 }, 1072 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 1073 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1074 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1075 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1076 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1077 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1078 }, 1079 "type": "A String", # 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). 1080 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 1081 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 1082 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 1083 "expression": "A String", # Keyword expression being targeted by the ad. 1084 }, 1085 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1086 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1087 "value": "A String", # The value of the dimension. 1088 "dimensionName": "A String", # The name of the dimension. 1089 "etag": "A String", # The eTag of this response for caching purposes. 1090 "matchType": "A 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. 1091 "id": "A String", # The ID associated with the value if available. 1092 }, 1093 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 1094 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 1095 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 1096 }, 1097 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 1098 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1099 }, 1100 "startTime": "A String", # 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. 1101 "active": True or False, # Whether this ad is active. When true, archived must be false. 1102 "compatibility": "A 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. 1103 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 1104 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 1105 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 1106 "dayPartTargeting": { # Day Part Targeting. # 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. 1107 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 1108 "hoursOfDay": [ # 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. 1109 42, 1110 ], 1111 "daysOfWeek": [ # Days of the week when the ad will serve. 1112 # 1113 # Acceptable values are: 1114 # - "SUNDAY" 1115 # - "MONDAY" 1116 # - "TUESDAY" 1117 # - "WEDNESDAY" 1118 # - "THURSDAY" 1119 # - "FRIDAY" 1120 # - "SATURDAY" 1121 "A String", 1122 ], 1123 }, 1124 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 1125 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1126 }, 1127 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 1128 "placementAssignments": [ # Placement assignments for this ad. 1129 { # Placement Assignment. 1130 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 1131 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 1132 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1133 "value": "A String", # The value of the dimension. 1134 "dimensionName": "A String", # The name of the dimension. 1135 "etag": "A String", # The eTag of this response for caching purposes. 1136 "matchType": "A 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. 1137 "id": "A String", # The ID associated with the value if available. 1138 }, 1139 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 1140 "sslRequired": True or False, # 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. 1141 }, 1142 ], 1143 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 1144 "dynamicClickTracker": True or False, # 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. 1145 }</pre> 1146 </div> 1147 1148 <div class="method"> 1149 <code class="details" id="list">list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)</code> 1150 <pre>Retrieves a list of ads, possibly filtered. This method supports paging. 1151 1152 Args: 1153 profileId: string, User profile ID associated with this request. (required) 1154 landingPageIds: string, Select only ads with these landing page IDs. (repeated) 1155 overriddenEventTagId: string, Select only ads with this event tag override ID. 1156 campaignIds: string, Select only ads with these campaign IDs. (repeated) 1157 sizeIds: string, Select only ads with these size IDs. (repeated) 1158 archived: boolean, Select only archived ads. 1159 creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated) 1160 sslCompliant: boolean, Select only ads that are SSL-compliant. 1161 pageToken: string, Value of the nextPageToken from the previous result page. 1162 sortOrder: string, Order of sorted results. 1163 Allowed values 1164 ASCENDING - 1165 DESCENDING - 1166 type: string, Select only ads with these types. (repeated) 1167 Allowed values 1168 AD_SERVING_CLICK_TRACKER - 1169 AD_SERVING_DEFAULT_AD - 1170 AD_SERVING_STANDARD_AD - 1171 AD_SERVING_TRACKING - 1172 sslRequired: boolean, Select only ads that require SSL. 1173 creativeIds: string, Select only ads with these creative IDs assigned. (repeated) 1174 remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated) 1175 maxResults: integer, Maximum number of results to return. 1176 placementIds: string, Select only ads with these placement IDs assigned. (repeated) 1177 active: boolean, Select only active ads. 1178 compatibility: string, 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. 1179 Allowed values 1180 APP - 1181 APP_INTERSTITIAL - 1182 DISPLAY - 1183 DISPLAY_INTERSTITIAL - 1184 IN_STREAM_VIDEO - 1185 advertiserId: string, Select only ads with this advertiser ID. 1186 searchString: string, 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". 1187 audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated) 1188 ids: string, Select only ads with these IDs. (repeated) 1189 sortField: string, Field by which to sort the list. 1190 Allowed values 1191 ID - 1192 NAME - 1193 dynamicClickTracker: boolean, 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. 1194 1195 Returns: 1196 An object of the form: 1197 1198 { # Ad List Response 1199 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 1200 "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". 1201 "ads": [ # Ad collection. 1202 { # Contains properties of a DCM ad. 1203 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 1204 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 1205 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 1206 }, 1207 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 1208 "languageTargeting": { # Language Targeting. # 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. 1209 "languages": [ # 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. 1210 { # Contains information about a language that can be targeted by ads. 1211 "languageCode": "A 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. 1212 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 1213 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 1214 "name": "A String", # Name of this language. 1215 }, 1216 ], 1217 }, 1218 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 1219 "geoTargeting": { # Geographical Targeting. # 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. 1220 "countries": [ # 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. 1221 { # Contains information about a country that can be targeted by ads. 1222 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 1223 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 1224 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 1225 "countryCode": "A String", # Country code. 1226 "name": "A String", # Name of this country. 1227 }, 1228 ], 1229 "excludeCountries": True or False, # 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. 1230 "postalCodes": [ # 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. 1231 { # Contains information about a postal code that can be targeted by ads. 1232 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 1233 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 1234 "code": "A String", # Postal code. This is equivalent to the id field. 1235 "id": "A String", # ID of this postal code. 1236 "countryCode": "A String", # Country code of the country to which this postal code belongs. 1237 }, 1238 ], 1239 "regions": [ # 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. 1240 { # Contains information about a region that can be targeted by ads. 1241 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 1242 "countryDartId": "A String", # DART ID of the country to which this region belongs. 1243 "name": "A String", # Name of this region. 1244 "countryCode": "A String", # Country code of the country to which this region belongs. 1245 "regionCode": "A String", # Region code. 1246 "dartId": "A String", # DART ID of this region. 1247 }, 1248 ], 1249 "cities": [ # 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. 1250 { # Contains information about a city that can be targeted by ads. 1251 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 1252 "countryDartId": "A String", # DART ID of the country to which this city belongs. 1253 "name": "A String", # Name of this city. 1254 "countryCode": "A String", # Country code of the country to which this city belongs. 1255 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 1256 "regionCode": "A String", # Region code of the region to which this city belongs. 1257 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 1258 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 1259 "regionDartId": "A String", # DART ID of the region to which this city belongs. 1260 }, 1261 ], 1262 "metros": [ # 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. 1263 { # Contains information about a metro region that can be targeted by ads. 1264 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 1265 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 1266 "name": "A String", # Name of this metro region. 1267 "countryCode": "A String", # Country code of the country to which this metro region belongs. 1268 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 1269 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 1270 "dartId": "A String", # DART ID of this metro region. 1271 }, 1272 ], 1273 }, 1274 "creativeGroupAssignments": [ # 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. 1275 { # Creative Group Assignment. 1276 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 1277 "creativeGroupId": "A String", # ID of the creative group to be assigned. 1278 }, 1279 ], 1280 "deliverySchedule": { # Delivery Schedule. # 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. 1281 "priority": "A 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. 1282 "hardCutoff": True or False, # 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. 1283 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 1284 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 1285 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 1286 }, 1287 "impressionRatio": "A String", # 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. 1288 }, 1289 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1290 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1291 "value": "A String", # The value of the dimension. 1292 "dimensionName": "A String", # The name of the dimension. 1293 "etag": "A String", # The eTag of this response for caching purposes. 1294 "matchType": "A 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. 1295 "id": "A String", # The ID associated with the value if available. 1296 }, 1297 "eventTagOverrides": [ # Event tag overrides for this ad. 1298 { # Event tag override information. 1299 "enabled": True or False, # Whether this override is enabled. 1300 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 1301 }, 1302 ], 1303 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 1304 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 1305 "archived": True or False, # Whether this ad is archived. When true, active must be false. 1306 "targetingTemplateId": "A 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. 1307 "technologyTargeting": { # Technology Targeting. # 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. 1308 "platformTypes": [ # 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. 1309 { # Contains information about a platform type that can be targeted by ads. 1310 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 1311 "id": "A String", # ID of this platform type. 1312 "name": "A String", # Name of this platform type. 1313 }, 1314 ], 1315 "operatingSystemVersions": [ # 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. 1316 { # Contains information about a particular version of an operating system that can be targeted by ads. 1317 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 1318 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 1319 "name": "A String", # Name of this operating system version. 1320 "id": "A String", # ID of this operating system version. 1321 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 1322 "mobile": True or False, # Whether this operating system is for mobile. 1323 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1324 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1325 "name": "A String", # Name of this operating system. 1326 "desktop": True or False, # Whether this operating system is for desktop. 1327 }, 1328 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 1329 }, 1330 ], 1331 "browsers": [ # 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. 1332 { # Contains information about a browser that can be targeted by ads. 1333 "majorVersion": "A 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. 1334 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 1335 "name": "A String", # Name of this browser. 1336 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 1337 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 1338 "minorVersion": "A 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. 1339 }, 1340 ], 1341 "operatingSystems": [ # 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. 1342 { # Contains information about an operating system that can be targeted by ads. 1343 "mobile": True or False, # Whether this operating system is for mobile. 1344 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1345 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1346 "name": "A String", # Name of this operating system. 1347 "desktop": True or False, # Whether this operating system is for desktop. 1348 }, 1349 ], 1350 "mobileCarriers": [ # 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. 1351 { # Contains information about a mobile carrier that can be targeted by ads. 1352 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 1353 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 1354 "id": "A String", # ID of this mobile carrier. 1355 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 1356 "name": "A String", # Name of this mobile carrier. 1357 }, 1358 ], 1359 "connectionTypes": [ # 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. 1360 { # 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. 1361 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 1362 "id": "A String", # ID of this connection type. 1363 "name": "A String", # Name of this connection type. 1364 }, 1365 ], 1366 }, 1367 "creativeRotation": { # Creative Rotation. # 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. 1368 "creativeAssignments": [ # Creative assignments in this creative rotation. 1369 { # Creative Assignment. 1370 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 1371 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 1372 "applyEventTags": True or False, # 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. 1373 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 1374 # Applicable when the creative type is any of the following: 1375 # - DISPLAY 1376 # - RICH_MEDIA_INPAGE 1377 # - RICH_MEDIA_INPAGE_FLOATING 1378 # - RICH_MEDIA_IM_EXPAND 1379 # - RICH_MEDIA_EXPANDING 1380 # - RICH_MEDIA_INTERSTITIAL_FLOAT 1381 # - RICH_MEDIA_MOBILE_IN_APP 1382 # - RICH_MEDIA_MULTI_FLOATING 1383 # - RICH_MEDIA_PEEL_DOWN 1384 # - VPAID_LINEAR 1385 # - VPAID_NON_LINEAR 1386 { # Rich Media Exit Override. 1387 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 1388 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1389 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1390 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1391 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1392 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1393 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1394 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1395 }, 1396 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 1397 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 1398 }, 1399 ], 1400 "sslCompliant": True or False, # 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. 1401 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 1402 { # Creative Group Assignment. 1403 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 1404 "creativeGroupId": "A String", # ID of the creative group to be assigned. 1405 }, 1406 ], 1407 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 1408 { # Companion Click-through override. 1409 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 1410 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1411 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1412 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1413 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1414 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1415 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1416 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1417 }, 1418 "creativeId": "A String", # ID of the creative for this companion click-through override. 1419 }, 1420 ], 1421 "startTime": "A String", # Date and time that the assigned creative should start serving. 1422 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 1423 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1424 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1425 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1426 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1427 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1428 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1429 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1430 }, 1431 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 1432 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 1433 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 1434 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 1435 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1436 "value": "A String", # The value of the dimension. 1437 "dimensionName": "A String", # The name of the dimension. 1438 "etag": "A String", # The eTag of this response for caching purposes. 1439 "matchType": "A 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. 1440 "id": "A String", # The ID associated with the value if available. 1441 }, 1442 }, 1443 ], 1444 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 1445 "creativeOptimizationConfigurationId": "A String", # 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. 1446 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 1447 }, 1448 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 1449 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1450 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1451 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1452 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1453 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1454 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1455 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1456 }, 1457 "comments": "A String", # Comments for this ad. 1458 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 1459 "expression": "A String", # Expression describing which lists are being targeted by the ad. 1460 }, 1461 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 1462 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1463 "value": "A String", # The value of the dimension. 1464 "dimensionName": "A String", # The name of the dimension. 1465 "etag": "A String", # The eTag of this response for caching purposes. 1466 "matchType": "A 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. 1467 "id": "A String", # The ID associated with the value if available. 1468 }, 1469 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 1470 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1471 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1472 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1473 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1474 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1475 }, 1476 "type": "A String", # 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). 1477 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 1478 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 1479 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 1480 "expression": "A String", # Keyword expression being targeted by the ad. 1481 }, 1482 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1483 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1484 "value": "A String", # The value of the dimension. 1485 "dimensionName": "A String", # The name of the dimension. 1486 "etag": "A String", # The eTag of this response for caching purposes. 1487 "matchType": "A 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. 1488 "id": "A String", # The ID associated with the value if available. 1489 }, 1490 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 1491 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 1492 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 1493 }, 1494 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 1495 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1496 }, 1497 "startTime": "A String", # 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. 1498 "active": True or False, # Whether this ad is active. When true, archived must be false. 1499 "compatibility": "A 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. 1500 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 1501 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 1502 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 1503 "dayPartTargeting": { # Day Part Targeting. # 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. 1504 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 1505 "hoursOfDay": [ # 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. 1506 42, 1507 ], 1508 "daysOfWeek": [ # Days of the week when the ad will serve. 1509 # 1510 # Acceptable values are: 1511 # - "SUNDAY" 1512 # - "MONDAY" 1513 # - "TUESDAY" 1514 # - "WEDNESDAY" 1515 # - "THURSDAY" 1516 # - "FRIDAY" 1517 # - "SATURDAY" 1518 "A String", 1519 ], 1520 }, 1521 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 1522 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1523 }, 1524 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 1525 "placementAssignments": [ # Placement assignments for this ad. 1526 { # Placement Assignment. 1527 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 1528 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 1529 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1530 "value": "A String", # The value of the dimension. 1531 "dimensionName": "A String", # The name of the dimension. 1532 "etag": "A String", # The eTag of this response for caching purposes. 1533 "matchType": "A 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. 1534 "id": "A String", # The ID associated with the value if available. 1535 }, 1536 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 1537 "sslRequired": True or False, # 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. 1538 }, 1539 ], 1540 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 1541 "dynamicClickTracker": True or False, # 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. 1542 }, 1543 ], 1544 }</pre> 1545 </div> 1546 1547 <div class="method"> 1548 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1549 <pre>Retrieves the next page of results. 1550 1551 Args: 1552 previous_request: The request for the previous page. (required) 1553 previous_response: The response from the request for the previous page. (required) 1554 1555 Returns: 1556 A request object that you can call 'execute()' on to request the next 1557 page. Returns None if there are no more items in the collection. 1558 </pre> 1559 </div> 1560 1561 <div class="method"> 1562 <code class="details" id="patch">patch(profileId, id, body)</code> 1563 <pre>Updates an existing ad. This method supports patch semantics. 1564 1565 Args: 1566 profileId: string, User profile ID associated with this request. (required) 1567 id: string, Ad ID. (required) 1568 body: object, The request body. (required) 1569 The object takes the form of: 1570 1571 { # Contains properties of a DCM ad. 1572 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 1573 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 1574 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 1575 }, 1576 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 1577 "languageTargeting": { # Language Targeting. # 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. 1578 "languages": [ # 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. 1579 { # Contains information about a language that can be targeted by ads. 1580 "languageCode": "A 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. 1581 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 1582 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 1583 "name": "A String", # Name of this language. 1584 }, 1585 ], 1586 }, 1587 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 1588 "geoTargeting": { # Geographical Targeting. # 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. 1589 "countries": [ # 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. 1590 { # Contains information about a country that can be targeted by ads. 1591 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 1592 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 1593 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 1594 "countryCode": "A String", # Country code. 1595 "name": "A String", # Name of this country. 1596 }, 1597 ], 1598 "excludeCountries": True or False, # 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. 1599 "postalCodes": [ # 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. 1600 { # Contains information about a postal code that can be targeted by ads. 1601 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 1602 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 1603 "code": "A String", # Postal code. This is equivalent to the id field. 1604 "id": "A String", # ID of this postal code. 1605 "countryCode": "A String", # Country code of the country to which this postal code belongs. 1606 }, 1607 ], 1608 "regions": [ # 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. 1609 { # Contains information about a region that can be targeted by ads. 1610 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 1611 "countryDartId": "A String", # DART ID of the country to which this region belongs. 1612 "name": "A String", # Name of this region. 1613 "countryCode": "A String", # Country code of the country to which this region belongs. 1614 "regionCode": "A String", # Region code. 1615 "dartId": "A String", # DART ID of this region. 1616 }, 1617 ], 1618 "cities": [ # 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. 1619 { # Contains information about a city that can be targeted by ads. 1620 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 1621 "countryDartId": "A String", # DART ID of the country to which this city belongs. 1622 "name": "A String", # Name of this city. 1623 "countryCode": "A String", # Country code of the country to which this city belongs. 1624 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 1625 "regionCode": "A String", # Region code of the region to which this city belongs. 1626 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 1627 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 1628 "regionDartId": "A String", # DART ID of the region to which this city belongs. 1629 }, 1630 ], 1631 "metros": [ # 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. 1632 { # Contains information about a metro region that can be targeted by ads. 1633 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 1634 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 1635 "name": "A String", # Name of this metro region. 1636 "countryCode": "A String", # Country code of the country to which this metro region belongs. 1637 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 1638 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 1639 "dartId": "A String", # DART ID of this metro region. 1640 }, 1641 ], 1642 }, 1643 "creativeGroupAssignments": [ # 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. 1644 { # Creative Group Assignment. 1645 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 1646 "creativeGroupId": "A String", # ID of the creative group to be assigned. 1647 }, 1648 ], 1649 "deliverySchedule": { # Delivery Schedule. # 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. 1650 "priority": "A 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. 1651 "hardCutoff": True or False, # 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. 1652 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 1653 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 1654 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 1655 }, 1656 "impressionRatio": "A String", # 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. 1657 }, 1658 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1659 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1660 "value": "A String", # The value of the dimension. 1661 "dimensionName": "A String", # The name of the dimension. 1662 "etag": "A String", # The eTag of this response for caching purposes. 1663 "matchType": "A 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. 1664 "id": "A String", # The ID associated with the value if available. 1665 }, 1666 "eventTagOverrides": [ # Event tag overrides for this ad. 1667 { # Event tag override information. 1668 "enabled": True or False, # Whether this override is enabled. 1669 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 1670 }, 1671 ], 1672 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 1673 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 1674 "archived": True or False, # Whether this ad is archived. When true, active must be false. 1675 "targetingTemplateId": "A 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. 1676 "technologyTargeting": { # Technology Targeting. # 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. 1677 "platformTypes": [ # 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. 1678 { # Contains information about a platform type that can be targeted by ads. 1679 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 1680 "id": "A String", # ID of this platform type. 1681 "name": "A String", # Name of this platform type. 1682 }, 1683 ], 1684 "operatingSystemVersions": [ # 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. 1685 { # Contains information about a particular version of an operating system that can be targeted by ads. 1686 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 1687 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 1688 "name": "A String", # Name of this operating system version. 1689 "id": "A String", # ID of this operating system version. 1690 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 1691 "mobile": True or False, # Whether this operating system is for mobile. 1692 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1693 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1694 "name": "A String", # Name of this operating system. 1695 "desktop": True or False, # Whether this operating system is for desktop. 1696 }, 1697 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 1698 }, 1699 ], 1700 "browsers": [ # 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. 1701 { # Contains information about a browser that can be targeted by ads. 1702 "majorVersion": "A 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. 1703 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 1704 "name": "A String", # Name of this browser. 1705 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 1706 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 1707 "minorVersion": "A 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. 1708 }, 1709 ], 1710 "operatingSystems": [ # 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. 1711 { # Contains information about an operating system that can be targeted by ads. 1712 "mobile": True or False, # Whether this operating system is for mobile. 1713 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1714 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1715 "name": "A String", # Name of this operating system. 1716 "desktop": True or False, # Whether this operating system is for desktop. 1717 }, 1718 ], 1719 "mobileCarriers": [ # 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. 1720 { # Contains information about a mobile carrier that can be targeted by ads. 1721 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 1722 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 1723 "id": "A String", # ID of this mobile carrier. 1724 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 1725 "name": "A String", # Name of this mobile carrier. 1726 }, 1727 ], 1728 "connectionTypes": [ # 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. 1729 { # 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. 1730 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 1731 "id": "A String", # ID of this connection type. 1732 "name": "A String", # Name of this connection type. 1733 }, 1734 ], 1735 }, 1736 "creativeRotation": { # Creative Rotation. # 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. 1737 "creativeAssignments": [ # Creative assignments in this creative rotation. 1738 { # Creative Assignment. 1739 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 1740 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 1741 "applyEventTags": True or False, # 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. 1742 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 1743 # Applicable when the creative type is any of the following: 1744 # - DISPLAY 1745 # - RICH_MEDIA_INPAGE 1746 # - RICH_MEDIA_INPAGE_FLOATING 1747 # - RICH_MEDIA_IM_EXPAND 1748 # - RICH_MEDIA_EXPANDING 1749 # - RICH_MEDIA_INTERSTITIAL_FLOAT 1750 # - RICH_MEDIA_MOBILE_IN_APP 1751 # - RICH_MEDIA_MULTI_FLOATING 1752 # - RICH_MEDIA_PEEL_DOWN 1753 # - VPAID_LINEAR 1754 # - VPAID_NON_LINEAR 1755 { # Rich Media Exit Override. 1756 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 1757 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1758 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1759 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1760 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1761 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1762 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1763 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1764 }, 1765 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 1766 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 1767 }, 1768 ], 1769 "sslCompliant": True or False, # 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. 1770 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 1771 { # Creative Group Assignment. 1772 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 1773 "creativeGroupId": "A String", # ID of the creative group to be assigned. 1774 }, 1775 ], 1776 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 1777 { # Companion Click-through override. 1778 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 1779 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1780 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1781 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1782 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1783 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1784 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1785 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1786 }, 1787 "creativeId": "A String", # ID of the creative for this companion click-through override. 1788 }, 1789 ], 1790 "startTime": "A String", # Date and time that the assigned creative should start serving. 1791 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 1792 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1793 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1794 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1795 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1796 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1797 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1798 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1799 }, 1800 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 1801 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 1802 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 1803 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 1804 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1805 "value": "A String", # The value of the dimension. 1806 "dimensionName": "A String", # The name of the dimension. 1807 "etag": "A String", # The eTag of this response for caching purposes. 1808 "matchType": "A 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. 1809 "id": "A String", # The ID associated with the value if available. 1810 }, 1811 }, 1812 ], 1813 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 1814 "creativeOptimizationConfigurationId": "A String", # 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. 1815 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 1816 }, 1817 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 1818 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 1819 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 1820 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 1821 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 1822 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 1823 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 1824 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 1825 }, 1826 "comments": "A String", # Comments for this ad. 1827 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 1828 "expression": "A String", # Expression describing which lists are being targeted by the ad. 1829 }, 1830 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 1831 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1832 "value": "A String", # The value of the dimension. 1833 "dimensionName": "A String", # The name of the dimension. 1834 "etag": "A String", # The eTag of this response for caching purposes. 1835 "matchType": "A 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. 1836 "id": "A String", # The ID associated with the value if available. 1837 }, 1838 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 1839 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1840 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1841 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1842 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1843 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1844 }, 1845 "type": "A String", # 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). 1846 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 1847 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 1848 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 1849 "expression": "A String", # Keyword expression being targeted by the ad. 1850 }, 1851 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1852 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1853 "value": "A String", # The value of the dimension. 1854 "dimensionName": "A String", # The name of the dimension. 1855 "etag": "A String", # The eTag of this response for caching purposes. 1856 "matchType": "A 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. 1857 "id": "A String", # The ID associated with the value if available. 1858 }, 1859 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 1860 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 1861 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 1862 }, 1863 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 1864 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1865 }, 1866 "startTime": "A String", # 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. 1867 "active": True or False, # Whether this ad is active. When true, archived must be false. 1868 "compatibility": "A 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. 1869 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 1870 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 1871 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 1872 "dayPartTargeting": { # Day Part Targeting. # 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. 1873 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 1874 "hoursOfDay": [ # 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. 1875 42, 1876 ], 1877 "daysOfWeek": [ # Days of the week when the ad will serve. 1878 # 1879 # Acceptable values are: 1880 # - "SUNDAY" 1881 # - "MONDAY" 1882 # - "TUESDAY" 1883 # - "WEDNESDAY" 1884 # - "THURSDAY" 1885 # - "FRIDAY" 1886 # - "SATURDAY" 1887 "A String", 1888 ], 1889 }, 1890 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 1891 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1892 }, 1893 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 1894 "placementAssignments": [ # Placement assignments for this ad. 1895 { # Placement Assignment. 1896 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 1897 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 1898 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1899 "value": "A String", # The value of the dimension. 1900 "dimensionName": "A String", # The name of the dimension. 1901 "etag": "A String", # The eTag of this response for caching purposes. 1902 "matchType": "A 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. 1903 "id": "A String", # The ID associated with the value if available. 1904 }, 1905 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 1906 "sslRequired": True or False, # 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. 1907 }, 1908 ], 1909 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 1910 "dynamicClickTracker": True or False, # 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. 1911 } 1912 1913 1914 Returns: 1915 An object of the form: 1916 1917 { # Contains properties of a DCM ad. 1918 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 1919 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 1920 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 1921 }, 1922 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 1923 "languageTargeting": { # Language Targeting. # 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. 1924 "languages": [ # 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. 1925 { # Contains information about a language that can be targeted by ads. 1926 "languageCode": "A 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. 1927 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 1928 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 1929 "name": "A String", # Name of this language. 1930 }, 1931 ], 1932 }, 1933 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 1934 "geoTargeting": { # Geographical Targeting. # 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. 1935 "countries": [ # 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. 1936 { # Contains information about a country that can be targeted by ads. 1937 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 1938 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 1939 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 1940 "countryCode": "A String", # Country code. 1941 "name": "A String", # Name of this country. 1942 }, 1943 ], 1944 "excludeCountries": True or False, # 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. 1945 "postalCodes": [ # 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. 1946 { # Contains information about a postal code that can be targeted by ads. 1947 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 1948 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 1949 "code": "A String", # Postal code. This is equivalent to the id field. 1950 "id": "A String", # ID of this postal code. 1951 "countryCode": "A String", # Country code of the country to which this postal code belongs. 1952 }, 1953 ], 1954 "regions": [ # 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. 1955 { # Contains information about a region that can be targeted by ads. 1956 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 1957 "countryDartId": "A String", # DART ID of the country to which this region belongs. 1958 "name": "A String", # Name of this region. 1959 "countryCode": "A String", # Country code of the country to which this region belongs. 1960 "regionCode": "A String", # Region code. 1961 "dartId": "A String", # DART ID of this region. 1962 }, 1963 ], 1964 "cities": [ # 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. 1965 { # Contains information about a city that can be targeted by ads. 1966 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 1967 "countryDartId": "A String", # DART ID of the country to which this city belongs. 1968 "name": "A String", # Name of this city. 1969 "countryCode": "A String", # Country code of the country to which this city belongs. 1970 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 1971 "regionCode": "A String", # Region code of the region to which this city belongs. 1972 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 1973 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 1974 "regionDartId": "A String", # DART ID of the region to which this city belongs. 1975 }, 1976 ], 1977 "metros": [ # 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. 1978 { # Contains information about a metro region that can be targeted by ads. 1979 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 1980 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 1981 "name": "A String", # Name of this metro region. 1982 "countryCode": "A String", # Country code of the country to which this metro region belongs. 1983 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 1984 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 1985 "dartId": "A String", # DART ID of this metro region. 1986 }, 1987 ], 1988 }, 1989 "creativeGroupAssignments": [ # 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. 1990 { # Creative Group Assignment. 1991 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 1992 "creativeGroupId": "A String", # ID of the creative group to be assigned. 1993 }, 1994 ], 1995 "deliverySchedule": { # Delivery Schedule. # 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. 1996 "priority": "A 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. 1997 "hardCutoff": True or False, # 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. 1998 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 1999 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 2000 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 2001 }, 2002 "impressionRatio": "A String", # 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. 2003 }, 2004 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 2005 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2006 "value": "A String", # The value of the dimension. 2007 "dimensionName": "A String", # The name of the dimension. 2008 "etag": "A String", # The eTag of this response for caching purposes. 2009 "matchType": "A 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. 2010 "id": "A String", # The ID associated with the value if available. 2011 }, 2012 "eventTagOverrides": [ # Event tag overrides for this ad. 2013 { # Event tag override information. 2014 "enabled": True or False, # Whether this override is enabled. 2015 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 2016 }, 2017 ], 2018 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 2019 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 2020 "archived": True or False, # Whether this ad is archived. When true, active must be false. 2021 "targetingTemplateId": "A 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. 2022 "technologyTargeting": { # Technology Targeting. # 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. 2023 "platformTypes": [ # 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. 2024 { # Contains information about a platform type that can be targeted by ads. 2025 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 2026 "id": "A String", # ID of this platform type. 2027 "name": "A String", # Name of this platform type. 2028 }, 2029 ], 2030 "operatingSystemVersions": [ # 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. 2031 { # Contains information about a particular version of an operating system that can be targeted by ads. 2032 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 2033 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 2034 "name": "A String", # Name of this operating system version. 2035 "id": "A String", # ID of this operating system version. 2036 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 2037 "mobile": True or False, # Whether this operating system is for mobile. 2038 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 2039 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 2040 "name": "A String", # Name of this operating system. 2041 "desktop": True or False, # Whether this operating system is for desktop. 2042 }, 2043 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 2044 }, 2045 ], 2046 "browsers": [ # 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. 2047 { # Contains information about a browser that can be targeted by ads. 2048 "majorVersion": "A 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. 2049 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 2050 "name": "A String", # Name of this browser. 2051 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 2052 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 2053 "minorVersion": "A 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. 2054 }, 2055 ], 2056 "operatingSystems": [ # 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. 2057 { # Contains information about an operating system that can be targeted by ads. 2058 "mobile": True or False, # Whether this operating system is for mobile. 2059 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 2060 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 2061 "name": "A String", # Name of this operating system. 2062 "desktop": True or False, # Whether this operating system is for desktop. 2063 }, 2064 ], 2065 "mobileCarriers": [ # 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. 2066 { # Contains information about a mobile carrier that can be targeted by ads. 2067 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 2068 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 2069 "id": "A String", # ID of this mobile carrier. 2070 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 2071 "name": "A String", # Name of this mobile carrier. 2072 }, 2073 ], 2074 "connectionTypes": [ # 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. 2075 { # 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. 2076 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 2077 "id": "A String", # ID of this connection type. 2078 "name": "A String", # Name of this connection type. 2079 }, 2080 ], 2081 }, 2082 "creativeRotation": { # Creative Rotation. # 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. 2083 "creativeAssignments": [ # Creative assignments in this creative rotation. 2084 { # Creative Assignment. 2085 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 2086 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 2087 "applyEventTags": True or False, # 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. 2088 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 2089 # Applicable when the creative type is any of the following: 2090 # - DISPLAY 2091 # - RICH_MEDIA_INPAGE 2092 # - RICH_MEDIA_INPAGE_FLOATING 2093 # - RICH_MEDIA_IM_EXPAND 2094 # - RICH_MEDIA_EXPANDING 2095 # - RICH_MEDIA_INTERSTITIAL_FLOAT 2096 # - RICH_MEDIA_MOBILE_IN_APP 2097 # - RICH_MEDIA_MULTI_FLOATING 2098 # - RICH_MEDIA_PEEL_DOWN 2099 # - VPAID_LINEAR 2100 # - VPAID_NON_LINEAR 2101 { # Rich Media Exit Override. 2102 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 2103 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2104 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2105 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2106 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2107 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2108 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2109 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2110 }, 2111 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 2112 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 2113 }, 2114 ], 2115 "sslCompliant": True or False, # 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. 2116 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 2117 { # Creative Group Assignment. 2118 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 2119 "creativeGroupId": "A String", # ID of the creative group to be assigned. 2120 }, 2121 ], 2122 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 2123 { # Companion Click-through override. 2124 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 2125 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2126 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2127 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2128 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2129 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2130 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2131 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2132 }, 2133 "creativeId": "A String", # ID of the creative for this companion click-through override. 2134 }, 2135 ], 2136 "startTime": "A String", # Date and time that the assigned creative should start serving. 2137 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 2138 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2139 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2140 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2141 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2142 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2143 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2144 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2145 }, 2146 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 2147 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 2148 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 2149 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 2150 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2151 "value": "A String", # The value of the dimension. 2152 "dimensionName": "A String", # The name of the dimension. 2153 "etag": "A String", # The eTag of this response for caching purposes. 2154 "matchType": "A 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. 2155 "id": "A String", # The ID associated with the value if available. 2156 }, 2157 }, 2158 ], 2159 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 2160 "creativeOptimizationConfigurationId": "A String", # 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. 2161 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 2162 }, 2163 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 2164 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2165 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2166 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2167 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2168 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2169 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2170 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2171 }, 2172 "comments": "A String", # Comments for this ad. 2173 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 2174 "expression": "A String", # Expression describing which lists are being targeted by the ad. 2175 }, 2176 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 2177 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2178 "value": "A String", # The value of the dimension. 2179 "dimensionName": "A String", # The name of the dimension. 2180 "etag": "A String", # The eTag of this response for caching purposes. 2181 "matchType": "A 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. 2182 "id": "A String", # The ID associated with the value if available. 2183 }, 2184 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 2185 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 2186 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 2187 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 2188 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 2189 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 2190 }, 2191 "type": "A String", # 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). 2192 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 2193 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 2194 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 2195 "expression": "A String", # Keyword expression being targeted by the ad. 2196 }, 2197 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 2198 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2199 "value": "A String", # The value of the dimension. 2200 "dimensionName": "A String", # The name of the dimension. 2201 "etag": "A String", # The eTag of this response for caching purposes. 2202 "matchType": "A 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. 2203 "id": "A String", # The ID associated with the value if available. 2204 }, 2205 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 2206 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 2207 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 2208 }, 2209 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 2210 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 2211 }, 2212 "startTime": "A String", # 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. 2213 "active": True or False, # Whether this ad is active. When true, archived must be false. 2214 "compatibility": "A 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. 2215 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 2216 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 2217 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 2218 "dayPartTargeting": { # Day Part Targeting. # 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. 2219 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 2220 "hoursOfDay": [ # 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. 2221 42, 2222 ], 2223 "daysOfWeek": [ # Days of the week when the ad will serve. 2224 # 2225 # Acceptable values are: 2226 # - "SUNDAY" 2227 # - "MONDAY" 2228 # - "TUESDAY" 2229 # - "WEDNESDAY" 2230 # - "THURSDAY" 2231 # - "FRIDAY" 2232 # - "SATURDAY" 2233 "A String", 2234 ], 2235 }, 2236 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 2237 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 2238 }, 2239 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 2240 "placementAssignments": [ # Placement assignments for this ad. 2241 { # Placement Assignment. 2242 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 2243 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 2244 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2245 "value": "A String", # The value of the dimension. 2246 "dimensionName": "A String", # The name of the dimension. 2247 "etag": "A String", # The eTag of this response for caching purposes. 2248 "matchType": "A 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. 2249 "id": "A String", # The ID associated with the value if available. 2250 }, 2251 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 2252 "sslRequired": True or False, # 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. 2253 }, 2254 ], 2255 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 2256 "dynamicClickTracker": True or False, # 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. 2257 }</pre> 2258 </div> 2259 2260 <div class="method"> 2261 <code class="details" id="update">update(profileId, body)</code> 2262 <pre>Updates an existing ad. 2263 2264 Args: 2265 profileId: string, User profile ID associated with this request. (required) 2266 body: object, The request body. (required) 2267 The object takes the form of: 2268 2269 { # Contains properties of a DCM ad. 2270 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 2271 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 2272 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 2273 }, 2274 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 2275 "languageTargeting": { # Language Targeting. # 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. 2276 "languages": [ # 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. 2277 { # Contains information about a language that can be targeted by ads. 2278 "languageCode": "A 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. 2279 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 2280 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 2281 "name": "A String", # Name of this language. 2282 }, 2283 ], 2284 }, 2285 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 2286 "geoTargeting": { # Geographical Targeting. # 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. 2287 "countries": [ # 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. 2288 { # Contains information about a country that can be targeted by ads. 2289 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 2290 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 2291 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 2292 "countryCode": "A String", # Country code. 2293 "name": "A String", # Name of this country. 2294 }, 2295 ], 2296 "excludeCountries": True or False, # 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. 2297 "postalCodes": [ # 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. 2298 { # Contains information about a postal code that can be targeted by ads. 2299 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 2300 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 2301 "code": "A String", # Postal code. This is equivalent to the id field. 2302 "id": "A String", # ID of this postal code. 2303 "countryCode": "A String", # Country code of the country to which this postal code belongs. 2304 }, 2305 ], 2306 "regions": [ # 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. 2307 { # Contains information about a region that can be targeted by ads. 2308 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 2309 "countryDartId": "A String", # DART ID of the country to which this region belongs. 2310 "name": "A String", # Name of this region. 2311 "countryCode": "A String", # Country code of the country to which this region belongs. 2312 "regionCode": "A String", # Region code. 2313 "dartId": "A String", # DART ID of this region. 2314 }, 2315 ], 2316 "cities": [ # 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. 2317 { # Contains information about a city that can be targeted by ads. 2318 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 2319 "countryDartId": "A String", # DART ID of the country to which this city belongs. 2320 "name": "A String", # Name of this city. 2321 "countryCode": "A String", # Country code of the country to which this city belongs. 2322 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 2323 "regionCode": "A String", # Region code of the region to which this city belongs. 2324 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 2325 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 2326 "regionDartId": "A String", # DART ID of the region to which this city belongs. 2327 }, 2328 ], 2329 "metros": [ # 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. 2330 { # Contains information about a metro region that can be targeted by ads. 2331 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 2332 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 2333 "name": "A String", # Name of this metro region. 2334 "countryCode": "A String", # Country code of the country to which this metro region belongs. 2335 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 2336 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 2337 "dartId": "A String", # DART ID of this metro region. 2338 }, 2339 ], 2340 }, 2341 "creativeGroupAssignments": [ # 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. 2342 { # Creative Group Assignment. 2343 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 2344 "creativeGroupId": "A String", # ID of the creative group to be assigned. 2345 }, 2346 ], 2347 "deliverySchedule": { # Delivery Schedule. # 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. 2348 "priority": "A 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. 2349 "hardCutoff": True or False, # 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. 2350 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 2351 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 2352 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 2353 }, 2354 "impressionRatio": "A String", # 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. 2355 }, 2356 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 2357 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2358 "value": "A String", # The value of the dimension. 2359 "dimensionName": "A String", # The name of the dimension. 2360 "etag": "A String", # The eTag of this response for caching purposes. 2361 "matchType": "A 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. 2362 "id": "A String", # The ID associated with the value if available. 2363 }, 2364 "eventTagOverrides": [ # Event tag overrides for this ad. 2365 { # Event tag override information. 2366 "enabled": True or False, # Whether this override is enabled. 2367 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 2368 }, 2369 ], 2370 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 2371 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 2372 "archived": True or False, # Whether this ad is archived. When true, active must be false. 2373 "targetingTemplateId": "A 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. 2374 "technologyTargeting": { # Technology Targeting. # 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. 2375 "platformTypes": [ # 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. 2376 { # Contains information about a platform type that can be targeted by ads. 2377 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 2378 "id": "A String", # ID of this platform type. 2379 "name": "A String", # Name of this platform type. 2380 }, 2381 ], 2382 "operatingSystemVersions": [ # 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. 2383 { # Contains information about a particular version of an operating system that can be targeted by ads. 2384 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 2385 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 2386 "name": "A String", # Name of this operating system version. 2387 "id": "A String", # ID of this operating system version. 2388 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 2389 "mobile": True or False, # Whether this operating system is for mobile. 2390 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 2391 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 2392 "name": "A String", # Name of this operating system. 2393 "desktop": True or False, # Whether this operating system is for desktop. 2394 }, 2395 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 2396 }, 2397 ], 2398 "browsers": [ # 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. 2399 { # Contains information about a browser that can be targeted by ads. 2400 "majorVersion": "A 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. 2401 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 2402 "name": "A String", # Name of this browser. 2403 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 2404 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 2405 "minorVersion": "A 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. 2406 }, 2407 ], 2408 "operatingSystems": [ # 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. 2409 { # Contains information about an operating system that can be targeted by ads. 2410 "mobile": True or False, # Whether this operating system is for mobile. 2411 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 2412 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 2413 "name": "A String", # Name of this operating system. 2414 "desktop": True or False, # Whether this operating system is for desktop. 2415 }, 2416 ], 2417 "mobileCarriers": [ # 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. 2418 { # Contains information about a mobile carrier that can be targeted by ads. 2419 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 2420 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 2421 "id": "A String", # ID of this mobile carrier. 2422 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 2423 "name": "A String", # Name of this mobile carrier. 2424 }, 2425 ], 2426 "connectionTypes": [ # 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. 2427 { # 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. 2428 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 2429 "id": "A String", # ID of this connection type. 2430 "name": "A String", # Name of this connection type. 2431 }, 2432 ], 2433 }, 2434 "creativeRotation": { # Creative Rotation. # 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. 2435 "creativeAssignments": [ # Creative assignments in this creative rotation. 2436 { # Creative Assignment. 2437 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 2438 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 2439 "applyEventTags": True or False, # 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. 2440 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 2441 # Applicable when the creative type is any of the following: 2442 # - DISPLAY 2443 # - RICH_MEDIA_INPAGE 2444 # - RICH_MEDIA_INPAGE_FLOATING 2445 # - RICH_MEDIA_IM_EXPAND 2446 # - RICH_MEDIA_EXPANDING 2447 # - RICH_MEDIA_INTERSTITIAL_FLOAT 2448 # - RICH_MEDIA_MOBILE_IN_APP 2449 # - RICH_MEDIA_MULTI_FLOATING 2450 # - RICH_MEDIA_PEEL_DOWN 2451 # - VPAID_LINEAR 2452 # - VPAID_NON_LINEAR 2453 { # Rich Media Exit Override. 2454 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 2455 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2456 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2457 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2458 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2459 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2460 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2461 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2462 }, 2463 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 2464 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 2465 }, 2466 ], 2467 "sslCompliant": True or False, # 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. 2468 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 2469 { # Creative Group Assignment. 2470 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 2471 "creativeGroupId": "A String", # ID of the creative group to be assigned. 2472 }, 2473 ], 2474 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 2475 { # Companion Click-through override. 2476 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 2477 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2478 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2479 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2480 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2481 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2482 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2483 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2484 }, 2485 "creativeId": "A String", # ID of the creative for this companion click-through override. 2486 }, 2487 ], 2488 "startTime": "A String", # Date and time that the assigned creative should start serving. 2489 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 2490 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2491 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2492 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2493 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2494 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2495 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2496 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2497 }, 2498 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 2499 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 2500 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 2501 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 2502 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2503 "value": "A String", # The value of the dimension. 2504 "dimensionName": "A String", # The name of the dimension. 2505 "etag": "A String", # The eTag of this response for caching purposes. 2506 "matchType": "A 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. 2507 "id": "A String", # The ID associated with the value if available. 2508 }, 2509 }, 2510 ], 2511 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 2512 "creativeOptimizationConfigurationId": "A String", # 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. 2513 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 2514 }, 2515 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 2516 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2517 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2518 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2519 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2520 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2521 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2522 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2523 }, 2524 "comments": "A String", # Comments for this ad. 2525 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 2526 "expression": "A String", # Expression describing which lists are being targeted by the ad. 2527 }, 2528 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 2529 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2530 "value": "A String", # The value of the dimension. 2531 "dimensionName": "A String", # The name of the dimension. 2532 "etag": "A String", # The eTag of this response for caching purposes. 2533 "matchType": "A 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. 2534 "id": "A String", # The ID associated with the value if available. 2535 }, 2536 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 2537 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 2538 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 2539 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 2540 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 2541 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 2542 }, 2543 "type": "A String", # 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). 2544 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 2545 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 2546 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 2547 "expression": "A String", # Keyword expression being targeted by the ad. 2548 }, 2549 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 2550 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2551 "value": "A String", # The value of the dimension. 2552 "dimensionName": "A String", # The name of the dimension. 2553 "etag": "A String", # The eTag of this response for caching purposes. 2554 "matchType": "A 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. 2555 "id": "A String", # The ID associated with the value if available. 2556 }, 2557 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 2558 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 2559 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 2560 }, 2561 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 2562 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 2563 }, 2564 "startTime": "A String", # 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. 2565 "active": True or False, # Whether this ad is active. When true, archived must be false. 2566 "compatibility": "A 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. 2567 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 2568 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 2569 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 2570 "dayPartTargeting": { # Day Part Targeting. # 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. 2571 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 2572 "hoursOfDay": [ # 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. 2573 42, 2574 ], 2575 "daysOfWeek": [ # Days of the week when the ad will serve. 2576 # 2577 # Acceptable values are: 2578 # - "SUNDAY" 2579 # - "MONDAY" 2580 # - "TUESDAY" 2581 # - "WEDNESDAY" 2582 # - "THURSDAY" 2583 # - "FRIDAY" 2584 # - "SATURDAY" 2585 "A String", 2586 ], 2587 }, 2588 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 2589 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 2590 }, 2591 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 2592 "placementAssignments": [ # Placement assignments for this ad. 2593 { # Placement Assignment. 2594 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 2595 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 2596 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2597 "value": "A String", # The value of the dimension. 2598 "dimensionName": "A String", # The name of the dimension. 2599 "etag": "A String", # The eTag of this response for caching purposes. 2600 "matchType": "A 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. 2601 "id": "A String", # The ID associated with the value if available. 2602 }, 2603 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 2604 "sslRequired": True or False, # 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. 2605 }, 2606 ], 2607 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 2608 "dynamicClickTracker": True or False, # 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. 2609 } 2610 2611 2612 Returns: 2613 An object of the form: 2614 2615 { # Contains properties of a DCM ad. 2616 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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. 2617 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 2618 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 2619 }, 2620 "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion. 2621 "languageTargeting": { # Language Targeting. # 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. 2622 "languages": [ # 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. 2623 { # Contains information about a language that can be targeted by ads. 2624 "languageCode": "A 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. 2625 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 2626 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 2627 "name": "A String", # Name of this language. 2628 }, 2629 ], 2630 }, 2631 "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion. 2632 "geoTargeting": { # Geographical Targeting. # 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. 2633 "countries": [ # 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. 2634 { # Contains information about a country that can be targeted by ads. 2635 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 2636 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 2637 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 2638 "countryCode": "A String", # Country code. 2639 "name": "A String", # Name of this country. 2640 }, 2641 ], 2642 "excludeCountries": True or False, # 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. 2643 "postalCodes": [ # 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. 2644 { # Contains information about a postal code that can be targeted by ads. 2645 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 2646 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 2647 "code": "A String", # Postal code. This is equivalent to the id field. 2648 "id": "A String", # ID of this postal code. 2649 "countryCode": "A String", # Country code of the country to which this postal code belongs. 2650 }, 2651 ], 2652 "regions": [ # 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. 2653 { # Contains information about a region that can be targeted by ads. 2654 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 2655 "countryDartId": "A String", # DART ID of the country to which this region belongs. 2656 "name": "A String", # Name of this region. 2657 "countryCode": "A String", # Country code of the country to which this region belongs. 2658 "regionCode": "A String", # Region code. 2659 "dartId": "A String", # DART ID of this region. 2660 }, 2661 ], 2662 "cities": [ # 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. 2663 { # Contains information about a city that can be targeted by ads. 2664 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 2665 "countryDartId": "A String", # DART ID of the country to which this city belongs. 2666 "name": "A String", # Name of this city. 2667 "countryCode": "A String", # Country code of the country to which this city belongs. 2668 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 2669 "regionCode": "A String", # Region code of the region to which this city belongs. 2670 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 2671 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 2672 "regionDartId": "A String", # DART ID of the region to which this city belongs. 2673 }, 2674 ], 2675 "metros": [ # 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. 2676 { # Contains information about a metro region that can be targeted by ads. 2677 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 2678 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 2679 "name": "A String", # Name of this metro region. 2680 "countryCode": "A String", # Country code of the country to which this metro region belongs. 2681 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 2682 "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. 2683 "dartId": "A String", # DART ID of this metro region. 2684 }, 2685 ], 2686 }, 2687 "creativeGroupAssignments": [ # 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. 2688 { # Creative Group Assignment. 2689 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 2690 "creativeGroupId": "A String", # ID of the creative group to be assigned. 2691 }, 2692 ], 2693 "deliverySchedule": { # Delivery Schedule. # 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. 2694 "priority": "A 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. 2695 "hardCutoff": True or False, # 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. 2696 "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time. 2697 "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. 2698 "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. 2699 }, 2700 "impressionRatio": "A String", # 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. 2701 }, 2702 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 2703 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2704 "value": "A String", # The value of the dimension. 2705 "dimensionName": "A String", # The name of the dimension. 2706 "etag": "A String", # The eTag of this response for caching purposes. 2707 "matchType": "A 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. 2708 "id": "A String", # The ID associated with the value if available. 2709 }, 2710 "eventTagOverrides": [ # Event tag overrides for this ad. 2711 { # Event tag override information. 2712 "enabled": True or False, # Whether this override is enabled. 2713 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 2714 }, 2715 ], 2716 "id": "A String", # ID of this ad. This is a read-only, auto-generated field. 2717 "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank. 2718 "archived": True or False, # Whether this ad is archived. When true, active must be false. 2719 "targetingTemplateId": "A 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. 2720 "technologyTargeting": { # Technology Targeting. # 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. 2721 "platformTypes": [ # 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. 2722 { # Contains information about a platform type that can be targeted by ads. 2723 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 2724 "id": "A String", # ID of this platform type. 2725 "name": "A String", # Name of this platform type. 2726 }, 2727 ], 2728 "operatingSystemVersions": [ # 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. 2729 { # Contains information about a particular version of an operating system that can be targeted by ads. 2730 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 2731 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 2732 "name": "A String", # Name of this operating system version. 2733 "id": "A String", # ID of this operating system version. 2734 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 2735 "mobile": True or False, # Whether this operating system is for mobile. 2736 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 2737 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 2738 "name": "A String", # Name of this operating system. 2739 "desktop": True or False, # Whether this operating system is for desktop. 2740 }, 2741 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 2742 }, 2743 ], 2744 "browsers": [ # 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. 2745 { # Contains information about a browser that can be targeted by ads. 2746 "majorVersion": "A 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. 2747 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 2748 "name": "A String", # Name of this browser. 2749 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 2750 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 2751 "minorVersion": "A 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. 2752 }, 2753 ], 2754 "operatingSystems": [ # 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. 2755 { # Contains information about an operating system that can be targeted by ads. 2756 "mobile": True or False, # Whether this operating system is for mobile. 2757 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 2758 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 2759 "name": "A String", # Name of this operating system. 2760 "desktop": True or False, # Whether this operating system is for desktop. 2761 }, 2762 ], 2763 "mobileCarriers": [ # 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. 2764 { # Contains information about a mobile carrier that can be targeted by ads. 2765 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 2766 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 2767 "id": "A String", # ID of this mobile carrier. 2768 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 2769 "name": "A String", # Name of this mobile carrier. 2770 }, 2771 ], 2772 "connectionTypes": [ # 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. 2773 { # 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. 2774 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 2775 "id": "A String", # ID of this connection type. 2776 "name": "A String", # Name of this connection type. 2777 }, 2778 ], 2779 }, 2780 "creativeRotation": { # Creative Rotation. # 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. 2781 "creativeAssignments": [ # Creative assignments in this creative rotation. 2782 { # Creative Assignment. 2783 "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. 2784 "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. 2785 "applyEventTags": True or False, # 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. 2786 "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. 2787 # Applicable when the creative type is any of the following: 2788 # - DISPLAY 2789 # - RICH_MEDIA_INPAGE 2790 # - RICH_MEDIA_INPAGE_FLOATING 2791 # - RICH_MEDIA_IM_EXPAND 2792 # - RICH_MEDIA_EXPANDING 2793 # - RICH_MEDIA_INTERSTITIAL_FLOAT 2794 # - RICH_MEDIA_MOBILE_IN_APP 2795 # - RICH_MEDIA_MULTI_FLOATING 2796 # - RICH_MEDIA_PEEL_DOWN 2797 # - VPAID_LINEAR 2798 # - VPAID_NON_LINEAR 2799 { # Rich Media Exit Override. 2800 "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. 2801 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2802 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2803 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2804 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2805 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2806 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2807 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2808 }, 2809 "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used. 2810 "exitId": "A String", # ID for the override to refer to a specific exit in the creative. 2811 }, 2812 ], 2813 "sslCompliant": True or False, # 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. 2814 "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. 2815 { # Creative Group Assignment. 2816 "creativeGroupNumber": "A String", # Creative group number of the creative group assignment. 2817 "creativeGroupId": "A String", # ID of the creative group to be assigned. 2818 }, 2819 ], 2820 "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads. 2821 { # Companion Click-through override. 2822 "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override. 2823 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2824 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2825 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2826 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2827 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2828 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2829 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2830 }, 2831 "creativeId": "A String", # ID of the creative for this companion click-through override. 2832 }, 2833 ], 2834 "startTime": "A String", # Date and time that the assigned creative should start serving. 2835 "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment. 2836 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2837 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2838 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2839 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2840 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2841 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2842 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2843 }, 2844 "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. 2845 "creativeId": "A String", # ID of the creative to be assigned. This is a required field. 2846 "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time. 2847 "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field. 2848 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2849 "value": "A String", # The value of the dimension. 2850 "dimensionName": "A String", # The name of the dimension. 2851 "etag": "A String", # The eTag of this response for caching purposes. 2852 "matchType": "A 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. 2853 "id": "A String", # The ID associated with the value if available. 2854 }, 2855 }, 2856 ], 2857 "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. 2858 "creativeOptimizationConfigurationId": "A String", # 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. 2859 "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation. 2860 }, 2861 "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. 2862 "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: 2863 # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. 2864 # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. 2865 # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. 2866 "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. 2867 "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. 2868 "defaultLandingPage": True or False, # Whether the campaign default landing page is used. 2869 }, 2870 "comments": "A String", # Comments for this ad. 2871 "remarketingListExpression": { # Remarketing List Targeting Expression. # 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. 2872 "expression": "A String", # Expression describing which lists are being targeted by the ad. 2873 }, 2874 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field. 2875 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2876 "value": "A String", # The value of the dimension. 2877 "dimensionName": "A String", # The name of the dimension. 2878 "etag": "A String", # The eTag of this response for caching purposes. 2879 "matchType": "A 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. 2880 "id": "A String", # The ID associated with the value if available. 2881 }, 2882 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. 2883 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 2884 "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 2885 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 2886 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 2887 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 2888 }, 2889 "type": "A String", # 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). 2890 "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. 2891 "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. 2892 "keyValueTargetingExpression": { # Key Value Targeting Expression. # 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. 2893 "expression": "A String", # Keyword expression being targeted by the ad. 2894 }, 2895 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 2896 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2897 "value": "A String", # The value of the dimension. 2898 "dimensionName": "A String", # The name of the dimension. 2899 "etag": "A String", # The eTag of this response for caching purposes. 2900 "matchType": "A 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. 2901 "id": "A String", # The ID associated with the value if available. 2902 }, 2903 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad. 2904 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 2905 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 2906 }, 2907 "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field. 2908 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 2909 }, 2910 "startTime": "A String", # 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. 2911 "active": True or False, # Whether this ad is active. When true, archived must be false. 2912 "compatibility": "A 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. 2913 "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". 2914 "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank. 2915 "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long. 2916 "dayPartTargeting": { # Day Part Targeting. # 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. 2917 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 2918 "hoursOfDay": [ # 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. 2919 42, 2920 ], 2921 "daysOfWeek": [ # Days of the week when the ad will serve. 2922 # 2923 # Acceptable values are: 2924 # - "SUNDAY" 2925 # - "MONDAY" 2926 # - "TUESDAY" 2927 # - "WEDNESDAY" 2928 # - "THURSDAY" 2929 # - "FRIDAY" 2930 # - "SATURDAY" 2931 "A String", 2932 ], 2933 }, 2934 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field. 2935 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 2936 }, 2937 "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. 2938 "placementAssignments": [ # Placement assignments for this ad. 2939 { # Placement Assignment. 2940 "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. 2941 "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field. 2942 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 2943 "value": "A String", # The value of the dimension. 2944 "dimensionName": "A String", # The name of the dimension. 2945 "etag": "A String", # The eTag of this response for caching purposes. 2946 "matchType": "A 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. 2947 "id": "A String", # The ID associated with the value if available. 2948 }, 2949 "placementId": "A String", # ID of the placement to be assigned. This is a required field. 2950 "sslRequired": True or False, # 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. 2951 }, 2952 ], 2953 "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. 2954 "dynamicClickTracker": True or False, # 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. 2955 }</pre> 2956 </div> 2957 2958 </body></html>
