Google Ads API is returning to beta status. Please read our blog post for more details.

campaign_budget

The campaign budget referenced in the query.


Attributed resources

Fields from the following resources may be selected along with this resource in your select and where clauses. These fields will not segment metrics.

info_outline  Attributes

layers  Segments

show_chart  Metrics

campaign_budget.amount_micros

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.delivery_method

Field descriptionThe delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v2.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.explicitly_shared

Field descriptionSpecifies 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.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.has_recommended_budget

Field descriptionIndicates whether there is a recommended budget for this campaign budget. This field is read-only.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.id

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.name

Field descriptionThe 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).
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.period

Field descriptionPeriod over which to spend the budget. Defaults to DAILY if not specified.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v2.enums.BudgetPeriodEnum.BudgetPeriod
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.recommended_budget_amount_micros

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.recommended_budget_estimated_change_weekly_clicks

Field descriptionThe estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.recommended_budget_estimated_change_weekly_cost_micros

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.recommended_budget_estimated_change_weekly_interactions

Field descriptionThe estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.recommended_budget_estimated_change_weekly_views

Field descriptionThe estimated change in weekly views if the recommended budget is applied. This field is read-only.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.reference_count

Field descriptionThe number of campaigns actively using the budget. This field is read-only.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.resource_name

Field descriptionThe resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{budget_id}`
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

campaign_budget.status

Field descriptionThe status of this campaign budget. This field is read-only.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v2.enums.BudgetStatusEnum.BudgetStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.total_amount_micros

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign_budget.type

Field descriptionThe type of the campaign budget.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v2.enums.BudgetTypeEnum.BudgetType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions

Field descriptionThe total number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions_from_interactions_rate

Field descriptionAll conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions_value

Field descriptionThe total value of all conversions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cost

Field descriptionThe average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpc

Field descriptionThe total cost of all clicks divided by the total number of clicks received.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpe

Field descriptionThe 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpm

Field descriptionAverage cost-per-thousand impressions (CPM).
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpv

Field descriptionThe 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.clicks

Field descriptionThe number of clicks.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.conversions

Field descriptionThe number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.conversions_from_interactions_rate

Field descriptionConversions 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.conversions_value

Field descriptionThe total value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cost_micros

Field descriptionThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cost_per_all_conversions

Field descriptionThe cost of ad interactions divided by all conversions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cost_per_conversion

Field descriptionThe cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cross_device_conversions

Field descriptionConversions 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.ctr

Field descriptionThe number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.engagement_rate

Field descriptionHow 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.engagements

Field descriptionThe number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.impressions

Field descriptionCount of how often your ad has appeared on a search results page or website on the Google Network.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.interaction_event_types

Field descriptionThe types of payable and free interactions.
CategoryMETRIC
Data TypeENUM
Type URLgoogle.ads.googleads.v2.enums.InteractionEventTypeEnum.InteractionEventType
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

metrics.interaction_rate

Field descriptionHow 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.interactions

Field descriptionThe 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.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.value_per_all_conversions

Field descriptionThe value of all conversions divided by the number of all conversions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.value_per_conversion

Field descriptionThe value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_view_rate

Field descriptionThe number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_views

Field descriptionThe number of times your video ads were viewed.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.view_through_conversions

Field descriptionThe 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 (e.g., clicking on) another ad.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_action

Field descriptionResource name of the conversion action.
CategorySEGMENT
Data TypeRESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_action_category

Field descriptionConversion action category.
CategorySEGMENT
Data TypeENUM
Type URLgoogle.ads.googleads.v2.enums.ConversionActionCategoryEnum.ConversionActionCategory
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_action_name

Field descriptionConversion action name.
CategorySEGMENT
Data TypeSTRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.external_conversion_source

Field descriptionExternal conversion source.
CategorySEGMENT
Data TypeENUM
Type URLgoogle.ads.googleads.v2.enums.ExternalConversionSourceEnum.ExternalConversionSource
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

Send feedback about...

Google Ads API Beta
Google Ads API Beta
Need help? Visit our support page.