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.accounts.html">accounts</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 account by ID.</p> 80 <p class="toc_element"> 81 <code><a href="#list">list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)</a></code></p> 82 <p class="firstline">Retrieves the list of accounts, possibly filtered. This method supports paging.</p> 83 <p class="toc_element"> 84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 85 <p class="firstline">Retrieves the next page of results.</p> 86 <p class="toc_element"> 87 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 88 <p class="firstline">Updates an existing account. This method supports patch semantics.</p> 89 <p class="toc_element"> 90 <code><a href="#update">update(profileId, body)</a></code></p> 91 <p class="firstline">Updates an existing account.</p> 92 <h3>Method Details</h3> 93 <div class="method"> 94 <code class="details" id="get">get(profileId, id)</code> 95 <pre>Gets one account by ID. 96 97 Args: 98 profileId: string, User profile ID associated with this request. (required) 99 id: string, Account ID. (required) 100 101 Returns: 102 An object of the form: 103 104 { # Contains properties of a DCM account. 105 "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". 106 "countryId": "A String", # ID of the country associated with this account. 107 "availablePermissionIds": [ # User role permissions available to the user roles of this account. 108 "A String", 109 ], 110 "description": "A String", # Description of this account. 111 "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. 112 "currencyId": "A String", # ID of currency associated with this account. This is a required field. 113 # Acceptable values are: 114 # - "1" for USD 115 # - "2" for GBP 116 # - "3" for ESP 117 # - "4" for SEK 118 # - "5" for CAD 119 # - "6" for JPY 120 # - "7" for DEM 121 # - "8" for AUD 122 # - "9" for FRF 123 # - "10" for ITL 124 # - "11" for DKK 125 # - "12" for NOK 126 # - "13" for FIM 127 # - "14" for ZAR 128 # - "15" for IEP 129 # - "16" for NLG 130 # - "17" for EUR 131 # - "18" for KRW 132 # - "19" for TWD 133 # - "20" for SGD 134 # - "21" for CNY 135 # - "22" for HKD 136 # - "23" for NZD 137 # - "24" for MYR 138 # - "25" for BRL 139 # - "26" for PTE 140 # - "27" for MXP 141 # - "28" for CLP 142 # - "29" for TRY 143 # - "30" for ARS 144 # - "31" for PEN 145 # - "32" for ILS 146 # - "33" for CHF 147 # - "34" for VEF 148 # - "35" for COP 149 # - "36" for GTQ 150 # - "37" for PLN 151 # - "39" for INR 152 # - "40" for THB 153 # - "41" for IDR 154 # - "42" for CZK 155 # - "43" for RON 156 # - "44" for HUF 157 # - "45" for RUB 158 # - "46" for AED 159 # - "47" for BGN 160 # - "48" for HRK 161 # - "49" for MXN 162 "defaultCreativeSizeId": "A String", # Default placement dimensions for this account. 163 "accountPermissionIds": [ # Account permissions assigned to this account. 164 "A String", 165 ], 166 "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. 167 "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank. 168 "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. 169 "locale": "A String", # Locale of this account. 170 # Acceptable values are: 171 # - "cs" (Czech) 172 # - "de" (German) 173 # - "en" (English) 174 # - "en-GB" (English United Kingdom) 175 # - "es" (Spanish) 176 # - "fr" (French) 177 # - "it" (Italian) 178 # - "ja" (Japanese) 179 # - "ko" (Korean) 180 # - "pl" (Polish) 181 # - "pt-BR" (Portuguese Brazil) 182 # - "ru" (Russian) 183 # - "sv" (Swedish) 184 # - "tr" (Turkish) 185 # - "zh-CN" (Chinese Simplified) 186 # - "zh-TW" (Chinese Traditional) 187 "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. 188 "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account. 189 "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. 190 # Acceptable values are: 191 # 192 # - "1" for "America/New_York" 193 # - "2" for "Europe/London" 194 # - "3" for "Europe/Paris" 195 # - "4" for "Africa/Johannesburg" 196 # - "5" for "Asia/Jerusalem" 197 # - "6" for "Asia/Shanghai" 198 # - "7" for "Asia/Hong_Kong" 199 # - "8" for "Asia/Tokyo" 200 # - "9" for "Australia/Sydney" 201 # - "10" for "Asia/Dubai" 202 # - "11" for "America/Los_Angeles" 203 # - "12" for "Pacific/Auckland" 204 # - "13" for "America/Sao_Paulo" 205 "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. 206 "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account. 207 "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 208 "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 209 }, 210 }, 211 "active": True or False, # Whether this account is active. 212 "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. 213 "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter. 214 "id": "A String", # ID of this account. This is a read-only, auto-generated field. 215 "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account. 216 }</pre> 217 </div> 218 219 <div class="method"> 220 <code class="details" id="list">list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)</code> 221 <pre>Retrieves the list of accounts, possibly filtered. This method supports paging. 222 223 Args: 224 profileId: string, User profile ID associated with this request. (required) 225 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". 226 sortField: string, Field by which to sort the list. 227 Allowed values 228 ID - 229 NAME - 230 ids: string, Select only accounts with these IDs. (repeated) 231 maxResults: integer, Maximum number of results to return. 232 pageToken: string, Value of the nextPageToken from the previous result page. 233 sortOrder: string, Order of sorted results. 234 Allowed values 235 ASCENDING - 236 DESCENDING - 237 active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts. 238 239 Returns: 240 An object of the form: 241 242 { # Account List Response 243 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 244 "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". 245 "accounts": [ # Account collection. 246 { # Contains properties of a DCM account. 247 "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". 248 "countryId": "A String", # ID of the country associated with this account. 249 "availablePermissionIds": [ # User role permissions available to the user roles of this account. 250 "A String", 251 ], 252 "description": "A String", # Description of this account. 253 "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. 254 "currencyId": "A String", # ID of currency associated with this account. This is a required field. 255 # Acceptable values are: 256 # - "1" for USD 257 # - "2" for GBP 258 # - "3" for ESP 259 # - "4" for SEK 260 # - "5" for CAD 261 # - "6" for JPY 262 # - "7" for DEM 263 # - "8" for AUD 264 # - "9" for FRF 265 # - "10" for ITL 266 # - "11" for DKK 267 # - "12" for NOK 268 # - "13" for FIM 269 # - "14" for ZAR 270 # - "15" for IEP 271 # - "16" for NLG 272 # - "17" for EUR 273 # - "18" for KRW 274 # - "19" for TWD 275 # - "20" for SGD 276 # - "21" for CNY 277 # - "22" for HKD 278 # - "23" for NZD 279 # - "24" for MYR 280 # - "25" for BRL 281 # - "26" for PTE 282 # - "27" for MXP 283 # - "28" for CLP 284 # - "29" for TRY 285 # - "30" for ARS 286 # - "31" for PEN 287 # - "32" for ILS 288 # - "33" for CHF 289 # - "34" for VEF 290 # - "35" for COP 291 # - "36" for GTQ 292 # - "37" for PLN 293 # - "39" for INR 294 # - "40" for THB 295 # - "41" for IDR 296 # - "42" for CZK 297 # - "43" for RON 298 # - "44" for HUF 299 # - "45" for RUB 300 # - "46" for AED 301 # - "47" for BGN 302 # - "48" for HRK 303 # - "49" for MXN 304 "defaultCreativeSizeId": "A String", # Default placement dimensions for this account. 305 "accountPermissionIds": [ # Account permissions assigned to this account. 306 "A String", 307 ], 308 "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. 309 "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank. 310 "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. 311 "locale": "A String", # Locale of this account. 312 # Acceptable values are: 313 # - "cs" (Czech) 314 # - "de" (German) 315 # - "en" (English) 316 # - "en-GB" (English United Kingdom) 317 # - "es" (Spanish) 318 # - "fr" (French) 319 # - "it" (Italian) 320 # - "ja" (Japanese) 321 # - "ko" (Korean) 322 # - "pl" (Polish) 323 # - "pt-BR" (Portuguese Brazil) 324 # - "ru" (Russian) 325 # - "sv" (Swedish) 326 # - "tr" (Turkish) 327 # - "zh-CN" (Chinese Simplified) 328 # - "zh-TW" (Chinese Traditional) 329 "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. 330 "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account. 331 "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. 332 # Acceptable values are: 333 # 334 # - "1" for "America/New_York" 335 # - "2" for "Europe/London" 336 # - "3" for "Europe/Paris" 337 # - "4" for "Africa/Johannesburg" 338 # - "5" for "Asia/Jerusalem" 339 # - "6" for "Asia/Shanghai" 340 # - "7" for "Asia/Hong_Kong" 341 # - "8" for "Asia/Tokyo" 342 # - "9" for "Australia/Sydney" 343 # - "10" for "Asia/Dubai" 344 # - "11" for "America/Los_Angeles" 345 # - "12" for "Pacific/Auckland" 346 # - "13" for "America/Sao_Paulo" 347 "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. 348 "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account. 349 "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 350 "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 351 }, 352 }, 353 "active": True or False, # Whether this account is active. 354 "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. 355 "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter. 356 "id": "A String", # ID of this account. This is a read-only, auto-generated field. 357 "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account. 358 }, 359 ], 360 }</pre> 361 </div> 362 363 <div class="method"> 364 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 365 <pre>Retrieves the next page of results. 366 367 Args: 368 previous_request: The request for the previous page. (required) 369 previous_response: The response from the request for the previous page. (required) 370 371 Returns: 372 A request object that you can call 'execute()' on to request the next 373 page. Returns None if there are no more items in the collection. 374 </pre> 375 </div> 376 377 <div class="method"> 378 <code class="details" id="patch">patch(profileId, id, body)</code> 379 <pre>Updates an existing account. This method supports patch semantics. 380 381 Args: 382 profileId: string, User profile ID associated with this request. (required) 383 id: string, Account ID. (required) 384 body: object, The request body. (required) 385 The object takes the form of: 386 387 { # Contains properties of a DCM account. 388 "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". 389 "countryId": "A String", # ID of the country associated with this account. 390 "availablePermissionIds": [ # User role permissions available to the user roles of this account. 391 "A String", 392 ], 393 "description": "A String", # Description of this account. 394 "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. 395 "currencyId": "A String", # ID of currency associated with this account. This is a required field. 396 # Acceptable values are: 397 # - "1" for USD 398 # - "2" for GBP 399 # - "3" for ESP 400 # - "4" for SEK 401 # - "5" for CAD 402 # - "6" for JPY 403 # - "7" for DEM 404 # - "8" for AUD 405 # - "9" for FRF 406 # - "10" for ITL 407 # - "11" for DKK 408 # - "12" for NOK 409 # - "13" for FIM 410 # - "14" for ZAR 411 # - "15" for IEP 412 # - "16" for NLG 413 # - "17" for EUR 414 # - "18" for KRW 415 # - "19" for TWD 416 # - "20" for SGD 417 # - "21" for CNY 418 # - "22" for HKD 419 # - "23" for NZD 420 # - "24" for MYR 421 # - "25" for BRL 422 # - "26" for PTE 423 # - "27" for MXP 424 # - "28" for CLP 425 # - "29" for TRY 426 # - "30" for ARS 427 # - "31" for PEN 428 # - "32" for ILS 429 # - "33" for CHF 430 # - "34" for VEF 431 # - "35" for COP 432 # - "36" for GTQ 433 # - "37" for PLN 434 # - "39" for INR 435 # - "40" for THB 436 # - "41" for IDR 437 # - "42" for CZK 438 # - "43" for RON 439 # - "44" for HUF 440 # - "45" for RUB 441 # - "46" for AED 442 # - "47" for BGN 443 # - "48" for HRK 444 # - "49" for MXN 445 "defaultCreativeSizeId": "A String", # Default placement dimensions for this account. 446 "accountPermissionIds": [ # Account permissions assigned to this account. 447 "A String", 448 ], 449 "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. 450 "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank. 451 "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. 452 "locale": "A String", # Locale of this account. 453 # Acceptable values are: 454 # - "cs" (Czech) 455 # - "de" (German) 456 # - "en" (English) 457 # - "en-GB" (English United Kingdom) 458 # - "es" (Spanish) 459 # - "fr" (French) 460 # - "it" (Italian) 461 # - "ja" (Japanese) 462 # - "ko" (Korean) 463 # - "pl" (Polish) 464 # - "pt-BR" (Portuguese Brazil) 465 # - "ru" (Russian) 466 # - "sv" (Swedish) 467 # - "tr" (Turkish) 468 # - "zh-CN" (Chinese Simplified) 469 # - "zh-TW" (Chinese Traditional) 470 "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. 471 "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account. 472 "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. 473 # Acceptable values are: 474 # 475 # - "1" for "America/New_York" 476 # - "2" for "Europe/London" 477 # - "3" for "Europe/Paris" 478 # - "4" for "Africa/Johannesburg" 479 # - "5" for "Asia/Jerusalem" 480 # - "6" for "Asia/Shanghai" 481 # - "7" for "Asia/Hong_Kong" 482 # - "8" for "Asia/Tokyo" 483 # - "9" for "Australia/Sydney" 484 # - "10" for "Asia/Dubai" 485 # - "11" for "America/Los_Angeles" 486 # - "12" for "Pacific/Auckland" 487 # - "13" for "America/Sao_Paulo" 488 "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. 489 "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account. 490 "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 491 "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 492 }, 493 }, 494 "active": True or False, # Whether this account is active. 495 "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. 496 "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter. 497 "id": "A String", # ID of this account. This is a read-only, auto-generated field. 498 "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account. 499 } 500 501 502 Returns: 503 An object of the form: 504 505 { # Contains properties of a DCM account. 506 "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". 507 "countryId": "A String", # ID of the country associated with this account. 508 "availablePermissionIds": [ # User role permissions available to the user roles of this account. 509 "A String", 510 ], 511 "description": "A String", # Description of this account. 512 "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. 513 "currencyId": "A String", # ID of currency associated with this account. This is a required field. 514 # Acceptable values are: 515 # - "1" for USD 516 # - "2" for GBP 517 # - "3" for ESP 518 # - "4" for SEK 519 # - "5" for CAD 520 # - "6" for JPY 521 # - "7" for DEM 522 # - "8" for AUD 523 # - "9" for FRF 524 # - "10" for ITL 525 # - "11" for DKK 526 # - "12" for NOK 527 # - "13" for FIM 528 # - "14" for ZAR 529 # - "15" for IEP 530 # - "16" for NLG 531 # - "17" for EUR 532 # - "18" for KRW 533 # - "19" for TWD 534 # - "20" for SGD 535 # - "21" for CNY 536 # - "22" for HKD 537 # - "23" for NZD 538 # - "24" for MYR 539 # - "25" for BRL 540 # - "26" for PTE 541 # - "27" for MXP 542 # - "28" for CLP 543 # - "29" for TRY 544 # - "30" for ARS 545 # - "31" for PEN 546 # - "32" for ILS 547 # - "33" for CHF 548 # - "34" for VEF 549 # - "35" for COP 550 # - "36" for GTQ 551 # - "37" for PLN 552 # - "39" for INR 553 # - "40" for THB 554 # - "41" for IDR 555 # - "42" for CZK 556 # - "43" for RON 557 # - "44" for HUF 558 # - "45" for RUB 559 # - "46" for AED 560 # - "47" for BGN 561 # - "48" for HRK 562 # - "49" for MXN 563 "defaultCreativeSizeId": "A String", # Default placement dimensions for this account. 564 "accountPermissionIds": [ # Account permissions assigned to this account. 565 "A String", 566 ], 567 "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. 568 "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank. 569 "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. 570 "locale": "A String", # Locale of this account. 571 # Acceptable values are: 572 # - "cs" (Czech) 573 # - "de" (German) 574 # - "en" (English) 575 # - "en-GB" (English United Kingdom) 576 # - "es" (Spanish) 577 # - "fr" (French) 578 # - "it" (Italian) 579 # - "ja" (Japanese) 580 # - "ko" (Korean) 581 # - "pl" (Polish) 582 # - "pt-BR" (Portuguese Brazil) 583 # - "ru" (Russian) 584 # - "sv" (Swedish) 585 # - "tr" (Turkish) 586 # - "zh-CN" (Chinese Simplified) 587 # - "zh-TW" (Chinese Traditional) 588 "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. 589 "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account. 590 "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. 591 # Acceptable values are: 592 # 593 # - "1" for "America/New_York" 594 # - "2" for "Europe/London" 595 # - "3" for "Europe/Paris" 596 # - "4" for "Africa/Johannesburg" 597 # - "5" for "Asia/Jerusalem" 598 # - "6" for "Asia/Shanghai" 599 # - "7" for "Asia/Hong_Kong" 600 # - "8" for "Asia/Tokyo" 601 # - "9" for "Australia/Sydney" 602 # - "10" for "Asia/Dubai" 603 # - "11" for "America/Los_Angeles" 604 # - "12" for "Pacific/Auckland" 605 # - "13" for "America/Sao_Paulo" 606 "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. 607 "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account. 608 "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 609 "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 610 }, 611 }, 612 "active": True or False, # Whether this account is active. 613 "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. 614 "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter. 615 "id": "A String", # ID of this account. This is a read-only, auto-generated field. 616 "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account. 617 }</pre> 618 </div> 619 620 <div class="method"> 621 <code class="details" id="update">update(profileId, body)</code> 622 <pre>Updates an existing account. 623 624 Args: 625 profileId: string, User profile ID associated with this request. (required) 626 body: object, The request body. (required) 627 The object takes the form of: 628 629 { # Contains properties of a DCM account. 630 "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". 631 "countryId": "A String", # ID of the country associated with this account. 632 "availablePermissionIds": [ # User role permissions available to the user roles of this account. 633 "A String", 634 ], 635 "description": "A String", # Description of this account. 636 "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. 637 "currencyId": "A String", # ID of currency associated with this account. This is a required field. 638 # Acceptable values are: 639 # - "1" for USD 640 # - "2" for GBP 641 # - "3" for ESP 642 # - "4" for SEK 643 # - "5" for CAD 644 # - "6" for JPY 645 # - "7" for DEM 646 # - "8" for AUD 647 # - "9" for FRF 648 # - "10" for ITL 649 # - "11" for DKK 650 # - "12" for NOK 651 # - "13" for FIM 652 # - "14" for ZAR 653 # - "15" for IEP 654 # - "16" for NLG 655 # - "17" for EUR 656 # - "18" for KRW 657 # - "19" for TWD 658 # - "20" for SGD 659 # - "21" for CNY 660 # - "22" for HKD 661 # - "23" for NZD 662 # - "24" for MYR 663 # - "25" for BRL 664 # - "26" for PTE 665 # - "27" for MXP 666 # - "28" for CLP 667 # - "29" for TRY 668 # - "30" for ARS 669 # - "31" for PEN 670 # - "32" for ILS 671 # - "33" for CHF 672 # - "34" for VEF 673 # - "35" for COP 674 # - "36" for GTQ 675 # - "37" for PLN 676 # - "39" for INR 677 # - "40" for THB 678 # - "41" for IDR 679 # - "42" for CZK 680 # - "43" for RON 681 # - "44" for HUF 682 # - "45" for RUB 683 # - "46" for AED 684 # - "47" for BGN 685 # - "48" for HRK 686 # - "49" for MXN 687 "defaultCreativeSizeId": "A String", # Default placement dimensions for this account. 688 "accountPermissionIds": [ # Account permissions assigned to this account. 689 "A String", 690 ], 691 "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. 692 "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank. 693 "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. 694 "locale": "A String", # Locale of this account. 695 # Acceptable values are: 696 # - "cs" (Czech) 697 # - "de" (German) 698 # - "en" (English) 699 # - "en-GB" (English United Kingdom) 700 # - "es" (Spanish) 701 # - "fr" (French) 702 # - "it" (Italian) 703 # - "ja" (Japanese) 704 # - "ko" (Korean) 705 # - "pl" (Polish) 706 # - "pt-BR" (Portuguese Brazil) 707 # - "ru" (Russian) 708 # - "sv" (Swedish) 709 # - "tr" (Turkish) 710 # - "zh-CN" (Chinese Simplified) 711 # - "zh-TW" (Chinese Traditional) 712 "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. 713 "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account. 714 "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. 715 # Acceptable values are: 716 # 717 # - "1" for "America/New_York" 718 # - "2" for "Europe/London" 719 # - "3" for "Europe/Paris" 720 # - "4" for "Africa/Johannesburg" 721 # - "5" for "Asia/Jerusalem" 722 # - "6" for "Asia/Shanghai" 723 # - "7" for "Asia/Hong_Kong" 724 # - "8" for "Asia/Tokyo" 725 # - "9" for "Australia/Sydney" 726 # - "10" for "Asia/Dubai" 727 # - "11" for "America/Los_Angeles" 728 # - "12" for "Pacific/Auckland" 729 # - "13" for "America/Sao_Paulo" 730 "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. 731 "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account. 732 "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 733 "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 734 }, 735 }, 736 "active": True or False, # Whether this account is active. 737 "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. 738 "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter. 739 "id": "A String", # ID of this account. This is a read-only, auto-generated field. 740 "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account. 741 } 742 743 744 Returns: 745 An object of the form: 746 747 { # Contains properties of a DCM account. 748 "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". 749 "countryId": "A String", # ID of the country associated with this account. 750 "availablePermissionIds": [ # User role permissions available to the user roles of this account. 751 "A String", 752 ], 753 "description": "A String", # Description of this account. 754 "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. 755 "currencyId": "A String", # ID of currency associated with this account. This is a required field. 756 # Acceptable values are: 757 # - "1" for USD 758 # - "2" for GBP 759 # - "3" for ESP 760 # - "4" for SEK 761 # - "5" for CAD 762 # - "6" for JPY 763 # - "7" for DEM 764 # - "8" for AUD 765 # - "9" for FRF 766 # - "10" for ITL 767 # - "11" for DKK 768 # - "12" for NOK 769 # - "13" for FIM 770 # - "14" for ZAR 771 # - "15" for IEP 772 # - "16" for NLG 773 # - "17" for EUR 774 # - "18" for KRW 775 # - "19" for TWD 776 # - "20" for SGD 777 # - "21" for CNY 778 # - "22" for HKD 779 # - "23" for NZD 780 # - "24" for MYR 781 # - "25" for BRL 782 # - "26" for PTE 783 # - "27" for MXP 784 # - "28" for CLP 785 # - "29" for TRY 786 # - "30" for ARS 787 # - "31" for PEN 788 # - "32" for ILS 789 # - "33" for CHF 790 # - "34" for VEF 791 # - "35" for COP 792 # - "36" for GTQ 793 # - "37" for PLN 794 # - "39" for INR 795 # - "40" for THB 796 # - "41" for IDR 797 # - "42" for CZK 798 # - "43" for RON 799 # - "44" for HUF 800 # - "45" for RUB 801 # - "46" for AED 802 # - "47" for BGN 803 # - "48" for HRK 804 # - "49" for MXN 805 "defaultCreativeSizeId": "A String", # Default placement dimensions for this account. 806 "accountPermissionIds": [ # Account permissions assigned to this account. 807 "A String", 808 ], 809 "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. 810 "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank. 811 "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. 812 "locale": "A String", # Locale of this account. 813 # Acceptable values are: 814 # - "cs" (Czech) 815 # - "de" (German) 816 # - "en" (English) 817 # - "en-GB" (English United Kingdom) 818 # - "es" (Spanish) 819 # - "fr" (French) 820 # - "it" (Italian) 821 # - "ja" (Japanese) 822 # - "ko" (Korean) 823 # - "pl" (Polish) 824 # - "pt-BR" (Portuguese Brazil) 825 # - "ru" (Russian) 826 # - "sv" (Swedish) 827 # - "tr" (Turkish) 828 # - "zh-CN" (Chinese Simplified) 829 # - "zh-TW" (Chinese Traditional) 830 "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. 831 "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account. 832 "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. 833 # Acceptable values are: 834 # 835 # - "1" for "America/New_York" 836 # - "2" for "Europe/London" 837 # - "3" for "Europe/Paris" 838 # - "4" for "Africa/Johannesburg" 839 # - "5" for "Asia/Jerusalem" 840 # - "6" for "Asia/Shanghai" 841 # - "7" for "Asia/Hong_Kong" 842 # - "8" for "Asia/Tokyo" 843 # - "9" for "Australia/Sydney" 844 # - "10" for "Asia/Dubai" 845 # - "11" for "America/Los_Angeles" 846 # - "12" for "Pacific/Auckland" 847 # - "13" for "America/Sao_Paulo" 848 "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. 849 "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account. 850 "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 851 "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. 852 }, 853 }, 854 "active": True or False, # Whether this account is active. 855 "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. 856 "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter. 857 "id": "A String", # ID of this account. This is a read-only, auto-generated field. 858 "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account. 859 }</pre> 860 </div> 861 862 </body></html>
