com.google.api.services.dfareporting.model

Class Account

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.Account

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Account
extends com.google.api.client.json.GenericJson

Contains properties of a Campaign Manager account.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Campaign Manager 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Account()

Method Summary

Modifier and Type	Method and Description
Account	clone()
List<Long>	getAccountPermissionIds() Account permissions assigned to this account.
String	getAccountProfile() Profile for this account.
Boolean	getActive() Whether this account is active.
String	getActiveAdsLimitTier() Maximum number of active ads allowed for this account.
Boolean	getActiveViewOptOut() Whether to serve creatives with Active View tags.
List<Long>	getAvailablePermissionIds() User role permissions available to the user roles of this account.
Long	getCountryId() ID of the country associated with this account.
Long	getCurrencyId() ID of currency associated with this account.
Long	getDefaultCreativeSizeId() Default placement dimensions for this account.
String	getDescription() Description of this account.
Long	getId() ID of this account.
String	getKind() Identifies what kind of resource this is.
String	getLocale() Locale of this account.
Long	getMaximumImageSize() Maximum image size allowed for this account, in kilobytes.
String	getName() Name of this account.
Boolean	getNielsenOcrEnabled() Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
ReportsConfiguration	getReportsConfiguration() Reporting configuration of this account.
Boolean	getShareReportsWithTwitter() Share Path to Conversion reports with Twitter.
Long	getTeaserSizeLimit() File size limit in kilobytes of Rich Media teaser creatives.
Account	set(String fieldName, Object value)
Account	setAccountPermissionIds(List<Long> accountPermissionIds) Account permissions assigned to this account.
Account	setAccountProfile(String accountProfile) Profile for this account.
Account	setActive(Boolean active) Whether this account is active.
Account	setActiveAdsLimitTier(String activeAdsLimitTier) Maximum number of active ads allowed for this account.
Account	setActiveViewOptOut(Boolean activeViewOptOut) Whether to serve creatives with Active View tags.
Account	setAvailablePermissionIds(List<Long> availablePermissionIds) User role permissions available to the user roles of this account.
Account	setCountryId(Long countryId) ID of the country associated with this account.
Account	setCurrencyId(Long currencyId) ID of currency associated with this account.
Account	setDefaultCreativeSizeId(Long defaultCreativeSizeId) Default placement dimensions for this account.
Account	setDescription(String description) Description of this account.
Account	setId(Long id) ID of this account.
Account	setKind(String kind) Identifies what kind of resource this is.
Account	setLocale(String locale) Locale of this account.
Account	setMaximumImageSize(Long maximumImageSize) Maximum image size allowed for this account, in kilobytes.
Account	setName(String name) Name of this account.
Account	setNielsenOcrEnabled(Boolean nielsenOcrEnabled) Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
Account	setReportsConfiguration(ReportsConfiguration reportsConfiguration) Reporting configuration of this account.
Account	setShareReportsWithTwitter(Boolean shareReportsWithTwitter) Share Path to Conversion reports with Twitter.
Account	setTeaserSizeLimit(Long teaserSizeLimit) File size limit in kilobytes of Rich Media teaser creatives.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Account

public Account()

Method Detail

getAccountPermissionIds

public List<Long> getAccountPermissionIds()

Account permissions assigned to this account.

Returns:

value or null for none

setAccountPermissionIds

public Account setAccountPermissionIds(List<Long> accountPermissionIds)

Account permissions assigned to this account.

Parameters:

accountPermissionIds - accountPermissionIds or null for none

getAccountProfile

public String getAccountProfile()

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

Returns:

value or null for none

setAccountProfile

public Account setAccountProfile(String accountProfile)

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

Parameters:

accountProfile - accountProfile or null for none

getActive

public Boolean getActive()

Whether this account is active.

Returns:

value or null for none

setActive

public Account setActive(Boolean active)

Whether this account is active.

Parameters:

active - active or null for none

getActiveAdsLimitTier

public String getActiveAdsLimitTier()

Maximum number of active ads allowed for this account.

Returns:

value or null for none

setActiveAdsLimitTier

public Account setActiveAdsLimitTier(String activeAdsLimitTier)

Maximum number of active ads allowed for this account.

Parameters:

activeAdsLimitTier - activeAdsLimitTier or null for none

getActiveViewOptOut

public Boolean getActiveViewOptOut()

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

Returns:

value or null for none

setActiveViewOptOut

public Account setActiveViewOptOut(Boolean activeViewOptOut)

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

Parameters:

activeViewOptOut - activeViewOptOut or null for none

getAvailablePermissionIds

public List<Long> getAvailablePermissionIds()

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

Returns:

value or null for none

setAvailablePermissionIds

public Account setAvailablePermissionIds(List<Long> availablePermissionIds)

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

Parameters:

availablePermissionIds - availablePermissionIds or null for none

getCountryId

public Long getCountryId()

ID of the country associated with this account.

Returns:

value or null for none

setCountryId

public Account setCountryId(Long countryId)

ID of the country associated with this account.

Parameters:

countryId - countryId or null for none

getCurrencyId

public Long getCurrencyId()

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

Returns:

value or null for none

setCurrencyId

public Account setCurrencyId(Long currencyId)

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

Parameters:

currencyId - currencyId or null for none

getDefaultCreativeSizeId

public Long getDefaultCreativeSizeId()

Default placement dimensions for this account.

Returns:

value or null for none

setDefaultCreativeSizeId

public Account setDefaultCreativeSizeId(Long defaultCreativeSizeId)

Default placement dimensions for this account.

Parameters:

defaultCreativeSizeId - defaultCreativeSizeId or null for none

getDescription

public String getDescription()

Description of this account.

Returns:

value or null for none

setDescription

public Account setDescription(String description)

Description of this account.

Parameters:

description - description or null for none

getId

public Long getId()

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

Returns:

value or null for none

setId

public Account setId(Long id)

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

Parameters:

id - id or null for none

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".

Returns:

value or null for none

setKind

public Account setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".

Parameters:

kind - kind or null for none

getLocale

public String getLocale()

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)

Returns:

value or null for none

setLocale

public Account setLocale(String locale)

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)

Parameters:

locale - locale or null for none

getMaximumImageSize

public Long getMaximumImageSize()

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

Returns:

value or null for none

setMaximumImageSize

public Account setMaximumImageSize(Long maximumImageSize)

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

Parameters:

maximumImageSize - maximumImageSize or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public Account setName(String name)

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

Parameters:

name - name or null for none

getNielsenOcrEnabled

public Boolean getNielsenOcrEnabled()

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

Returns:

value or null for none

setNielsenOcrEnabled

public Account setNielsenOcrEnabled(Boolean nielsenOcrEnabled)

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

Parameters:

nielsenOcrEnabled - nielsenOcrEnabled or null for none

getReportsConfiguration

public ReportsConfiguration getReportsConfiguration()

Reporting configuration of this account.

Returns:

value or null for none

setReportsConfiguration

public Account setReportsConfiguration(ReportsConfiguration reportsConfiguration)

Reporting configuration of this account.

Parameters:

reportsConfiguration - reportsConfiguration or null for none

getShareReportsWithTwitter

public Boolean getShareReportsWithTwitter()

Share Path to Conversion reports with Twitter.

Returns:

value or null for none

setShareReportsWithTwitter

public Account setShareReportsWithTwitter(Boolean shareReportsWithTwitter)

Share Path to Conversion reports with Twitter.

Parameters:

shareReportsWithTwitter - shareReportsWithTwitter or null for none

getTeaserSizeLimit

public Long getTeaserSizeLimit()

File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.

Returns:

value or null for none

setTeaserSizeLimit

public Account setTeaserSizeLimit(Long teaserSizeLimit)

File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.

Parameters:

teaserSizeLimit - teaserSizeLimit or null for none

set

public Account set(String fieldName,
                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Account clone()

Overrides:

clone in class com.google.api.client.json.GenericJson