Campaign (Display & Video 360 API v4-rev20260505-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.displayvideo.v4.model.Campaign

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Campaign
extends com.google.api.client.json.GenericJson
```
A single 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 Display & Video 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`	`getAdvertiserId()` Output only.
`List<CampaignBudget>`	`getCampaignBudgets()` The list of budgets available to this campaign.
`CampaignFlight`	`getCampaignFlight()` Required.
`CampaignGoal`	`getCampaignGoal()` Required.
`Long`	`getCampaignId()` Output only.
`String`	`getDisplayName()` Required.
`String`	`getEntityStatus()` Required.
`FrequencyCap`	`getFrequencyCap()` Required.
`String`	`getName()` Output only.
`String`	`getUpdateTime()` Output only.
`Campaign`	`set(String fieldName, Object value)`
`Campaign`	`setAdvertiserId(Long advertiserId)` Output only.
`Campaign`	`setCampaignBudgets(List<CampaignBudget> campaignBudgets)` The list of budgets available to this campaign.
`Campaign`	`setCampaignFlight(CampaignFlight campaignFlight)` Required.
`Campaign`	`setCampaignGoal(CampaignGoal campaignGoal)` Required.
`Campaign`	`setCampaignId(Long campaignId)` Output only.
`Campaign`	`setDisplayName(String displayName)` Required.
`Campaign`	`setEntityStatus(String entityStatus)` Required.
`Campaign`	`setFrequencyCap(FrequencyCap frequencyCap)` Required.
`Campaign`	`setName(String name)` Output only.
`Campaign`	`setUpdateTime(String updateTime)` Output only.

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
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Output only. The unique ID of the advertiser the campaign belongs to.
    
    Returns:
    
    value or null for none
  - setAdvertiserId
```
public Campaign setAdvertiserId(Long advertiserId)
```
    Output only. The unique ID of the advertiser the campaign belongs to.
    
    Parameters:
    
    advertiserId - advertiserId or null for none
  - getCampaignBudgets
```
public List<CampaignBudget> getCampaignBudgets()
```
    The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
    
    Returns:
    
    value or null for none
  - setCampaignBudgets
```
public Campaign setCampaignBudgets(List<CampaignBudget> campaignBudgets)
```
    The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.
    
    Parameters:
    
    campaignBudgets - campaignBudgets or null for none
  - getCampaignFlight
```
public CampaignFlight getCampaignFlight()
```
    Required. The planned spend and duration of the campaign.
    
    Returns:
    
    value or null for none
  - setCampaignFlight
```
public Campaign setCampaignFlight(CampaignFlight campaignFlight)
```
    Required. The planned spend and duration of the campaign.
    
    Parameters:
    
    campaignFlight - campaignFlight or null for none
  - getCampaignGoal
```
public CampaignGoal getCampaignGoal()
```
    Required. The goal of the campaign.
    
    Returns:
    
    value or null for none
  - setCampaignGoal
```
public Campaign setCampaignGoal(CampaignGoal campaignGoal)
```
    Required. The goal of the campaign.
    
    Parameters:
    
    campaignGoal - campaignGoal or null for none
  - getCampaignId
```
public Long getCampaignId()
```
    Output only. The unique ID of the campaign. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setCampaignId
```
public Campaign setCampaignId(Long campaignId)
```
    Output only. The unique ID of the campaign. Assigned by the system.
    
    Parameters:
    
    campaignId - campaignId or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Campaign setDisplayName(String displayName)
```
    Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEntityStatus
```
public String getEntityStatus()
```
    Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
    
    Returns:
    
    value or null for none
  - setEntityStatus
```
public Campaign setEntityStatus(String entityStatus)
```
    Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
    
    Parameters:
    
    entityStatus - entityStatus or null for none
  - getFrequencyCap
```
public FrequencyCap getFrequencyCap()
```
    Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
    
    Returns:
    
    value or null for none
  - setFrequencyCap
```
public Campaign setFrequencyCap(FrequencyCap frequencyCap)
```
    Required. The frequency cap setting of the campaign. *Warning*: On **February 28, 2025**, frequency cap time periods greater than 30 days will no longer be accepted. [Read more about this announced change](/display-video/api/deprecations#features.lifetime_frequency_cap)
    
    Parameters:
    
    frequencyCap - frequencyCap or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the campaign.
    
    Returns:
    
    value or null for none
  - setName
```
public Campaign setName(String name)
```
    Output only. The resource name of the campaign.
    
    Parameters:
    
    name - name or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The timestamp when the campaign was last updated. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Campaign setUpdateTime(String updateTime)
```
    Output only. The timestamp when the campaign was last updated. Assigned by the system.
    
    Parameters:
    
    updateTime - updateTime 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

getAdvertiserId

setAdvertiserId

getCampaignBudgets

setCampaignBudgets

getCampaignFlight

setCampaignFlight

getCampaignGoal

setCampaignGoal

getCampaignId

setCampaignId

getDisplayName

setDisplayName

getEntityStatus

setEntityStatus

getFrequencyCap

setFrequencyCap

getName

setName

getUpdateTime

setUpdateTime

set

clone