Campaign (DCM/DFA Reporting And Trafficking API v3.0 (Rev. 1) 1.23.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dfareporting.model.Campaign

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Campaign
extends com.google.api.client.json.GenericJson
```
Contains properties of a DCM campaign.
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 DCM/DFA Reporting And Trafficking 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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Campaign()

Constructors
Constructor and Description
`Campaign()`

Method Summary

Methods
Modifier and Type	Method and Description
`Campaign`	`clone()`
`java.lang.Long`	`getAccountId()` Account ID of this campaign.
`AdBlockingConfiguration`	`getAdBlockingConfiguration()` Ad blocking settings for this campaign.
`java.util.List<CreativeOptimizationConfiguration>`	`getAdditionalCreativeOptimizationConfigurations()` Additional creative optimization configurations for the campaign.
`java.lang.Long`	`getAdvertiserGroupId()` Advertiser group ID of the associated advertiser.
`java.lang.Long`	`getAdvertiserId()` Advertiser ID of this campaign.
`DimensionValue`	`getAdvertiserIdDimensionValue()` Dimension value for the advertiser ID of this campaign.
`java.lang.Boolean`	`getArchived()` Whether this campaign has been archived.
`java.util.List<AudienceSegmentGroup>`	`getAudienceSegmentGroups()` Audience segment groups assigned to this campaign.
`java.lang.String`	`getBillingInvoiceCode()` Billing invoice code included in the DCM client billing invoices associated with the campaign.
`ClickThroughUrlSuffixProperties`	`getClickThroughUrlSuffixProperties()` Click-through URL suffix override properties for this campaign.
`java.lang.String`	`getComment()` Arbitrary comments about this campaign.
`LastModifiedInfo`	`getCreateInfo()` Information about the creation of this campaign.
`java.util.List<java.lang.Long>`	`getCreativeGroupIds()` List of creative group IDs that are assigned to the campaign.
`CreativeOptimizationConfiguration`	`getCreativeOptimizationConfiguration()` Creative optimization configuration for the campaign.
`DefaultClickThroughEventTagProperties`	`getDefaultClickThroughEventTagProperties()` Click-through event tag ID override properties for this campaign.
`java.lang.Long`	`getDefaultLandingPageId()` The default landing page ID for this campaign.
`com.google.api.client.util.DateTime`	`getEndDate()` Date on which the campaign will stop running.
`java.util.List<EventTagOverride>`	`getEventTagOverrides()` Overrides that can be used to activate or deactivate advertiser event tags.
`java.lang.String`	`getExternalId()` External ID for this campaign.
`java.lang.Long`	`getId()` ID of this campaign.
`DimensionValue`	`getIdDimensionValue()` Dimension value for the ID of this campaign.
`java.lang.String`	`getKind()` Identifies what kind of resource this is.
`LastModifiedInfo`	`getLastModifiedInfo()` Information about the most recent modification of this campaign.
`LookbackConfiguration`	`getLookbackConfiguration()` Lookback window settings for the campaign.
`java.lang.String`	`getName()` Name of this campaign.
`java.lang.Boolean`	`getNielsenOcrEnabled()` Whether Nielsen reports are enabled for this campaign.
`com.google.api.client.util.DateTime`	`getStartDate()` Date on which the campaign starts running.
`java.lang.Long`	`getSubaccountId()` Subaccount ID of this campaign.
`java.util.List<java.lang.String>`	`getTraffickerEmails()` Campaign trafficker contact emails.
`Campaign`	`set(java.lang.String fieldName, java.lang.Object value)`
`Campaign`	`setAccountId(java.lang.Long accountId)` Account ID of this campaign.
`Campaign`	`setAdBlockingConfiguration(AdBlockingConfiguration adBlockingConfiguration)` Ad blocking settings for this campaign.
`Campaign`	`setAdditionalCreativeOptimizationConfigurations(java.util.List<CreativeOptimizationConfiguration> additionalCreativeOptimizationConfigurations)` Additional creative optimization configurations for the campaign.
`Campaign`	`setAdvertiserGroupId(java.lang.Long advertiserGroupId)` Advertiser group ID of the associated advertiser.
`Campaign`	`setAdvertiserId(java.lang.Long advertiserId)` Advertiser ID of this campaign.
`Campaign`	`setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue)` Dimension value for the advertiser ID of this campaign.
`Campaign`	`setArchived(java.lang.Boolean archived)` Whether this campaign has been archived.
`Campaign`	`setAudienceSegmentGroups(java.util.List<AudienceSegmentGroup> audienceSegmentGroups)` Audience segment groups assigned to this campaign.
`Campaign`	`setBillingInvoiceCode(java.lang.String billingInvoiceCode)` Billing invoice code included in the DCM client billing invoices associated with the campaign.
`Campaign`	`setClickThroughUrlSuffixProperties(ClickThroughUrlSuffixProperties clickThroughUrlSuffixProperties)` Click-through URL suffix override properties for this campaign.
`Campaign`	`setComment(java.lang.String comment)` Arbitrary comments about this campaign.
`Campaign`	`setCreateInfo(LastModifiedInfo createInfo)` Information about the creation of this campaign.
`Campaign`	`setCreativeGroupIds(java.util.List<java.lang.Long> creativeGroupIds)` List of creative group IDs that are assigned to the campaign.
`Campaign`	`setCreativeOptimizationConfiguration(CreativeOptimizationConfiguration creativeOptimizationConfiguration)` Creative optimization configuration for the campaign.
`Campaign`	`setDefaultClickThroughEventTagProperties(DefaultClickThroughEventTagProperties defaultClickThroughEventTagProperties)` Click-through event tag ID override properties for this campaign.
`Campaign`	`setDefaultLandingPageId(java.lang.Long defaultLandingPageId)` The default landing page ID for this campaign.
`Campaign`	`setEndDate(com.google.api.client.util.DateTime endDate)` Date on which the campaign will stop running.
`Campaign`	`setEventTagOverrides(java.util.List<EventTagOverride> eventTagOverrides)` Overrides that can be used to activate or deactivate advertiser event tags.
`Campaign`	`setExternalId(java.lang.String externalId)` External ID for this campaign.
`Campaign`	`setId(java.lang.Long id)` ID of this campaign.
`Campaign`	`setIdDimensionValue(DimensionValue idDimensionValue)` Dimension value for the ID of this campaign.
`Campaign`	`setKind(java.lang.String kind)` Identifies what kind of resource this is.
`Campaign`	`setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)` Information about the most recent modification of this campaign.
`Campaign`	`setLookbackConfiguration(LookbackConfiguration lookbackConfiguration)` Lookback window settings for the campaign.
`Campaign`	`setName(java.lang.String name)` Name of this campaign.
`Campaign`	`setNielsenOcrEnabled(java.lang.Boolean nielsenOcrEnabled)` Whether Nielsen reports are enabled for this campaign.
`Campaign`	`setStartDate(com.google.api.client.util.DateTime startDate)` Date on which the campaign starts running.
`Campaign`	`setSubaccountId(java.lang.Long subaccountId)` Subaccount ID of this campaign.
`Campaign`	`setTraffickerEmails(java.util.List<java.lang.String> traffickerEmails)` Campaign trafficker contact emails.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Campaign
```
public Campaign()
```
- Method Detail
  - getAccountId
```
public java.lang.Long getAccountId()
```
    Account ID of this campaign. This is a read-only field that can be left blank.
    
    Returns:
    value or null for none
  - setAccountId
```
public Campaign setAccountId(java.lang.Long accountId)
```
    Account ID of this campaign. This is a read-only field that can be left blank.
    
    Parameters:
    accountId - accountId or null for none
  - getAdBlockingConfiguration
```
public AdBlockingConfiguration getAdBlockingConfiguration()
```
    Ad blocking settings for this campaign.
    
    Returns:
    value or null for none
  - setAdBlockingConfiguration
```
public Campaign setAdBlockingConfiguration(AdBlockingConfiguration adBlockingConfiguration)
```
    Ad blocking settings for this campaign.
    
    Parameters:
    adBlockingConfiguration - adBlockingConfiguration or null for none
  - getAdditionalCreativeOptimizationConfigurations
```
public java.util.List<CreativeOptimizationConfiguration> getAdditionalCreativeOptimizationConfigurations()
```
    Additional creative optimization configurations for the campaign.
    
    Returns:
    value or null for none
  - setAdditionalCreativeOptimizationConfigurations
```
public Campaign setAdditionalCreativeOptimizationConfigurations(java.util.List<CreativeOptimizationConfiguration> additionalCreativeOptimizationConfigurations)
```
    Additional creative optimization configurations for the campaign.
    
    Parameters:
    additionalCreativeOptimizationConfigurations - additionalCreativeOptimizationConfigurations or null for none
  - getAdvertiserGroupId
```
public java.lang.Long getAdvertiserGroupId()
```
    Advertiser group ID of the associated advertiser.
    
    Returns:
    value or null for none
  - setAdvertiserGroupId
```
public Campaign setAdvertiserGroupId(java.lang.Long advertiserGroupId)
```
    Advertiser group ID of the associated advertiser.
    
    Parameters:
    advertiserGroupId - advertiserGroupId or null for none
  - getAdvertiserId
```
public java.lang.Long getAdvertiserId()
```
    Advertiser ID of this campaign. This is a required field.
    
    Returns:
    value or null for none
  - setAdvertiserId
```
public Campaign setAdvertiserId(java.lang.Long advertiserId)
```
    Advertiser ID of this campaign. This is a required field.
    
    Parameters:
    advertiserId - advertiserId or null for none
  - getAdvertiserIdDimensionValue
```
public DimensionValue getAdvertiserIdDimensionValue()
```
    Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
    
    Returns:
    value or null for none
  - setAdvertiserIdDimensionValue
```
public Campaign setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue)
```
    Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
    
    Parameters:
    advertiserIdDimensionValue - advertiserIdDimensionValue or null for none
  - getArchived
```
public java.lang.Boolean getArchived()
```
    Whether this campaign has been archived.
    
    Returns:
    value or null for none
  - setArchived
```
public Campaign setArchived(java.lang.Boolean archived)
```
    Whether this campaign has been archived.
    
    Parameters:
    archived - archived or null for none
  - getAudienceSegmentGroups
```
public java.util.List<AudienceSegmentGroup> getAudienceSegmentGroups()
```
    Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
    
    Returns:
    value or null for none
  - setAudienceSegmentGroups
```
public Campaign setAudienceSegmentGroups(java.util.List<AudienceSegmentGroup> audienceSegmentGroups)
```
    Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
    
    Parameters:
    audienceSegmentGroups - audienceSegmentGroups or null for none
  - getBillingInvoiceCode
```
public java.lang.String getBillingInvoiceCode()
```
    Billing invoice code included in the DCM client billing invoices associated with the campaign.
    
    Returns:
    value or null for none
  - setBillingInvoiceCode
```
public Campaign setBillingInvoiceCode(java.lang.String billingInvoiceCode)
```
    Billing invoice code included in the DCM client billing invoices associated with the campaign.
    
    Parameters:
    billingInvoiceCode - billingInvoiceCode or null for none
  - getClickThroughUrlSuffixProperties
```
public ClickThroughUrlSuffixProperties getClickThroughUrlSuffixProperties()
```
    Click-through URL suffix override properties for this campaign.
    
    Returns:
    value or null for none
  - setClickThroughUrlSuffixProperties
```
public Campaign setClickThroughUrlSuffixProperties(ClickThroughUrlSuffixProperties clickThroughUrlSuffixProperties)
```
    Click-through URL suffix override properties for this campaign.
    
    Parameters:
    clickThroughUrlSuffixProperties - clickThroughUrlSuffixProperties or null for none
  - getComment
```
public java.lang.String getComment()
```
    Arbitrary comments about this campaign. Must be less than 256 characters long.
    
    Returns:
    value or null for none
  - setComment
```
public Campaign setComment(java.lang.String comment)
```
    Arbitrary comments about this campaign. Must be less than 256 characters long.
    
    Parameters:
    comment - comment or null for none
  - getCreateInfo
```
public LastModifiedInfo getCreateInfo()
```
    Information about the creation of this campaign. This is a read-only field.
    
    Returns:
    value or null for none
  - setCreateInfo
```
public Campaign setCreateInfo(LastModifiedInfo createInfo)
```
    Information about the creation of this campaign. This is a read-only field.
    
    Parameters:
    createInfo - createInfo or null for none
  - getCreativeGroupIds
```
public java.util.List<java.lang.Long> getCreativeGroupIds()
```
    List of creative group IDs that are assigned to the campaign.
    
    Returns:
    value or null for none
  - setCreativeGroupIds
```
public Campaign setCreativeGroupIds(java.util.List<java.lang.Long> creativeGroupIds)
```
    List of creative group IDs that are assigned to the campaign.
    
    Parameters:
    creativeGroupIds - creativeGroupIds or null for none
  - getCreativeOptimizationConfiguration
```
public CreativeOptimizationConfiguration getCreativeOptimizationConfiguration()
```
    Creative optimization configuration for the campaign.
    
    Returns:
    value or null for none
  - setCreativeOptimizationConfiguration
```
public Campaign setCreativeOptimizationConfiguration(CreativeOptimizationConfiguration creativeOptimizationConfiguration)
```
    Creative optimization configuration for the campaign.
    
    Parameters:
    creativeOptimizationConfiguration - creativeOptimizationConfiguration or null for none
  - getDefaultClickThroughEventTagProperties
```
public DefaultClickThroughEventTagProperties getDefaultClickThroughEventTagProperties()
```
    Click-through event tag ID override properties for this campaign.
    
    Returns:
    value or null for none
  - setDefaultClickThroughEventTagProperties
```
public Campaign setDefaultClickThroughEventTagProperties(DefaultClickThroughEventTagProperties defaultClickThroughEventTagProperties)
```
    Click-through event tag ID override properties for this campaign.
    
    Parameters:
    defaultClickThroughEventTagProperties - defaultClickThroughEventTagProperties or null for none
  - getDefaultLandingPageId
```
public java.lang.Long getDefaultLandingPageId()
```
    The default landing page ID for this campaign.
    
    Returns:
    value or null for none
  - setDefaultLandingPageId
```
public Campaign setDefaultLandingPageId(java.lang.Long defaultLandingPageId)
```
    The default landing page ID for this campaign.
    
    Parameters:
    defaultLandingPageId - defaultLandingPageId or null for none
  - getEndDate
```
public com.google.api.client.util.DateTime getEndDate()
```
    Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    
    Returns:
    value or null for none
  - setEndDate
```
public Campaign setEndDate(com.google.api.client.util.DateTime endDate)
```
    Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
    
    Parameters:
    endDate - endDate or null for none
  - getEventTagOverrides
```
public java.util.List<EventTagOverride> getEventTagOverrides()
```
    Overrides that can be used to activate or deactivate advertiser event tags.
    
    Returns:
    value or null for none
  - setEventTagOverrides
```
public Campaign setEventTagOverrides(java.util.List<EventTagOverride> eventTagOverrides)
```
    Overrides that can be used to activate or deactivate advertiser event tags.
    
    Parameters:
    eventTagOverrides - eventTagOverrides or null for none
  - getExternalId
```
public java.lang.String getExternalId()
```
    External ID for this campaign.
    
    Returns:
    value or null for none
  - setExternalId
```
public Campaign setExternalId(java.lang.String externalId)
```
    External ID for this campaign.
    
    Parameters:
    externalId - externalId or null for none
  - getId
```
public java.lang.Long getId()
```
    ID of this campaign. This is a read-only auto-generated field.
    
    Returns:
    value or null for none
  - setId
```
public Campaign setId(java.lang.Long id)
```
    ID of this campaign. This is a read-only auto-generated field.
    
    Parameters:
    id - id or null for none
  - getIdDimensionValue
```
public DimensionValue getIdDimensionValue()
```
    Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
    
    Returns:
    value or null for none
  - setIdDimensionValue
```
public Campaign setIdDimensionValue(DimensionValue idDimensionValue)
```
    Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
    
    Parameters:
    idDimensionValue - idDimensionValue or null for none
  - getKind
```
public java.lang.String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    
    Returns:
    value or null for none
  - setKind
```
public Campaign setKind(java.lang.String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
    
    Parameters:
    kind - kind or null for none
  - getLastModifiedInfo
```
public LastModifiedInfo getLastModifiedInfo()
```
    Information about the most recent modification of this campaign. This is a read-only field.
    
    Returns:
    value or null for none
  - setLastModifiedInfo
```
public Campaign setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)
```
    Information about the most recent modification of this campaign. This is a read-only field.
    
    Parameters:
    lastModifiedInfo - lastModifiedInfo or null for none
  - getLookbackConfiguration
```
public LookbackConfiguration getLookbackConfiguration()
```
    Lookback window settings for the campaign.
    
    Returns:
    value or null for none
  - setLookbackConfiguration
```
public Campaign setLookbackConfiguration(LookbackConfiguration lookbackConfiguration)
```
    Lookback window settings for the campaign.
    
    Parameters:
    lookbackConfiguration - lookbackConfiguration or null for none
  - getName
```
public java.lang.String getName()
```
    Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    
    Returns:
    value or null for none
  - setName
```
public Campaign setName(java.lang.String name)
```
    Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
    
    Parameters:
    name - name or null for none
  - getNielsenOcrEnabled
```
public java.lang.Boolean getNielsenOcrEnabled()
```
    Whether Nielsen reports are enabled for this campaign.
    
    Returns:
    value or null for none
  - setNielsenOcrEnabled
```
public Campaign setNielsenOcrEnabled(java.lang.Boolean nielsenOcrEnabled)
```
    Whether Nielsen reports are enabled for this campaign.
    
    Parameters:
    nielsenOcrEnabled - nielsenOcrEnabled or null for none
  - getStartDate
```
public com.google.api.client.util.DateTime getStartDate()
```
    Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    
    Returns:
    value or null for none
  - setStartDate
```
public Campaign setStartDate(com.google.api.client.util.DateTime startDate)
```
    Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
    
    Parameters:
    startDate - startDate or null for none
  - getSubaccountId
```
public java.lang.Long getSubaccountId()
```
    Subaccount ID of this campaign. This is a read-only field that can be left blank.
    
    Returns:
    value or null for none
  - setSubaccountId
```
public Campaign setSubaccountId(java.lang.Long subaccountId)
```
    Subaccount ID of this campaign. This is a read-only field that can be left blank.
    
    Parameters:
    subaccountId - subaccountId or null for none
  - getTraffickerEmails
```
public java.util.List<java.lang.String> getTraffickerEmails()
```
    Campaign trafficker contact emails.
    
    Returns:
    value or null for none
  - setTraffickerEmails
```
public Campaign setTraffickerEmails(java.util.List<java.lang.String> traffickerEmails)
```
    Campaign trafficker contact emails.
    
    Parameters:
    traffickerEmails - traffickerEmails or null for none
  - set
```
public Campaign set(java.lang.String fieldName,
           java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Campaign clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

DCM/DFA Reporting And Trafficking API v3.0 (revision 1)

Class Campaign

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Campaign

Method Detail

getAccountId

setAccountId

getAdBlockingConfiguration

setAdBlockingConfiguration

getAdditionalCreativeOptimizationConfigurations

setAdditionalCreativeOptimizationConfigurations

getAdvertiserGroupId

setAdvertiserGroupId

getAdvertiserId

setAdvertiserId

getAdvertiserIdDimensionValue

setAdvertiserIdDimensionValue

getArchived

setArchived

getAudienceSegmentGroups

setAudienceSegmentGroups

getBillingInvoiceCode

setBillingInvoiceCode

getClickThroughUrlSuffixProperties

setClickThroughUrlSuffixProperties

getComment

setComment

getCreateInfo

setCreateInfo

getCreativeGroupIds

setCreativeGroupIds

getCreativeOptimizationConfiguration

setCreativeOptimizationConfiguration

getDefaultClickThroughEventTagProperties

setDefaultClickThroughEventTagProperties

getDefaultLandingPageId

setDefaultLandingPageId

getEndDate

setEndDate

getEventTagOverrides

setEventTagOverrides

getExternalId

setExternalId

getId

setId

getIdDimensionValue

setIdDimensionValue

getKind

setKind

getLastModifiedInfo

setLastModifiedInfo

getLookbackConfiguration

setLookbackConfiguration

getName

setName

getNielsenOcrEnabled

setNielsenOcrEnabled

getStartDate

setStartDate

getSubaccountId

setSubaccountId

getTraffickerEmails

setTraffickerEmails

set

clone