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 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. |
| 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 |
ENUM
ACCELERATED
STANDARD
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v22.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 |
|
campaign_budget.has_recommended_budget |
| 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 |
ENUM
CUSTOM_PERIOD
DAILY
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v22.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 |
ENUM
ENABLED
REMOVED
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v22.enums.BudgetStatusEnum.BudgetStatus |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
|
campaign_budget.total_amount_micros |
| Field description | 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. |
| 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 |
ENUM
FIXED_CPA
LOCAL_SERVICES
SMART_CAMPAIGN
STANDARD
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v22.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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
segments.conversion_action_category |
| Field description | Conversion action category. |
| Category | SEGMENT |
| Data Type |
ENUM
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
|
| Type URL | google.ads.googleads.v22.enums.ConversionActionCategoryEnum.ConversionActionCategory |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
segments.external_conversion_source |
| Field description | External conversion source. |
| Category | SEGMENT |
| Data Type |
ENUM
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
|
| Type URL | google.ads.googleads.v22.enums.ExternalConversionSourceEnum.ExternalConversionSource |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
metrics.trueview_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 TrueView views. |
| Category | METRIC |
| Data Type | DOUBLE |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
metrics.video_trueview_view_rate |
| Field description | The number of TrueView views your 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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
metrics.video_trueview_views |
| Field description | The number of TrueView views your video ads received. |
| Category | METRIC |
| Data Type | INT64 |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
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 |
| Selectable with |
The following fields/resources can be selected with this field:
|
|