Package google.ads.searchads360.v0.resources

string

The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form:

customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}

int64

The ID of the bidding strategy.

string

The name of the bidding strategy.

BiddingStrategyType

The type of the bidding strategy.

int64

The ID of the Customer which owns the bidding strategy.

string

descriptive_name of the Customer which owns the bidding strategy.

MaximizeConversionValue

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

MaximizeConversions

An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.

TargetCpa

A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

TargetImpressionShare

A bidding strategy that automatically optimizes towards a chosen percentage of impressions.

TargetRoas

A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).

TargetSpend

A bid strategy that sets your bids to help get as many clicks as possible within your budget.

double

The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.

int64

The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.

int64

The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.

int64

Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.

TargetImpressionShareLocation

The targeted location on the search results page.

int64

The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.

int64

The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

double

The chosen revenue (based on conversion data) per unit of spend.

int64

The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.

int64

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

string

The resource name of the ad. Ad resource names have the form:

customers/{customer_id}/ads/{ad_id}

string

The list of possible final URLs after all cross-domain redirects for the ad.

AdType

The type of ad.

int64

The ID of the ad.

string

The URL that appears in the ad description for some ad formats.

string

The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd.

SearchAds360TextAdInfo

Details pertaining to a text ad.

SearchAds360ExpandedTextAdInfo

Details pertaining to an expanded text ad.

SearchAds360ResponsiveSearchAdInfo

Details pertaining to a responsive search ad.

SearchAds360ProductAdInfo

Details pertaining to a product ad.

SearchAds360ExpandedDynamicSearchAdInfo

Details pertaining to an expanded dynamic search ad.

string

The resource name of the ad group. Ad group resource names have the form:

customers/{customer_id}/adGroups/{ad_group_id}

AdGroupStatus

The status of the ad group.

AdGroupType

The type of the ad group.

AdGroupAdRotationMode

The ad rotation mode of the ad group.

string

The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

TargetingSetting

Setting for targeting related features.

string

The resource names of labels attached to this ad group.

string

The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group.

string

ID of the ad group in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group.id" instead.

string

Date when this ad group starts serving ads. By default, the ad group starts now or the ad group's start date, whichever is later. If this field is set, then the ad group starts at the beginning of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts.

Format: YYYY-MM-DD Example: 2019-03-14

string

Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts.

Format: YYYY-MM-DD Example: 2019-03-14

string

The language of the ads and keywords in an ad group. This field is only available for Microsoft Advertising accounts. More details: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage

string

The datetime when this ad group was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

int64

The ID of the ad group.

string

The name of the ad group.

This field is required and should not be empty when creating new ad groups.

It must contain fewer than 255 UTF-8 full-width characters.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

int64

The maximum CPC (cost-per-click) bid.

AdGroupEngineStatus

The Engine Status for ad group.

string

The resource name of the ad. Ad group ad resource names have the form:

customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

AdGroupAdStatus

The status of the ad.

Ad

The ad.

string

The timestamp when this ad_group_ad was created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

string

The resource names of labels attached to this ad group ad.

string

ID of the ad in the external engine account. This field is for Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 360 entity, use "ad_group_ad.ad.id" instead.

AdGroupAdEngineStatus

Additional status of the ad in the external engine account. Possible statuses (depending on the type of external account) include active, eligible, pending review, etc.

string

The datetime when this ad group ad was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

string

The resource name of the ad group ad label. Ad group ad label resource names have the form: customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}

string

The ad group ad to which the label is attached.

string

The label assigned to the ad group ad.

int64

The ID of the Customer which owns the label.

string

The resource name of the ad group asset. AdGroupAsset resource names have the form:

customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}

string

Required. The ad group to which the asset is linked.

string

Required. The asset which is linked to the ad group.

AssetLinkStatus

Status of the ad group asset.

string

The resource name of the ad group asset set. Ad group asset set resource names have the form:

customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}

string

The ad group to which this asset set is linked.

string

The asset set which is linked to the ad group.

AssetSetLinkStatus

The status of the ad group asset set. Read-only.

string

The resource name of the ad group audience view. Ad group audience view resource names have the form:

customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}

string

The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form:

customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}

double

The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type.

DeviceInfo

A device criterion.

string

The resource name of the ad group criterion. Ad group criterion resource names have the form:

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

string

The timestamp when this ad group criterion was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

AdGroupCriterionStatus

The status of the criterion.

This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.

QualityInfo

Information regarding the quality of the criterion.

CriterionType

The type of the criterion.

string

The resource names of labels attached to this ad group criterion.

PositionEstimates

Estimates for criterion bids at various positions.

string

The list of possible final URLs after all cross-domain redirects for the ad.

string

ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group_criterion.criterion_id" instead.

string

The datetime when this ad group criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

int64

The ID of the criterion.

string

The ad group to which the criterion belongs.

bool

Whether to target (false) or exclude (true) the criterion.

This field is immutable. To switch a criterion from positive to negative, remove then re-add it.

double

The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.

int64

The CPC (cost-per-click) bid.

int64

The effective CPC (cost-per-click) bid.

AdGroupCriterionEngineStatus

The Engine Status for ad group criterion.

string

URL template for appending params to final URL.

string

The URL template for constructing a tracking URL.

KeywordInfo

Keyword.

ListingGroupInfo

Listing group.

AgeRangeInfo

Age range.

GenderInfo

Gender.

UserListInfo

User List.

WebpageInfo

Webpage

LocationInfo

Location.

int64

The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.

int32

The quality score.

This field may not be populated if Google does not have enough information to determine a value.

string

The resource name of the ad group criterion label. Ad group criterion label resource names have the form: customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}

string

The ad group criterion to which the label is attached.

string

The label assigned to the ad group criterion.

int64

The ID of the Customer which owns the label.

string

The resource name of the ad group effective label. Ad group effective label resource names have the form: customers/{customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}

string

The ad group to which the effective label is attached.

string

The effective label assigned to the ad group.

int64

The ID of the Customer which owns the effective label.

string

The resource name of the ad group label. Ad group label resource names have the form: customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}

string

The ad group to which the label is attached.

string

The label assigned to the ad group.

int64

The ID of the Customer which owns the label.

string

The resource name of the age range view. Age range view resource names have the form:

customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}

string

The resource name of the asset. Asset resource names have the form:

customers/{customer_id}/assets/{asset_id}

AssetType

Type of the asset.

string

A list of possible final URLs after all cross domain redirects.

AssetStatus

The status of the asset.

string

The timestamp when this asset was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

string

The datetime when this asset was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

int64

The ID of the asset.

string

Optional name of the asset.

string

URL template for constructing a tracking URL.

AssetEngineStatus

The Engine Status for an asset.

YoutubeVideoAsset

A YouTube video asset.

ImageAsset

An image asset.

TextAsset

A text asset.

UnifiedCalloutAsset

A unified callout asset.

UnifiedSitelinkAsset

A unified sitelink asset.

UnifiedPageFeedAsset

A unified page feed asset.

MobileAppAsset

A mobile app asset.

UnifiedCallAsset

A unified call asset.

CallToActionAsset

A call to action asset.

UnifiedLocationAsset

A unified location asset.

string

The resource name of the asset group. Asset group resource names have the form:

customers/{customer_id}/assetGroups/{asset_group_id}

int64

The ID of the asset group.

string

The campaign with which this asset group is associated. The asset which is linked to the asset group.

string

Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.

string

A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.

string

A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.

AssetGroupStatus

The status of the asset group.

string

First part of text that may appear appended to the url displayed in the ad.

string

Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.

AdStrength

Overall ad strength of this asset group.

string

The resource name of the asset group asset. Asset group asset resource name have the form:

customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}

string

The asset group which this asset group asset is linking.

string

The asset which this asset group asset is linking.

AssetFieldType

The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc

AssetLinkStatus

The status of the link between an asset and asset group.

AssetUsage

Served assets.

string

The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form:

customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}

string

The asset group which this asset group listing group filter is part of.

int64

The ID of the ListingGroupFilter.

ListingGroupFilterType

Type of a listing group filter node.

ListingGroupFilterVertical

The vertical the current node tree represents. All nodes in the same tree must belong to the same vertical.

ListingGroupFilterDimension

Dimension value with which this listing group is refining its parent. Undefined for the root group.

string

Resource name of the parent listing group subdivision. Null for the root listing group filter node.

ListingGroupFilterDimensionPath

The path of dimensions defining this listing group filter.

string

The resource name of the asset group signal. Asset group signal resource name have the form:

customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}

string

The asset group which this asset group signal belongs to.

AudienceInfo

The audience signal to be used by the performance max campaign.

string

The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"

AssetGroupAssetCombinationData

The top combinations of assets that served together.

int64

The ID of the asset set.

string

The resource name of the asset set. Asset set resource names have the form:

customers/{customer_id}/assetSets/{asset_set_id}

string

The resource name of the asset set asset. Asset set asset resource names have the form:

customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}

string

The asset set which this asset set asset is linking to.

string

The asset which this asset set asset is linking to.

AssetSetAssetStatus

The status of the asset set asset. Read-only.

string

The resource name of the audience. Audience names have the form:

customers/{customer_id}/audiences/{audience_id}

int64

ID of the audience.

string

Required. Name of the audience. It should be unique across all audiences. It must have a minimum length of 1 and maximum length of 255.

string

Description of this audience.

string

The resource name of the bidding strategy. Bidding strategy resource names have the form:

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

BiddingStrategyStatus

The status of the bidding strategy.

This field is read-only.

BiddingStrategyType

The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme.

This field is read-only.

string

The currency used by the bidding strategy (ISO 4217 three-letter code).

For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.

int64

The ID of the bidding strategy.

string

The name of the bidding strategy. All bidding strategies within an account must be named distinctly.

The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).

string

The currency used by the bidding strategy (ISO 4217 three-letter code).

For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code.

Bidding strategy metrics are reported in this currency.

This field is read-only.

int64

The number of campaigns attached to this bidding strategy.

This field is read-only.

int64

The number of non-removed campaigns attached to this bidding strategy.

This field is read-only.

EnhancedCpc

A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.

MaximizeConversionValue

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

MaximizeConversions

An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.

TargetCpa

A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

TargetImpressionShare

A bidding strategy that automatically optimizes towards a chosen percentage of impressions.

TargetOutrankShare

A bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This field is deprecated. Creating a new bidding strategy with this field or attaching bidding strategies with this field to a campaign will fail. Mutates to strategies that already have this scheme populated are allowed.

TargetRoas

A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).

TargetSpend

A bid strategy that sets your bids to help get as many clicks as possible within your budget.

string

The resource name of the campaign. Campaign resource names have the form:

customers/{customer_id}/campaigns/{campaign_id}

CampaignStatus

The status of the campaign.

When a new campaign is added, the status defaults to ENABLED.

CampaignServingStatus

The ad serving status of the campaign.

BiddingStrategySystemStatus

The system status of the campaign's bidding strategy.

AdServingOptimizationStatus

The ad serving optimization status of the campaign.

AdvertisingChannelType

The primary serving target for ads within the campaign. The targeting options can be refined in network_settings.

This field is required and should not be empty when creating new campaigns.

Can be set only when creating campaigns. After the campaign is created, the field can not be changed.

AdvertisingChannelSubType

Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type.

Can be set only when creating campaigns. After campaign is created, the field can not be changed.

CustomParameter

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

RealTimeBiddingSetting

Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.

NetworkSettings

The network settings for the campaign.

DynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA).

ShoppingSetting

The setting for controlling Shopping campaigns.

GeoTargetTypeSetting

The setting for ads geotargeting.

string

The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.

string

The resource names of labels attached to this campaign.

BiddingStrategyType

The type of bidding strategy.

A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy.

This field is read-only.

string

Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.

FrequencyCapEntry

A list that limits how often each user will see this campaign's ads.

SelectiveOptimization

Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.

OptimizationGoalSetting

Optimization goal setting for this campaign, which includes a set of optimization goal types.

TrackingSetting

Campaign-level settings for tracking information.

string

ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.

AssetFieldType

The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.

string

The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. create_time will be deprecated in v1. Use creation_time instead.

string

The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

string

The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

int64

The ID of the campaign.

string

The name of the campaign.

This field is required and should not be empty when creating new campaigns.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

string

The URL template for constructing a tracking URL.

string

The resource name of the campaign budget of the campaign.

string

The date when campaign started in serving customer's timezone in YYYY-MM-DD format.

string

The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.

string

Suffix used to append query parameters to landing pages that are served with parallel tracking.

bool

Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.

string

The resource name of the portfolio bidding strategy used by the campaign.

ManualCpa

Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.

ManualCpc

Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.

ManualCpm

Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.

MaximizeConversions

Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.

MaximizeConversionValue

Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.

TargetCpa

Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

TargetImpressionShare

Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.

TargetRoas

Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).

TargetSpend

Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.

PercentCpc

Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.

TargetCpm

A bidding strategy that automatically optimizes cost per thousand impressions.

string

Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".

string

Required. The language code specifying the language of the domain, for example, "en".

bool

Whether the campaign uses advertiser supplied URLs exclusively.

PositiveGeoTargetType

The setting used for positive geotargeting in this particular campaign.

NegativeGeoTargetType

The setting used for negative geotargeting in this particular campaign.

bool

Whether ads will be served with google.com search results.

bool

Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true).

bool

Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.

bool

Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.

OptimizationGoalType

The list of optimization goal types.

string

The selected set of resource names for conversion actions for optimizing this campaign.

string

Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.

bool

Whether to target Vehicle Listing inventory.

int64

ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.

string

Sales country of products to include in the campaign.

int32

Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.

bool

Whether to include local products.

string

The url used for dynamic tracking.

string

The resource name of the campaign asset. CampaignAsset resource names have the form:

customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}

AssetLinkStatus

Status of the campaign asset.

string

The campaign to which the asset is linked.

string

The asset which is linked to the campaign.

string

The resource name of the campaign asset set. Asset set asset resource names have the form:

customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}

string

The campaign to which this asset set is linked.

string

The asset set which is linked to the campaign.

AssetSetLinkStatus

The status of the campaign asset set asset. Read-only.

string

The resource name of the campaign audience view. Campaign audience view resource names have the form:

customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}

string

The resource name of the campaign budget. Campaign budget resource names have the form:

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

BudgetDeliveryMethod

The delivery method that determines the rate at which the campaign budget is spent.

Defaults to STANDARD if unspecified in a create operation.

BudgetPeriod

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

int64

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.

string

The resource name of the campaign criterion. Campaign criterion resource names have the form:

customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}

string

The display name of the criterion.

This field is ignored for mutates.

CriterionType

The type of the criterion.

CampaignCriterionStatus

The status of the criterion.

string

The datetime when this campaign criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

int64

The ID of the criterion.

This field is ignored during mutate.

float

The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.

bool

Whether to target (false) or exclude (true) the criterion.

KeywordInfo

Keyword.

LocationInfo

Location.

DeviceInfo

Device.

AgeRangeInfo

Age range.

GenderInfo

Gender.

UserListInfo

User List.

LanguageInfo

Language.

WebpageInfo

Webpage.

LocationGroupInfo

Location Group

string

Name of the resource. CampaignEffectivelabel resource names have the form: customers/{customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}

string

The campaign to which the effective label is attached.

string

The effective label assigned to the campaign.

int64

The ID of the Customer which owns the effective label.

string

Name of the resource. Campaign label resource names have the form: customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}

string

The campaign to which the label is attached.

string

The label assigned to the campaign.

int64

The ID of the Customer which owns the label.

string

The resource name of the Cart data sales view. Cart data sales view resource names have the form: customers/{customer_id}/cartDataSalesView

string

The resource name of the conversion. Conversion resource names have the form:

customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}

int64

The ID of the conversion

int64

Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed.

int64

The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.

int64

Ad ID. A value of 0 indicates that the ad is unattributed.

string

A unique string, for the visit that the conversion is attributed to, that is passed to the landing page as the click id URL parameter.

int64

The Search Ads 360 visit ID that the conversion is attributed to.

string

For offline conversions, this is an ID provided by advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 generates one. For online conversions, this is equal to the id column or the floodlight_order_id column depending on the advertiser's Floodlight instructions.

string

The ID of the product clicked on.

ProductChannel

The sales channel of the product that was clicked on: Online or Local.

string

The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.

string

The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.

string

The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on.

AttributionType

What the conversion is attributed to: Visit or Keyword+Ad.

string

The timestamp of the conversion event.

string

The timestamp of the last time the conversion was modified.

string

The timestamp of the visit that the conversion is attributed to.

int64

The quantity of items recorded by the conversion, as determined by the qty url parameter. The advertiser is responsible for dynamically populating the parameter (such as number of items sold in the conversion), otherwise it defaults to 1.

int64

The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account.

int64

The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications.

string

The Floodlight order ID provided by the advertiser for the conversion.

ConversionStatus

The status of the conversion, either ENABLED or REMOVED..

int64

ID of the asset which was interacted with during the conversion event.

AssetFieldType

Asset field type of the conversion event.

string

The resource name of the conversion action. Conversion action resource names have the form:

customers/{customer_id}/conversionActions/{conversion_action_id}

string

Timestamp of the Floodlight activity's creation, formatted in ISO 8601.

ConversionActionStatus

The status of this conversion action for conversion event accrual.

ConversionActionType

The type of this conversion action.

ConversionActionCategory

The category of conversions reported for this conversion action.

ValueSettings

Settings related to the value for conversion events associated with this conversion action.

AttributionModelSettings

Settings related to this conversion action's attribution model.

FloodlightSettings

Floodlight settings for Floodlight conversion types.

int64

The ID of the conversion action.

string

The name of the conversion action.

This field is required and should not be empty when creating new conversion actions.

bool

If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.

string

The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.

bool

Whether this conversion action should be included in the "client_account_conversions" metric.

bool

Whether this conversion action should be included in the "conversions" metric.

int64

The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.

string

App ID for an app conversion action.

AttributionModel

The attribution model type of this conversion action.

DataDrivenModelStatus

The status of the data-driven attribution model for the conversion action.

string

String used to identify a Floodlight activity group when reporting conversions.

string

String used to identify a Floodlight activity when reporting conversions.

int64

ID of the Floodlight activity in DoubleClick Campaign Manager (DCM).

double

The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.

string

The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.

bool

Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.

string

The resource name of the conversion custom variable. Conversion custom variable resource names have the form:

customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}

int64

The ID of the conversion custom variable.

string

Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.

string

Required. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".

ConversionCustomVariableStatus

The status of the conversion custom variable for conversion event accrual.

string

The resource name of the customer that owns the conversion custom variable.

ConversionCustomVariableFamily

Family of the conversion custom variable.

ConversionCustomVariableCardinality

Cardinality of the conversion custom variable.

FloodlightConversionCustomVariableInfo

Fields for Search Ads 360 floodlight conversion custom variables.

int64

The IDs of custom columns that use this conversion custom variable.

FloodlightVariableType

Floodlight variable type defined in Search Ads 360.

FloodlightVariableDataType

Floodlight variable data type defined in Search Ads 360.

bool

Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.

ConversionTrackingStatus

Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request.

bool

Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.

string

The resource name of the customer where conversions are created and managed. This field is read-only.

int64

The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.

int64

The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.

int64

The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.

string

The resource name of the custom column. Custom column resource names have the form:

customers/{customer_id}/customColumns/{custom_column_id}

int64

ID of the custom column.

string

User-defined name of the custom column.

string

User-defined description of the custom column.

CustomColumnValueType

The type of the result value of the custom column.

bool

True when the custom column is referring to one or more attributes.

bool

True when the custom column is referring to one or more metrics.

bool

True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.

string

The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.

CustomColumnRenderType

How the result value of the custom column should be interpreted.

string

The resource name of the customer. Customer resource names have the form:

customers/{customer_id}

ConversionTrackingSetting

Conversion tracking setting for a customer.

AccountType

Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.

DoubleClickCampaignManagerSetting

DoubleClick Campaign Manager (DCM) setting for a manager customer.

AccountStatus

Account status, for example, Enabled, Paused, Removed, etc.

string

The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

string

ID of the account in the external engine account.

CustomerStatus

The status of the customer.

string

The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

int64

The ID of the customer.

string

Optional, non-unique descriptive name of the customer.

string

The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.

string

The local timezone ID of the customer.

string

The URL template for constructing a tracking URL out of parameters.

string

The URL template for appending params to the final URL.

bool

Whether auto-tagging is enabled for the customer.

bool

Whether the customer is a manager.

string

The resource name of the customer asset. CustomerAsset resource names have the form:

customers/{customer_id}/customerAssets/{asset_id}~{field_type}

string

Required. The asset which is linked to the customer.

AssetLinkStatus

Status of the customer asset.

string

The resource name of the customer asset set. Asset set asset resource names have the form:

customers/{customer_id}/customerAssetSets/{asset_set_id}

string

The asset set which is linked to the customer.

string

The customer to which this asset set is linked.

AssetSetLinkStatus

The status of the customer asset set asset. Read-only.

string

The resource name of the customer client. CustomerClient resource names have the form: customers/{customer_id}/customerClients/{client_customer_id}

string

The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form:

customers/{customer_id}/labels/{label_id}

CustomerStatus

The status of the client customer. Read only.

string

The resource name of the client-customer which is linked to the given customer. Read only.

bool

Specifies whether this is a hidden account.

Read only.

int64

Distance between given customer and client. For self link, the level value will be 0. Read only.

string

Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.

bool

Identifies if the client is a test account. Read only.

bool

Identifies if the client is a manager. Read only.

string

Descriptive name for the client. Read only.

string

Currency code (for example, 'USD', 'EUR') for the client. Read only.

int64

The ID of the client customer. Read only.

string

Name of the resource. CustomerManagerLink resource names have the form: customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}

ManagerLinkStatus

Status of the link between the customer and the manager.

string

The manager customer linked to the customer.

int64

ID of the customer-manager link. This field is read only.

string

The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

int64

ID of the Campaign Manager advertiser associated with this customer.

int64

ID of the Campaign Manager network associated with this customer.

string

Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.

string

The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form:

customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}

string

The dynamically selected landing page URL of the impression.

This field is read-only.

string

The resource name of the gender view. Gender view resource names have the form:

customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}

string

The resource name of the geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{geo_target_constant_id}

GeoTargetConstantStatus

Geo target constant status.

int64

The ID of the geo target constant.

string

Geo target constant English name.

string

The ISO-3166-1 alpha-2 country code that is associated with the target.

string

Geo target constant target type.

string

The fully qualified English name, consisting of the target's name and that of its parent and country.

string

The resource name of the parent geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{parent_geo_target_constant_id}

string

The resource name of the keyword view. Keyword view resource names have the form:

customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}

string

Name of the resource. Label resource names have the form: customers/{customer_id}/labels/{label_id}

LabelStatus

Status of the label. Read only.

TextLabel

A type of label displaying text on a colored background.

int64

ID of the label. Read only.

string

The name of the label.

This field is required and should not be empty when creating a new label.

The length of this string should be between 1 and 80, inclusive.

string

The resource name of the language constant. Language constant resource names have the form:

languageConstants/{criterion_id}

int64

The ID of the language constant.

string

The language code, for example, "en_US", "en_AU", "es", "fr", etc.

string

The full name of the language in English, for example, "English (US)", "Spanish", etc.

bool

Whether the language is targetable.

ProductBiddingCategory

Bidding category of a product offer.

ProductBrand

Brand of a product offer.

ProductChannel

Locality of a product offer.

ProductCondition

Condition of a product offer.

ProductCustomAttribute

Custom attribute of a product offer.

ProductItemId

Item id of a product offer.

ProductType

Type of a product offer.

ListingGroupFilterBiddingCategoryLevel

Indicates the level of the category in the taxonomy.

int64

ID of the product bidding category.

This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436

string

String value of the product brand.

ListingGroupFilterProductChannel

Value of the locality.

ListingGroupFilterProductCondition

Value of the condition.

ListingGroupFilterCustomAttributeIndex

Indicates the index of the custom attribute.

string

String value of the product custom attribute.

string

Value of the id.

ListingGroupFilterProductTypeLevel

Level of the type.

string

Value of the type.

ListingGroupFilterDimension

The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.

string

The resource name of the location view. Location view resource names have the form:

customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}

string

The resource name of the product bidding category. Product bidding category resource names have the form:

productBiddingCategoryConstants/{country_code}~{level}~{id}

ProductBiddingCategoryLevel

Level of the product bidding category.

ProductBiddingCategoryStatus

Status of the product bidding category.

int64

ID of the product bidding category.

This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.

string

Two-letter upper-case country code of the product bidding category.

string

Resource name of the parent product bidding category.

string

Language code of the product bidding category.

string

Display value of the product bidding category localized according to language_code.

string

The resource name of the product group view. Product group view resource names have the form:

customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}

string

The resource name of the artifact. Artifact resource names have the form:

SearchAds360Fields/{name}

SearchAds360FieldCategory

The category of the artifact.

string

The names of all resources, segments, and metrics that are selectable with the described artifact.

string

The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries.

This field is only set for artifacts whose category is RESOURCE.

string

This field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

string

This field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

string

Values the artifact can assume if it is a field of type ENUM.

This field is only set for artifacts of category SEGMENT or ATTRIBUTE.

SearchAds360FieldDataType

This field determines the operators that can be used with the artifact in WHERE clauses.

string

The name of the artifact.

bool

Whether the artifact can be used in a SELECT clause in search queries.

bool

Whether the artifact can be used in a WHERE clause in search queries.

bool

Whether the artifact can be used in a ORDER BY clause in search queries.

string

The URL of proto describing the artifact's data type.

bool

Whether the field artifact is repeated.

string

The resource name of the Shopping performance view. Shopping performance view resource names have the form: customers/{customer_id}/shoppingPerformanceView

string

The resource name of the user list. User list resource names have the form:

customers/{customer_id}/userLists/{user_list_id}

UserListType

Type of this list.

This field is read-only.

int64

Id of the user list.

string

Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)

string

The resource name of the visit. Visit resource names have the form:

customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}

int64

The ID of the visit.

int64

Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed.

int64

The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.

int64

Ad ID. A value of 0 indicates that the ad is unattributed.

string

A unique string for each visit that is passed to the landing page as the click id URL parameter.

string

The timestamp of the visit event. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

string

The ID of the product clicked on.

ProductChannel

The sales channel of the product that was clicked on: Online or Local.

string

The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.

string

The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.

string

The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on.

int64

ID of the asset which was interacted with during the visit event.

AssetFieldType

Asset field type of the visit event.

string

The resource name of the webpage view. Webpage view resource names have the form:

customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}