REST Resource: accounts

AI-generated Key Takeaways

The Account resource contains properties of a Campaign Manager account, including ID, name, active status, description, and currency.
The ReportsConfiguration object within the Account resource defines settings for report generation, such as time zone and exposure to conversion reporting.
The available methods for accounts include retrieving a single account by ID, listing accounts with filtering, and updating accounts.

Resource: Account
- JSON representation
ReportsConfiguration
- JSON representation
Methods

Resource: Account

Contains properties of a Campaign Manager account .

JSON representation

JSON representation
{ "id" : string , "name" : string , "active" : boolean , "description" : string , "currencyId" : string , "kind" : string , "maximumImageSize" : string , "defaultCreativeSizeId" : string , "activeAdsLimitTier" : enum ( `ResourceQuotaServiceTier` ) , "countryId" : string , "reportsConfiguration" : { object ( `ReportsConfiguration` ) } , "activeViewOptOut" : boolean , "accountPermissionIds" : [ string ] , "availablePermissionIds" : [ string ] , "accountProfile" : enum ( `AccountProfile` ) , "nielsenOcrEnabled" : boolean , "locale" : string , "shareReportsWithTwitter" : boolean , "teaserSizeLimit" : string }

 { 
 "id" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "active" 
 : 
 boolean 
 , 
 "description" 
 : 
 string 
 , 
 "currencyId" 
 : 
 string 
 , 
 "kind" 
 : 
 string 
 , 
 "maximumImageSize" 
 : 
 string 
 , 
 "defaultCreativeSizeId" 
 : 
 string 
 , 
 "activeAdsLimitTier" 
 : 
 enum (  ResourceQuotaServiceTier 
 
) 
 , 
 "countryId" 
 : 
 string 
 , 
 "reportsConfiguration" 
 : 
 { 
 object (  ReportsConfiguration 
 
) 
 } 
 , 
 "activeViewOptOut" 
 : 
 boolean 
 , 
 "accountPermissionIds" 
 : 
 [ 
 string 
 ] 
 , 
 "availablePermissionIds" 
 : 
 [ 
 string 
 ] 
 , 
 "accountProfile" 
 : 
 enum (  AccountProfile 
 
) 
 , 
 "nielsenOcrEnabled" 
 : 
 boolean 
 , 
 "locale" 
 : 
 string 
 , 
 "shareReportsWithTwitter" 
 : 
 boolean 
 , 
 "teaserSizeLimit" 
 : 
 string 
 }

Fields

id

string ( int64 format)

ID of this account. This is a read-only, auto-generated field.

name

string

Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.

active

boolean

Whether this account is active.

description

string

Description of this account.

currencyId

string ( int64 format)

ID of currency associated with this account. This is a required field.

Acceptable values are:

"
1

" for

USD
"
2

" for

GBP
"
3

" for

ESP
"
4

" for

SEK
"
5

" for

CAD
"
6

" for

JPY
"
7

" for

DEM
"
8

" for

AUD
"
9

" for

FRF
"
10

" for

ITL
"
11

" for

DKK
"
12

" for

NOK
"
13

" for

FIM
"
14

" for

ZAR
"
15

" for

IEP
"
16

" for

NLG
"
17

" for

EUR
"
18

" for

KRW
"
19

" for

TWD
"
20

" for

SGD
"
21

" for

CNY
"
22

" for

HKD
"
23

" for

NZD
"
24

" for

MYR
"
25

" for

BRL
"
26

" for

PTE
"
28

" for

CLP
"
29

" for

TRY
"
30

" for

ARS
"
31

" for

PEN
"
32

" for

ILS
"
33

" for

CHF
"
34

" for

VEF
"
35

" for

COP
"
36

" for

GTQ
"
37

" for

PLN
"
39

" for

INR
"
40

" for

THB
"
41

" for

IDR
"
42

" for

CZK
"
43

" for

RON
"
44

" for

HUF
"
45

" for

RUB
"
46

" for

AED
"
47

" for

BGN
"
48

" for

HRK
"
49

" for

MXN
"
50

" for

NGN
"
51

" for

EGP

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#account"

maximumImageSize

string ( int64 format)

Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to

1

defaultCreativeSizeId

string ( int64 format)

Default placement dimensions for this account.

activeAdsLimitTier

enum ( ResourceQuotaServiceTier )

Maximum number of active ads allowed for this account.

countryId

string ( int64 format)

ID of the country associated with this account.

reportsConfiguration

object ( ReportsConfiguration )

Reporting configuration of this account.

activeViewOptOut

boolean

Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.

accountPermissionIds[]

string ( int64 format)

Account permissions assigned to this account.

availablePermissionIds[]

string ( int64 format)

User role permissions available to the user roles of this account.

accountProfile

enum ( AccountProfile )

Profile for this account. This is a read-only field that can be left blank.

nielsenOcrEnabled

boolean

Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.

locale

string

Locale of this account.

Acceptable values are:

"
cs

" (Czech)
"
de

" (German)
"
en

" (English)
"
en-GB

" (English United Kingdom)
"
es

" (Spanish)
"
fr

" (French)
"
it

" (Italian)
"
ja

" (Japanese)
"
ko

" (Korean)
"
pl

" (Polish)
"
pt-BR

" (Portuguese Brazil)
"
ru

" (Russian)
"
sv

" (Swedish)
"
tr

" (Turkish)
"
zh-CN

" (Chinese Simplified)
"
zh-TW

" (Chinese Traditional)

shareReportsWithTwitter

boolean

Share Path to Conversion reports with Twitter.

teaserSizeLimit

string ( int64 format)

File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are

1

10240

, inclusive.

ReportsConfiguration

Reporting Configuration

JSON representation
{ "reportGenerationTimeZoneId" : string , "exposureToConversionEnabled" : boolean , "lookbackConfiguration" : { object ( `LookbackConfiguration` ) } }

Fields

reportGenerationTimeZoneId

string ( int64 format)

Report generation time zone ID of this account. This is a required field that cannot be changed on update.

Acceptable values are:

"
1

" for "America/New_York"
"
2

" for "Europe/London"
"
3

" for "Europe/Paris"
"
4

" for "Africa/Johannesburg"
"
5

" for "Asia/Jerusalem"
"
6

" for "Asia/Shanghai"
"
7

" for "Asia/Hong_Kong"
"
8

" for "Asia/Tokyo"
"
9

" for "Australia/Sydney"
"
10

" for "Asia/Dubai"
"
11

" for "America/Los_Angeles"
"
12

" for "Pacific/Auckland"
"
13

" for "America/Sao_Paulo"
"
16

" for "America/Asuncion"
"
17

" for "America/Chicago"
"
18

" for "America/Denver"
"
19

" for "America/St_Johns"
"
20

" for "Asia/Dhaka"
"
21

" for "Asia/Jakarta"
"
22

" for "Asia/Kabul"
"
23

" for "Asia/Karachi"
"
24

" for "Asia/Calcutta"
"
25

" for "Asia/Pyongyang"
"
26

" for "Asia/Rangoon"
"
27

" for "Atlantic/Cape_Verde"
"
28

" for "Atlantic/South_Georgia"
"
29

" for "Australia/Adelaide"
"
30

" for "Australia/Lord_Howe"
"
31

" for "Europe/Moscow"
"
32

" for "Pacific/Kiritimati"
"
35

" for "Pacific/Norfolk"
"
36

" for "Pacific/Tongatapu"

exposureToConversionEnabled

boolean

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.

lookbackConfiguration

object ( LookbackConfiguration )

Default lookback windows for new advertisers in this account.

Methods
`get`	Gets one account by ID.
`list`	Retrieves the list of accounts, possibly filtered.
`patch`	Updates an existing account.
`update`	Updates an existing account.

REST Resource: accounts

AI-generated Key Takeaways

Resource: Account

ReportsConfiguration

Methods

`get`

`list`

`patch`

`update`

REST Resource: accounts Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

Resource: Account

ReportsConfiguration

Methods

get

list

patch

update

REST Resource: accounts

`get`

`list`

`patch`

`update`