1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.targetingTemplates.html">targetingTemplates</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#get">get(profileId, id)</a></code></p> 79 <p class="firstline">Gets one targeting template by ID.</p> 80 <p class="toc_element"> 81 <code><a href="#insert">insert(profileId, body)</a></code></p> 82 <p class="firstline">Inserts a new targeting template.</p> 83 <p class="toc_element"> 84 <code><a href="#list">list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p> 85 <p class="firstline">Retrieves a list of targeting templates, optionally filtered. This method supports paging.</p> 86 <p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88 <p class="firstline">Retrieves the next page of results.</p> 89 <p class="toc_element"> 90 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 91 <p class="firstline">Updates an existing targeting template. This method supports patch semantics.</p> 92 <p class="toc_element"> 93 <code><a href="#update">update(profileId, body)</a></code></p> 94 <p class="firstline">Updates an existing targeting template.</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="get">get(profileId, id)</code> 98 <pre>Gets one targeting template by ID. 99 100 Args: 101 profileId: string, User profile ID associated with this request. (required) 102 id: string, Targeting template ID. (required) 103 104 Returns: 105 An object of the form: 106 107 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 108 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 109 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 110 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 111 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 112 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 113 "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. 114 42, 115 ], 116 "daysOfWeek": [ # Days of the week when the ad will serve. 117 # 118 # Acceptable values are: 119 # - "SUNDAY" 120 # - "MONDAY" 121 # - "TUESDAY" 122 # - "WEDNESDAY" 123 # - "THURSDAY" 124 # - "FRIDAY" 125 # - "SATURDAY" 126 "A String", 127 ], 128 }, 129 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 130 "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. 131 { # Contains information about a platform type that can be targeted by ads. 132 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 133 "id": "A String", # ID of this platform type. 134 "name": "A String", # Name of this platform type. 135 }, 136 ], 137 "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. 138 { # Contains information about a particular version of an operating system that can be targeted by ads. 139 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 140 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 141 "name": "A String", # Name of this operating system version. 142 "id": "A String", # ID of this operating system version. 143 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 144 "mobile": True or False, # Whether this operating system is for mobile. 145 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 146 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 147 "name": "A String", # Name of this operating system. 148 "desktop": True or False, # Whether this operating system is for desktop. 149 }, 150 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 151 }, 152 ], 153 "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. 154 { # Contains information about a browser that can be targeted by ads. 155 "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. 156 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 157 "name": "A String", # Name of this browser. 158 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 159 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 160 "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. 161 }, 162 ], 163 "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. 164 { # Contains information about an operating system that can be targeted by ads. 165 "mobile": True or False, # Whether this operating system is for mobile. 166 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 167 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 168 "name": "A String", # Name of this operating system. 169 "desktop": True or False, # Whether this operating system is for desktop. 170 }, 171 ], 172 "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. 173 { # Contains information about a mobile carrier that can be targeted by ads. 174 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 175 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 176 "id": "A String", # ID of this mobile carrier. 177 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 178 "name": "A String", # Name of this mobile carrier. 179 }, 180 ], 181 "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. 182 { # 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. 183 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 184 "id": "A String", # ID of this connection type. 185 "name": "A String", # Name of this connection type. 186 }, 187 ], 188 }, 189 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 190 "expression": "A String", # Expression describing which lists are being targeted by the ad. 191 }, 192 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 193 "expression": "A String", # Keyword expression being targeted by the ad. 194 }, 195 "languageTargeting": { # Language Targeting. # Language targeting criteria. 196 "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. 197 { # Contains information about a language that can be targeted by ads. 198 "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. 199 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 200 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 201 "name": "A String", # Name of this language. 202 }, 203 ], 204 }, 205 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 206 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 207 "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. 208 { # Contains information about a country that can be targeted by ads. 209 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 210 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 211 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 212 "countryCode": "A String", # Country code. 213 "name": "A String", # Name of this country. 214 }, 215 ], 216 "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. 217 "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. 218 { # Contains information about a postal code that can be targeted by ads. 219 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 220 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 221 "code": "A String", # Postal code. This is equivalent to the id field. 222 "id": "A String", # ID of this postal code. 223 "countryCode": "A String", # Country code of the country to which this postal code belongs. 224 }, 225 ], 226 "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. 227 { # Contains information about a region that can be targeted by ads. 228 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 229 "countryDartId": "A String", # DART ID of the country to which this region belongs. 230 "name": "A String", # Name of this region. 231 "countryCode": "A String", # Country code of the country to which this region belongs. 232 "regionCode": "A String", # Region code. 233 "dartId": "A String", # DART ID of this region. 234 }, 235 ], 236 "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. 237 { # Contains information about a city that can be targeted by ads. 238 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 239 "countryDartId": "A String", # DART ID of the country to which this city belongs. 240 "name": "A String", # Name of this city. 241 "countryCode": "A String", # Country code of the country to which this city belongs. 242 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 243 "regionCode": "A String", # Region code of the region to which this city belongs. 244 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 245 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 246 "regionDartId": "A String", # DART ID of the region to which this city belongs. 247 }, 248 ], 249 "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. 250 { # Contains information about a metro region that can be targeted by ads. 251 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 252 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 253 "name": "A String", # Name of this metro region. 254 "countryCode": "A String", # Country code of the country to which this metro region belongs. 255 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 256 "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. 257 "dartId": "A String", # DART ID of this metro region. 258 }, 259 ], 260 }, 261 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 262 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 263 "value": "A String", # The value of the dimension. 264 "dimensionName": "A String", # The name of the dimension. 265 "etag": "A String", # The eTag of this response for caching purposes. 266 "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. 267 "id": "A String", # The ID associated with the value if available. 268 }, 269 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 270 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 271 }</pre> 272 </div> 273 274 <div class="method"> 275 <code class="details" id="insert">insert(profileId, body)</code> 276 <pre>Inserts a new targeting template. 277 278 Args: 279 profileId: string, User profile ID associated with this request. (required) 280 body: object, The request body. (required) 281 The object takes the form of: 282 283 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 284 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 285 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 286 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 287 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 288 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 289 "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. 290 42, 291 ], 292 "daysOfWeek": [ # Days of the week when the ad will serve. 293 # 294 # Acceptable values are: 295 # - "SUNDAY" 296 # - "MONDAY" 297 # - "TUESDAY" 298 # - "WEDNESDAY" 299 # - "THURSDAY" 300 # - "FRIDAY" 301 # - "SATURDAY" 302 "A String", 303 ], 304 }, 305 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 306 "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. 307 { # Contains information about a platform type that can be targeted by ads. 308 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 309 "id": "A String", # ID of this platform type. 310 "name": "A String", # Name of this platform type. 311 }, 312 ], 313 "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. 314 { # Contains information about a particular version of an operating system that can be targeted by ads. 315 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 316 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 317 "name": "A String", # Name of this operating system version. 318 "id": "A String", # ID of this operating system version. 319 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 320 "mobile": True or False, # Whether this operating system is for mobile. 321 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 322 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 323 "name": "A String", # Name of this operating system. 324 "desktop": True or False, # Whether this operating system is for desktop. 325 }, 326 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 327 }, 328 ], 329 "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. 330 { # Contains information about a browser that can be targeted by ads. 331 "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. 332 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 333 "name": "A String", # Name of this browser. 334 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 335 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 336 "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. 337 }, 338 ], 339 "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. 340 { # Contains information about an operating system that can be targeted by ads. 341 "mobile": True or False, # Whether this operating system is for mobile. 342 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 343 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 344 "name": "A String", # Name of this operating system. 345 "desktop": True or False, # Whether this operating system is for desktop. 346 }, 347 ], 348 "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. 349 { # Contains information about a mobile carrier that can be targeted by ads. 350 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 351 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 352 "id": "A String", # ID of this mobile carrier. 353 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 354 "name": "A String", # Name of this mobile carrier. 355 }, 356 ], 357 "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. 358 { # 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. 359 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 360 "id": "A String", # ID of this connection type. 361 "name": "A String", # Name of this connection type. 362 }, 363 ], 364 }, 365 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 366 "expression": "A String", # Expression describing which lists are being targeted by the ad. 367 }, 368 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 369 "expression": "A String", # Keyword expression being targeted by the ad. 370 }, 371 "languageTargeting": { # Language Targeting. # Language targeting criteria. 372 "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. 373 { # Contains information about a language that can be targeted by ads. 374 "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. 375 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 376 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 377 "name": "A String", # Name of this language. 378 }, 379 ], 380 }, 381 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 382 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 383 "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. 384 { # Contains information about a country that can be targeted by ads. 385 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 386 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 387 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 388 "countryCode": "A String", # Country code. 389 "name": "A String", # Name of this country. 390 }, 391 ], 392 "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. 393 "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. 394 { # Contains information about a postal code that can be targeted by ads. 395 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 396 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 397 "code": "A String", # Postal code. This is equivalent to the id field. 398 "id": "A String", # ID of this postal code. 399 "countryCode": "A String", # Country code of the country to which this postal code belongs. 400 }, 401 ], 402 "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. 403 { # Contains information about a region that can be targeted by ads. 404 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 405 "countryDartId": "A String", # DART ID of the country to which this region belongs. 406 "name": "A String", # Name of this region. 407 "countryCode": "A String", # Country code of the country to which this region belongs. 408 "regionCode": "A String", # Region code. 409 "dartId": "A String", # DART ID of this region. 410 }, 411 ], 412 "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. 413 { # Contains information about a city that can be targeted by ads. 414 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 415 "countryDartId": "A String", # DART ID of the country to which this city belongs. 416 "name": "A String", # Name of this city. 417 "countryCode": "A String", # Country code of the country to which this city belongs. 418 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 419 "regionCode": "A String", # Region code of the region to which this city belongs. 420 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 421 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 422 "regionDartId": "A String", # DART ID of the region to which this city belongs. 423 }, 424 ], 425 "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. 426 { # Contains information about a metro region that can be targeted by ads. 427 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 428 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 429 "name": "A String", # Name of this metro region. 430 "countryCode": "A String", # Country code of the country to which this metro region belongs. 431 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 432 "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. 433 "dartId": "A String", # DART ID of this metro region. 434 }, 435 ], 436 }, 437 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 438 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 439 "value": "A String", # The value of the dimension. 440 "dimensionName": "A String", # The name of the dimension. 441 "etag": "A String", # The eTag of this response for caching purposes. 442 "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. 443 "id": "A String", # The ID associated with the value if available. 444 }, 445 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 446 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 447 } 448 449 450 Returns: 451 An object of the form: 452 453 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 454 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 455 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 456 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 457 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 458 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 459 "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. 460 42, 461 ], 462 "daysOfWeek": [ # Days of the week when the ad will serve. 463 # 464 # Acceptable values are: 465 # - "SUNDAY" 466 # - "MONDAY" 467 # - "TUESDAY" 468 # - "WEDNESDAY" 469 # - "THURSDAY" 470 # - "FRIDAY" 471 # - "SATURDAY" 472 "A String", 473 ], 474 }, 475 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 476 "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. 477 { # Contains information about a platform type that can be targeted by ads. 478 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 479 "id": "A String", # ID of this platform type. 480 "name": "A String", # Name of this platform type. 481 }, 482 ], 483 "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. 484 { # Contains information about a particular version of an operating system that can be targeted by ads. 485 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 486 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 487 "name": "A String", # Name of this operating system version. 488 "id": "A String", # ID of this operating system version. 489 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 490 "mobile": True or False, # Whether this operating system is for mobile. 491 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 492 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 493 "name": "A String", # Name of this operating system. 494 "desktop": True or False, # Whether this operating system is for desktop. 495 }, 496 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 497 }, 498 ], 499 "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. 500 { # Contains information about a browser that can be targeted by ads. 501 "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. 502 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 503 "name": "A String", # Name of this browser. 504 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 505 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 506 "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. 507 }, 508 ], 509 "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. 510 { # Contains information about an operating system that can be targeted by ads. 511 "mobile": True or False, # Whether this operating system is for mobile. 512 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 513 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 514 "name": "A String", # Name of this operating system. 515 "desktop": True or False, # Whether this operating system is for desktop. 516 }, 517 ], 518 "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. 519 { # Contains information about a mobile carrier that can be targeted by ads. 520 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 521 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 522 "id": "A String", # ID of this mobile carrier. 523 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 524 "name": "A String", # Name of this mobile carrier. 525 }, 526 ], 527 "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. 528 { # 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. 529 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 530 "id": "A String", # ID of this connection type. 531 "name": "A String", # Name of this connection type. 532 }, 533 ], 534 }, 535 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 536 "expression": "A String", # Expression describing which lists are being targeted by the ad. 537 }, 538 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 539 "expression": "A String", # Keyword expression being targeted by the ad. 540 }, 541 "languageTargeting": { # Language Targeting. # Language targeting criteria. 542 "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. 543 { # Contains information about a language that can be targeted by ads. 544 "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. 545 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 546 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 547 "name": "A String", # Name of this language. 548 }, 549 ], 550 }, 551 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 552 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 553 "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. 554 { # Contains information about a country that can be targeted by ads. 555 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 556 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 557 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 558 "countryCode": "A String", # Country code. 559 "name": "A String", # Name of this country. 560 }, 561 ], 562 "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. 563 "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. 564 { # Contains information about a postal code that can be targeted by ads. 565 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 566 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 567 "code": "A String", # Postal code. This is equivalent to the id field. 568 "id": "A String", # ID of this postal code. 569 "countryCode": "A String", # Country code of the country to which this postal code belongs. 570 }, 571 ], 572 "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. 573 { # Contains information about a region that can be targeted by ads. 574 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 575 "countryDartId": "A String", # DART ID of the country to which this region belongs. 576 "name": "A String", # Name of this region. 577 "countryCode": "A String", # Country code of the country to which this region belongs. 578 "regionCode": "A String", # Region code. 579 "dartId": "A String", # DART ID of this region. 580 }, 581 ], 582 "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. 583 { # Contains information about a city that can be targeted by ads. 584 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 585 "countryDartId": "A String", # DART ID of the country to which this city belongs. 586 "name": "A String", # Name of this city. 587 "countryCode": "A String", # Country code of the country to which this city belongs. 588 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 589 "regionCode": "A String", # Region code of the region to which this city belongs. 590 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 591 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 592 "regionDartId": "A String", # DART ID of the region to which this city belongs. 593 }, 594 ], 595 "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. 596 { # Contains information about a metro region that can be targeted by ads. 597 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 598 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 599 "name": "A String", # Name of this metro region. 600 "countryCode": "A String", # Country code of the country to which this metro region belongs. 601 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 602 "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. 603 "dartId": "A String", # DART ID of this metro region. 604 }, 605 ], 606 }, 607 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 608 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 609 "value": "A String", # The value of the dimension. 610 "dimensionName": "A String", # The name of the dimension. 611 "etag": "A String", # The eTag of this response for caching purposes. 612 "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. 613 "id": "A String", # The ID associated with the value if available. 614 }, 615 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 616 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 617 }</pre> 618 </div> 619 620 <div class="method"> 621 <code class="details" id="list">list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code> 622 <pre>Retrieves a list of targeting templates, optionally filtered. This method supports paging. 623 624 Args: 625 profileId: string, User profile ID associated with this request. (required) 626 advertiserId: string, Select only targeting templates with this advertiser ID. 627 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". 628 pageToken: string, Value of the nextPageToken from the previous result page. 629 sortField: string, Field by which to sort the list. 630 Allowed values 631 ID - 632 NAME - 633 ids: string, Select only targeting templates with these IDs. (repeated) 634 maxResults: integer, Maximum number of results to return. 635 sortOrder: string, Order of sorted results. 636 Allowed values 637 ASCENDING - 638 DESCENDING - 639 640 Returns: 641 An object of the form: 642 643 { # Targeting Template List Response 644 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 645 "kind": "dfareporting#targetingTemplatesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". 646 "targetingTemplates": [ # Targeting template collection. 647 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 648 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 649 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 650 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 651 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 652 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 653 "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. 654 42, 655 ], 656 "daysOfWeek": [ # Days of the week when the ad will serve. 657 # 658 # Acceptable values are: 659 # - "SUNDAY" 660 # - "MONDAY" 661 # - "TUESDAY" 662 # - "WEDNESDAY" 663 # - "THURSDAY" 664 # - "FRIDAY" 665 # - "SATURDAY" 666 "A String", 667 ], 668 }, 669 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 670 "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. 671 { # Contains information about a platform type that can be targeted by ads. 672 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 673 "id": "A String", # ID of this platform type. 674 "name": "A String", # Name of this platform type. 675 }, 676 ], 677 "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. 678 { # Contains information about a particular version of an operating system that can be targeted by ads. 679 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 680 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 681 "name": "A String", # Name of this operating system version. 682 "id": "A String", # ID of this operating system version. 683 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 684 "mobile": True or False, # Whether this operating system is for mobile. 685 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 686 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 687 "name": "A String", # Name of this operating system. 688 "desktop": True or False, # Whether this operating system is for desktop. 689 }, 690 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 691 }, 692 ], 693 "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. 694 { # Contains information about a browser that can be targeted by ads. 695 "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. 696 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 697 "name": "A String", # Name of this browser. 698 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 699 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 700 "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. 701 }, 702 ], 703 "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. 704 { # Contains information about an operating system that can be targeted by ads. 705 "mobile": True or False, # Whether this operating system is for mobile. 706 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 707 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 708 "name": "A String", # Name of this operating system. 709 "desktop": True or False, # Whether this operating system is for desktop. 710 }, 711 ], 712 "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. 713 { # Contains information about a mobile carrier that can be targeted by ads. 714 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 715 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 716 "id": "A String", # ID of this mobile carrier. 717 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 718 "name": "A String", # Name of this mobile carrier. 719 }, 720 ], 721 "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. 722 { # 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. 723 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 724 "id": "A String", # ID of this connection type. 725 "name": "A String", # Name of this connection type. 726 }, 727 ], 728 }, 729 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 730 "expression": "A String", # Expression describing which lists are being targeted by the ad. 731 }, 732 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 733 "expression": "A String", # Keyword expression being targeted by the ad. 734 }, 735 "languageTargeting": { # Language Targeting. # Language targeting criteria. 736 "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. 737 { # Contains information about a language that can be targeted by ads. 738 "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. 739 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 740 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 741 "name": "A String", # Name of this language. 742 }, 743 ], 744 }, 745 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 746 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 747 "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. 748 { # Contains information about a country that can be targeted by ads. 749 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 750 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 751 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 752 "countryCode": "A String", # Country code. 753 "name": "A String", # Name of this country. 754 }, 755 ], 756 "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. 757 "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. 758 { # Contains information about a postal code that can be targeted by ads. 759 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 760 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 761 "code": "A String", # Postal code. This is equivalent to the id field. 762 "id": "A String", # ID of this postal code. 763 "countryCode": "A String", # Country code of the country to which this postal code belongs. 764 }, 765 ], 766 "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. 767 { # Contains information about a region that can be targeted by ads. 768 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 769 "countryDartId": "A String", # DART ID of the country to which this region belongs. 770 "name": "A String", # Name of this region. 771 "countryCode": "A String", # Country code of the country to which this region belongs. 772 "regionCode": "A String", # Region code. 773 "dartId": "A String", # DART ID of this region. 774 }, 775 ], 776 "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. 777 { # Contains information about a city that can be targeted by ads. 778 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 779 "countryDartId": "A String", # DART ID of the country to which this city belongs. 780 "name": "A String", # Name of this city. 781 "countryCode": "A String", # Country code of the country to which this city belongs. 782 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 783 "regionCode": "A String", # Region code of the region to which this city belongs. 784 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 785 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 786 "regionDartId": "A String", # DART ID of the region to which this city belongs. 787 }, 788 ], 789 "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. 790 { # Contains information about a metro region that can be targeted by ads. 791 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 792 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 793 "name": "A String", # Name of this metro region. 794 "countryCode": "A String", # Country code of the country to which this metro region belongs. 795 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 796 "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. 797 "dartId": "A String", # DART ID of this metro region. 798 }, 799 ], 800 }, 801 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 802 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 803 "value": "A String", # The value of the dimension. 804 "dimensionName": "A String", # The name of the dimension. 805 "etag": "A String", # The eTag of this response for caching purposes. 806 "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. 807 "id": "A String", # The ID associated with the value if available. 808 }, 809 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 810 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 811 }, 812 ], 813 }</pre> 814 </div> 815 816 <div class="method"> 817 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 818 <pre>Retrieves the next page of results. 819 820 Args: 821 previous_request: The request for the previous page. (required) 822 previous_response: The response from the request for the previous page. (required) 823 824 Returns: 825 A request object that you can call 'execute()' on to request the next 826 page. Returns None if there are no more items in the collection. 827 </pre> 828 </div> 829 830 <div class="method"> 831 <code class="details" id="patch">patch(profileId, id, body)</code> 832 <pre>Updates an existing targeting template. This method supports patch semantics. 833 834 Args: 835 profileId: string, User profile ID associated with this request. (required) 836 id: string, Targeting template ID. (required) 837 body: object, The request body. (required) 838 The object takes the form of: 839 840 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 841 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 842 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 843 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 844 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 845 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 846 "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. 847 42, 848 ], 849 "daysOfWeek": [ # Days of the week when the ad will serve. 850 # 851 # Acceptable values are: 852 # - "SUNDAY" 853 # - "MONDAY" 854 # - "TUESDAY" 855 # - "WEDNESDAY" 856 # - "THURSDAY" 857 # - "FRIDAY" 858 # - "SATURDAY" 859 "A String", 860 ], 861 }, 862 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 863 "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. 864 { # Contains information about a platform type that can be targeted by ads. 865 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 866 "id": "A String", # ID of this platform type. 867 "name": "A String", # Name of this platform type. 868 }, 869 ], 870 "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. 871 { # Contains information about a particular version of an operating system that can be targeted by ads. 872 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 873 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 874 "name": "A String", # Name of this operating system version. 875 "id": "A String", # ID of this operating system version. 876 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 877 "mobile": True or False, # Whether this operating system is for mobile. 878 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 879 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 880 "name": "A String", # Name of this operating system. 881 "desktop": True or False, # Whether this operating system is for desktop. 882 }, 883 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 884 }, 885 ], 886 "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. 887 { # Contains information about a browser that can be targeted by ads. 888 "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. 889 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 890 "name": "A String", # Name of this browser. 891 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 892 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 893 "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. 894 }, 895 ], 896 "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. 897 { # Contains information about an operating system that can be targeted by ads. 898 "mobile": True or False, # Whether this operating system is for mobile. 899 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 900 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 901 "name": "A String", # Name of this operating system. 902 "desktop": True or False, # Whether this operating system is for desktop. 903 }, 904 ], 905 "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. 906 { # Contains information about a mobile carrier that can be targeted by ads. 907 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 908 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 909 "id": "A String", # ID of this mobile carrier. 910 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 911 "name": "A String", # Name of this mobile carrier. 912 }, 913 ], 914 "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. 915 { # 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. 916 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 917 "id": "A String", # ID of this connection type. 918 "name": "A String", # Name of this connection type. 919 }, 920 ], 921 }, 922 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 923 "expression": "A String", # Expression describing which lists are being targeted by the ad. 924 }, 925 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 926 "expression": "A String", # Keyword expression being targeted by the ad. 927 }, 928 "languageTargeting": { # Language Targeting. # Language targeting criteria. 929 "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. 930 { # Contains information about a language that can be targeted by ads. 931 "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. 932 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 933 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 934 "name": "A String", # Name of this language. 935 }, 936 ], 937 }, 938 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 939 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 940 "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. 941 { # Contains information about a country that can be targeted by ads. 942 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 943 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 944 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 945 "countryCode": "A String", # Country code. 946 "name": "A String", # Name of this country. 947 }, 948 ], 949 "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. 950 "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. 951 { # Contains information about a postal code that can be targeted by ads. 952 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 953 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 954 "code": "A String", # Postal code. This is equivalent to the id field. 955 "id": "A String", # ID of this postal code. 956 "countryCode": "A String", # Country code of the country to which this postal code belongs. 957 }, 958 ], 959 "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. 960 { # Contains information about a region that can be targeted by ads. 961 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 962 "countryDartId": "A String", # DART ID of the country to which this region belongs. 963 "name": "A String", # Name of this region. 964 "countryCode": "A String", # Country code of the country to which this region belongs. 965 "regionCode": "A String", # Region code. 966 "dartId": "A String", # DART ID of this region. 967 }, 968 ], 969 "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. 970 { # Contains information about a city that can be targeted by ads. 971 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 972 "countryDartId": "A String", # DART ID of the country to which this city belongs. 973 "name": "A String", # Name of this city. 974 "countryCode": "A String", # Country code of the country to which this city belongs. 975 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 976 "regionCode": "A String", # Region code of the region to which this city belongs. 977 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 978 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 979 "regionDartId": "A String", # DART ID of the region to which this city belongs. 980 }, 981 ], 982 "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. 983 { # Contains information about a metro region that can be targeted by ads. 984 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 985 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 986 "name": "A String", # Name of this metro region. 987 "countryCode": "A String", # Country code of the country to which this metro region belongs. 988 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 989 "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. 990 "dartId": "A String", # DART ID of this metro region. 991 }, 992 ], 993 }, 994 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 995 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 996 "value": "A String", # The value of the dimension. 997 "dimensionName": "A String", # The name of the dimension. 998 "etag": "A String", # The eTag of this response for caching purposes. 999 "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. 1000 "id": "A String", # The ID associated with the value if available. 1001 }, 1002 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 1003 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 1004 } 1005 1006 1007 Returns: 1008 An object of the form: 1009 1010 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 1011 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 1012 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 1013 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 1014 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 1015 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 1016 "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. 1017 42, 1018 ], 1019 "daysOfWeek": [ # Days of the week when the ad will serve. 1020 # 1021 # Acceptable values are: 1022 # - "SUNDAY" 1023 # - "MONDAY" 1024 # - "TUESDAY" 1025 # - "WEDNESDAY" 1026 # - "THURSDAY" 1027 # - "FRIDAY" 1028 # - "SATURDAY" 1029 "A String", 1030 ], 1031 }, 1032 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 1033 "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. 1034 { # Contains information about a platform type that can be targeted by ads. 1035 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 1036 "id": "A String", # ID of this platform type. 1037 "name": "A String", # Name of this platform type. 1038 }, 1039 ], 1040 "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. 1041 { # Contains information about a particular version of an operating system that can be targeted by ads. 1042 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 1043 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 1044 "name": "A String", # Name of this operating system version. 1045 "id": "A String", # ID of this operating system version. 1046 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 1047 "mobile": True or False, # Whether this operating system is for mobile. 1048 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1049 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1050 "name": "A String", # Name of this operating system. 1051 "desktop": True or False, # Whether this operating system is for desktop. 1052 }, 1053 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 1054 }, 1055 ], 1056 "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. 1057 { # Contains information about a browser that can be targeted by ads. 1058 "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. 1059 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 1060 "name": "A String", # Name of this browser. 1061 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 1062 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 1063 "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. 1064 }, 1065 ], 1066 "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. 1067 { # Contains information about an operating system that can be targeted by ads. 1068 "mobile": True or False, # Whether this operating system is for mobile. 1069 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1070 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1071 "name": "A String", # Name of this operating system. 1072 "desktop": True or False, # Whether this operating system is for desktop. 1073 }, 1074 ], 1075 "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. 1076 { # Contains information about a mobile carrier that can be targeted by ads. 1077 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 1078 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 1079 "id": "A String", # ID of this mobile carrier. 1080 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 1081 "name": "A String", # Name of this mobile carrier. 1082 }, 1083 ], 1084 "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. 1085 { # 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. 1086 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 1087 "id": "A String", # ID of this connection type. 1088 "name": "A String", # Name of this connection type. 1089 }, 1090 ], 1091 }, 1092 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 1093 "expression": "A String", # Expression describing which lists are being targeted by the ad. 1094 }, 1095 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 1096 "expression": "A String", # Keyword expression being targeted by the ad. 1097 }, 1098 "languageTargeting": { # Language Targeting. # Language targeting criteria. 1099 "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. 1100 { # Contains information about a language that can be targeted by ads. 1101 "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. 1102 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 1103 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 1104 "name": "A String", # Name of this language. 1105 }, 1106 ], 1107 }, 1108 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 1109 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 1110 "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. 1111 { # Contains information about a country that can be targeted by ads. 1112 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 1113 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 1114 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 1115 "countryCode": "A String", # Country code. 1116 "name": "A String", # Name of this country. 1117 }, 1118 ], 1119 "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. 1120 "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. 1121 { # Contains information about a postal code that can be targeted by ads. 1122 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 1123 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 1124 "code": "A String", # Postal code. This is equivalent to the id field. 1125 "id": "A String", # ID of this postal code. 1126 "countryCode": "A String", # Country code of the country to which this postal code belongs. 1127 }, 1128 ], 1129 "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. 1130 { # Contains information about a region that can be targeted by ads. 1131 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 1132 "countryDartId": "A String", # DART ID of the country to which this region belongs. 1133 "name": "A String", # Name of this region. 1134 "countryCode": "A String", # Country code of the country to which this region belongs. 1135 "regionCode": "A String", # Region code. 1136 "dartId": "A String", # DART ID of this region. 1137 }, 1138 ], 1139 "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. 1140 { # Contains information about a city that can be targeted by ads. 1141 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 1142 "countryDartId": "A String", # DART ID of the country to which this city belongs. 1143 "name": "A String", # Name of this city. 1144 "countryCode": "A String", # Country code of the country to which this city belongs. 1145 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 1146 "regionCode": "A String", # Region code of the region to which this city belongs. 1147 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 1148 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 1149 "regionDartId": "A String", # DART ID of the region to which this city belongs. 1150 }, 1151 ], 1152 "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. 1153 { # Contains information about a metro region that can be targeted by ads. 1154 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 1155 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 1156 "name": "A String", # Name of this metro region. 1157 "countryCode": "A String", # Country code of the country to which this metro region belongs. 1158 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 1159 "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. 1160 "dartId": "A String", # DART ID of this metro region. 1161 }, 1162 ], 1163 }, 1164 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1165 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1166 "value": "A String", # The value of the dimension. 1167 "dimensionName": "A String", # The name of the dimension. 1168 "etag": "A String", # The eTag of this response for caching purposes. 1169 "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. 1170 "id": "A String", # The ID associated with the value if available. 1171 }, 1172 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 1173 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 1174 }</pre> 1175 </div> 1176 1177 <div class="method"> 1178 <code class="details" id="update">update(profileId, body)</code> 1179 <pre>Updates an existing targeting template. 1180 1181 Args: 1182 profileId: string, User profile ID associated with this request. (required) 1183 body: object, The request body. (required) 1184 The object takes the form of: 1185 1186 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 1187 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 1188 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 1189 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 1190 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 1191 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 1192 "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. 1193 42, 1194 ], 1195 "daysOfWeek": [ # Days of the week when the ad will serve. 1196 # 1197 # Acceptable values are: 1198 # - "SUNDAY" 1199 # - "MONDAY" 1200 # - "TUESDAY" 1201 # - "WEDNESDAY" 1202 # - "THURSDAY" 1203 # - "FRIDAY" 1204 # - "SATURDAY" 1205 "A String", 1206 ], 1207 }, 1208 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 1209 "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. 1210 { # Contains information about a platform type that can be targeted by ads. 1211 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 1212 "id": "A String", # ID of this platform type. 1213 "name": "A String", # Name of this platform type. 1214 }, 1215 ], 1216 "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. 1217 { # Contains information about a particular version of an operating system that can be targeted by ads. 1218 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 1219 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 1220 "name": "A String", # Name of this operating system version. 1221 "id": "A String", # ID of this operating system version. 1222 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 1223 "mobile": True or False, # Whether this operating system is for mobile. 1224 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1225 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1226 "name": "A String", # Name of this operating system. 1227 "desktop": True or False, # Whether this operating system is for desktop. 1228 }, 1229 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 1230 }, 1231 ], 1232 "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. 1233 { # Contains information about a browser that can be targeted by ads. 1234 "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. 1235 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 1236 "name": "A String", # Name of this browser. 1237 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 1238 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 1239 "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. 1240 }, 1241 ], 1242 "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. 1243 { # Contains information about an operating system that can be targeted by ads. 1244 "mobile": True or False, # Whether this operating system is for mobile. 1245 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1246 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1247 "name": "A String", # Name of this operating system. 1248 "desktop": True or False, # Whether this operating system is for desktop. 1249 }, 1250 ], 1251 "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. 1252 { # Contains information about a mobile carrier that can be targeted by ads. 1253 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 1254 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 1255 "id": "A String", # ID of this mobile carrier. 1256 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 1257 "name": "A String", # Name of this mobile carrier. 1258 }, 1259 ], 1260 "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. 1261 { # 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. 1262 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 1263 "id": "A String", # ID of this connection type. 1264 "name": "A String", # Name of this connection type. 1265 }, 1266 ], 1267 }, 1268 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 1269 "expression": "A String", # Expression describing which lists are being targeted by the ad. 1270 }, 1271 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 1272 "expression": "A String", # Keyword expression being targeted by the ad. 1273 }, 1274 "languageTargeting": { # Language Targeting. # Language targeting criteria. 1275 "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. 1276 { # Contains information about a language that can be targeted by ads. 1277 "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. 1278 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 1279 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 1280 "name": "A String", # Name of this language. 1281 }, 1282 ], 1283 }, 1284 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 1285 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 1286 "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. 1287 { # Contains information about a country that can be targeted by ads. 1288 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 1289 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 1290 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 1291 "countryCode": "A String", # Country code. 1292 "name": "A String", # Name of this country. 1293 }, 1294 ], 1295 "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. 1296 "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. 1297 { # Contains information about a postal code that can be targeted by ads. 1298 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 1299 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 1300 "code": "A String", # Postal code. This is equivalent to the id field. 1301 "id": "A String", # ID of this postal code. 1302 "countryCode": "A String", # Country code of the country to which this postal code belongs. 1303 }, 1304 ], 1305 "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. 1306 { # Contains information about a region that can be targeted by ads. 1307 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 1308 "countryDartId": "A String", # DART ID of the country to which this region belongs. 1309 "name": "A String", # Name of this region. 1310 "countryCode": "A String", # Country code of the country to which this region belongs. 1311 "regionCode": "A String", # Region code. 1312 "dartId": "A String", # DART ID of this region. 1313 }, 1314 ], 1315 "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. 1316 { # Contains information about a city that can be targeted by ads. 1317 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 1318 "countryDartId": "A String", # DART ID of the country to which this city belongs. 1319 "name": "A String", # Name of this city. 1320 "countryCode": "A String", # Country code of the country to which this city belongs. 1321 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 1322 "regionCode": "A String", # Region code of the region to which this city belongs. 1323 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 1324 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 1325 "regionDartId": "A String", # DART ID of the region to which this city belongs. 1326 }, 1327 ], 1328 "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. 1329 { # Contains information about a metro region that can be targeted by ads. 1330 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 1331 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 1332 "name": "A String", # Name of this metro region. 1333 "countryCode": "A String", # Country code of the country to which this metro region belongs. 1334 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 1335 "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. 1336 "dartId": "A String", # DART ID of this metro region. 1337 }, 1338 ], 1339 }, 1340 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1341 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1342 "value": "A String", # The value of the dimension. 1343 "dimensionName": "A String", # The name of the dimension. 1344 "etag": "A String", # The eTag of this response for caching purposes. 1345 "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. 1346 "id": "A String", # The ID associated with the value if available. 1347 }, 1348 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 1349 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 1350 } 1351 1352 1353 Returns: 1354 An object of the form: 1355 1356 { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. 1357 "kind": "dfareporting#targetingTemplate", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". 1358 "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 1359 "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. 1360 "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. 1361 "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. 1362 "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. 1363 42, 1364 ], 1365 "daysOfWeek": [ # Days of the week when the ad will serve. 1366 # 1367 # Acceptable values are: 1368 # - "SUNDAY" 1369 # - "MONDAY" 1370 # - "TUESDAY" 1371 # - "WEDNESDAY" 1372 # - "THURSDAY" 1373 # - "FRIDAY" 1374 # - "SATURDAY" 1375 "A String", 1376 ], 1377 }, 1378 "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. 1379 "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. 1380 { # Contains information about a platform type that can be targeted by ads. 1381 "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". 1382 "id": "A String", # ID of this platform type. 1383 "name": "A String", # Name of this platform type. 1384 }, 1385 ], 1386 "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. 1387 { # Contains information about a particular version of an operating system that can be targeted by ads. 1388 "majorVersion": "A String", # Major version (leftmost number) of this operating system version. 1389 "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". 1390 "name": "A String", # Name of this operating system version. 1391 "id": "A String", # ID of this operating system version. 1392 "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. 1393 "mobile": True or False, # Whether this operating system is for mobile. 1394 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1395 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1396 "name": "A String", # Name of this operating system. 1397 "desktop": True or False, # Whether this operating system is for desktop. 1398 }, 1399 "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. 1400 }, 1401 ], 1402 "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. 1403 { # Contains information about a browser that can be targeted by ads. 1404 "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. 1405 "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". 1406 "name": "A String", # Name of this browser. 1407 "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. 1408 "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. 1409 "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. 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 "mobile": True or False, # Whether this operating system is for mobile. 1415 "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. 1416 "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". 1417 "name": "A String", # Name of this operating system. 1418 "desktop": True or False, # Whether this operating system is for desktop. 1419 }, 1420 ], 1421 "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. 1422 { # Contains information about a mobile carrier that can be targeted by ads. 1423 "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". 1424 "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. 1425 "id": "A String", # ID of this mobile carrier. 1426 "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. 1427 "name": "A String", # Name of this mobile carrier. 1428 }, 1429 ], 1430 "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. 1431 { # 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. 1432 "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". 1433 "id": "A String", # ID of this connection type. 1434 "name": "A String", # Name of this connection type. 1435 }, 1436 ], 1437 }, 1438 "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. 1439 "expression": "A String", # Expression describing which lists are being targeted by the ad. 1440 }, 1441 "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. 1442 "expression": "A String", # Keyword expression being targeted by the ad. 1443 }, 1444 "languageTargeting": { # Language Targeting. # Language targeting criteria. 1445 "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. 1446 { # Contains information about a language that can be targeted by ads. 1447 "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. 1448 "kind": "dfareporting#language", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". 1449 "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. 1450 "name": "A String", # Name of this language. 1451 }, 1452 ], 1453 }, 1454 "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. 1455 "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. 1456 "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. 1457 { # Contains information about a country that can be targeted by ads. 1458 "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. 1459 "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. 1460 "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". 1461 "countryCode": "A String", # Country code. 1462 "name": "A String", # Name of this country. 1463 }, 1464 ], 1465 "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. 1466 "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. 1467 { # Contains information about a postal code that can be targeted by ads. 1468 "countryDartId": "A String", # DART ID of the country to which this postal code belongs. 1469 "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". 1470 "code": "A String", # Postal code. This is equivalent to the id field. 1471 "id": "A String", # ID of this postal code. 1472 "countryCode": "A String", # Country code of the country to which this postal code belongs. 1473 }, 1474 ], 1475 "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. 1476 { # Contains information about a region that can be targeted by ads. 1477 "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". 1478 "countryDartId": "A String", # DART ID of the country to which this region belongs. 1479 "name": "A String", # Name of this region. 1480 "countryCode": "A String", # Country code of the country to which this region belongs. 1481 "regionCode": "A String", # Region code. 1482 "dartId": "A String", # DART ID of this region. 1483 }, 1484 ], 1485 "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. 1486 { # Contains information about a city that can be targeted by ads. 1487 "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". 1488 "countryDartId": "A String", # DART ID of the country to which this city belongs. 1489 "name": "A String", # Name of this city. 1490 "countryCode": "A String", # Country code of the country to which this city belongs. 1491 "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. 1492 "regionCode": "A String", # Region code of the region to which this city belongs. 1493 "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. 1494 "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. 1495 "regionDartId": "A String", # DART ID of the region to which this city belongs. 1496 }, 1497 ], 1498 "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. 1499 { # Contains information about a metro region that can be targeted by ads. 1500 "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". 1501 "countryDartId": "A String", # DART ID of the country to which this metro region belongs. 1502 "name": "A String", # Name of this metro region. 1503 "countryCode": "A String", # Country code of the country to which this metro region belongs. 1504 "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. 1505 "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. 1506 "dartId": "A String", # DART ID of this metro region. 1507 }, 1508 ], 1509 }, 1510 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1511 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 1512 "value": "A String", # The value of the dimension. 1513 "dimensionName": "A String", # The name of the dimension. 1514 "etag": "A String", # The eTag of this response for caching purposes. 1515 "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. 1516 "id": "A String", # The ID associated with the value if available. 1517 }, 1518 "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. 1519 "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. 1520 }</pre> 1521 </div> 1522 1523 </body></html>
