CampaignBudget
A campaign budget shared amongst various budget recommendation types.
Table Specific Information
Select
Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.
To use the nondefault fields, explicitly select them in your query.
Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.
Columns
| Name | Type | Behavior | Description |
| CampaignBudgetAlignedBiddingStrategyId | Long | ATTRIBUTE | 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. |
| CampaignBudgetAmountMicros | Long | ATTRIBUTE | 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. |
| CampaignBudgetDeliveryMethod | String | ATTRIBUTE | The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
The allowed values are ACCELERATED, STANDARD, UNKNOWN, UNSPECIFIED. |
| CampaignBudgetExplicitlyShared | Bool | ATTRIBUTE | 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. |
| CampaignBudgetHasRecommendedBudget | Bool | ATTRIBUTE | Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only. |
| CampaignBudgetId | Long | ATTRIBUTE | 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. |
| CampaignBudgetName | String | ATTRIBUTE | 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). |
| CampaignBudgetPeriod | String | ATTRIBUTE | Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
The allowed values are CUSTOM_PERIOD, DAILY, UNKNOWN, UNSPECIFIED. |
| CampaignBudgetRecommendedBudgetAmountMicros | Long | ATTRIBUTE | 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. |
| CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyClicks | Long | ATTRIBUTE | Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only. |
| CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyCostMicros | Long | ATTRIBUTE | 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. |
| CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyInteractions | Long | ATTRIBUTE | Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only. |
| CampaignBudgetRecommendedBudgetEstimatedChangeWeeklyViews | Long | ATTRIBUTE | Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only. |
| CampaignBudgetReferenceCount | Long | ATTRIBUTE | Output only. The number of campaigns actively using the budget. This field is read-only. |
| CampaignBudgetResourceName | String | ATTRIBUTE | Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: customers/{customer_id}/campaignBudgets/{campaign_budget_id} |
| CampaignBudgetStatus | String | ATTRIBUTE | Output only. The status of this campaign budget. This field is read-only.
The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED. |
| CampaignBudgetTotalAmountMicros | Long | ATTRIBUTE | 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. |
| CampaignBudgetType | String | ATTRIBUTE | Immutable. The type of the campaign budget.
The allowed values are FIXED_CPA, LOCAL_SERVICES, SMART_CAMPAIGN, STANDARD, UNKNOWN, UNSPECIFIED. |
| CustomerId | Long | ATTRIBUTE | Output only. The ID of the customer. |
| AllConversions | Double | METRIC | The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. |
| AllConversionsFromInteractionsRate | Double | METRIC | All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. |
| AllConversionsValue | Double | METRIC | The value of all conversions. |
| AverageCost | Double | METRIC | The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. |
| AverageCpc | Double | METRIC | The total cost of all clicks divided by the total number of clicks received. |
| AverageCpe | Double | METRIC | 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. |
| AverageCpm | Double | METRIC | Average cost-per-thousand impressions (CPM). |
| AverageCpv | Double | METRIC | 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. |
| Clicks | Long | METRIC | The number of clicks. |
| Conversions | Double | METRIC | 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. |
| ConversionsFromInteractionsRate | Double | METRIC | 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. |
| ConversionsValue | Double | METRIC | 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. |
| CostMicros | Long | METRIC | The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. |
| CostPerAllConversions | Double | METRIC | The cost of ad interactions divided by all conversions. |
| CostPerConversion | Double | METRIC | 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. |
| CrossDeviceConversions | Double | METRIC | 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. |
| Ctr | Double | METRIC | The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). |
| EngagementRate | Double | METRIC | 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. |
| Engagements | Long | METRIC | 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. |
| Impressions | Long | METRIC | Count of how often your ad has appeared on a search results page or website on the Google Network. |
| InteractionEventTypes | String | METRIC | The types of payable and free interactions.
The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE. |
| InteractionRate | Double | METRIC | 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. |
| Interactions | Long | METRIC | 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. |
| ValuePerAllConversions | Double | METRIC | The value of all conversions divided by the number of all conversions. |
| ValuePerConversion | Double | METRIC | 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. |
| VideoViewRate | Double | METRIC | The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads. |
| VideoViews | Long | METRIC | The number of times your video ads were viewed. |
| ViewThroughConversions | Long | METRIC | 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. |
| BudgetCampaignAssociationStatusCampaign | String | SEGMENT | The campaign resource name. |
| BudgetCampaignAssociationStatusStatus | String | SEGMENT | Budget campaign association status.
The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED. |
| ConversionAction | String | SEGMENT | Resource name of the conversion action. |
| ConversionActionCategory | String | SEGMENT | Conversion action category.
The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED. |
| ConversionActionName | String | SEGMENT | Conversion action name. |
| Date | Date | SEGMENT | Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17. |
| ExternalConversionSource | String | SEGMENT | External conversion source.
The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS. |
| Period | String | SEGMENT | Predefined date range.
The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ManagerId | Long | Id of the manager account on behalf of which you are requesting customer data. |