CampaignBudget (Display & Video 360 API v3-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.v3.model.CampaignBudget

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class CampaignBudget
extends com.google.api.client.json.GenericJson
```
Settings that control how the campaign budget is allocated.
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

CampaignBudget()

Constructors
Constructor and Description
`CampaignBudget()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CampaignBudget`	`clone()`
`Long`	`getBudgetAmountMicros()` Required.
`Long`	`getBudgetId()` The unique ID of the campaign budget.
`String`	`getBudgetUnit()` Required.
`DateRange`	`getDateRange()` Required.
`String`	`getDisplayName()` Required.
`String`	`getExternalBudgetId()` Immutable.
`String`	`getExternalBudgetSource()` Required.
`String`	`getInvoiceGroupingId()` Immutable.
`PrismaConfig`	`getPrismaConfig()` Additional metadata for use by the Mediaocean Prisma tool.
`CampaignBudget`	`set(String fieldName, Object value)`
`CampaignBudget`	`setBudgetAmountMicros(Long budgetAmountMicros)` Required.
`CampaignBudget`	`setBudgetId(Long budgetId)` The unique ID of the campaign budget.
`CampaignBudget`	`setBudgetUnit(String budgetUnit)` Required.
`CampaignBudget`	`setDateRange(DateRange dateRange)` Required.
`CampaignBudget`	`setDisplayName(String displayName)` Required.
`CampaignBudget`	`setExternalBudgetId(String externalBudgetId)` Immutable.
`CampaignBudget`	`setExternalBudgetSource(String externalBudgetSource)` Required.
`CampaignBudget`	`setInvoiceGroupingId(String invoiceGroupingId)` Immutable.
`CampaignBudget`	`setPrismaConfig(PrismaConfig prismaConfig)` Additional metadata for use by the Mediaocean Prisma tool.

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
  - CampaignBudget
```
public CampaignBudget()
```
- Method Detail
  - getBudgetAmountMicros
```
public Long getBudgetAmountMicros()
```
    Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
    
    Returns:
    
    value or null for none
  - setBudgetAmountMicros
```
public CampaignBudget setBudgetAmountMicros(Long budgetAmountMicros)
```
    Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
    
    Parameters:
    
    budgetAmountMicros - budgetAmountMicros or null for none
  - getBudgetId
```
public Long getBudgetId()
```
    The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
    
    Returns:
    
    value or null for none
  - setBudgetId
```
public CampaignBudget setBudgetId(Long budgetId)
```
    The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.
    
    Parameters:
    
    budgetId - budgetId or null for none
  - getBudgetUnit
```
public String getBudgetUnit()
```
    Required. Immutable. Specifies whether the budget is measured in currency or impressions.
    
    Returns:
    
    value or null for none
  - setBudgetUnit
```
public CampaignBudget setBudgetUnit(String budgetUnit)
```
    Required. Immutable. Specifies whether the budget is measured in currency or impressions.
    
    Parameters:
    
    budgetUnit - budgetUnit or null for none
  - getDateRange
```
public DateRange getDateRange()
```
    Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
    
    Returns:
    
    value or null for none
  - setDateRange
```
public CampaignBudget setDateRange(DateRange dateRange)
```
    Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037.
    
    Parameters:
    
    dateRange - dateRange or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public CampaignBudget setDisplayName(String displayName)
```
    Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getExternalBudgetId
```
public String getExternalBudgetId()
```
    Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
    
    Returns:
    
    value or null for none
  - setExternalBudgetId
```
public CampaignBudget setExternalBudgetId(String externalBudgetId)
```
    Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.
    
    Parameters:
    
    externalBudgetId - externalBudgetId or null for none
  - getExternalBudgetSource
```
public String getExternalBudgetSource()
```
    Required. The external source of the budget.
    
    Returns:
    
    value or null for none
  - setExternalBudgetSource
```
public CampaignBudget setExternalBudgetSource(String externalBudgetSource)
```
    Required. The external source of the budget.
    
    Parameters:
    
    externalBudgetSource - externalBudgetSource or null for none
  - getInvoiceGroupingId
```
public String getInvoiceGroupingId()
```
    Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
    
    Returns:
    
    value or null for none
  - setInvoiceGroupingId
```
public CampaignBudget setInvoiceGroupingId(String invoiceGroupingId)
```
    Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.
    
    Parameters:
    
    invoiceGroupingId - invoiceGroupingId or null for none
  - getPrismaConfig
```
public PrismaConfig getPrismaConfig()
```
    Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
    
    Returns:
    
    value or null for none
  - setPrismaConfig
```
public CampaignBudget setPrismaConfig(PrismaConfig prismaConfig)
```
    Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers.
    
    Parameters:
    
    prismaConfig - prismaConfig or null for none
  - set
```
public CampaignBudget set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CampaignBudget clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class CampaignBudget

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

CampaignBudget

Method Detail

getBudgetAmountMicros

setBudgetAmountMicros

getBudgetId

setBudgetId

getBudgetUnit

setBudgetUnit

getDateRange

setDateRange

getDisplayName

setDisplayName

getExternalBudgetId

setExternalBudgetId

getExternalBudgetSource

setExternalBudgetSource

getInvoiceGroupingId

setInvoiceGroupingId

getPrismaConfig

setPrismaConfig

set

clone