Class GoogleAdsSearchads360V23ResourcesCampaignBudget

A campaign budget.

Inheritance
object
GoogleAdsSearchads360V23ResourcesCampaignBudget
Implements
Inherited Members
Namespace: Google.Apis.SA360.v23.Data
Assembly: Google.Apis.SA360.v23.dll
Syntax
public class GoogleAdsSearchads360V23ResourcesCampaignBudget : IDirectResponseSchema

Properties

AlignedBiddingStrategyId

ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campaigns that are added to the campaign budget must also use the aligned bidding strategy.

Declaration
[JsonProperty("alignedBiddingStrategyId")]
public virtual long? AlignedBiddingStrategyId { get; set; }
Property Value
Type Description
long?

AmountMicros

The average daily amount to be spent by the campaign. This field is used when the CampaignBudget period is set to DAILY, which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. The effective monthly spend is capped at 30.4 times this daily amount. This field is mutually exclusive with 'total_amount_micros'. Only one of 'amount_micros' or 'total_amount_micros' should be set.

Declaration
[JsonProperty("amountMicros")]
public virtual long? AmountMicros { get; set; }
Property Value
Type Description
long?

DeliveryMethod

The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.

Declaration
[JsonProperty("deliveryMethod")]
public virtual string DeliveryMethod { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExplicitlyShared

Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared.

Declaration
[JsonProperty("explicitlyShared")]
public virtual bool? ExplicitlyShared { get; set; }
Property Value
Type Description
bool?

HasRecommendedBudget

Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.

Declaration
[JsonProperty("hasRecommendedBudget")]
public virtual bool? HasRecommendedBudget { get; set; }
Property Value
Type Description
bool?

Id

Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results.

Declaration
[JsonProperty("id")]
public virtual long? Id { get; set; }
Property Value
Type Description
long?

Name

The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Period

Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.

Declaration
[JsonProperty("period")]
public virtual string Period { get; set; }
Property Value
Type Description
string

RecommendedBudgetAmountMicros

Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only.

Declaration
[JsonProperty("recommendedBudgetAmountMicros")]
public virtual long? RecommendedBudgetAmountMicros { get; set; }
Property Value
Type Description
long?

RecommendedBudgetEstimatedChangeWeeklyClicks

Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.

Declaration
[JsonProperty("recommendedBudgetEstimatedChangeWeeklyClicks")]
public virtual long? RecommendedBudgetEstimatedChangeWeeklyClicks { get; set; }
Property Value
Type Description
long?

RecommendedBudgetEstimatedChangeWeeklyCostMicros

Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only.

Declaration
[JsonProperty("recommendedBudgetEstimatedChangeWeeklyCostMicros")]
public virtual long? RecommendedBudgetEstimatedChangeWeeklyCostMicros { get; set; }
Property Value
Type Description
long?

RecommendedBudgetEstimatedChangeWeeklyInteractions

Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.

Declaration
[JsonProperty("recommendedBudgetEstimatedChangeWeeklyInteractions")]
public virtual long? RecommendedBudgetEstimatedChangeWeeklyInteractions { get; set; }
Property Value
Type Description
long?

RecommendedBudgetEstimatedChangeWeeklyViews

Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.

Declaration
[JsonProperty("recommendedBudgetEstimatedChangeWeeklyViews")]
public virtual long? RecommendedBudgetEstimatedChangeWeeklyViews { get; set; }
Property Value
Type Description
long?

ReferenceCount

Output only. The number of campaigns actively using the budget. This field is read-only.

Declaration
[JsonProperty("referenceCount")]
public virtual long? ReferenceCount { get; set; }
Property Value
Type Description
long?

ResourceName

Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: customers/{customer_id}/campaignBudgets/{campaign_budget_id}

Declaration
[JsonProperty("resourceName")]
public virtual string ResourceName { get; set; }
Property Value
Type Description
string

Status

Output only. The status of this campaign budget. This field is read-only.

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

TotalAmountMicros

The total amount to be spent by the campaign over its entire duration. This field is used only when the CampaignBudget period is set to CUSTOM_PERIOD. It represents the budget cap for the campaign's lifetime, rather than a daily limit. The amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. This field is mutually exclusive with 'amount_micros'. Only one of 'total_amount_micros' or 'amount_micros' should be set.

Declaration
[JsonProperty("totalAmountMicros")]
public virtual long? TotalAmountMicros { get; set; }
Property Value
Type Description
long?

Type

Immutable. The type of the campaign budget.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements