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