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