campaign_budget

A campaign budget shared amongst various budget recommendation types.

Attributed resources
customer

Fields from the above resources may be selected along with this resource in your SELECT and WHERE clauses. These fields will not segment metrics in your SELECT clause.

Segmenting resources
campaign

Fields from the above resources, when selected along with this resource in your SELECT and WHERE clauses, will segment metrics.

Fields/Segments/Metrics

This page shows all metrics and segments that can be put in the same SELECT clause as the fields of campaign_budget . However, when you specify campaign_budget in the FROM clause, some metrics and segments cannot be used. Use the following filter to show only the fields that can be used when campaign_budget is specified in the FROM clause.

Is campaign_budget specified in the FROM clause of your query?

 Resource fields
aligned_bidding_strategy_id
amount_micros
delivery_method
explicitly_shared
has_recommended_budget
id
name
period
recommended_budget_amount_micros
recommended_budget_estimated_change_weekly_clicks
recommended_budget_estimated_change_weekly_cost_micros
recommended_budget_estimated_change_weekly_interactions
recommended_budget_estimated_change_weekly_views
reference_count
resource_name
status
total_amount_micros
type
 Segments
budget_campaign_association_status.campaign
budget_campaign_association_status.status
conversion_action
conversion_action_category
conversion_action_name
date
external_conversion_source
 Metrics
all_conversions
all_conversions_from_interactions_rate
all_conversions_value
average_cost
average_cpc
average_cpe
average_cpm
average_cpv
clicks
conversions
conversions_from_interactions_rate
conversions_value
cost_micros
cost_per_all_conversions
cost_per_conversion
cross_device_conversions
ctr
engagement_rate
engagements
impressions
interaction_event_types
interaction_rate
interactions
value_per_all_conversions
value_per_conversion
video_view_rate
video_views
view_through_conversions

campaign_budget.aligned_bidding_strategy_id

Field description 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.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.amount_micros

Field description The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.delivery_method

Field description The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
Category ATTRIBUTE
Data Type
Type URL google.ads.googleads.v16.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.explicitly_shared

Field description 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.
Category ATTRIBUTE
Data Type BOOLEAN
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False
Field description Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.
Category ATTRIBUTE
Data Type BOOLEAN
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.id

Field description 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.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.name

Field description 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).
Category ATTRIBUTE
Data Type STRING
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.period

Field description Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
Category ATTRIBUTE
Data Type
Type URL google.ads.googleads.v16.enums.BudgetPeriodEnum.BudgetPeriod
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.recommended_budget_amount_micros

Field description 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.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.recommended_budget_estimated_change_weekly_clicks

Field description Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.recommended_budget_estimated_change_weekly_cost_micros

Field description 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.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.recommended_budget_estimated_change_weekly_interactions

Field description Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.recommended_budget_estimated_change_weekly_views

Field description Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.reference_count

Field description Output only. The number of campaigns actively using the budget. This field is read-only.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.resource_name

Field description Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: customers/{customer_id}/campaignBudgets/{campaign_budget_id}
Category ATTRIBUTE
Data Type RESOURCE_NAME
Type URL N/A
Filterable True
Selectable True
Sortable False
Repeated False

campaign_budget.status

Field description Output only. The status of this campaign budget. This field is read-only.
Category ATTRIBUTE
Data Type
Type URL google.ads.googleads.v16.enums.BudgetStatusEnum.BudgetStatus
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.total_amount_micros

Field description The lifetime amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.
Category ATTRIBUTE
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

campaign_budget.type

Field description Immutable. The type of the campaign budget.
Category ATTRIBUTE
Data Type
Type URL google.ads.googleads.v16.enums.BudgetTypeEnum.BudgetType
Filterable True
Selectable True
Sortable True
Repeated False

segments.budget_campaign_association_status.campaign

Field description The campaign resource name.
Category SEGMENT
Data Type RESOURCE_NAME
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

segments.budget_campaign_association_status.status

Field description Budget campaign association status.
Category SEGMENT
Data Type
Type URL google.ads.googleads.v16.enums.BudgetCampaignAssociationStatusEnum.BudgetCampaignAssociationStatus
Filterable True
Selectable True
Sortable True
Repeated False

segments.conversion_action

Field description Resource name of the conversion action.
Category SEGMENT
Data Type RESOURCE_NAME
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

segments.conversion_action_category

Field description Conversion action category.
Category SEGMENT
Data Type
Type URL google.ads.googleads.v16.enums.ConversionActionCategoryEnum.ConversionActionCategory
Filterable True
Selectable True
Sortable True
Repeated False

segments.conversion_action_name

Field description Conversion action name.
Category SEGMENT
Data Type STRING
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

segments.date

Field description Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Category SEGMENT
Data Type DATE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

segments.external_conversion_source

Field description External conversion source.
Category SEGMENT
Data Type
Type URL google.ads.googleads.v16.enums.ExternalConversionSourceEnum.ExternalConversionSource
Filterable True
Selectable True
Sortable True
Repeated False

metrics.all_conversions

Field description The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.all_conversions_from_interactions_rate

Field description All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.all_conversions_value

Field description The value of all conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.average_cost

Field description The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.average_cpc

Field description The total cost of all clicks divided by the total number of clicks received.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.average_cpe

Field description The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.average_cpm

Field description Average cost-per-thousand impressions (CPM).
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.average_cpv

Field description The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.clicks

Field description The number of clicks.
Category METRIC
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.conversions

Field description The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.conversions_from_interactions_rate

Field description Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.conversions_value

Field description The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.cost_micros

Field description The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
Category METRIC
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.cost_per_all_conversions

Field description The cost of ad interactions divided by all conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.cost_per_conversion

Field description The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.cross_device_conversions

Field description Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.ctr

Field description The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.engagement_rate

Field description How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.engagements

Field description The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Category METRIC
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.impressions

Field description Count of how often your ad has appeared on a search results page or website on the Google Network.
Category METRIC
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.interaction_event_types

Field description The types of payable and free interactions.
Category METRIC
Data Type ENUM
Type URL google.ads.googleads.v16.enums.InteractionEventTypeEnum.InteractionEventType
Filterable True
Selectable True
Sortable False
Repeated True

metrics.interaction_rate

Field description How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.interactions

Field description The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
Category METRIC
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.value_per_all_conversions

Field description The value of all conversions divided by the number of all conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.value_per_conversion

Field description The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.video_view_rate

Field description The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
Category METRIC
Data Type DOUBLE
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.video_views

Field description The number of times your video ads were viewed.
Category METRIC
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False

metrics.view_through_conversions

Field description The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
Category METRIC
Data Type INT64
Type URL N/A
Filterable True
Selectable True
Sortable True
Repeated False