Package google.ads.searchads360.v0.resources

Index

An ad.

Fields
resource_name

string

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

customers/{customer_id}/ads/{ad_id}

final_urls[]

string

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

type

AdType

The type of ad.

id

int64

The ID of the ad.

display_url

string

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

name

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.

Union field ad_data. Details pertinent to the ad type. Exactly one value must be set. ad_data can be only one of the following:
text_ad

SearchAds360TextAdInfo

Details pertaining to a text ad.

expanded_text_ad

SearchAds360ExpandedTextAdInfo

Details pertaining to an expanded text ad.

responsive_search_ad

SearchAds360ResponsiveSearchAdInfo

Details pertaining to a responsive search ad.

product_ad

SearchAds360ProductAdInfo

Details pertaining to a product ad.

expanded_dynamic_search_ad

SearchAds360ExpandedDynamicSearchAdInfo

Details pertaining to an expanded dynamic search ad.

AdGroup

An ad group.

Fields
resource_name

string

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

customers/{customer_id}/adGroups/{ad_group_id}

status

AdGroupStatus

The status of the ad group.

type

AdGroupType

The type of the ad group.

ad_rotation_mode

AdGroupAdRotationMode

The ad rotation mode of the ad group.

creation_time

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.

targeting_setting

TargetingSetting

Setting for targeting related features.

labels[]

string

The resource names of labels attached to this ad group.

engine_id

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.

start_date

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

end_date

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

language_code

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

last_modified_time

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.

id

int64

The ID of the ad group.

name

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.

cpc_bid_micros

int64

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

engine_status

AdGroupEngineStatus

The Engine Status for ad group.

AdGroupAd

An ad group ad.

Fields
resource_name

string

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

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

status

AdGroupAdStatus

The status of the ad.

ad

Ad

The ad.

creation_time

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.

labels[]

string

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

engine_id

string

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

engine_status

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.

last_modified_time

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.

AdGroupAdLabel

A relationship between an ad group ad and a label.

Fields
resource_name

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}

ad_group_ad

string

The ad group ad to which the label is attached.

label

string

The label assigned to the ad group ad.

AdGroupAsset

A link between an ad group and an asset.

Fields
resource_name

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}

ad_group

string

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

asset

string

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

status

AssetLinkStatus

Status of the ad group asset.

AdGroupAssetSet

AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group.

Fields
resource_name

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}

ad_group

string

The ad group to which this asset set is linked.

asset_set

string

The asset set which is linked to the ad group.

status

AssetSetLinkStatus

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

AdGroupAudienceView

An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level.

Fields
resource_name

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}

AdGroupBidModifier

Represents an ad group bid modifier.

Fields
resource_name

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}

bid_modifier

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.

Union field criterion. The criterion of this ad group bid modifier.

Required in create operations starting in V5. criterion can be only one of the following:

device

DeviceInfo

A device criterion.

AdGroupCriterion

An ad group criterion. The ad_group_criterion report only returns criteria that were explicitly added to the ad group.

Fields
resource_name

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}

creation_time

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.

status

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.

quality_info

QualityInfo

Information regarding the quality of the criterion.

type

CriterionType

The type of the criterion.

labels[]

string

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

position_estimates

PositionEstimates

Estimates for criterion bids at various positions.

final_urls[]

string

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

engine_id

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.

last_modified_time

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.

criterion_id

int64

The ID of the criterion.

ad_group

string

The ad group to which the criterion belongs.

negative

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.

bid_modifier

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.

cpc_bid_micros

int64

The CPC (cost-per-click) bid.

effective_cpc_bid_micros

int64

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

engine_status

AdGroupCriterionEngineStatus

The Engine Status for ad group criterion.

final_url_suffix

string

URL template for appending params to final URL.

tracking_url_template

string

The URL template for constructing a tracking URL.

Union field criterion. The ad group criterion.

Exactly one must be set. criterion can be only one of the following:

keyword

KeywordInfo

Keyword.

listing_group

ListingGroupInfo

Listing group.

age_range

AgeRangeInfo

Age range.

gender

GenderInfo

Gender.

user_list

UserListInfo

User List. The Similar Audiences sunset starts May 2023. Refer to https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html for other options.

webpage

WebpageInfo

Webpage

location

LocationInfo

Location.

PositionEstimates

Estimates for criterion bids at various positions.

Fields
top_of_page_cpc_micros

int64

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

QualityInfo

A container for ad group criterion quality information.

Fields
quality_score

int32

The quality score.

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

AdGroupCriterionLabel

A relationship between an ad group criterion and a label.

Fields
resource_name

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}

ad_group_criterion

string

The ad group criterion to which the label is attached.

label

string

The label assigned to the ad group criterion.

AdGroupLabel

A relationship between an ad group and a label.

Fields
resource_name

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}

ad_group

string

The ad group to which the label is attached.

label

string

The label assigned to the ad group.

AgeRangeView

An age range view.

Fields
resource_name

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}

Asset

Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.

Fields
resource_name

string

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

customers/{customer_id}/assets/{asset_id}

type

AssetType

Type of the asset.

final_urls[]

string

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

status

AssetStatus

The status of the asset.

creation_time

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.

last_modified_time

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.

id

int64

The ID of the asset.

name

string

Optional name of the asset.

tracking_url_template

string

URL template for constructing a tracking URL.

engine_status

AssetEngineStatus

The Engine Status for an asset.

Union field asset_data. The specific type of the asset. asset_data can be only one of the following:
youtube_video_asset

YoutubeVideoAsset

A YouTube video asset.

image_asset

ImageAsset

An image asset.

text_asset

TextAsset

A text asset.

callout_asset

UnifiedCalloutAsset

A unified callout asset.

page_feed_asset

UnifiedPageFeedAsset

A unified page feed asset.

mobile_app_asset

MobileAppAsset

A mobile app asset.

call_asset

UnifiedCallAsset

A unified call asset.

call_to_action_asset

CallToActionAsset

A call to action asset.

location_asset

UnifiedLocationAsset

A unified location asset.

AssetGroup

An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group.

Fields
resource_name

string

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

customers/{customer_id}/assetGroups/{asset_group_id}

id

int64

The ID of the asset group.

campaign

string

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

name

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.

final_urls[]

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.

final_mobile_urls[]

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.

status

AssetGroupStatus

The status of the asset group.

path1

string

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

path2

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.

ad_strength

AdStrength

Overall ad strength of this asset group.

AssetGroupAsset

AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group.

Fields
resource_name

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}

asset_group

string

The asset group which this asset group asset is linking.

asset

string

The asset which this asset group asset is linking.

field_type

AssetFieldType

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

status

AssetLinkStatus

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

AssetGroupAssetCombinationData

Asset group asset combination data

Fields
asset_combination_served_assets[]

AssetUsage

Served assets.

AssetGroupListingGroupFilter

AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.

Fields
resource_name

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}

asset_group

string

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

id

int64

The ID of the ListingGroupFilter.

type

ListingGroupFilterType

Type of a listing group filter node.

vertical

ListingGroupFilterVertical

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

case_value

ListingGroupFilterDimension

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

parent_listing_group_filter

string

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

path

ListingGroupFilterDimensionPath

The path of dimensions defining this listing group filter.

AssetGroupSignal

AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more.

Fields
resource_name

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}

asset_group

string

The asset group which this asset group signal belongs to.

Union field signal. The signal of the asset group. signal can be only one of the following:
audience

AudienceInfo

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

AssetGroupTopCombinationView

A view on the usage of ad group ad asset combination.

Fields
resource_name

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}"

asset_group_top_combinations[]

AssetGroupAssetCombinationData

The top combinations of assets that served together.

AssetSet

An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.

Fields
id

int64

The ID of the asset set.

resource_name

string

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

customers/{customer_id}/assetSets/{asset_set_id}

AssetSetAsset

AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.

Fields
resource_name

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}

asset_set

string

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

asset

string

The asset which this asset set asset is linking to.

status

AssetSetAssetStatus

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

Audience

Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.

Fields
resource_name

string

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

customers/{customer_id}/audiences/{audience_id}

id

int64

ID of the audience.

name

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.

description

string

Description of this audience.

BiddingStrategy

A bidding strategy.

Fields
resource_name

string

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

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

status

BiddingStrategyStatus

The status of the bidding strategy.

This field is read-only.

type

BiddingStrategyType

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

This field is read-only.

currency_code

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.

id

int64

The ID of the bidding strategy.

name

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).

effective_currency_code

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.

campaign_count

int64

The number of campaigns attached to this bidding strategy.

This field is read-only.

non_removed_campaign_count

int64

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

This field is read-only.

Union field scheme. The bidding scheme.

Only one can be set. scheme can be only one of the following:

enhanced_cpc

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.

maximize_conversion_value

MaximizeConversionValue

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

maximize_conversions

MaximizeConversions

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

target_cpa

TargetCpa

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

target_impression_share

TargetImpressionShare

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

target_outrank_share

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.

target_roas

TargetRoas

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

target_spend

TargetSpend

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

Campaign

A campaign.

Fields
resource_name

string

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

customers/{customer_id}/campaigns/{campaign_id}

status

CampaignStatus

The status of the campaign.

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

serving_status

CampaignServingStatus

The ad serving status of the campaign.

bidding_strategy_system_status

BiddingStrategySystemStatus

The system status of the campaign's bidding strategy.

ad_serving_optimization_status

AdServingOptimizationStatus

The ad serving optimization status of the campaign.

advertising_channel_type

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.

advertising_channel_sub_type

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.

url_custom_parameters[]

CustomParameter

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

real_time_bidding_setting

RealTimeBiddingSetting

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

network_settings

NetworkSettings

The network settings for the campaign.

dynamic_search_ads_setting

DynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA).

shopping_setting

ShoppingSetting

The setting for controlling Shopping campaigns.

geo_target_type_setting

GeoTargetTypeSetting

The setting for ads geotargeting.

labels[]

string

The resource names of labels attached to this campaign.

bidding_strategy_type

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.

frequency_caps[]

FrequencyCapEntry

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

selective_optimization

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.

optimization_goal_setting

OptimizationGoalSetting

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

tracking_setting

TrackingSetting

Campaign-level settings for tracking information.

engine_id

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.

excluded_parent_asset_field_types[]

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.

create_time

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.

creation_time

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.

last_modified_time

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.

id

int64

The ID of the campaign.

name

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.

tracking_url_template

string

The URL template for constructing a tracking URL.

campaign_budget

string

The budget of the campaign.

start_date

string

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

end_date

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.

final_url_suffix

string

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

url_expansion_opt_out

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.

Union field campaign_bidding_strategy. The bidding strategy for the campaign.

Must be either portfolio (created through BiddingStrategy service) or standard, that is embedded into the campaign. campaign_bidding_strategy can be only one of the following:

bidding_strategy

string

Portfolio bidding strategy used by campaign.

manual_cpa

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.

manual_cpc

ManualCpc

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

manual_cpm

ManualCpm

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

maximize_conversions

MaximizeConversions

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

maximize_conversion_value

MaximizeConversionValue

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

target_cpa

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.

target_impression_share

TargetImpressionShare

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

target_roas

TargetRoas

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

target_spend

TargetSpend

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

percent_cpc

PercentCpc

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

target_cpm

TargetCpm

A bidding strategy that automatically optimizes cost per thousand impressions.

DynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA).

Fields
domain_name

string

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

language_code

string

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

use_supplied_urls_only

bool

Whether the campaign uses advertiser supplied URLs exclusively.

GeoTargetTypeSetting

Represents a collection of settings related to ads geotargeting.

Fields
positive_geo_target_type

PositiveGeoTargetType

The setting used for positive geotargeting in this particular campaign.

negative_geo_target_type

NegativeGeoTargetType

The setting used for negative geotargeting in this particular campaign.

NetworkSettings

The network settings for the campaign.

Fields
target_search_network

bool

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

target_content_network

bool

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

target_partner_search_network

bool

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

OptimizationGoalSetting

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

Fields
optimization_goal_types[]

OptimizationGoalType

The list of optimization goal types.

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.

Fields
conversion_actions[]

string

The selected set of conversion actions for optimizing this campaign.

ShoppingSetting

The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns.

Fields
feed_label

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.

use_vehicle_inventory

bool

Whether to target Vehicle Listing inventory.

merchant_id

int64

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

sales_country

string

Sales country of products to include in the campaign.

campaign_priority

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.

enable_local

bool

Whether to include local products.

TrackingSetting

Campaign-level settings for tracking information.

Fields
tracking_url

string

The url used for dynamic tracking.

CampaignAsset

A link between a Campaign and an Asset.

Fields
resource_name

string

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

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

status

AssetLinkStatus

Status of the campaign asset.

campaign

string

The campaign to which the asset is linked.

asset

string

The asset which is linked to the campaign.

CampaignAssetSet

CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign.

Fields
resource_name

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}

campaign

string

The campaign to which this asset set is linked.

asset_set

string

The asset set which is linked to the campaign.

status

AssetSetLinkStatus

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

CampaignAudienceView

A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level.

Fields
resource_name

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}

CampaignBudget

A campaign budget.

Fields
resource_name

string

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

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

delivery_method

BudgetDeliveryMethod

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

Defaults to STANDARD if unspecified in a create operation.

period

BudgetPeriod

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

amount_micros

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.

CampaignCriterion

A campaign criterion.

Fields
resource_name

string

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

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

display_name

string

The display name of the criterion.

This field is ignored for mutates.

type

CriterionType

The type of the criterion.

status

CampaignCriterionStatus

The status of the criterion.

last_modified_time

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.

criterion_id

int64

The ID of the criterion.

This field is ignored during mutate.

bid_modifier

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.

negative

bool

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

Union field criterion. The campaign criterion.

Exactly one must be set. criterion can be only one of the following:

keyword

KeywordInfo

Keyword.

location

LocationInfo

Location.

device

DeviceInfo

Device.

age_range

AgeRangeInfo

Age range.

gender

GenderInfo

Gender.

user_list

UserListInfo

User List. The Similar Audiences sunset starts May 2023. Refer to https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html for other options.

language

LanguageInfo

Language.

webpage

WebpageInfo

Webpage.

location_group

LocationGroupInfo

Location Group

CampaignLabel

Represents a relationship between a campaign and a label.

Fields
resource_name

string

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

campaign

string

The campaign to which the label is attached.

label

string

The label assigned to the campaign.

CartDataSalesView

Cart data sales view.

Fields
resource_name

string

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

Conversion

A conversion.

Fields
resource_name

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}

id

int64

The ID of the conversion

criterion_id

int64

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

merchant_id

int64

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

ad_id

int64

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

click_id

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.

visit_id

int64

The SearchAds360 visit ID that the conversion is attributed to.

advertiser_conversion_id

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.

product_id

string

The ID of the product clicked on.

product_channel

ProductChannel

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

product_language_code

string

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

product_store_id

string

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

product_country_code

string

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

attribution_type

AttributionType

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

conversion_date_time

string

The timestamp of the conversion event.

conversion_last_modified_date_time

string

The timestamp of the last time the conversion was modified.

conversion_visit_date_time

string

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

conversion_quantity

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.

conversion_revenue_micros

int64

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

floodlight_original_revenue

int64

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

floodlight_order_id

string

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

status

ConversionStatus

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

asset_id

int64

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

asset_field_type

AssetFieldType

Asset field type of the conversion event.

ConversionAction

A conversion action.

Fields
resource_name

string

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

customers/{customer_id}/conversionActions/{conversion_action_id}

creation_time

string

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

status

ConversionActionStatus

The status of this conversion action for conversion event accrual.

type

ConversionActionType

The type of this conversion action.

category

ConversionActionCategory

The category of conversions reported for this conversion action.

value_settings

ValueSettings

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

attribution_model_settings

AttributionModelSettings

Settings related to this conversion action's attribution model.

floodlight_settings

FloodlightSettings

Floodlight settings for Floodlight conversion types.

id

int64

The ID of the conversion action.

name

string

The name of the conversion action.

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

primary_for_goal

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.

owner_customer

string

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

include_in_client_account_conversions_metric

bool

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

include_in_conversions_metric

bool

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

click_through_lookback_window_days

int64

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

app_id

string

App ID for an app conversion action.

AttributionModelSettings

Settings related to this conversion action's attribution model.

Fields
attribution_model

AttributionModel

The attribution model type of this conversion action.

data_driven_model_status

DataDrivenModelStatus

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

FloodlightSettings

Settings related to a Floodlight conversion action.

Fields
activity_group_tag

string

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

activity_tag

string

String used to identify a Floodlight activity when reporting conversions.

activity_id

int64

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

ValueSettings

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

Fields
default_value

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.

default_currency_code

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.

always_use_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.

ConversionCustomVariable

A conversion custom variable. See "About custom Floodlight metrics and dimensions in the new Search Ads 360" at https://support.google.com/sa360/answer/13567857

Fields
resource_name

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}

id

int64

The ID of the conversion custom variable.

name

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.

tag

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".

status

ConversionCustomVariableStatus

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

owner_customer

string

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

family

ConversionCustomVariableFamily

Family of the conversion custom variable.

cardinality

ConversionCustomVariableCardinality

Cardinality of the conversion custom variable.

floodlight_conversion_custom_variable_info

FloodlightConversionCustomVariableInfo

Fields for Search Ads 360 floodlight conversion custom variables.

custom_column_ids[]

int64

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

FloodlightConversionCustomVariableInfo

Information for Search Ads 360 Floodlight Conversion Custom Variables.

Fields
floodlight_variable_type

FloodlightVariableType

Floodlight variable type defined in Search Ads 360.

floodlight_variable_data_type

FloodlightVariableDataType

Floodlight variable data type defined in Search Ads 360.

ConversionTrackingSetting

A collection of customer-wide settings related to Search Ads 360 Conversion Tracking.

Fields
accepted_customer_data_terms

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.

conversion_tracking_status

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.

enhanced_conversions_for_leads_enabled

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.

google_ads_conversion_customer

string

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

conversion_tracking_id

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.

google_ads_cross_account_conversion_tracking_id

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.

cross_account_conversion_tracking_id

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.

CustomColumn

A custom column. See Search Ads 360 custom column at https://support.google.com/sa360/answer/9633916

Fields
resource_name

string

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

customers/{customer_id}/customColumns/{custom_column_id}

id

int64

ID of the custom column.

name

string

User-defined name of the custom column.

description

string

User-defined description of the custom column.

value_type

CustomColumnValueType

The type of the result value of the custom column.

references_attributes

bool

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

references_metrics

bool

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

queryable

bool

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

referenced_system_columns[]

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"}.

Customer

A customer.

Fields
resource_name

string

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

customers/{customer_id}

conversion_tracking_setting

ConversionTrackingSetting

Conversion tracking setting for a customer.

account_type

AccountType

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

double_click_campaign_manager_setting

DoubleClickCampaignManagerSetting

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

account_status

AccountStatus

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

last_modified_time

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.

engine_id

string

ID of the account in the external engine account.

status

CustomerStatus

The status of the customer.

creation_time

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.

id

int64

The ID of the customer.

descriptive_name

string

Optional, non-unique descriptive name of the customer.

currency_code

string

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

time_zone

string

The local timezone ID of the customer.

tracking_url_template

string

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

final_url_suffix

string

The URL template for appending params to the final URL.

auto_tagging_enabled

bool

Whether auto-tagging is enabled for the customer.

manager

bool

Whether the customer is a manager.

CustomerAsset

A link between a customer and an asset.

Fields
resource_name

string

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

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

asset

string

Required. The asset which is linked to the customer.

status

AssetLinkStatus

Status of the customer asset.

CustomerAssetSet

CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer.

Fields
resource_name

string

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

customers/{customer_id}/customerAssetSets/{asset_set_id}

asset_set

string

The asset set which is linked to the customer.

customer

string

The customer to which this asset set is linked.

status

AssetSetLinkStatus

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

CustomerClient

A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself.

Fields
resource_name

string

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

applied_labels[]

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}

status

CustomerStatus

The status of the client customer. Read only.

client_customer

string

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

hidden

bool

Specifies whether this is a hidden account.

Read only.

level

int64

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

time_zone

string

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

test_account

bool

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

manager

bool

Identifies if the client is a manager. Read only.

descriptive_name

string

Descriptive name for the client. Read only.

currency_code

string

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

id

int64

The ID of the client customer. Read only.

DoubleClickCampaignManagerSetting

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

Fields
advertiser_id

int64

ID of the Campaign Manager advertiser associated with this customer.

network_id

int64

ID of the Campaign Manager network associated with this customer.

time_zone

string

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

DynamicSearchAdsSearchTermView

A dynamic search ads search term view.

Fields
resource_name

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}

landing_page

string

The dynamically selected landing page URL of the impression.

This field is read-only.

GenderView

A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats.

Fields
resource_name

string

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

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

GeoTargetConstant

A geo target constant.

Fields
resource_name

string

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

geoTargetConstants/{geo_target_constant_id}

status

GeoTargetConstantStatus

Geo target constant status.

id

int64

The ID of the geo target constant.

name

string

Geo target constant English name.

country_code

string

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

target_type

string

Geo target constant target type.

canonical_name

string

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

parent_geo_target

string

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

geoTargetConstants/{parent_geo_target_constant_id}

KeywordView

A keyword view.

Fields
resource_name

string

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

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

Label

A label.

Fields
resource_name

string

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

status

LabelStatus

Status of the label. Read only.

text_label

TextLabel

A type of label displaying text on a colored background.

id

int64

ID of the label. Read only.

name

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.

LanguageConstant

A language.

Fields
resource_name

string

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

languageConstants/{criterion_id}

id

int64

The ID of the language constant.

code

string

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

name

string

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

targetable

bool

Whether the language is targetable.

ListingGroupFilterDimension

Listing dimensions for the asset group listing group filter.

Fields
Union field dimension. Dimension of one of the types below is always present. dimension can be only one of the following:
product_bidding_category

ProductBiddingCategory

Bidding category of a product offer.

product_brand

ProductBrand

Brand of a product offer.

product_channel

ProductChannel

Locality of a product offer.

product_condition

ProductCondition

Condition of a product offer.

product_custom_attribute

ProductCustomAttribute

Custom attribute of a product offer.

product_item_id

ProductItemId

Item id of a product offer.

product_type

ProductType

Type of a product offer.

ProductBiddingCategory

One element of a bidding category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level).

Fields
level

ListingGroupFilterBiddingCategoryLevel

Indicates the level of the category in the taxonomy.

id

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

ProductBrand

Brand of the product.

Fields
value

string

String value of the product brand.

ProductChannel

Locality of a product offer.

Fields
channel

ListingGroupFilterProductChannel

Value of the locality.

ProductCondition

Condition of a product offer.

Fields
condition

ListingGroupFilterProductCondition

Value of the condition.

ProductCustomAttribute

Custom attribute of a product offer.

Fields
index

ListingGroupFilterCustomAttributeIndex

Indicates the index of the custom attribute.

value

string

String value of the product custom attribute.

ProductItemId

Item id of a product offer.

Fields
value

string

Value of the id.

ProductType

Type of a product offer.

Fields
level

ListingGroupFilterProductTypeLevel

Level of the type.

value

string

Value of the type.

ListingGroupFilterDimensionPath

The path defining of dimensions defining a listing group filter.

Fields
dimensions[]

ListingGroupFilterDimension

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

LocationView

A location view summarizes the performance of campaigns by a Location criterion.

Fields
resource_name

string

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

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

ProductBiddingCategoryConstant

A Product Bidding Category.

Fields
resource_name

string

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

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

level

ProductBiddingCategoryLevel

Level of the product bidding category.

status

ProductBiddingCategoryStatus

Status of the product bidding category.

id

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.

country_code

string

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

product_bidding_category_constant_parent

string

Resource name of the parent product bidding category.

language_code

string

Language code of the product bidding category.

localized_name

string

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

ProductGroupView

A product group view.

Fields
resource_name

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}

SearchAds360Field

A field or resource (artifact) used by SearchAds360Service.

Fields
resource_name

string

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

SearchAds360Fields/{name}

category

SearchAds360FieldCategory

The category of the artifact.

selectable_with[]

string

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

attribute_resources[]

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.

metrics[]

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.

segments[]

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.

enum_values[]

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.

data_type

SearchAds360FieldDataType

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

name

string

The name of the artifact.

selectable

bool

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

filterable

bool

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

sortable

bool

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

type_url

string

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

is_repeated

bool

Whether the field artifact is repeated.

ShoppingPerformanceView

Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.

Fields
resource_name

string

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

UserList

A user list. This is a list of users a customer may target.

Fields
resource_name

string

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

customers/{customer_id}/userLists/{user_list_id}

type

UserListType

Type of this list.

This field is read-only.

id

int64

Id of the user list.

name

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)

Visit

A visit.

Fields
resource_name

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}

id

int64

The ID of the visit.

criterion_id

int64

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

merchant_id

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.

ad_id

int64

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

click_id

string

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

visit_date_time

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.

product_id

string

The ID of the product clicked on.

product_channel

ProductChannel

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

product_language_code

string

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

product_store_id

string

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

product_country_code

string

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

asset_id

int64

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

asset_field_type

AssetFieldType

Asset field type of the visit event.

WebpageView

A webpage view.

Fields
resource_name

string

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

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