Campaign (Campaign Manager 360 API v5-rev20251009-2.0.0)

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.Campaign

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Campaign
extends com.google.api.client.json.GenericJson
```
Contains properties of a Campaign Manager 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 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

Campaign()

Constructors
Constructor and Description
`Campaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Campaign`	`clone()`
`Long`	`getAccountId()` Account ID of this campaign.
`AdBlockingConfiguration`	`getAdBlockingConfiguration()` Ad blocking settings for this campaign.
`List<CreativeOptimizationConfiguration>`	`getAdditionalCreativeOptimizationConfigurations()` Additional creative optimization configurations for the campaign.
`Long`	`getAdvertiserGroupId()` Advertiser group ID of the associated advertiser.
`Long`	`getAdvertiserId()` Advertiser ID of this campaign.
`DimensionValue`	`getAdvertiserIdDimensionValue()` Dimension value for the advertiser ID of this campaign.
`Boolean`	`getArchived()` Whether this campaign has been archived.
`List<AudienceSegmentGroup>`	`getAudienceSegmentGroups()` Audience segment groups assigned to this campaign.
`String`	`getBillingInvoiceCode()` Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
`ClickThroughUrlSuffixProperties`	`getClickThroughUrlSuffixProperties()` Click-through URL suffix override properties for this campaign.
`String`	`getComment()` Arbitrary comments about this campaign.
`LastModifiedInfo`	`getCreateInfo()` Information about the creation of this campaign.
`List<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.
`Long`	`getDefaultLandingPageId()` The default landing page ID for this campaign.
`com.google.api.client.util.DateTime`	`getEndDate()`
`String`	`getEuPoliticalAdsDeclaration()` Optional.
`List<EventTagOverride>`	`getEventTagOverrides()` Overrides that can be used to activate or deactivate advertiser event tags.
`String`	`getExternalId()` External ID for this campaign.
`Long`	`getId()` ID of this campaign.
`DimensionValue`	`getIdDimensionValue()` Dimension value for the ID of this campaign.
`String`	`getKind()` Identifies what kind of resource this is.
`LastModifiedInfo`	`getLastModifiedInfo()` Information about the most recent modification of this campaign.
`MeasurementPartnerCampaignLink`	`getMeasurementPartnerLink()` Measurement partner campaign link for tag wrapping.
`String`	`getName()` Name of this campaign.
`com.google.api.client.util.DateTime`	`getStartDate()`
`Long`	`getSubaccountId()` Subaccount ID of this campaign.
`Campaign`	`set(String fieldName, Object value)`
`Campaign`	`setAccountId(Long accountId)` Account ID of this campaign.
`Campaign`	`setAdBlockingConfiguration(AdBlockingConfiguration adBlockingConfiguration)` Ad blocking settings for this campaign.
`Campaign`	`setAdditionalCreativeOptimizationConfigurations(List<CreativeOptimizationConfiguration> additionalCreativeOptimizationConfigurations)` Additional creative optimization configurations for the campaign.
`Campaign`	`setAdvertiserGroupId(Long advertiserGroupId)` Advertiser group ID of the associated advertiser.
`Campaign`	`setAdvertiserId(Long advertiserId)` Advertiser ID of this campaign.
`Campaign`	`setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue)` Dimension value for the advertiser ID of this campaign.
`Campaign`	`setArchived(Boolean archived)` Whether this campaign has been archived.
`Campaign`	`setAudienceSegmentGroups(List<AudienceSegmentGroup> audienceSegmentGroups)` Audience segment groups assigned to this campaign.
`Campaign`	`setBillingInvoiceCode(String billingInvoiceCode)` Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
`Campaign`	`setClickThroughUrlSuffixProperties(ClickThroughUrlSuffixProperties clickThroughUrlSuffixProperties)` Click-through URL suffix override properties for this campaign.
`Campaign`	`setComment(String comment)` Arbitrary comments about this campaign.
`Campaign`	`setCreateInfo(LastModifiedInfo createInfo)` Information about the creation of this campaign.
`Campaign`	`setCreativeGroupIds(List<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(Long defaultLandingPageId)` The default landing page ID for this campaign.
`Campaign`	`setEndDate(com.google.api.client.util.DateTime endDate)`
`Campaign`	`setEuPoliticalAdsDeclaration(String euPoliticalAdsDeclaration)` Optional.
`Campaign`	`setEventTagOverrides(List<EventTagOverride> eventTagOverrides)` Overrides that can be used to activate or deactivate advertiser event tags.
`Campaign`	`setExternalId(String externalId)` External ID for this campaign.
`Campaign`	`setId(Long id)` ID of this campaign.
`Campaign`	`setIdDimensionValue(DimensionValue idDimensionValue)` Dimension value for the ID of this campaign.
`Campaign`	`setKind(String kind)` Identifies what kind of resource this is.
`Campaign`	`setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)` Information about the most recent modification of this campaign.
`Campaign`	`setMeasurementPartnerLink(MeasurementPartnerCampaignLink measurementPartnerLink)` Measurement partner campaign link for tag wrapping.
`Campaign`	`setName(String name)` Name of this campaign.
`Campaign`	`setStartDate(com.google.api.client.util.DateTime startDate)`
`Campaign`	`setSubaccountId(Long subaccountId)` Subaccount ID of this campaign.

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
  - Campaign
```
public Campaign()
```
- Method Detail
  - getAccountId
```
public 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(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 List<CreativeOptimizationConfiguration> getAdditionalCreativeOptimizationConfigurations()
```
    Additional creative optimization configurations for the campaign.
    
    Returns:
    
    value or null for none
  - setAdditionalCreativeOptimizationConfigurations
```
public Campaign setAdditionalCreativeOptimizationConfigurations(List<CreativeOptimizationConfiguration> additionalCreativeOptimizationConfigurations)
```
    Additional creative optimization configurations for the campaign.
    
    Parameters:
    
    additionalCreativeOptimizationConfigurations - additionalCreativeOptimizationConfigurations or null for none
  - getAdvertiserGroupId
```
public Long getAdvertiserGroupId()
```
    Advertiser group ID of the associated advertiser.
    
    Returns:
    
    value or null for none
  - setAdvertiserGroupId
```
public Campaign setAdvertiserGroupId(Long advertiserGroupId)
```
    Advertiser group ID of the associated advertiser.
    
    Parameters:
    
    advertiserGroupId - advertiserGroupId or null for none
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Advertiser ID of this campaign. This is a required field.
    
    Returns:
    
    value or null for none
  - setAdvertiserId
```
public Campaign setAdvertiserId(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 Boolean getArchived()
```
    Whether this campaign has been archived.
    
    Returns:
    
    value or null for none
  - setArchived
```
public Campaign setArchived(Boolean archived)
```
    Whether this campaign has been archived.
    
    Parameters:
    
    archived - archived or null for none
  - getAudienceSegmentGroups
```
public 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(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 String getBillingInvoiceCode()
```
    Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
    
    Returns:
    
    value or null for none
  - setBillingInvoiceCode
```
public Campaign setBillingInvoiceCode(String billingInvoiceCode)
```
    Billing invoice code included in the Campaign Manager 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 String getComment()
```
    Arbitrary comments about this campaign. Must be less than 256 characters long.
    
    Returns:
    
    value or null for none
  - setComment
```
public Campaign setComment(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 List<Long> getCreativeGroupIds()
```
    List of creative group IDs that are assigned to the campaign.
    
    Returns:
    
    value or null for none
  - setCreativeGroupIds
```
public Campaign setCreativeGroupIds(List<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 Long getDefaultLandingPageId()
```
    The default landing page ID for this campaign.
    
    Returns:
    
    value or null for none
  - setDefaultLandingPageId
```
public Campaign setDefaultLandingPageId(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()
```
    Returns:
    
    value or null for none
  - setEndDate
```
public Campaign setEndDate(com.google.api.client.util.DateTime endDate)
```
    Parameters:
    
    endDate - endDate or null for none
  - getEuPoliticalAdsDeclaration
```
public String getEuPoliticalAdsDeclaration()
```
    Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions.
    
    Returns:
    
    value or null for none
  - setEuPoliticalAdsDeclaration
```
public Campaign setEuPoliticalAdsDeclaration(String euPoliticalAdsDeclaration)
```
    Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions.
    
    Parameters:
    
    euPoliticalAdsDeclaration - euPoliticalAdsDeclaration or null for none
  - getEventTagOverrides
```
public 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(List<EventTagOverride> eventTagOverrides)
```
    Overrides that can be used to activate or deactivate advertiser event tags.
    
    Parameters:
    
    eventTagOverrides - eventTagOverrides or null for none
  - getExternalId
```
public String getExternalId()
```
    External ID for this campaign.
    
    Returns:
    
    value or null for none
  - setExternalId
```
public Campaign setExternalId(String externalId)
```
    External ID for this campaign.
    
    Parameters:
    
    externalId - externalId or null for none
  - getId
```
public Long getId()
```
    ID of this campaign. This is a read-only auto-generated field.
    
    Returns:
    
    value or null for none
  - setId
```
public Campaign setId(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 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(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
  - getMeasurementPartnerLink
```
public MeasurementPartnerCampaignLink getMeasurementPartnerLink()
```
    Measurement partner campaign link for tag wrapping.
    
    Returns:
    
    value or null for none
  - setMeasurementPartnerLink
```
public Campaign setMeasurementPartnerLink(MeasurementPartnerCampaignLink measurementPartnerLink)
```
    Measurement partner campaign link for tag wrapping.
    
    Parameters:
    
    measurementPartnerLink - measurementPartnerLink or null for none
  - getName
```
public String getName()
```
    Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser.
    
    Returns:
    
    value or null for none
  - setName
```
public Campaign setName(String name)
```
    Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser.
    
    Parameters:
    
    name - name or null for none
  - getStartDate
```
public com.google.api.client.util.DateTime getStartDate()
```
    Returns:
    
    value or null for none
  - setStartDate
```
public Campaign setStartDate(com.google.api.client.util.DateTime startDate)
```
    Parameters:
    
    startDate - startDate or null for none
  - getSubaccountId
```
public 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(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
  - set
```
public Campaign set(String fieldName,
                    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

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

Methods inherited from interface java.util.Map

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

getEuPoliticalAdsDeclaration

setEuPoliticalAdsDeclaration

getEventTagOverrides

setEventTagOverrides

getExternalId

setExternalId

getId

setId

getIdDimensionValue

setIdDimensionValue

getKind

setKind

getLastModifiedInfo

setLastModifiedInfo

getMeasurementPartnerLink

setMeasurementPartnerLink

getName

setName

getStartDate

setStartDate

getSubaccountId

setSubaccountId

set

clone