- JSON representation
- AdGroup
- AdGroupStatus
- AdGroupType
- AdGroupAdRotationMode
- AdGroupEngineStatus
- TargetingSetting
- TargetRestriction
- TargetingDimension
- AdGroupAd
- AdGroupAdStatus
- Ad
- AdType
- SearchAds360TextAdInfo
- SearchAds360ExpandedTextAdInfo
- SearchAds360ResponsiveSearchAdInfo
- AdTextAsset
- SearchAds360ProductAdInfo
- SearchAds360ExpandedDynamicSearchAdInfo
- AdGroupAdEngineStatus
- AdGroupAdLabel
- AdGroupAsset
- AssetLinkStatus
- AdGroupAssetSet
- AssetSetLinkStatus
- AdGroupAudienceView
- AdGroupBidModifier
- DeviceInfo
- Device
- AdGroupCriterion
- AdGroupCriterionStatus
- QualityInfo
- CriterionType
- PositionEstimates
- AdGroupCriterionEngineStatus
- KeywordInfo
- KeywordMatchType
- ListingGroupInfo
- ListingGroupType
- AgeRangeInfo
- AgeRangeType
- GenderInfo
- GenderType
- UserListInfo
- WebpageInfo
- WebpageConditionInfo
- WebpageConditionOperand
- WebpageConditionOperator
- LocationInfo
- AdGroupCriterionLabel
- AdGroupLabel
- AgeRangeView
- Asset
- AssetType
- AssetStatus
- AssetEngineStatus
- YoutubeVideoAsset
- ImageAsset
- MimeType
- ImageDimension
- TextAsset
- UnifiedCalloutAsset
- AdScheduleInfo
- MinuteOfHour
- DayOfWeek
- UnifiedSitelinkAsset
- UnifiedPageFeedAsset
- MobileAppAsset
- MobileAppVendor
- UnifiedCallAsset
- CallConversionReportingState
- CallToActionAsset
- CallToActionType
- UnifiedLocationAsset
- BusinessProfileLocation
- LocationOwnershipType
- AssetGroupAsset
- AssetFieldType
- AssetGroupSignal
- AudienceInfo
- AssetGroupListingGroupFilter
- ListingGroupFilterType
- ListingGroupFilterVertical
- ListingGroupFilterDimension
- ProductBiddingCategory
- ListingGroupFilterBiddingCategoryLevel
- ProductBrand
- ProductChannel
- ListingGroupFilterProductChannel
- ProductCondition
- ListingGroupFilterProductCondition
- ProductCustomAttribute
- ListingGroupFilterCustomAttributeIndex
- ProductItemId
- ProductType
- ListingGroupFilterProductTypeLevel
- ListingGroupFilterDimensionPath
- AssetGroupTopCombinationView
- AssetGroupAssetCombinationData
- AssetUsage
- ServedAssetFieldType
- AssetGroup
- AssetGroupStatus
- AdStrength
- AssetSetAsset
- AssetSetAssetStatus
- AssetSet
- BiddingStrategy
- BiddingStrategyStatus
- BiddingStrategyType
- EnhancedCpc
- MaximizeConversionValue
- MaximizeConversions
- TargetCpa
- TargetImpressionShare
- TargetImpressionShareLocation
- TargetOutrankShare
- TargetRoas
- TargetSpend
- CampaignBudget
- BudgetDeliveryMethod
- BudgetPeriod
- Campaign
- CampaignStatus
- CampaignServingStatus
- BiddingStrategySystemStatus
- AdServingOptimizationStatus
- AdvertisingChannelType
- AdvertisingChannelSubType
- CustomParameter
- RealTimeBiddingSetting
- NetworkSettings
- DynamicSearchAdsSetting
- ShoppingSetting
- GeoTargetTypeSetting
- PositiveGeoTargetType
- NegativeGeoTargetType
- FrequencyCapEntry
- SelectiveOptimization
- OptimizationGoalSetting
- OptimizationGoalType
- TrackingSetting
- ManualCpa
- ManualCpc
- ManualCpm
- PercentCpc
- TargetCpm
- CampaignAsset
- CampaignAssetSet
- CampaignAudienceView
- CampaignCriterion
- CampaignCriterionStatus
- LanguageInfo
- LocationGroupInfo
- LocationGroupRadiusUnits
- CampaignLabel
- CartDataSalesView
- Audience
- ConversionAction
- ConversionActionStatus
- ConversionActionType
- ConversionActionCategory
- ValueSettings
- AttributionModelSettings
- AttributionModel
- DataDrivenModelStatus
- FloodlightSettings
- ConversionCustomVariable
- ConversionCustomVariableStatus
- ConversionCustomVariableFamily
- ConversionCustomVariableCardinality
- FloodlightConversionCustomVariableInfo
- FloodlightVariableType
- FloodlightVariableDataType
- Customer
- ConversionTrackingSetting
- ConversionTrackingStatus
- AccountType
- DoubleClickCampaignManagerSetting
- AccountStatus
- CustomerStatus
- CustomerAsset
- CustomerAssetSet
- AccessibleBiddingStrategy
- MaximizeConversionValue
- MaximizeConversions
- TargetCpa
- TargetImpressionShare
- TargetRoas
- TargetSpend
- CustomerManagerLink
- ManagerLinkStatus
- CustomerClient
- DynamicSearchAdsSearchTermView
- GenderView
- GeoTargetConstant
- GeoTargetConstantStatus
- KeywordView
- Label
- LabelStatus
- TextLabel
- LanguageConstant
- LocationView
- ProductBiddingCategoryConstant
- ProductBiddingCategoryLevel
- ProductBiddingCategoryStatus
- ProductGroupView
- ShoppingPerformanceView
- UserList
- UserListType
- WebpageView
- Visit
- ProductChannel
- Conversion
- AttributionType
- ConversionStatus
- Metrics
- Value
- QualityScoreBucket
- InteractionEventType
- Segments
- AdNetworkType
- Keyword
- ProductChannelExclusivity
- ProductCondition
- AssetInteractionTarget
A returned row from the query.
JSON representation |
---|
{ "adGroup": { object ( |
Fields | |
---|---|
adGroup |
The ad group referenced in the query. |
adGroupAd |
The ad referenced in the query. |
adGroupAdLabel |
The ad group ad label referenced in the query. |
adGroupAsset |
The ad group asset referenced in the query. |
adGroupAssetSet |
The ad group asset set referenced in the query. |
adGroupAudienceView |
The ad group audience view referenced in the query. |
adGroupBidModifier |
The bid modifier referenced in the query. |
adGroupCriterion |
The criterion referenced in the query. |
adGroupCriterionLabel |
The ad group criterion label referenced in the query. |
adGroupLabel |
The ad group label referenced in the query. |
ageRangeView |
The age range view referenced in the query. |
asset |
The asset referenced in the query. |
assetGroupAsset |
The asset group asset referenced in the query. |
assetGroupSignal |
The asset group signal referenced in the query. |
assetGroupListingGroupFilter |
The asset group listing group filter referenced in the query. |
assetGroupTopCombinationView |
The asset group top combination view referenced in the query. |
assetGroup |
The asset group referenced in the query. |
assetSetAsset |
The asset set asset referenced in the query. |
assetSet |
The asset set referenced in the query. |
biddingStrategy |
The bidding strategy referenced in the query. |
campaignBudget |
The campaign budget referenced in the query. |
campaign |
The campaign referenced in the query. |
campaignAsset |
The campaign asset referenced in the query. |
campaignAssetSet |
The campaign asset set referenced in the query. |
campaignAudienceView |
The campaign audience view referenced in the query. |
campaignCriterion |
The campaign criterion referenced in the query. |
campaignLabel |
The campaign label referenced in the query. |
cartDataSalesView |
The cart data sales view referenced in the query. |
audience |
The Audience referenced in the query. |
conversionAction |
The conversion action referenced in the query. |
conversionCustomVariable |
The conversion custom variable referenced in the query. |
customer |
The customer referenced in the query. |
customerAsset |
The customer asset referenced in the query. |
customerAssetSet |
The customer asset set referenced in the query. |
accessibleBiddingStrategy |
The accessible bidding strategy referenced in the query. |
customerManagerLink |
The CustomerManagerLink referenced in the query. |
customerClient |
The CustomerClient referenced in the query. |
dynamicSearchAdsSearchTermView |
The dynamic search ads search term view referenced in the query. |
genderView |
The gender view referenced in the query. |
geoTargetConstant |
The geo target constant referenced in the query. |
keywordView |
The keyword view referenced in the query. |
label |
The label referenced in the query. |
languageConstant |
The language constant referenced in the query. |
locationView |
The location view referenced in the query. |
productBiddingCategoryConstant |
The Product Bidding Category referenced in the query. |
productGroupView |
The product group view referenced in the query. |
shoppingPerformanceView |
The shopping performance view referenced in the query. |
userList |
The user list referenced in the query. |
webpageView |
The webpage view referenced in the query. |
visit |
The event level visit referenced in the query. |
conversion |
The event level conversion referenced in the query. |
metrics |
The metrics. |
segments |
The segments. |
customColumns[] |
The custom columns. |
AdGroup
An ad group.
JSON representation |
---|
{ "resourceName": string, "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the ad group. Ad group resource names have the form:
|
status |
The status of the ad group. |
type |
The type of the ad group. |
adRotationMode |
The ad rotation mode of the ad group. |
creationTime |
The timestamp when this adGroup 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. |
labels[] |
The resource names of labels attached to this ad group. |
engineId |
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 "adGroup.id" instead. |
startDate |
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 |
endDate |
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 |
languageCode |
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 |
lastModifiedTime |
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 |
The ID of the ad group. |
name |
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. |
cpcBidMicros |
The maximum CPC (cost-per-click) bid. |
engineStatus |
The Engine Status for ad group. |
AdGroupStatus
The possible statuses of an ad group.
Enums | |
---|---|
UNSPECIFIED |
The status has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The ad group is enabled. |
PAUSED |
The ad group is paused. |
REMOVED |
The ad group is removed. |
AdGroupType
Enum listing the possible types of an ad group.
Enums | |
---|---|
UNSPECIFIED |
The type has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
SEARCH_STANDARD |
The default ad group type for Search campaigns. |
DISPLAY_STANDARD |
The default ad group type for Display campaigns. |
SHOPPING_PRODUCT_ADS |
The ad group type for Shopping campaigns serving standard product ads. |
SHOPPING_SHOWCASE_ADS |
The type for ad groups that are limited to serving Showcase or Merchant ads in Shopping results. |
HOTEL_ADS |
The default ad group type for Hotel campaigns. |
SHOPPING_SMART_ADS |
The type for ad groups in Smart Shopping campaigns. |
VIDEO_BUMPER |
Short unskippable in-stream video ads. |
VIDEO_TRUE_VIEW_IN_STREAM |
TrueView (skippable) in-stream video ads. |
VIDEO_TRUE_VIEW_IN_DISPLAY |
TrueView in-display video ads. |
VIDEO_NON_SKIPPABLE_IN_STREAM |
Unskippable in-stream video ads. |
VIDEO_OUTSTREAM |
Outstream video ads. |
SEARCH_DYNAMIC_ADS |
Ad group type for Dynamic Search Ads ad groups. |
SHOPPING_COMPARISON_LISTING_ADS |
The type for ad groups in Shopping Comparison Listing campaigns. |
PROMOTED_HOTEL_ADS |
The ad group type for Promoted Hotel ad groups. |
VIDEO_RESPONSIVE |
Video responsive ad groups. |
VIDEO_EFFICIENT_REACH |
Video efficient reach ad groups. |
SMART_CAMPAIGN_ADS |
Ad group type for Smart campaigns. |
TRAVEL_ADS |
Ad group type for Travel campaigns. |
AdGroupAdRotationMode
The possible ad rotation modes of an ad group.
Enums | |
---|---|
UNSPECIFIED |
The ad rotation mode has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
OPTIMIZE |
Optimize ad group ads based on clicks or conversions. |
ROTATE_FOREVER |
Rotate evenly forever. |
AdGroupEngineStatus
Status of the ad group engine.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
AD_GROUP_ELIGIBLE |
Deprecated. Do not use. |
AD_GROUP_EXPIRED |
No ads are running for this ad group, because the ad group's end date has passed. |
AD_GROUP_REMOVED |
The ad group has been deleted. |
AD_GROUP_DRAFT |
No ads are running for this ad group because the associated ad group is still in draft form. |
AD_GROUP_PAUSED |
The ad group has been paused. |
AD_GROUP_SERVING |
The ad group is active and currently serving ads. |
AD_GROUP_SUBMITTED |
The ad group has been submitted (Microsoft Bing Ads legacy status). |
CAMPAIGN_PAUSED |
No ads are running for this ad group, because the campaign has been paused. |
ACCOUNT_PAUSED |
No ads are running for this ad group, because the account has been paused. |
TargetingSetting
Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594
JSON representation |
---|
{
"targetRestrictions": [
{
object ( |
Fields | |
---|---|
targetRestrictions[] |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group. |
TargetRestriction
The list of per-targeting-dimension targeting settings.
JSON representation |
---|
{
"targetingDimension": enum ( |
Fields | |
---|---|
targetingDimension |
The targeting dimension that these settings apply to. |
bidOnly |
Indicates whether to restrict your ads to show only for the criteria you have selected for this targetingDimension, or to target all values for this targetingDimension and show ads based on your targeting in other TargetingDimensions. A value of |
TargetingDimension
Enum describing possible targeting dimensions.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
KEYWORD |
Keyword criteria, for example, 'mars cruise'. KEYWORD may be used as a custom bid dimension. Keywords are always a targeting dimension, so may not be set as a target "ALL" dimension with TargetRestriction. |
AUDIENCE |
Audience criteria, which include user list, user interest, custom affinity, and custom in market. |
TOPIC |
Topic criteria for targeting categories of content, for example, 'category::Animals>Pets' Used for Display and Video targeting. |
GENDER |
Criteria for targeting gender. |
AGE_RANGE |
Criteria for targeting age ranges. |
PLACEMENT |
Placement criteria, which include websites like 'www.flowers4sale.com', as well as mobile applications, mobile app categories, YouTube videos, and YouTube channels. |
PARENTAL_STATUS |
Criteria for parental status targeting. |
INCOME_RANGE |
Criteria for income range targeting. |
AdGroupAd
An ad group ad.
JSON representation |
---|
{ "resourceName": string, "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the ad. Ad group ad resource names have the form:
|
status |
The status of the ad. |
ad |
The ad. |
creationTime |
The timestamp when this adGroupAd was created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. |
labels[] |
The resource names of labels attached to this ad group ad. |
engineId |
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 "adGroupAd.ad.id" instead. |
engineStatus |
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. |
lastModifiedTime |
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. |
AdGroupAdStatus
The possible statuses of an AdGroupAd.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The ad group ad is enabled. |
PAUSED |
The ad group ad is paused. |
REMOVED |
The ad group ad is removed. |
Ad
An ad.
JSON representation |
---|
{ "resourceName": string, "finalUrls": [ string ], "type": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the ad. Ad resource names have the form:
|
finalUrls[] |
The list of possible final URLs after all cross-domain redirects for the ad. |
type |
The type of ad. |
id |
The ID of the ad. |
displayUrl |
The URL that appears in the ad description for some ad formats. |
name |
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: |
|
textAd |
Details pertaining to a text ad. |
expandedTextAd |
Details pertaining to an expanded text ad. |
responsiveSearchAd |
Details pertaining to a responsive search ad. |
productAd |
Details pertaining to a product ad. |
expandedDynamicSearchAd |
Details pertaining to an expanded dynamic search ad. |
AdType
The possible types of an ad.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
TEXT_AD |
The ad is a text ad. |
EXPANDED_TEXT_AD |
The ad is an expanded text ad. |
CALL_ONLY_AD |
The ad is a call only ad. |
EXPANDED_DYNAMIC_SEARCH_AD |
The ad is an expanded dynamic search ad. |
HOTEL_AD |
The ad is a hotel ad. |
SHOPPING_SMART_AD |
The ad is a Smart Shopping ad. |
SHOPPING_PRODUCT_AD |
The ad is a standard Shopping ad. |
VIDEO_AD |
The ad is a video ad. |
GMAIL_AD |
This ad is a Gmail ad. |
IMAGE_AD |
This ad is an Image ad. |
RESPONSIVE_SEARCH_AD |
The ad is a responsive search ad. |
LEGACY_RESPONSIVE_DISPLAY_AD |
The ad is a legacy responsive display ad. |
APP_AD |
The ad is an app ad. |
LEGACY_APP_INSTALL_AD |
The ad is a legacy app install ad. |
RESPONSIVE_DISPLAY_AD |
The ad is a responsive display ad. |
LOCAL_AD |
The ad is a local ad. |
HTML5_UPLOAD_AD |
The ad is a display upload ad with the HTML5_UPLOAD_AD product type. |
DYNAMIC_HTML5_AD |
The ad is a display upload ad with one of the DYNAMIC_HTML5_* product types. |
APP_ENGAGEMENT_AD |
The ad is an app engagement ad. |
SHOPPING_COMPARISON_LISTING_AD |
The ad is a Shopping Comparison Listing ad. |
VIDEO_BUMPER_AD |
Video bumper ad. |
VIDEO_NON_SKIPPABLE_IN_STREAM_AD |
Video non-skippable in-stream ad. |
VIDEO_OUTSTREAM_AD |
Video outstream ad. |
VIDEO_TRUEVIEW_DISCOVERY_AD |
Video TrueView in-display ad. |
VIDEO_TRUEVIEW_IN_STREAM_AD |
Video TrueView in-stream ad. |
VIDEO_RESPONSIVE_AD |
Video responsive ad. |
SMART_CAMPAIGN_AD |
Smart campaign ad. |
APP_PRE_REGISTRATION_AD |
Universal app pre-registration ad. |
DISCOVERY_MULTI_ASSET_AD |
Discovery multi asset ad. |
DISCOVERY_CAROUSEL_AD |
Discovery carousel ad. |
TRAVEL_AD |
Travel ad. |
DISCOVERY_VIDEO_RESPONSIVE_AD |
Discovery video responsive ad. |
MULTIMEDIA_AD |
Multimedia ad. |
SearchAds360TextAdInfo
A Search Ads 360 text ad.
JSON representation |
---|
{ "headline": string, "description1": string, "description2": string, "displayUrl": string, "displayMobileUrl": string, "adTrackingId": string } |
Fields | |
---|---|
headline |
The headline of the ad. |
description1 |
The first line of the ad's description. |
description2 |
The second line of the ad's description. |
displayUrl |
The displayed URL of the ad. |
displayMobileUrl |
The displayed mobile URL of the ad. |
adTrackingId |
The tracking id of the ad. |
SearchAds360ExpandedTextAdInfo
A Search Ads 360 expanded text ad.
JSON representation |
---|
{ "headline": string, "headline2": string, "headline3": string, "description1": string, "description2": string, "path1": string, "path2": string, "adTrackingId": string } |
Fields | |
---|---|
headline |
The headline of the ad. |
headline2 |
The second headline of the ad. |
headline3 |
The third headline of the ad. |
description1 |
The first line of the ad's description. |
description2 |
The second line of the ad's description. |
path1 |
Text appended to the auto-generated visible URL with a delimiter. |
path2 |
Text appended to path1 with a delimiter. |
adTrackingId |
The tracking id of the ad. |
SearchAds360ResponsiveSearchAdInfo
A Search Ads 360 responsive search ad.
JSON representation |
---|
{ "headlines": [ { object ( |
Fields | |
---|---|
headlines[] |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. |
descriptions[] |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. |
path1 |
Text appended to the auto-generated visible URL with a delimiter. |
path2 |
Text appended to path1 with a delimiter. |
adTrackingId |
The tracking id of the ad. |
AdTextAsset
A text asset used inside an ad.
JSON representation |
---|
{ "text": string } |
Fields | |
---|---|
text |
Asset text. |
SearchAds360ProductAdInfo
This type has no fields.
A Search Ads 360 product ad.
SearchAds360ExpandedDynamicSearchAdInfo
An expanded dynamic search ad.
JSON representation |
---|
{ "description1": string, "description2": string, "adTrackingId": string } |
Fields | |
---|---|
description1 |
The first line of the ad's description. |
description2 |
The second line of the ad's description. |
adTrackingId |
The tracking id of the ad. |
AdGroupAdEngineStatus
Enumerates AdGroupAd engine statuses.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
AD_GROUP_AD_ELIGIBLE |
Deprecated. Do not use. |
AD_GROUP_AD_INAPPROPRIATE_FOR_CAMPAIGN |
Baidu: Creative was not approved. |
AD_GROUP_AD_MOBILE_URL_UNDER_REVIEW |
Baidu: Mobile URL in process to be reviewed. |
AD_GROUP_AD_PARTIALLY_INVALID |
Baidu: Creative is invalid on mobile device but valid on desktop. |
AD_GROUP_AD_TO_BE_ACTIVATED |
Baidu: Creative is ready for activation. |
AD_GROUP_AD_NOT_REVIEWED |
Baidu: Creative not reviewed. |
AD_GROUP_AD_ON_HOLD |
Deprecated. Do not use. Previously used by Gemini |
AD_GROUP_AD_PAUSED |
Creative has been paused. |
AD_GROUP_AD_REMOVED |
Creative has been removed. |
AD_GROUP_AD_PENDING_REVIEW |
Creative is pending review. |
AD_GROUP_AD_UNDER_REVIEW |
Creative is under review. |
AD_GROUP_AD_APPROVED |
Creative has been approved. |
AD_GROUP_AD_DISAPPROVED |
Creative has been disapproved. |
AD_GROUP_AD_SERVING |
Creative is serving. |
AD_GROUP_AD_ACCOUNT_PAUSED |
Creative has been paused because the account is paused. |
AD_GROUP_AD_CAMPAIGN_PAUSED |
Creative has been paused because the campaign is paused. |
AD_GROUP_AD_AD_GROUP_PAUSED |
Creative has been paused because the ad group is paused. |
AdGroupAdLabel
A relationship between an ad group ad and a label.
JSON representation |
---|
{ "resourceName": string, "adGroupAd": string, "label": string, "ownerCustomerId": string } |
Fields | |
---|---|
resourceName |
The resource name of the ad group ad label. Ad group ad label resource names have the form: |
adGroupAd |
The ad group ad to which the label is attached. |
label |
The label assigned to the ad group ad. |
ownerCustomerId |
The ID of the Customer which owns the label. |
AdGroupAsset
A link between an ad group and an asset.
JSON representation |
---|
{
"resourceName": string,
"adGroup": string,
"asset": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the ad group asset. AdGroupAsset resource names have the form:
|
adGroup |
Required. The ad group to which the asset is linked. |
asset |
Required. The asset which is linked to the ad group. |
status |
Status of the ad group asset. |
AssetLinkStatus
Enum describing statuses of an asset link.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Asset link is enabled. |
REMOVED |
Asset link has been removed. |
PAUSED |
Asset link is paused. |
AdGroupAssetSet
AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group.
JSON representation |
---|
{
"resourceName": string,
"adGroup": string,
"assetSet": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the ad group asset set. Ad group asset set resource names have the form:
|
adGroup |
The ad group to which this asset set is linked. |
assetSet |
The asset set which is linked to the ad group. |
status |
The status of the ad group asset set. Read-only. |
AssetSetLinkStatus
The possible statuses of the linkage between asset set and its container.
Enums | |
---|---|
UNSPECIFIED |
The status has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The linkage between asset set and its container is enabled. |
REMOVED |
The linkage between asset set and its container is removed. |
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.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the ad group audience view. Ad group audience view resource names have the form:
|
AdGroupBidModifier
Represents an ad group bid modifier.
JSON representation |
---|
{ "resourceName": string, "bidModifier": number, // Union field |
Fields | |
---|---|
resourceName |
The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form:
|
bidModifier |
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 Required in create operations starting in V5. |
|
device |
A device criterion. |
DeviceInfo
A device criterion.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Type of the device. |
Device
Enumerates Google Ads devices available for targeting.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
MOBILE |
Mobile devices with full browsers. |
TABLET |
Tablets with full browsers. |
DESKTOP |
Computers. |
CONNECTED_TV |
Smart TVs and game consoles. |
OTHER |
Other device types. |
AdGroupCriterion
An ad group criterion. The adGroupCriterion report only returns criteria that were explicitly added to the ad group.
JSON representation |
---|
{ "resourceName": string, "creationTime": string, "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the ad group criterion. Ad group criterion resource names have the form:
|
creationTime |
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 |
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. |
type |
The type of the criterion. |
labels[] |
The resource names of labels attached to this ad group criterion. |
positionEstimates |
Estimates for criterion bids at various positions. |
finalUrls[] |
The list of possible final URLs after all cross-domain redirects for the ad. |
engineId |
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 "adGroupCriterion.criterion_id" instead. |
lastModifiedTime |
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. |
criterionId |
The ID of the criterion. |
adGroup |
The ad group to which the criterion belongs. |
negative |
Whether to target ( This field is immutable. To switch a criterion from positive to negative, remove then re-add it. |
bidModifier |
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. |
cpcBidMicros |
The CPC (cost-per-click) bid. |
effectiveCpcBidMicros |
The effective CPC (cost-per-click) bid. |
engineStatus |
The Engine Status for ad group criterion. |
finalUrlSuffix |
URL template for appending params to final URL. |
trackingUrlTemplate |
The URL template for constructing a tracking URL. |
Union field Exactly one must be set. |
|
keyword |
Keyword. |
listingGroup |
Listing group. |
ageRange |
Age range. |
gender |
Gender. |
userList |
User List. |
webpage |
Webpage |
location |
Location. |
AdGroupCriterionStatus
The possible statuses of an AdGroupCriterion.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The ad group criterion is enabled. |
PAUSED |
The ad group criterion is paused. |
REMOVED |
The ad group criterion is removed. |
QualityInfo
A container for ad group criterion quality information.
JSON representation |
---|
{ "qualityScore": integer } |
Fields | |
---|---|
qualityScore |
The quality score. This field may not be populated if Google does not have enough information to determine a value. |
CriterionType
Enum describing possible criterion types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
KEYWORD |
Keyword, for example, 'mars cruise'. |
PLACEMENT |
Placement, also known as Website, for example, 'www.flowers4sale.com' |
MOBILE_APP_CATEGORY |
Mobile application categories to target. |
MOBILE_APPLICATION |
Mobile applications to target. |
DEVICE |
Devices to target. |
LOCATION |
Locations to target. |
LISTING_GROUP |
Listing groups to target. |
AD_SCHEDULE |
Ad Schedule. |
AGE_RANGE |
Age range. |
GENDER |
Gender. |
INCOME_RANGE |
Income Range. |
PARENTAL_STATUS |
Parental status. |
YOUTUBE_VIDEO |
YouTube Video. |
YOUTUBE_CHANNEL |
YouTube Channel. |
USER_LIST |
User list. |
PROXIMITY |
Proximity. |
TOPIC |
A topic target on the display network (for example, "Pets & Animals"). |
LISTING_SCOPE |
Listing scope to target. |
LANGUAGE |
Language. |
IP_BLOCK |
IpBlock. |
CONTENT_LABEL |
Content Label for category exclusion. |
CARRIER |
Carrier. |
USER_INTEREST |
A category the user is interested in. |
WEBPAGE |
Webpage criterion for dynamic search ads. |
OPERATING_SYSTEM_VERSION |
Operating system version. |
APP_PAYMENT_MODEL |
App payment model. |
MOBILE_DEVICE |
Mobile device. |
CUSTOM_AFFINITY |
Custom affinity. |
CUSTOM_INTENT |
Custom intent. |
LOCATION_GROUP |
Location group. |
CUSTOM_AUDIENCE |
Custom audience |
COMBINED_AUDIENCE |
Combined audience |
KEYWORD_THEME |
Smart Campaign keyword theme |
AUDIENCE |
Audience |
LOCAL_SERVICE_ID |
Local Services Ads Service ID. |
BRAND |
Brand |
BRAND_LIST |
Brand List |
LIFE_EVENT |
Life Event |
PositionEstimates
Estimates for criterion bids at various positions.
JSON representation |
---|
{ "topOfPageCpcMicros": string } |
Fields | |
---|---|
topOfPageCpcMicros |
The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results. |
AdGroupCriterionEngineStatus
Enumerates AdGroupCriterion engine statuses.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
AD_GROUP_CRITERION_ELIGIBLE |
Deprecated. Do not use. |
AD_GROUP_CRITERION_INAPPROPRIATE_FOR_CAMPAIGN |
Baidu: Bid or quality too low to be displayed. |
AD_GROUP_CRITERION_INVALID_MOBILE_SEARCH |
Baidu: Bid or quality too low for mobile, but eligible to display for desktop. |
AD_GROUP_CRITERION_INVALID_PC_SEARCH |
Baidu: Bid or quality too low for desktop, but eligible to display for mobile. |
AD_GROUP_CRITERION_INVALID_SEARCH |
Baidu: Bid or quality too low to be displayed. |
AD_GROUP_CRITERION_LOW_SEARCH_VOLUME |
Baidu: Paused by Baidu due to low search volume. |
AD_GROUP_CRITERION_MOBILE_URL_UNDER_REVIEW |
Baidu: Mobile URL in process to be reviewed. |
AD_GROUP_CRITERION_PARTIALLY_INVALID |
Baidu: The landing page for one device is invalid, while the landing page for the other device is valid. |
AD_GROUP_CRITERION_TO_BE_ACTIVATED |
Baidu: Keyword has been created and paused by Baidu account management, and is now ready for you to activate it. |
AD_GROUP_CRITERION_UNDER_REVIEW |
Baidu: In process to be reviewed by Baidu. Gemini: Criterion under review. |
AD_GROUP_CRITERION_NOT_REVIEWED |
Baidu: Criterion to be reviewed. |
AD_GROUP_CRITERION_ON_HOLD |
Deprecated. Do not use. Previously used by Gemini |
AD_GROUP_CRITERION_PENDING_REVIEW |
Y!J : Criterion pending review |
AD_GROUP_CRITERION_PAUSED |
Criterion has been paused. |
AD_GROUP_CRITERION_REMOVED |
Criterion has been removed. |
AD_GROUP_CRITERION_APPROVED |
Criterion has been approved. |
AD_GROUP_CRITERION_DISAPPROVED |
Criterion has been disapproved. |
AD_GROUP_CRITERION_SERVING |
Criterion is active and serving. |
AD_GROUP_CRITERION_ACCOUNT_PAUSED |
Criterion has been paused since the account is paused. |
KeywordInfo
A keyword criterion.
JSON representation |
---|
{
"matchType": enum ( |
Fields | |
---|---|
matchType |
The match type of the keyword. |
text |
The text of the keyword (at most 80 characters and 10 words). |
KeywordMatchType
Possible Keyword match types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
EXACT |
Exact match. |
PHRASE |
Phrase match. |
BROAD |
Broad match. |
ListingGroupInfo
A listing group criterion.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Type of the listing group. |
ListingGroupType
The type of the listing group.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
SUBDIVISION |
Subdivision of products along some listing dimension. These nodes are not used by serving to target listing entries, but is purely to define the structure of the tree. |
UNIT |
Listing group unit that defines a bid. |
AgeRangeInfo
An age range criterion.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Type of the age range. |
AgeRangeType
The type of demographic age ranges (for example, between 18 and 24 years old).
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
AGE_RANGE_18_24 |
Between 18 and 24 years old. |
AGE_RANGE_25_34 |
Between 25 and 34 years old. |
AGE_RANGE_35_44 |
Between 35 and 44 years old. |
AGE_RANGE_45_54 |
Between 45 and 54 years old. |
AGE_RANGE_55_64 |
Between 55 and 64 years old. |
AGE_RANGE_65_UP |
65 years old and beyond. |
AGE_RANGE_UNDETERMINED |
Undetermined age range. |
GenderInfo
A gender criterion.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Type of the gender. |
GenderType
The type of demographic genders (for example, female).
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
MALE |
Male. |
FEMALE |
Female. |
UNDETERMINED |
Undetermined gender. |
UserListInfo
A User List criterion. Represents a user list that is defined by the advertiser to be targeted.
JSON representation |
---|
{ "userList": string } |
Fields | |
---|---|
userList |
The User List resource name. |
WebpageInfo
Represents a criterion for targeting webpages of an advertiser's website.
JSON representation |
---|
{
"conditions": [
{
object ( |
Fields | |
---|---|
conditions[] |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations. |
coveragePercentage |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only. |
criterionName |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations. |
WebpageConditionInfo
Logical expression for targeting webpages of an advertiser's website.
JSON representation |
---|
{ "operand": enum ( |
Fields | |
---|---|
operand |
Operand of webpage targeting condition. |
operator |
Operator of webpage targeting condition. |
argument |
Argument of webpage targeting condition. |
WebpageConditionOperand
The webpage condition operand in webpage criterion.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
URL |
Operand denoting a webpage URL targeting condition. |
CATEGORY |
Operand denoting a webpage category targeting condition. |
PAGE_TITLE |
Operand denoting a webpage title targeting condition. |
PAGE_CONTENT |
Operand denoting a webpage content targeting condition. |
CUSTOM_LABEL |
Operand denoting a webpage custom label targeting condition. |
WebpageConditionOperator
The webpage condition operator in webpage criterion.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
EQUALS |
The argument web condition is equal to the compared web condition. |
CONTAINS |
The argument web condition is part of the compared web condition. |
LocationInfo
A location criterion.
JSON representation |
---|
{ "geoTargetConstant": string } |
Fields | |
---|---|
geoTargetConstant |
The geo target constant resource name. |
AdGroupCriterionLabel
A relationship between an ad group criterion and a label.
JSON representation |
---|
{ "resourceName": string, "adGroupCriterion": string, "label": string, "ownerCustomerId": string } |
Fields | |
---|---|
resourceName |
The resource name of the ad group criterion label. Ad group criterion label resource names have the form: |
adGroupCriterion |
The ad group criterion to which the label is attached. |
label |
The label assigned to the ad group criterion. |
ownerCustomerId |
The ID of the Customer which owns the label. |
AdGroupLabel
A relationship between an ad group and a label.
JSON representation |
---|
{ "resourceName": string, "adGroup": string, "label": string, "ownerCustomerId": string } |
Fields | |
---|---|
resourceName |
The resource name of the ad group label. Ad group label resource names have the form: |
adGroup |
The ad group to which the label is attached. |
label |
The label assigned to the ad group. |
ownerCustomerId |
The ID of the Customer which owns the label. |
AgeRangeView
An age range view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the age range view. Age range view resource names have the form:
|
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.
JSON representation |
---|
{ "resourceName": string, "type": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the asset. Asset resource names have the form:
|
type |
Type of the asset. |
finalUrls[] |
A list of possible final URLs after all cross domain redirects. |
status |
The status of the asset. |
creationTime |
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. |
lastModifiedTime |
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 |
The ID of the asset. |
name |
Optional name of the asset. |
trackingUrlTemplate |
URL template for constructing a tracking URL. |
engineStatus |
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: |
|
youtubeVideoAsset |
A YouTube video asset. |
imageAsset |
An image asset. |
textAsset |
A text asset. |
calloutAsset |
A unified callout asset. |
sitelinkAsset |
A unified sitelink asset. |
pageFeedAsset |
A unified page feed asset. |
mobileAppAsset |
A mobile app asset. |
callAsset |
A unified call asset. |
callToActionAsset |
A call to action asset. |
locationAsset |
A unified location asset. |
AssetType
Enum describing possible types of asset.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
YOUTUBE_VIDEO |
YouTube video asset. |
MEDIA_BUNDLE |
Media bundle asset. |
IMAGE |
Image asset. |
TEXT |
Text asset. |
LEAD_FORM |
Lead form asset. |
BOOK_ON_GOOGLE |
Book on Google asset. |
PROMOTION |
Promotion asset. |
CALLOUT |
Callout asset. |
STRUCTURED_SNIPPET |
Structured Snippet asset. |
SITELINK |
Sitelink asset. |
PAGE_FEED |
Page Feed asset. |
DYNAMIC_EDUCATION |
Dynamic Education asset. |
MOBILE_APP |
Mobile app asset. |
HOTEL_CALLOUT |
Hotel callout asset. |
CALL |
Call asset. |
PRICE |
Price asset. |
CALL_TO_ACTION |
Call to action asset. |
DYNAMIC_REAL_ESTATE |
Dynamic real estate asset. |
DYNAMIC_CUSTOM |
Dynamic custom asset. |
DYNAMIC_HOTELS_AND_RENTALS |
Dynamic hotels and rentals asset. |
DYNAMIC_FLIGHTS |
Dynamic flights asset. |
DISCOVERY_CAROUSEL_CARD |
Discovery Carousel Card asset. |
DYNAMIC_TRAVEL |
Dynamic travel asset. |
DYNAMIC_LOCAL |
Dynamic local asset. |
DYNAMIC_JOBS |
Dynamic jobs asset. |
LOCATION |
Location asset. |
HOTEL_PROPERTY |
Hotel property asset. |
AssetStatus
The possible statuses of an asset.
Enums | |
---|---|
UNSPECIFIED |
The status has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The asset is enabled. |
REMOVED |
The asset is removed. |
ARCHIVED |
The asset is archived. |
PENDING_SYSTEM_GENERATED |
The asset is system generated pending user review. |
AssetEngineStatus
Next ID = 11
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
SERVING |
The asset is active. |
SERVING_LIMITED |
The asset is active limited. |
DISAPPROVED |
The asset is disapproved (not eligible). |
DISABLED |
The asset is inactive (pending). |
REMOVED |
The asset has been removed. |
YoutubeVideoAsset
A YouTube asset.
JSON representation |
---|
{ "youtubeVideoTitle": string, "youtubeVideoId": string } |
Fields | |
---|---|
youtubeVideoTitle |
YouTube video title. |
youtubeVideoId |
YouTube video id. This is the 11 character string value used in the YouTube video URL. |
ImageAsset
An Image asset.
JSON representation |
---|
{ "mimeType": enum ( |
Fields | |
---|---|
mimeType |
MIME type of the image asset. |
fullSize |
Metadata for this image at its original size. |
fileSize |
File size of the image asset in bytes. |
MimeType
The mime type
Enums | |
---|---|
UNSPECIFIED |
The mime type has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
IMAGE_JPEG |
MIME type of image/jpeg. |
IMAGE_GIF |
MIME type of image/gif. |
IMAGE_PNG |
MIME type of image/png. |
FLASH |
MIME type of application/x-shockwave-flash. |
TEXT_HTML |
MIME type of text/html. |
PDF |
MIME type of application/pdf. |
MSWORD |
MIME type of application/msword. |
MSEXCEL |
MIME type of application/vnd.ms-excel. |
RTF |
MIME type of application/rtf. |
AUDIO_WAV |
MIME type of audio/wav. |
AUDIO_MP3 |
MIME type of audio/mp3. |
HTML5_AD_ZIP |
MIME type of application/x-html5-ad-zip. |
ImageDimension
Metadata for an image at a certain size, either original or resized.
JSON representation |
---|
{ "heightPixels": string, "widthPixels": string, "url": string } |
Fields | |
---|---|
heightPixels |
Height of the image. |
widthPixels |
Width of the image. |
url |
A URL that returns the image with this height and width. |
TextAsset
A Text asset.
JSON representation |
---|
{ "text": string } |
Fields | |
---|---|
text |
Text content of the text asset. |
UnifiedCalloutAsset
A unified callout asset.
JSON representation |
---|
{
"calloutText": string,
"startDate": string,
"endDate": string,
"adScheduleTargets": [
{
object ( |
Fields | |
---|---|
calloutText |
The callout text. The length of this string should be between 1 and 25, inclusive. |
startDate |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format. |
endDate |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format. |
adScheduleTargets[] |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total. |
useSearcherTimeZone |
Whether to show the asset in search user's time zone. Applies to Microsoft Ads. |
AdScheduleInfo
Represents an AdSchedule criterion.
AdSchedule is specified as the day of the week and a time interval within which ads will be shown.
No more than six AdSchedules can be added for the same day.
JSON representation |
---|
{ "startMinute": enum ( |
Fields | |
---|---|
startMinute |
Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations. |
endMinute |
Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations. |
dayOfWeek |
Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations. |
startHour |
Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations. |
endHour |
Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations. |
MinuteOfHour
Enumerates of quarter-hours. For example, "FIFTEEN"
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
ZERO |
Zero minutes past the hour. |
FIFTEEN |
Fifteen minutes past the hour. |
THIRTY |
Thirty minutes past the hour. |
FORTY_FIVE |
Forty-five minutes past the hour. |
DayOfWeek
Enumerates days of the week, for example, "Monday".
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
MONDAY |
Monday. |
TUESDAY |
Tuesday. |
WEDNESDAY |
Wednesday. |
THURSDAY |
Thursday. |
FRIDAY |
Friday. |
SATURDAY |
Saturday. |
SUNDAY |
Sunday. |
UnifiedSitelinkAsset
A unified sitelink asset.
JSON representation |
---|
{
"linkText": string,
"description1": string,
"description2": string,
"startDate": string,
"endDate": string,
"adScheduleTargets": [
{
object ( |
Fields | |
---|---|
linkText |
URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive. |
description1 |
First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set. |
description2 |
Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set. |
startDate |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format. |
endDate |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format. |
adScheduleTargets[] |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total. |
trackingId |
ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field. |
useSearcherTimeZone |
Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads. |
mobilePreferred |
Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to Microsoft Ads. |
UnifiedPageFeedAsset
A Unified Page Feed asset.
JSON representation |
---|
{ "pageUrl": string, "labels": [ string ] } |
Fields | |
---|---|
pageUrl |
The webpage that advertisers want to target. |
labels[] |
Labels used to group the page urls. |
MobileAppAsset
An asset representing a mobile app.
JSON representation |
---|
{
"appId": string,
"appStore": enum ( |
Fields | |
---|---|
appId |
Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS. |
appStore |
Required. The application store that distributes this specific app. |
MobileAppVendor
The type of mobile app vendor
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
APPLE_APP_STORE |
Mobile app vendor for Apple app store. |
GOOGLE_APP_STORE |
Mobile app vendor for Google app store. |
UnifiedCallAsset
A unified call asset.
JSON representation |
---|
{ "countryCode": string, "phoneNumber": string, "callConversionReportingState": enum ( |
Fields | |
---|---|
countryCode |
Two-letter country code of the phone number. Examples: 'US', 'us'. |
phoneNumber |
The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890' |
callConversionReportingState |
Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion. |
callConversionAction |
The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if callConversionReportingState is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION. |
adScheduleTargets[] |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total. |
callOnly |
Whether the call only shows the phone number without a link to the website. Applies to Microsoft Ads. |
callTrackingEnabled |
Whether the call should be enabled on call tracking. Applies to Microsoft Ads. |
useSearcherTimeZone |
Whether to show the call extension in search user's time zone. Applies to Microsoft Ads. |
startDate |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format. |
endDate |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format. |
CallConversionReportingState
Possible data types for a call conversion action state.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
DISABLED |
Call conversion action is disabled. |
USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION |
Call conversion action will use call conversion type set at the account level. |
USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION |
Call conversion action will use call conversion type set at the resource (call only ads/call extensions) level. |
CallToActionAsset
A call to action asset.
JSON representation |
---|
{
"callToAction": enum ( |
Fields | |
---|---|
callToAction |
Call to action. |
CallToActionType
Enum describing possible types of call to action.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
LEARN_MORE |
The call to action type is learn more. |
GET_QUOTE |
The call to action type is get quote. |
APPLY_NOW |
The call to action type is apply now. |
SIGN_UP |
The call to action type is sign up. |
CONTACT_US |
The call to action type is contact us. |
SUBSCRIBE |
The call to action type is subscribe. |
DOWNLOAD |
The call to action type is download. |
BOOK_NOW |
The call to action type is book now. |
SHOP_NOW |
The call to action type is shop now. |
BUY_NOW |
The call to action type is buy now. |
DONATE_NOW |
The call to action type is donate now. |
ORDER_NOW |
The call to action type is order now. |
PLAY_NOW |
The call to action type is play now. |
SEE_MORE |
The call to action type is see more. |
START_NOW |
The call to action type is start now. |
VISIT_SITE |
The call to action type is visit site. |
WATCH_NOW |
The call to action type is watch now. |
UnifiedLocationAsset
A unified location asset.
JSON representation |
---|
{ "placeId": string, "businessProfileLocations": [ { object ( |
Fields | |
---|---|
placeId |
Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID. |
businessProfileLocations[] |
The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID. |
locationOwnershipType |
The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location. |
BusinessProfileLocation
Business Profile location data synced from the linked Business Profile account.
JSON representation |
---|
{ "labels": [ string ], "storeCode": string, "listingId": string } |
Fields | |
---|---|
labels[] |
Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account. |
storeCode |
Business Profile store code of this location. This is synced from the Business Profile account. |
listingId |
Listing ID of this Business Profile location. This is synced from the linked Business Profile account. |
LocationOwnershipType
Possible types of a location ownership.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_OWNER |
Business Owner of location(legacy location extension - LE). |
AFFILIATE |
Affiliate location(Third party location extension - ALE). |
AssetGroupAsset
AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group.
JSON representation |
---|
{ "resourceName": string, "assetGroup": string, "asset": string, "fieldType": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the asset group asset. Asset group asset resource name have the form:
|
assetGroup |
The asset group which this asset group asset is linking. |
asset |
The asset which this asset group asset is linking. |
fieldType |
The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc |
status |
The status of the link between an asset and asset group. |
AssetFieldType
Enum describing the possible placements of an asset.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
HEADLINE |
The asset is linked for use as a headline. |
DESCRIPTION |
The asset is linked for use as a description. |
MANDATORY_AD_TEXT |
The asset is linked for use as mandatory ad text. |
MARKETING_IMAGE |
The asset is linked for use as a marketing image. |
MEDIA_BUNDLE |
The asset is linked for use as a media bundle. |
YOUTUBE_VIDEO |
The asset is linked for use as a YouTube video. |
BOOK_ON_GOOGLE |
The asset is linked to indicate that a hotels campaign is "Book on Google" enabled. |
LEAD_FORM |
The asset is linked for use as a Lead Form extension. |
PROMOTION |
The asset is linked for use as a Promotion extension. |
CALLOUT |
The asset is linked for use as a Callout extension. |
STRUCTURED_SNIPPET |
The asset is linked for use as a Structured Snippet extension. |
SITELINK |
The asset is linked for use as a Sitelink. |
MOBILE_APP |
The asset is linked for use as a Mobile App extension. |
HOTEL_CALLOUT |
The asset is linked for use as a Hotel Callout extension. |
CALL |
The asset is linked for use as a Call extension. |
PRICE |
The asset is linked for use as a Price extension. |
LONG_HEADLINE |
The asset is linked for use as a long headline. |
BUSINESS_NAME |
The asset is linked for use as a business name. |
SQUARE_MARKETING_IMAGE |
The asset is linked for use as a square marketing image. |
PORTRAIT_MARKETING_IMAGE |
The asset is linked for use as a portrait marketing image. |
LOGO |
The asset is linked for use as a logo. |
LANDSCAPE_LOGO |
The asset is linked for use as a landscape logo. |
VIDEO |
The asset is linked for use as a non YouTube logo. |
CALL_TO_ACTION_SELECTION |
The asset is linked for use to select a call-to-action. |
AD_IMAGE |
The asset is linked for use to select an ad image. |
BUSINESS_LOGO |
The asset is linked for use as a business logo. |
HOTEL_PROPERTY |
The asset is linked for use as a hotel property in a Performance Max for travel goals campaign. |
DISCOVERY_CAROUSEL_CARD |
The asset is linked for use as a discovery carousel card. |
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.
JSON representation |
---|
{ "resourceName": string, "assetGroup": string, // Union field |
Fields | |
---|---|
resourceName |
The resource name of the asset group signal. Asset group signal resource name have the form:
|
assetGroup |
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 |
The audience signal to be used by the performance max campaign. |
AudienceInfo
An audience criterion.
JSON representation |
---|
{ "audience": string } |
Fields | |
---|---|
audience |
The Audience resource name. |
AssetGroupListingGroupFilter
AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.
JSON representation |
---|
{ "resourceName": string, "assetGroup": string, "id": string, "type": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form:
|
assetGroup |
The asset group which this asset group listing group filter is part of. |
id |
The ID of the ListingGroupFilter. |
type |
Type of a listing group filter node. |
vertical |
The vertical the current node tree represents. All nodes in the same tree must belong to the same vertical. |
caseValue |
Dimension value with which this listing group is refining its parent. Undefined for the root group. |
parentListingGroupFilter |
Resource name of the parent listing group subdivision. Null for the root listing group filter node. |
path |
The path of dimensions defining this listing group filter. |
ListingGroupFilterType
The type of the listing group filter.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
SUBDIVISION |
Subdivision of products along some listing dimensions. |
UNIT_INCLUDED |
An included listing group filter leaf node. |
UNIT_EXCLUDED |
An excluded listing group filter leaf node. |
ListingGroupFilterVertical
The type of the listing group filter vertical.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
SHOPPING |
Represents the shopping vertical. The vertical is allowed only in Performance Max for Retail campaigns. |
ListingGroupFilterDimension
Listing dimensions for the asset group listing group filter.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field dimension . Dimension of one of the types below is always present. dimension can be only one of the following: |
|
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. |
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).
JSON representation |
---|
{
"level": enum ( |
Fields | |
---|---|
level |
Indicates the level of the category in the taxonomy. |
id |
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 |
ListingGroupFilterBiddingCategoryLevel
The level of the listing group filter bidding category.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
LEVEL1 |
Level 1. |
LEVEL2 |
Level 2. |
LEVEL3 |
Level 3. |
LEVEL4 |
Level 4. |
LEVEL5 |
Level 5. |
ProductBrand
Brand of the product.
JSON representation |
---|
{ "value": string } |
Fields | |
---|---|
value |
String value of the product brand. |
ProductChannel
Locality of a product offer.
JSON representation |
---|
{
"channel": enum ( |
Fields | |
---|---|
channel |
Value of the locality. |
ListingGroupFilterProductChannel
Enum describing the locality of a product offer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ONLINE |
The item is sold online. |
LOCAL |
The item is sold in local stores. |
ProductCondition
Condition of a product offer.
JSON representation |
---|
{
"condition": enum ( |
Fields | |
---|---|
condition |
Value of the condition. |
ListingGroupFilterProductCondition
Enum describing the condition of a product offer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
NEW |
The product condition is new. |
REFURBISHED |
The product condition is refurbished. |
USED |
The product condition is used. |
ProductCustomAttribute
Custom attribute of a product offer.
JSON representation |
---|
{
"index": enum ( |
Fields | |
---|---|
index |
Indicates the index of the custom attribute. |
value |
String value of the product custom attribute. |
ListingGroupFilterCustomAttributeIndex
The index of customer attributes.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
INDEX0 |
First listing group filter custom attribute. |
INDEX1 |
Second listing group filter custom attribute. |
INDEX2 |
Third listing group filter custom attribute. |
INDEX3 |
Fourth listing group filter custom attribute. |
INDEX4 |
Fifth listing group filter custom attribute. |
ProductItemId
Item id of a product offer.
JSON representation |
---|
{ "value": string } |
Fields | |
---|---|
value |
Value of the id. |
ProductType
Type of a product offer.
JSON representation |
---|
{
"level": enum ( |
Fields | |
---|---|
level |
Level of the type. |
value |
Value of the type. |
ListingGroupFilterProductTypeLevel
Enum describing the level of the type of a product offer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
LEVEL1 |
Level 1. |
LEVEL2 |
Level 2. |
LEVEL3 |
Level 3. |
LEVEL4 |
Level 4. |
LEVEL5 |
Level 5. |
ListingGroupFilterDimensionPath
The path defining of dimensions defining a listing group filter.
JSON representation |
---|
{
"dimensions": [
{
object ( |
Fields | |
---|---|
dimensions[] |
The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter. |
AssetGroupTopCombinationView
A view on the usage of ad group ad asset combination.
JSON representation |
---|
{
"resourceName": string,
"assetGroupTopCombinations": [
{
object ( |
Fields | |
---|---|
resourceName |
The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customerId}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}" |
assetGroupTopCombinations[] |
The top combinations of assets that served together. |
AssetGroupAssetCombinationData
Asset group asset combination data
JSON representation |
---|
{
"assetCombinationServedAssets": [
{
object ( |
Fields | |
---|---|
assetCombinationServedAssets[] |
Served assets. |
AssetUsage
Contains the usage information of the asset.
JSON representation |
---|
{
"asset": string,
"servedAssetFieldType": enum ( |
Fields | |
---|---|
asset |
Resource name of the asset. |
servedAssetFieldType |
The served field type of the asset. |
ServedAssetFieldType
The possible asset field types.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
HEADLINE_1 |
The asset is used in headline 1. |
HEADLINE_2 |
The asset is used in headline 2. |
HEADLINE_3 |
The asset is used in headline 3. |
DESCRIPTION_1 |
The asset is used in description 1. |
DESCRIPTION_2 |
The asset is used in description 2. |
HEADLINE |
The asset was used in a headline. Use this only if there is only one headline in the ad. Otherwise, use the HEADLINE_1, HEADLINE_2 or HEADLINE_3 enums |
HEADLINE_IN_PORTRAIT |
The asset was used as a headline in portrait image. |
LONG_HEADLINE |
The asset was used in a long headline (used in MultiAssetResponsiveAd). |
DESCRIPTION |
The asset was used in a description. Use this only if there is only one description in the ad. Otherwise, use the DESCRIPTION_1 or DESCRIPTION_@ enums |
DESCRIPTION_IN_PORTRAIT |
The asset was used as description in portrait image. |
BUSINESS_NAME_IN_PORTRAIT |
The asset was used as business name in portrait image. |
BUSINESS_NAME |
The asset was used as business name. |
MARKETING_IMAGE |
The asset was used as a marketing image. |
MARKETING_IMAGE_IN_PORTRAIT |
The asset was used as a marketing image in portrait image. |
SQUARE_MARKETING_IMAGE |
The asset was used as a square marketing image. |
PORTRAIT_MARKETING_IMAGE |
The asset was used as a portrait marketing image. |
LOGO |
The asset was used as a logo. |
LANDSCAPE_LOGO |
The asset was used as a landscape logo. |
CALL_TO_ACTION |
The asset was used as a call-to-action. |
YOU_TUBE_VIDEO |
The asset was used as a YouTube video. |
SITELINK |
This asset is used as a sitelink. |
CALL |
This asset is used as a call. |
MOBILE_APP |
This asset is used as a mobile app. |
CALLOUT |
This asset is used as a callout. |
STRUCTURED_SNIPPET |
This asset is used as a structured snippet. |
PRICE |
This asset is used as a price. |
PROMOTION |
This asset is used as a promotion. |
AD_IMAGE |
This asset is used as an image. |
LEAD_FORM |
The asset is used as a lead form. |
BUSINESS_LOGO |
The asset is used as a business logo. |
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.
JSON representation |
---|
{ "resourceName": string, "id": string, "campaign": string, "name": string, "finalUrls": [ string ], "finalMobileUrls": [ string ], "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the asset group. Asset group resource names have the form:
|
id |
The ID of the asset group. |
campaign |
The campaign with which this asset group is associated. The asset which is linked to the asset group. |
name |
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. |
finalUrls[] |
A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out. |
finalMobileUrls[] |
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 |
The status of the asset group. |
path1 |
First part of text that may appear appended to the url displayed in the ad. |
path2 |
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. |
AssetGroupStatus
The possible statuses of an asset group.
Enums | |
---|---|
UNSPECIFIED |
The status has not been specified. |
UNKNOWN |
The received value is not known in this version. |
ENABLED |
The asset group is enabled. |
PAUSED |
The asset group is paused. |
REMOVED |
The asset group is removed. |
AdStrength
Enum listing the possible ad strengths.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PENDING |
The ad strength is currently pending. |
NO_ADS |
No ads could be generated. |
POOR |
Poor strength. |
AVERAGE |
Average strength. |
GOOD |
Good strength. |
EXCELLENT |
Excellent strength. |
AssetSetAsset
AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.
JSON representation |
---|
{
"resourceName": string,
"assetSet": string,
"asset": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the asset set asset. Asset set asset resource names have the form:
|
assetSet |
The asset set which this asset set asset is linking to. |
asset |
The asset which this asset set asset is linking to. |
status |
The status of the asset set asset. Read-only. |
AssetSetAssetStatus
The possible statuses of an asset set asset.
Enums | |
---|---|
UNSPECIFIED |
The status has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The asset set asset is enabled. |
REMOVED |
The asset set asset is removed. |
AssetSet
An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.
JSON representation |
---|
{ "id": string, "resourceName": string } |
Fields | |
---|---|
id |
The ID of the asset set. |
resourceName |
The resource name of the asset set. Asset set resource names have the form:
|
BiddingStrategy
A bidding strategy.
JSON representation |
---|
{ "resourceName": string, "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the bidding strategy. Bidding strategy resource names have the form:
|
status |
The status of the bidding strategy. This field is read-only. |
type |
The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only. |
currencyCode |
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 effectiveCurrencyCode field returns the currency used by the strategy. |
id |
The ID of the bidding strategy. |
name |
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). |
effectiveCurrencyCode |
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 currencyCode. Bidding strategy metrics are reported in this currency. This field is read-only. |
campaignCount |
The number of campaigns attached to this bidding strategy. This field is read-only. |
nonRemovedCampaignCount |
The number of non-removed campaigns attached to this bidding strategy. This field is read-only. |
Union field Only one can be set. |
|
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. |
BiddingStrategyStatus
The possible statuses of a BiddingStrategy.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The bidding strategy is enabled. |
REMOVED |
The bidding strategy is removed. |
BiddingStrategyType
Enum describing possible bidding strategy types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
COMMISSION |
Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value. |
ENHANCED_CPC |
Enhanced CPC is 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. |
INVALID |
Used for return value only. Indicates that a campaign does not have a bidding strategy. This prevents the campaign from serving. For example, a campaign may be attached to a manager bidding strategy and the serving account is subsequently unlinked from the manager account. In this case the campaign will automatically be detached from the now inaccessible manager bidding strategy and transition to the INVALID bidding strategy type. |
MANUAL_CPA |
Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. |
MANUAL_CPC |
Manual click based bidding where user pays per click. |
MANUAL_CPM |
Manual impression based bidding where user pays per thousand impressions. |
MANUAL_CPV |
A bidding strategy that pays a configurable amount per video view. |
MAXIMIZE_CONVERSIONS |
A bidding strategy that automatically maximizes number of conversions given a daily budget. |
MAXIMIZE_CONVERSION_VALUE |
An automated bidding strategy that automatically sets bids to maximize revenue while spending your budget. |
PAGE_ONE_PROMOTED |
Page-One Promoted bidding scheme, which sets max cpc bids to target impressions on page one or page one promoted slots on google.com. This enum value is deprecated. |
PERCENT_CPC |
Percent Cpc is bidding strategy where bids are a fraction of the advertised price for some good or service. |
TARGET_CPA |
Target CPA is an automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. |
TARGET_CPM |
Target CPM is an automated bid strategy that sets bids to help get as many impressions as possible at the target cost per one thousand impressions (CPM) you set. |
TARGET_IMPRESSION_SHARE |
An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location). |
TARGET_OUTRANK_SHARE |
Target Outrank Share is an automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This enum value is deprecated. |
TARGET_ROAS |
Target ROAS is an automated bidding strategy that helps you maximize revenue while averaging a specific target Return On Average Spend (ROAS). |
TARGET_SPEND |
Target Spend is an automated bid strategy that sets your bids to help get as many clicks as possible within your budget. |
EnhancedCpc
This type has no fields.
An automated 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.
This bidding strategy is deprecated and cannot be created anymore. Use ManualCpc with enhancedCpcEnabled set to true for equivalent functionality.
MaximizeConversionValue
An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
JSON representation |
---|
{ "cpcBidCeilingMicros": string, "cpcBidFloorMicros": string, "targetRoas": number } |
Fields | |
---|---|
cpcBidCeilingMicros |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only. |
cpcBidFloorMicros |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only. |
targetRoas |
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. |
MaximizeConversions
An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
JSON representation |
---|
{ "cpcBidCeilingMicros": string, "cpcBidFloorMicros": string, "targetCpaMicros": string } |
Fields | |
---|---|
cpcBidCeilingMicros |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only. |
cpcBidFloorMicros |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only. |
targetCpaMicros |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget. |
TargetCpa
An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
JSON representation |
---|
{ "targetCpaMicros": string, "cpcBidCeilingMicros": string, "cpcBidFloorMicros": string } |
Fields | |
---|---|
targetCpaMicros |
Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account. |
cpcBidCeilingMicros |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies. |
cpcBidFloorMicros |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies. |
TargetRoas
An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).
JSON representation |
---|
{ "targetRoas": number, "cpcBidCeilingMicros": string, "cpcBidFloorMicros": string } |
Fields | |
---|---|
targetRoas |
Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive. |
cpcBidCeilingMicros |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies. |
cpcBidFloorMicros |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies. |
TargetSpend
An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.
JSON representation |
---|
{ "targetSpendMicros": string, "cpcBidCeilingMicros": string } |
Fields | |
---|---|
targetSpendMicros |
Deprecated: 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. |
cpcBidCeilingMicros |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. |
CampaignBudget
A campaign budget.
JSON representation |
---|
{ "resourceName": string, "deliveryMethod": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the campaign budget. Campaign budget resource names have the form:
|
deliveryMethod |
The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation. |
period |
Period over which to spend the budget. Defaults to DAILY if not specified. |
amountMicros |
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. |
BudgetDeliveryMethod
Possible delivery methods of a Budget.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
STANDARD |
The budget server will throttle serving evenly across the entire time period. |
ACCELERATED |
The budget server will not throttle serving, and ads will serve as fast as possible. |
BudgetPeriod
Possible period of a Budget.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
DAILY |
Daily budget. |
FIXED_DAILY |
Fixed daily budget. |
CUSTOM_PERIOD |
Custom budget can be used with total_amount to specify lifetime budget limit. |
Campaign
A campaign.
JSON representation |
---|
{ "resourceName": string, "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the campaign. Campaign resource names have the form:
|
status |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED. |
servingStatus |
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 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 Can be set only when creating campaigns. After campaign is created, the field can not be changed. |
urlCustomParameters[] |
The list of mappings used to substitute custom parameter tags in a |
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. |
labels[] |
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 This field is read-only. |
accessibleBiddingStrategy |
Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'biddingStrategy'. 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. |
frequencyCaps[] |
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. |
engineId |
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. |
excludedParentAssetFieldTypes[] |
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. |
createTime |
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. createTime will be deprecated in v1. Use creationTime instead. |
creationTime |
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. |
lastModifiedTime |
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 |
The ID of the campaign. |
name |
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. |
trackingUrlTemplate |
The URL template for constructing a tracking URL. |
campaignBudget |
The budget of the campaign. |
startDate |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format. |
endDate |
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. |
finalUrlSuffix |
Suffix used to append query parameters to landing pages that are served with parallel tracking. |
urlExpansionOptOut |
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 Must be either portfolio (created through BiddingStrategy service) or standard, that is embedded into the campaign. |
|
biddingStrategy |
Portfolio bidding strategy used by 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. |
CampaignStatus
Possible statuses of a campaign.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Campaign is active and can show ads. |
PAUSED |
Campaign has been paused by the user. |
REMOVED |
Campaign has been removed. |
CampaignServingStatus
Possible serving statuses of a campaign.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
SERVING |
Serving. |
NONE |
None. |
ENDED |
Ended. |
PENDING |
Pending. |
SUSPENDED |
Suspended. |
BiddingStrategySystemStatus
The possible system statuses of a BiddingStrategy.
Enums | |
---|---|
UNSPECIFIED |
Signals that an unexpected error occurred, for example, no bidding strategy type was found, or no status information was found. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
The bid strategy is active, and AdWords cannot find any specific issues with the strategy. |
LEARNING_NEW |
The bid strategy is learning because it has been recently created or recently reactivated. |
LEARNING_SETTING_CHANGE |
The bid strategy is learning because of a recent setting change. |
LEARNING_BUDGET_CHANGE |
The bid strategy is learning because of a recent budget change. |
LEARNING_COMPOSITION_CHANGE |
The bid strategy is learning because of recent change in number of campaigns, ad groups or keywords attached to it. |
LEARNING_CONVERSION_TYPE_CHANGE |
The bid strategy depends on conversion reporting and the customer recently modified conversion types that were relevant to the bid strategy. |
LEARNING_CONVERSION_SETTING_CHANGE |
The bid strategy depends on conversion reporting and the customer recently changed their conversion settings. |
LIMITED_BY_CPC_BID_CEILING |
The bid strategy is limited by its bid ceiling. |
LIMITED_BY_CPC_BID_FLOOR |
The bid strategy is limited by its bid floor. |
LIMITED_BY_DATA |
The bid strategy is limited because there was not enough conversion traffic over the past weeks. |
LIMITED_BY_BUDGET |
A significant fraction of keywords in this bid strategy are limited by budget. |
LIMITED_BY_LOW_PRIORITY_SPEND |
The bid strategy cannot reach its target spend because its spend has been de-prioritized. |
LIMITED_BY_LOW_QUALITY |
A significant fraction of keywords in this bid strategy have a low Quality Score. |
LIMITED_BY_INVENTORY |
The bid strategy cannot fully spend its budget because of narrow targeting. |
MISCONFIGURED_ZERO_ELIGIBILITY |
Missing conversion tracking (no pings present) and/or remarketing lists for SSC. |
MISCONFIGURED_CONVERSION_TYPES |
The bid strategy depends on conversion reporting and the customer is lacking conversion types that might be reported against this strategy. |
MISCONFIGURED_CONVERSION_SETTINGS |
The bid strategy depends on conversion reporting and the customer's conversion settings are misconfigured. |
MISCONFIGURED_SHARED_BUDGET |
There are campaigns outside the bid strategy that share budgets with campaigns included in the strategy. |
MISCONFIGURED_STRATEGY_TYPE |
The campaign has an invalid strategy type and is not serving. |
PAUSED |
The bid strategy is not active. Either there are no active campaigns, ad groups or keywords attached to the bid strategy. Or there are no active budgets connected to the bid strategy. |
UNAVAILABLE |
This bid strategy currently does not support status reporting. |
MULTIPLE_LEARNING |
There were multiple LEARNING_* system statuses for this bid strategy during the time in question. |
MULTIPLE_LIMITED |
There were multiple LIMITED_* system statuses for this bid strategy during the time in question. |
MULTIPLE_MISCONFIGURED |
There were multiple MISCONFIGURED_* system statuses for this bid strategy during the time in question. |
MULTIPLE |
There were multiple system statuses for this bid strategy during the time in question. |
AdServingOptimizationStatus
Enum describing possible serving statuses.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
OPTIMIZE |
Ad serving is optimized based on CTR for the campaign. |
CONVERSION_OPTIMIZE |
Ad serving is optimized based on CTR * Conversion for the campaign. If the campaign is not in the conversion optimizer bidding strategy, it will default to OPTIMIZED. |
ROTATE |
Ads are rotated evenly for 90 days, then optimized for clicks. |
ROTATE_INDEFINITELY |
Show lower performing ads more evenly with higher performing ads, and do not optimize. |
UNAVAILABLE |
Ad serving optimization status is not available. |
AdvertisingChannelType
Enum describing the various advertising channel types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
SEARCH |
Search Network. Includes display bundled, and Search+ campaigns. |
DISPLAY |
Google Display Network only. |
SHOPPING |
Shopping campaigns serve on the shopping property and on google.com search results. |
HOTEL |
Hotel Ads campaigns. |
VIDEO |
Video campaigns. |
MULTI_CHANNEL |
App Campaigns, and App Campaigns for Engagement, that run across multiple channels. |
LOCAL |
Local ads campaigns. |
SMART |
Smart campaigns. |
PERFORMANCE_MAX |
Performance Max campaigns. |
LOCAL_SERVICES |
Local services campaigns. |
DISCOVERY |
Discovery campaigns. |
TRAVEL |
Travel campaigns. |
SOCIAL |
Social campaigns. |
AdvertisingChannelSubType
Enum describing the different channel subtypes.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used as a return value only. Represents value unknown in this version. |
SEARCH_MOBILE_APP |
Mobile app campaigns for Search. |
DISPLAY_MOBILE_APP |
Mobile app campaigns for Display. |
SEARCH_EXPRESS |
AdWords express campaigns for search. |
DISPLAY_EXPRESS |
AdWords Express campaigns for display. |
SHOPPING_SMART_ADS |
Smart Shopping campaigns. |
DISPLAY_GMAIL_AD |
Gmail Ad campaigns. |
DISPLAY_SMART_CAMPAIGN |
Smart display campaigns. New campaigns of this sub type cannot be created. |
VIDEO_OUTSTREAM |
Video Outstream campaigns. |
VIDEO_ACTION |
Video TrueView for Action campaigns. |
VIDEO_NON_SKIPPABLE |
Video campaigns with non-skippable video ads. |
APP_CAMPAIGN |
App Campaign that lets you easily promote your Android or iOS app across Google's top properties including Search, Play, YouTube, and the Google Display Network. |
APP_CAMPAIGN_FOR_ENGAGEMENT |
App Campaign for engagement, focused on driving re-engagement with the app across several of Google's top properties including Search, YouTube, and the Google Display Network. |
LOCAL_CAMPAIGN |
Campaigns specialized for local advertising. |
SHOPPING_COMPARISON_LISTING_ADS |
Shopping Comparison Listing campaigns. |
SMART_CAMPAIGN |
Standard Smart campaigns. |
VIDEO_SEQUENCE |
Video campaigns with sequence video ads. |
APP_CAMPAIGN_FOR_PRE_REGISTRATION |
App Campaign for pre registration, specialized for advertising mobile app pre-registration, that targets multiple advertising channels across Google Play, YouTube and Display Network. |
VIDEO_REACH_TARGET_FREQUENCY |
Video reach campaign with Target Frequency bidding strategy. |
TRAVEL_ACTIVITIES |
Travel Activities campaigns. |
SOCIAL_FACEBOOK_TRACKING_ONLY |
Facebook tracking only social campaigns. |
CustomParameter
A mapping that can be used by custom parameter tags in a trackingUrlTemplate
, finalUrls
, or mobile_final_urls
.
JSON representation |
---|
{ "key": string, "value": string } |
Fields | |
---|---|
key |
The key matching the parameter tag name. |
value |
The value to be substituted. |
RealTimeBiddingSetting
Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
JSON representation |
---|
{ "optIn": boolean } |
Fields | |
---|---|
optIn |
Whether the campaign is opted in to real-time bidding. |
NetworkSettings
The network settings for the campaign.
JSON representation |
---|
{ "targetGoogleSearch": boolean, "targetSearchNetwork": boolean, "targetContentNetwork": boolean, "targetPartnerSearchNetwork": boolean } |
Fields | |
---|---|
targetGoogleSearch |
Whether ads will be served with google.com search results. |
targetSearchNetwork |
Whether ads will be served on partner sites in the Google Search Network (requires |
targetContentNetwork |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion. |
targetPartnerSearchNetwork |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts. |
DynamicSearchAdsSetting
The setting for controlling Dynamic Search Ads (DSA).
JSON representation |
---|
{ "domainName": string, "languageCode": string, "useSuppliedUrlsOnly": boolean } |
Fields | |
---|---|
domainName |
Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com". |
languageCode |
Required. The language code specifying the language of the domain, for example, "en". |
useSuppliedUrlsOnly |
Whether the campaign uses advertiser supplied URLs exclusively. |
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.
JSON representation |
---|
{ "feedLabel": string, "useVehicleInventory": boolean, "merchantId": string, "salesCountry": string, "campaignPriority": integer, "enableLocal": boolean } |
Fields | |
---|---|
feedLabel |
Feed label of products to include in the campaign. Only one of feedLabel or salesCountry can be set. If used instead of salesCountry, the feedLabel field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center. |
useVehicleInventory |
Whether to target Vehicle Listing inventory. |
merchantId |
ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns. |
salesCountry |
Sales country of products to include in the campaign. |
campaignPriority |
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. |
enableLocal |
Whether to include local products. |
GeoTargetTypeSetting
Represents a collection of settings related to ads geotargeting.
JSON representation |
---|
{ "positiveGeoTargetType": enum ( |
Fields | |
---|---|
positiveGeoTargetType |
The setting used for positive geotargeting in this particular campaign. |
negativeGeoTargetType |
The setting used for negative geotargeting in this particular campaign. |
PositiveGeoTargetType
The possible positive geo target types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
PRESENCE_OR_INTEREST |
Specifies that an ad is triggered if the user is in, or shows interest in, advertiser's targeted locations. |
SEARCH_INTEREST |
Specifies that an ad is triggered if the user searches for advertiser's targeted locations. This can only be used with Search and standard Shopping campaigns. |
PRESENCE |
Specifies that an ad is triggered if the user is in or regularly in advertiser's targeted locations. |
NegativeGeoTargetType
The possible negative geo target types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
PRESENCE_OR_INTEREST |
Specifies that a user is excluded from seeing the ad if they are in, or show interest in, advertiser's excluded locations. |
PRESENCE |
Specifies that a user is excluded from seeing the ad if they are in advertiser's excluded locations. |
FrequencyCapEntry
This type has no fields.
A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.
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.
JSON representation |
---|
{ "conversionActions": [ string ] } |
Fields | |
---|---|
conversionActions[] |
The selected set of conversion actions for optimizing this campaign. |
OptimizationGoalSetting
Optimization goal setting for this campaign, which includes a set of optimization goal types.
JSON representation |
---|
{
"optimizationGoalTypes": [
enum ( |
Fields | |
---|---|
optimizationGoalTypes[] |
The list of optimization goal types. |
OptimizationGoalType
The type of optimization goal
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used as a return value only. Represents value unknown in this version. |
CALL_CLICKS |
Optimize for call clicks. Call click conversions are times people selected 'Call' to contact a store after viewing an ad. |
DRIVING_DIRECTIONS |
Optimize for driving directions. Driving directions conversions are times people selected 'Get directions' to navigate to a store after viewing an ad. |
APP_PRE_REGISTRATION |
Optimize for pre-registration. Pre-registration conversions are the number of pre-registration signups to receive a notification when the app is released. |
TrackingSetting
Campaign-level settings for tracking information.
JSON representation |
---|
{ "trackingUrl": string } |
Fields | |
---|---|
trackingUrl |
The url used for dynamic tracking. |
ManualCpa
This type has no fields.
Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action.
ManualCpc
Manual click-based bidding where user pays per click.
JSON representation |
---|
{ "enhancedCpcEnabled": boolean } |
Fields | |
---|---|
enhancedCpcEnabled |
Whether bids are to be enhanced based on conversion optimizer data. |
ManualCpm
This type has no fields.
Manual impression-based bidding where user pays per thousand impressions.
PercentCpc
A bidding strategy where bids are a fraction of the advertised price for some good or service.
JSON representation |
---|
{ "cpcBidCeilingMicros": string, "enhancedCpcEnabled": boolean } |
Fields | |
---|---|
cpcBidCeilingMicros |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined. |
enhancedCpcEnabled |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpcBidCeilingMicros, but the average bid amount for a campaign should not. |
TargetCpm
This type has no fields.
Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set.
CampaignAsset
A link between a Campaign and an Asset.
JSON representation |
---|
{
"resourceName": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the campaign asset. CampaignAsset resource names have the form:
|
status |
Status of the campaign asset. |
campaign |
The campaign to which the asset is linked. |
asset |
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.
JSON representation |
---|
{
"resourceName": string,
"campaign": string,
"assetSet": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the campaign asset set. Asset set asset resource names have the form:
|
campaign |
The campaign to which this asset set is linked. |
assetSet |
The asset set which is linked to the campaign. |
status |
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.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the campaign audience view. Campaign audience view resource names have the form:
|
CampaignCriterion
A campaign criterion.
JSON representation |
---|
{ "resourceName": string, "displayName": string, "type": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the campaign criterion. Campaign criterion resource names have the form:
|
displayName |
The display name of the criterion. This field is ignored for mutates. |
type |
The type of the criterion. |
status |
The status of the criterion. |
lastModifiedTime |
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. |
criterionId |
The ID of the criterion. This field is ignored during mutate. |
bidModifier |
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 |
Whether to target ( |
Union field Exactly one must be set. |
|
keyword |
Keyword. |
location |
Location. |
device |
Device. |
ageRange |
Age range. |
gender |
Gender. |
userList |
User List. |
language |
Language. |
webpage |
Webpage. |
locationGroup |
Location Group |
CampaignCriterionStatus
The possible statuses of a CampaignCriterion.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The campaign criterion is enabled. |
PAUSED |
The campaign criterion is paused. |
REMOVED |
The campaign criterion is removed. |
LanguageInfo
A language criterion.
JSON representation |
---|
{ "languageConstant": string } |
Fields | |
---|---|
languageConstant |
The language constant resource name. |
LocationGroupInfo
A radius around a list of locations specified through a feed.
JSON representation |
---|
{
"geoTargetConstants": [
string
],
"radiusUnits": enum ( |
Fields | |
---|---|
geoTargetConstants[] |
Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed. |
radiusUnits |
Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations. |
feedItemSets[] |
FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geoTargetConstants. This is optional and can only be set in CREATE operations. |
radius |
Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations. |
LocationGroupRadiusUnits
The unit of radius distance in location group (for example, MILES)
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
METERS |
Meters |
MILES |
Miles |
MILLI_MILES |
Milli Miles |
CampaignLabel
Represents a relationship between a campaign and a label.
JSON representation |
---|
{ "resourceName": string, "campaign": string, "label": string, "ownerCustomerId": string } |
Fields | |
---|---|
resourceName |
Name of the resource. Campaign label resource names have the form: |
campaign |
The campaign to which the label is attached. |
label |
The label assigned to the campaign. |
ownerCustomerId |
The ID of the Customer which owns the label. |
CartDataSalesView
Cart data sales view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the Cart data sales view. Cart data sales view resource names have the form: |
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.
JSON representation |
---|
{ "resourceName": string, "id": string, "name": string, "description": string } |
Fields | |
---|---|
resourceName |
The resource name of the audience. Audience names have the form:
|
id |
ID of the audience. |
name |
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 |
Description of this audience. |
ConversionAction
A conversion action.
JSON representation |
---|
{ "resourceName": string, "creationTime": string, "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the conversion action. Conversion action resource names have the form:
|
creationTime |
Timestamp of the Floodlight activity's creation, formatted in ISO 8601. |
status |
The status of this conversion action for conversion event accrual. |
type |
The type of this conversion action. |
category |
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. |
id |
The ID of the conversion action. |
name |
The name of the conversion action. This field is required and should not be empty when creating new conversion actions. |
primaryForGoal |
If a conversion action's primaryForGoal 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 primaryForGoal, so if a campaign has a custom conversion goal configured with a primaryForGoal = false conversion action, that conversion action is still biddable. By default, primaryForGoal will be true if not set. In V9, primaryForGoal can only be set to false after creation through an 'update' operation because it's not declared as optional. |
ownerCustomer |
The resource name of the conversion action owner customer, or null if this is a system-defined conversion action. |
includeInClientAccountConversionsMetric |
Whether this conversion action should be included in the "clientAccountConversions" metric. |
includeInConversionsMetric |
Whether this conversion action should be included in the "conversions" metric. |
clickThroughLookbackWindowDays |
The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event. |
appId |
App ID for an app conversion action. |
ConversionActionStatus
Possible statuses of a conversion action.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Conversions will be recorded. |
REMOVED |
Conversions will not be recorded. |
HIDDEN |
Conversions will not be recorded and the conversion action will not appear in the UI. |
ConversionActionType
Possible types of a conversion action.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
AD_CALL |
Conversions that occur when a user clicks on an ad's call extension. |
CLICK_TO_CALL |
Conversions that occur when a user on a mobile device clicks a phone number. |
GOOGLE_PLAY_DOWNLOAD |
Conversions that occur when a user downloads a mobile app from the Google Play Store. |
GOOGLE_PLAY_IN_APP_PURCHASE |
Conversions that occur when a user makes a purchase in an app through Android billing. |
UPLOAD_CALLS |
Call conversions that are tracked by the advertiser and uploaded. |
UPLOAD_CLICKS |
Conversions that are tracked by the advertiser and uploaded with attributed clicks. |
WEBPAGE |
Conversions that occur on a webpage. |
WEBSITE_CALL |
Conversions that occur when a user calls a dynamically-generated phone number from an advertiser's website. |
STORE_SALES_DIRECT_UPLOAD |
Store Sales conversion based on first-party or third-party merchant data uploads. Only customers on the allowlist can use store sales direct upload types. |
STORE_SALES |
Store Sales conversion based on first-party or third-party merchant data uploads and/or from in-store purchases using cards from payment networks. Only customers on the allowlist can use store sales types. Read only. |
FIREBASE_ANDROID_FIRST_OPEN |
Android app first open conversions tracked through Firebase. |
FIREBASE_ANDROID_IN_APP_PURCHASE |
Android app in app purchase conversions tracked through Firebase. |
FIREBASE_ANDROID_CUSTOM |
Android app custom conversions tracked through Firebase. |
FIREBASE_IOS_FIRST_OPEN |
iOS app first open conversions tracked through Firebase. |
FIREBASE_IOS_IN_APP_PURCHASE |
iOS app in app purchase conversions tracked through Firebase. |
FIREBASE_IOS_CUSTOM |
iOS app custom conversions tracked through Firebase. |
THIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPEN |
Android app first open conversions tracked through Third Party App Analytics. |
THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE |
Android app in app purchase conversions tracked through Third Party App Analytics. |
THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM |
Android app custom conversions tracked through Third Party App Analytics. |
THIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPEN |
iOS app first open conversions tracked through Third Party App Analytics. |
THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE |
iOS app in app purchase conversions tracked through Third Party App Analytics. |
THIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM |
iOS app custom conversions tracked through Third Party App Analytics. |
ANDROID_APP_PRE_REGISTRATION |
Conversions that occur when a user pre-registers a mobile app from the Google Play Store. Read only. |
ANDROID_INSTALLS_ALL_OTHER_APPS |
Conversions that track all Google Play downloads which aren't tracked by an app-specific type. Read only. |
FLOODLIGHT_ACTION |
Floodlight activity that counts the number of times that users have visited a particular webpage after seeing or clicking on one of an advertiser's ads. Read only. |
FLOODLIGHT_TRANSACTION |
Floodlight activity that tracks the number of sales made or the number of items purchased. Can also capture the total value of each sale. Read only. |
GOOGLE_HOSTED |
Conversions that track local actions from Google's products and services after interacting with an ad. Read only. |
LEAD_FORM_SUBMIT |
Conversions reported when a user submits a lead form. Read only. |
SALESFORCE |
Conversions that come from Salesforce. Read only. |
SEARCH_ADS_360 |
Conversions imported from Search Ads 360 Floodlight data. Read only. |
SMART_CAMPAIGN_AD_CLICKS_TO_CALL |
Call conversions that occur on Smart campaign Ads without call tracking setup, using Smart campaign custom criteria. Read only. |
SMART_CAMPAIGN_MAP_CLICKS_TO_CALL |
The user clicks on a call element within Google Maps. Smart campaign only. Read only. |
SMART_CAMPAIGN_MAP_DIRECTIONS |
The user requests directions to a business location within Google Maps. Smart campaign only. Read only. |
SMART_CAMPAIGN_TRACKED_CALLS |
Call conversions that occur on Smart campaign Ads with call tracking setup, using Smart campaign custom criteria. Read only. |
STORE_VISITS |
Conversions that occur when a user visits an advertiser's retail store. Read only. |
WEBPAGE_CODELESS |
Conversions created from website events (such as form submissions or page loads), that don't use individually coded event snippets. Read only. |
UNIVERSAL_ANALYTICS_GOAL |
Conversions that come from linked Universal Analytics goals. |
UNIVERSAL_ANALYTICS_TRANSACTION |
Conversions that come from linked Universal Analytics transactions. |
GOOGLE_ANALYTICS_4_CUSTOM |
Conversions that come from linked Google Analytics 4 custom event conversions. |
GOOGLE_ANALYTICS_4_PURCHASE |
Conversions that come from linked Google Analytics 4 purchase conversions. |
ConversionActionCategory
The category of conversions that are associated with a ConversionAction.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
DEFAULT |
Default category. |
PAGE_VIEW |
User visiting a page. |
PURCHASE |
Purchase, sales, or "order placed" event. |
SIGNUP |
Signup user action. |
LEAD |
Lead-generating action. |
DOWNLOAD |
Software download action (as for an app). |
ADD_TO_CART |
The addition of items to a shopping cart or bag on an advertiser site. |
BEGIN_CHECKOUT |
When someone enters the checkout flow on an advertiser site. |
SUBSCRIBE_PAID |
The start of a paid subscription for a product or service. |
PHONE_CALL_LEAD |
A call to indicate interest in an advertiser's offering. |
IMPORTED_LEAD |
A lead conversion imported from an external source into Google Ads. |
SUBMIT_LEAD_FORM |
A submission of a form on an advertiser site indicating business interest. |
BOOK_APPOINTMENT |
A booking of an appointment with an advertiser's business. |
REQUEST_QUOTE |
A quote or price estimate request. |
GET_DIRECTIONS |
A search for an advertiser's business location with intention to visit. |
OUTBOUND_CLICK |
A click to an advertiser's partner's site. |
CONTACT |
A call, SMS, email, chat or other type of contact to an advertiser. |
ENGAGEMENT |
A website engagement event such as long site time or a Google Analytics (GA) Smart Goal. Intended to be used for GA, Firebase, GA Gold goal imports. |
STORE_VISIT |
A visit to a physical store location. |
STORE_SALE |
A sale occurring in a physical store. |
QUALIFIED_LEAD |
A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser (marketing/sales team). In the lead-to-sale journey, advertisers get leads, then act on them by reaching out to the consumer. If the consumer is interested and may end up buying their product, the advertiser marks such leads as "qualified leads". |
CONVERTED_LEAD |
A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser. |
ValueSettings
Settings related to the value for conversion events associated with this conversion action.
JSON representation |
---|
{ "defaultValue": number, "defaultCurrencyCode": string, "alwaysUseDefaultValue": boolean } |
Fields | |
---|---|
defaultValue |
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. |
defaultCurrencyCode |
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. |
alwaysUseDefaultValue |
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. |
AttributionModelSettings
Settings related to this conversion action's attribution model.
JSON representation |
---|
{ "attributionModel": enum ( |
Fields | |
---|---|
attributionModel |
The attribution model type of this conversion action. |
dataDrivenModelStatus |
The status of the data-driven attribution model for the conversion action. |
AttributionModel
The attribution model that describes how to distribute credit for a particular conversion across potentially many prior interactions.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
EXTERNAL |
Uses external attribution. |
GOOGLE_ADS_LAST_CLICK |
Attributes all credit for a conversion to its last click. |
GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK |
Attributes all credit for a conversion to its first click using Google Search attribution. |
GOOGLE_SEARCH_ATTRIBUTION_LINEAR |
Attributes credit for a conversion equally across all of its clicks using Google Search attribution. |
GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY |
Attributes exponentially more credit for a conversion to its more recent clicks using Google Search attribution (half-life is 1 week). |
GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED |
Attributes 40% of the credit for a conversion to its first and last clicks. Remaining 20% is evenly distributed across all other clicks. This uses Google Search attribution. |
GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN |
Flexible model that uses machine learning to determine the appropriate distribution of credit among clicks using Google Search attribution. |
DataDrivenModelStatus
Enumerates data driven model statuses.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
AVAILABLE |
The data driven model is available. |
STALE |
The data driven model is stale. It hasn't been updated for at least 7 days. It is still being used, but will become expired if it does not get updated for 30 days. |
EXPIRED |
The data driven model expired. It hasn't been updated for at least 30 days and cannot be used. Most commonly this is because there hasn't been the required number of events in a recent 30-day period. |
NEVER_GENERATED |
The data driven model has never been generated. Most commonly this is because there has never been the required number of events in any 30-day period. |
FloodlightSettings
Settings related to a Floodlight conversion action.
JSON representation |
---|
{ "activityGroupTag": string, "activityTag": string, "activityId": string } |
Fields | |
---|---|
activityGroupTag |
String used to identify a Floodlight activity group when reporting conversions. |
activityTag |
String used to identify a Floodlight activity when reporting conversions. |
activityId |
ID of the Floodlight activity in DoubleClick Campaign Manager (DCM). |
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
JSON representation |
---|
{ "resourceName": string, "id": string, "name": string, "tag": string, "status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the conversion custom variable. Conversion custom variable resource names have the form:
|
id |
The ID of the conversion custom variable. |
name |
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 |
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 |
The status of the conversion custom variable for conversion event accrual. |
ownerCustomer |
The resource name of the customer that owns the conversion custom variable. |
family |
Family of the conversion custom variable. |
cardinality |
Cardinality of the conversion custom variable. |
floodlightConversionCustomVariableInfo |
Fields for Search Ads 360 floodlight conversion custom variables. |
customColumnIds[] |
The IDs of custom columns that use this conversion custom variable. |
ConversionCustomVariableStatus
Possible statuses of a conversion custom variable.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ACTIVATION_NEEDED |
The conversion custom variable is pending activation and will not accrue stats until set to ENABLED. This status can't be used in CREATE and UPDATE requests. |
ENABLED |
The conversion custom variable is enabled and will accrue stats. |
PAUSED |
The conversion custom variable is paused and will not accrue stats until set to ENABLED again. |
ConversionCustomVariableFamily
Family of a conversion custom variable.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
STANDARD |
The standard conversion custom variable. Customers are required to activate before use. |
FLOODLIGHT |
The conversion custom variable imported from a custom floodlight variable. |
ConversionCustomVariableCardinality
Cardinality of a conversion custom variable.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BELOW_ALL_LIMITS |
The conversion custom variable has cardinality below all limits. The variable can be used for segmentation, and stats can accrue for new values if the variable is enabled. |
EXCEEDS_SEGMENTATION_LIMIT_BUT_NOT_STATS_LIMIT |
The conversion custom variable has cardinality that exceeds the segmentation limit, but does not exceed the stats limit. Segmentation will be disabled, but stats can accrue for new values if the variable is enabled. |
APPROACHES_STATS_LIMIT |
The conversion custom variable has exceeded the segmentation limits, and is approaching the stats limits (> 90%). Segmentation will be disabled, but stats can accrue for new values if the variable is enabled. |
EXCEEDS_STATS_LIMIT |
The conversion custom variable has exceeded both the segmentation limits and stats limits. Segmentation will be disabled, and stats for enabled variables can accrue only if the existing values do not increase the cardinality of the variable any further. |
FloodlightConversionCustomVariableInfo
Information for Search Ads 360 Floodlight Conversion Custom Variables.
JSON representation |
---|
{ "floodlightVariableType": enum ( |
Fields | |
---|---|
floodlightVariableType |
Floodlight variable type defined in Search Ads 360. |
floodlightVariableDataType |
Floodlight variable data type defined in Search Ads 360. |
FloodlightVariableType
Type of the floodlight variable, as defined in the Search Ads 360. See https://support.google.com/searchads/answer/4397154?hl=en to learn more.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
DIMENSION |
Dimension floodlight variable type. |
METRIC |
Metric floodlight variable type. |
UNSET |
Floodlight variable type is unset. |
FloodlightVariableDataType
The data type of the floodlight variable, as defined in Search Ads 360. See https://support.google.com/searchads/answer/4397154?hl=en to learn more.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
NUMBER |
Represents a floodlight variable of "Number" type. This variable may be assigned to floodlight variables of DIMENSION or METRIC types. |
STRING |
Represents a floodlight variable of "String" type. This variable may be assigned to floodlight variables of DIMENSION type. |
Customer
A customer.
JSON representation |
---|
{ "resourceName": string, "conversionTrackingSetting": { object ( |
Fields | |
---|---|
resourceName |
The resource name of the customer. Customer resource names have the form:
|
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. |
lastModifiedTime |
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. |
engineId |
ID of the account in the external engine account. |
status |
The status of the customer. |
creationTime |
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 |
The ID of the customer. |
descriptiveName |
Optional, non-unique descriptive name of the customer. |
currencyCode |
The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported. |
timeZone |
The local timezone ID of the customer. |
trackingUrlTemplate |
The URL template for constructing a tracking URL out of parameters. |
finalUrlSuffix |
The URL template for appending params to the final URL. |
autoTaggingEnabled |
Whether auto-tagging is enabled for the customer. |
manager |
Whether the customer is a manager. |
ConversionTrackingSetting
A collection of customer-wide settings related to Search Ads 360 Conversion Tracking.
JSON representation |
---|
{
"acceptedCustomerDataTerms": boolean,
"conversionTrackingStatus": enum ( |
Fields | |
---|---|
acceptedCustomerDataTerms |
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 |
enhancedConversionsForLeadsEnabled |
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. |
googleAdsConversionCustomer |
The resource name of the customer where conversions are created and managed. This field is read-only. |
conversionTrackingId |
The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversionTrackingStatus does). This field is read-only. |
googleAdsCrossAccountConversionTrackingId |
The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversionTrackingId. This field can only be managed through the Google Ads UI. This field is read-only. |
crossAccountConversionTrackingId |
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 conversionTrackingId. |
ConversionTrackingStatus
Conversion Tracking status of the customer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
NOT_CONVERSION_TRACKED |
Customer does not use any conversion tracking. |
CONVERSION_TRACKING_MANAGED_BY_SELF |
The conversion actions are created and managed by this customer. |
CONVERSION_TRACKING_MANAGED_BY_THIS_MANAGER |
The conversion actions are created and managed by the manager specified in the request's login-customer-id . |
CONVERSION_TRACKING_MANAGED_BY_ANOTHER_MANAGER |
The conversion actions are created and managed by a manager different from the customer or manager specified in the request's login-customer-id . |
AccountType
Possible engine account types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BAIDU |
Baidu account. |
ENGINE_TRACK |
Engine track account. |
FACEBOOK |
Facebook account. |
FACEBOOK_GATEWAY |
Facebook account managed through gateway. |
GOOGLE_ADS |
Google Ads account. |
MICROSOFT |
Microsoft Advertising account. |
SEARCH_ADS_360 |
Search Ads 360 manager account. |
YAHOO_JAPAN |
Yahoo Japan account. |
DoubleClickCampaignManagerSetting
DoubleClick Campaign Manager (DCM) setting for a manager customer.
JSON representation |
---|
{ "advertiserId": string, "networkId": string, "timeZone": string } |
Fields | |
---|---|
advertiserId |
ID of the Campaign Manager advertiser associated with this customer. |
networkId |
ID of the Campaign Manager network associated with this customer. |
timeZone |
Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York. |
AccountStatus
Possible statuses of an account.
Enums | |
---|---|
UNSPECIFIED |
Default value. |
UNKNOWN |
Unknown value. |
ENABLED |
Account is able to serve ads. |
PAUSED |
Account is deactivated by the user. |
SUSPENDED |
Account is deactivated by an internal process. |
REMOVED |
Account is irrevocably deactivated. |
DRAFT |
Account is still in the process of setup, not ENABLED yet. |
CustomerStatus
Possible statuses of a customer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Indicates an active account able to serve ads. |
CANCELED |
Indicates a canceled account unable to serve ads. Can be reactivated by an admin user. |
SUSPENDED |
Indicates a suspended account unable to serve ads. May only be activated by Google support. |
CLOSED |
Indicates a closed account unable to serve ads. Test account will also have CLOSED status. Status is permanent and may not be reopened. |
CustomerAsset
A link between a customer and an asset.
JSON representation |
---|
{
"resourceName": string,
"asset": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the customer asset. CustomerAsset resource names have the form:
|
asset |
Required. The asset which is linked to the customer. |
status |
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.
JSON representation |
---|
{
"resourceName": string,
"assetSet": string,
"customer": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the customer asset set. Asset set asset resource names have the form:
|
assetSet |
The asset set which is linked to the customer. |
customer |
The customer to which this asset set is linked. |
status |
The status of the customer asset set asset. Read-only. |
AccessibleBiddingStrategy
Represents a view of BiddingStrategies owned by and shared with the customer.
In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.
JSON representation |
---|
{ "resourceName": string, "id": string, "name": string, "type": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form:
|
id |
The ID of the bidding strategy. |
name |
The name of the bidding strategy. |
type |
The type of the bidding strategy. |
ownerCustomerId |
The ID of the Customer which owns the bidding strategy. |
ownerDescriptiveName |
descriptiveName of the Customer which owns the bidding strategy. |
Union field Only one can be set. |
|
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. |
MaximizeConversionValue
An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
JSON representation |
---|
{ "targetRoas": number } |
Fields | |
---|---|
targetRoas |
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. |
MaximizeConversions
An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
JSON representation |
---|
{ "targetCpa": string, "targetCpaMicros": string } |
Fields | |
---|---|
targetCpa |
The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition. |
targetCpaMicros |
The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition. |
TargetCpa
An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
JSON representation |
---|
{ "targetCpaMicros": string } |
Fields | |
---|---|
targetCpaMicros |
Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account. |
TargetRoas
An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).
JSON representation |
---|
{ "targetRoas": number } |
Fields | |
---|---|
targetRoas |
The chosen revenue (based on conversion data) per unit of spend. |
TargetSpend
An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.
JSON representation |
---|
{ "targetSpendMicros": string, "cpcBidCeilingMicros": string } |
Fields | |
---|---|
targetSpendMicros |
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. |
cpcBidCeilingMicros |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. |
CustomerManagerLink
Represents customer-manager link relationship.
JSON representation |
---|
{
"resourceName": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
Name of the resource. CustomerManagerLink resource names have the form: |
status |
Status of the link between the customer and the manager. |
managerCustomer |
The manager customer linked to the customer. |
managerLinkId |
ID of the customer-manager link. This field is read only. |
startTime |
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. |
ManagerLinkStatus
Possible statuses of a link.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ACTIVE |
Indicates current in-effect relationship |
INACTIVE |
Indicates terminated relationship |
PENDING |
Indicates relationship has been requested by manager, but the client hasn't accepted yet. |
REFUSED |
Relationship was requested by the manager, but the client has refused. |
CANCELED |
Indicates relationship has been requested by manager, but manager canceled it. |
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.
JSON representation |
---|
{
"resourceName": string,
"appliedLabels": [
string
],
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the customer client. CustomerClient resource names have the form: |
appliedLabels[] |
The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form:
|
status |
The status of the client customer. Read only. |
clientCustomer |
The resource name of the client-customer which is linked to the given customer. Read only. |
level |
Distance between given customer and client. For self link, the level value will be 0. Read only. |
timeZone |
Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only. |
testAccount |
Identifies if the client is a test account. Read only. |
manager |
Identifies if the client is a manager. Read only. |
descriptiveName |
Descriptive name for the client. Read only. |
currencyCode |
Currency code (for example, 'USD', 'EUR') for the client. Read only. |
id |
The ID of the client customer. Read only. |
DynamicSearchAdsSearchTermView
A dynamic search ads search term view.
JSON representation |
---|
{ "resourceName": string, "landingPage": string } |
Fields | |
---|---|
resourceName |
The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form:
|
landingPage |
The dynamically selected landing page URL of the impression. This field is read-only. |
GenderView
A gender view. The genderView 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 genderView with stats.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the gender view. Gender view resource names have the form:
|
GeoTargetConstant
A geo target constant.
JSON representation |
---|
{
"resourceName": string,
"status": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the geo target constant. Geo target constant resource names have the form:
|
status |
Geo target constant status. |
id |
The ID of the geo target constant. |
name |
Geo target constant English name. |
countryCode |
The ISO-3166-1 alpha-2 country code that is associated with the target. |
targetType |
Geo target constant target type. |
canonicalName |
The fully qualified English name, consisting of the target's name and that of its parent and country. |
parentGeoTarget |
The resource name of the parent geo target constant. Geo target constant resource names have the form:
|
GeoTargetConstantStatus
The possible statuses of a geo target constant.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The geo target constant is valid. |
REMOVAL_PLANNED |
The geo target constant is obsolete and will be removed. |
KeywordView
A keyword view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the keyword view. Keyword view resource names have the form:
|
Label
A label.
JSON representation |
---|
{ "resourceName": string, "status": enum ( |
Fields | |
---|---|
resourceName |
Name of the resource. Label resource names have the form: |
status |
Status of the label. Read only. |
textLabel |
A type of label displaying text on a colored background. |
id |
ID of the label. Read only. |
name |
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. |
LabelStatus
Possible statuses of a label.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Label is enabled. |
REMOVED |
Label is removed. |
TextLabel
A type of label displaying text on a colored background.
JSON representation |
---|
{ "backgroundColor": string, "description": string } |
Fields | |
---|---|
backgroundColor |
Background color of the label in HEX format. This string must match the regular expression '^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts. |
description |
A short description of the label. The length must be no more than 200 characters. |
LanguageConstant
A language.
JSON representation |
---|
{ "resourceName": string, "id": string, "code": string, "name": string, "targetable": boolean } |
Fields | |
---|---|
resourceName |
The resource name of the language constant. Language constant resource names have the form:
|
id |
The ID of the language constant. |
code |
The language code, for example, "en_US", "en_AU", "es", "fr", etc. |
name |
The full name of the language in English, for example, "English (US)", "Spanish", etc. |
targetable |
Whether the language is targetable. |
LocationView
A location view summarizes the performance of campaigns by a Location criterion.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the location view. Location view resource names have the form:
|
ProductBiddingCategoryConstant
A Product Bidding Category.
JSON representation |
---|
{ "resourceName": string, "level": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the product bidding category. Product bidding category resource names have the form:
|
level |
Level of the product bidding category. |
status |
Status of the product bidding category. |
id |
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. |
countryCode |
Two-letter upper-case country code of the product bidding category. |
productBiddingCategoryConstantParent |
Resource name of the parent product bidding category. |
languageCode |
Language code of the product bidding category. |
localizedName |
Display value of the product bidding category localized according to languageCode. |
ProductBiddingCategoryLevel
Enum describing the level of the product bidding category.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
LEVEL1 |
Level 1. |
LEVEL2 |
Level 2. |
LEVEL3 |
Level 3. |
LEVEL4 |
Level 4. |
LEVEL5 |
Level 5. |
ProductBiddingCategoryStatus
Enum describing the status of the product bidding category.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ACTIVE |
The category is active and can be used for bidding. |
OBSOLETE |
The category is obsolete. Used only for reporting purposes. |
ProductGroupView
A product group view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the product group view. Product group view resource names have the form:
|
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.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the Shopping performance view. Shopping performance view resource names have the form: |
UserList
A user list. This is a list of users a customer may target.
JSON representation |
---|
{
"resourceName": string,
"type": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the user list. User list resource names have the form:
|
type |
Type of this list. This field is read-only. |
id |
Id of the user list. |
name |
Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED) |
UserListType
Enum containing possible user list types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
REMARKETING |
UserList represented as a collection of conversion types. |
LOGICAL |
UserList represented as a combination of other user lists/interests. |
EXTERNAL_REMARKETING |
UserList created in the Google Ad Manager platform. |
RULE_BASED |
UserList associated with a rule. |
SIMILAR |
UserList with users similar to users of another UserList. |
CRM_BASED |
UserList of first-party CRM data provided by advertiser in the form of emails or other formats. |
WebpageView
A webpage view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
The resource name of the webpage view. Webpage view resource names have the form:
|
Visit
A visit.
JSON representation |
---|
{ "resourceName": string, "id": string, "criterionId": string, "merchantId": string, "adId": string, "clickId": string, "visitDateTime": string, "productId": string, "productChannel": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the visit. Visit resource names have the form:
|
id |
The ID of the visit. |
criterionId |
Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed. |
merchantId |
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. |
adId |
Ad ID. A value of 0 indicates that the ad is unattributed. |
clickId |
A unique string for each visit that is passed to the landing page as the click id URL parameter. |
visitDateTime |
The timestamp of the visit event. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. |
productId |
The ID of the product clicked on. |
productChannel |
The sales channel of the product that was clicked on: Online or Local. |
productLanguageCode |
The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product. |
productStoreId |
The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed. |
productCountryCode |
The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on. |
assetId |
ID of the asset which was interacted with during the visit event. |
assetFieldType |
Asset field type of the visit event. |
ProductChannel
Enum describing the locality of a product offer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ONLINE |
The item is sold online. |
LOCAL |
The item is sold in local stores. |
Conversion
A conversion.
JSON representation |
---|
{ "resourceName": string, "id": string, "criterionId": string, "merchantId": string, "adId": string, "clickId": string, "visitId": string, "advertiserConversionId": string, "productId": string, "productChannel": enum ( |
Fields | |
---|---|
resourceName |
The resource name of the conversion. Conversion resource names have the form:
|
id |
The ID of the conversion |
criterionId |
Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed. |
merchantId |
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. |
adId |
Ad ID. A value of 0 indicates that the ad is unattributed. |
clickId |
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. |
visitId |
The Search Ads 360 visit ID that the conversion is attributed to. |
advertiserConversionId |
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 floodlightOrderId column depending on the advertiser's Floodlight instructions. |
productId |
The ID of the product clicked on. |
productChannel |
The sales channel of the product that was clicked on: Online or Local. |
productLanguageCode |
The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product. |
productStoreId |
The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed. |
productCountryCode |
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. |
conversionDateTime |
The timestamp of the conversion event. |
conversionLastModifiedDateTime |
The timestamp of the last time the conversion was modified. |
conversionVisitDateTime |
The timestamp of the visit that the conversion is attributed to. |
conversionQuantity |
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. |
conversionRevenueMicros |
The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account. |
floodlightOriginalRevenue |
The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications. |
floodlightOrderId |
The Floodlight order ID provided by the advertiser for the conversion. |
status |
The status of the conversion, either ENABLED or REMOVED.. |
assetId |
ID of the asset which was interacted with during the conversion event. |
assetFieldType |
Asset field type of the conversion event. |
AttributionType
Conversion attribution type in SearchAds360
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
VISIT |
The conversion is attributed to a visit. |
CRITERION_AD |
The conversion is attributed to a criterion and ad pair. |
ConversionStatus
Possible statuses of a conversion.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
The conversion is enabled. |
REMOVED |
The conversion has been removed. |
Metrics
Metrics data.
JSON representation |
---|
{ "allConversionsValueByConversionDate": number, "allConversionsByConversionDate": number, "conversionCustomMetrics": [ { object ( |
Fields | |
---|---|
allConversionsValueByConversionDate |
The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. |
allConversionsByConversionDate |
The total number of conversions. This includes all conversions regardless of the value of includeInConversionsMetric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. |
conversionCustomMetrics[] |
The conversion custom metrics. |
conversionsValueByConversionDate |
The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date. |
conversionsByConversionDate |
The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date. |
historicalCreativeQualityScore |
The creative historical quality score. |
historicalLandingPageQualityScore |
The quality of historical landing page experience. |
historicalSearchPredictedCtr |
The historical search predicted click through rate (CTR). |
interactionEventTypes[] |
The types of payable and free interactions. |
rawEventConversionMetrics[] |
The raw event conversion metrics. |
absoluteTopImpressionPercentage |
Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. |
allConversionsFromInteractionsRate |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. |
allConversionsValue |
The value of all conversions. |
allConversions |
The total number of conversions. This includes all conversions regardless of the value of includeInConversionsMetric. |
allConversionsValuePerCost |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). |
allConversionsFromClickToCall |
The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. |
allConversionsFromDirections |
The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only. |
allConversionsFromInteractionsValuePerInteraction |
The value of all conversions from interactions divided by the total number of interactions. |
allConversionsFromMenu |
The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only. |
allConversionsFromOrder |
The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only. |
allConversionsFromOtherEngagement |
The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only. |
allConversionsFromStoreVisit |
Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only. |
visits |
Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page. |
allConversionsFromStoreWebsite |
The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only. |
averageCost |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. |
averageCpc |
The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
averageCpm |
Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
clicks |
The number of clicks. |
contentBudgetLostImpressionShare |
The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
contentImpressionShare |
The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
contentRankLostImpressionShare |
The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
conversionsFromInteractionsRate |
Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion. |
clientAccountConversionsValue |
The value of client account conversions. This only includes conversion actions which includeInClientAccountConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
conversionsValuePerCost |
The value of biddable conversion divided by the total cost of conversion eligible interactions. |
conversionsFromInteractionsValuePerInteraction |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
clientAccountConversions |
The number of client account conversions. This only includes conversion actions which includeInClientAccountConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
costMicros |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
costPerAllConversions |
The cost of ad interactions divided by all conversions. |
costPerConversion |
Average conversion eligible cost per biddable conversion. |
costPerCurrentModelAttributedConversion |
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
crossDeviceConversions |
Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in allConversions. |
crossDeviceConversionsValue |
The sum of the value of cross-device conversions. |
ctr |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). |
conversions |
The number of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
conversionsValue |
The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions. |
averageQualityScore |
The average quality score. |
historicalQualityScore |
The historical quality score. |
impressions |
Count of how often your ad has appeared on a search results page or website on the Google Network. |
interactionRate |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown. |
interactions |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on. |
invalidClickRate |
The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period. |
invalidClicks |
Number of clicks Google considers illegitimate and doesn't charge you for. |
mobileFriendlyClicksPercentage |
The percentage of mobile clicks that go to a mobile-friendly page. |
searchAbsoluteTopImpressionShare |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999. |
searchBudgetLostAbsoluteTopImpressionShare |
The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
searchBudgetLostImpressionShare |
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
searchBudgetLostTopImpressionShare |
The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
searchClickShare |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
searchExactMatchImpressionShare |
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
searchImpressionShare |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
searchRankLostAbsoluteTopImpressionShare |
The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
searchRankLostImpressionShare |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
searchRankLostTopImpressionShare |
The number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
searchTopImpressionShare |
The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. Top ads are generally above the top organic results, although they may show below the top organic results on certain queries. |
topImpressionPercentage |
The percent of your ad impressions that are shown adjacent to the top organic search results. |
valuePerAllConversions |
The value of all conversions divided by the number of all conversions. |
valuePerAllConversionsByConversionDate |
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. |
valuePerConversion |
The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth. |
valuePerConversionsByConversionDate |
Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date. |
clientAccountViewThroughConversions |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad. |
clientAccountCrossSellCostOfGoodsSoldMicros |
Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
crossSellCostOfGoodsSoldMicros |
Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
clientAccountCrossSellGrossProfitMicros |
Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
crossSellGrossProfitMicros |
Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
clientAccountCrossSellRevenueMicros |
Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
crossSellRevenueMicros |
Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
clientAccountCrossSellUnitsSold |
Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. |
crossSellUnitsSold |
Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. |
clientAccountLeadCostOfGoodsSoldMicros |
Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
leadCostOfGoodsSoldMicros |
Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
clientAccountLeadGrossProfitMicros |
Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
leadGrossProfitMicros |
Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
clientAccountLeadRevenueMicros |
Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
leadRevenueMicros |
Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause |
clientAccountLeadUnitsSold |
Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. |
leadUnitsSold |
Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. |
Value
A generic data container.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field value . A value. value can be only one of the following: |
|
booleanValue |
A boolean. |
int64Value |
An int64. |
floatValue |
A float. |
doubleValue |
A double. |
stringValue |
A string. |
QualityScoreBucket
Enum listing the possible quality score buckets.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BELOW_AVERAGE |
Quality of the creative is below average. |
AVERAGE |
Quality of the creative is average. |
ABOVE_AVERAGE |
Quality of the creative is above average. |
InteractionEventType
Enum describing possible types of payable and free interactions.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
CLICK |
Click to site. In most cases, this interaction navigates to an external location, usually the advertiser's landing page. This is also the default InteractionEventType for click events. |
ENGAGEMENT |
The user's expressed intent to engage with the ad in-place. |
VIDEO_VIEW |
User viewed a video ad. |
NONE |
The default InteractionEventType for ad conversion events. This is used when an ad conversion row does NOT indicate that the free interactions (for example, the ad conversions) should be 'promoted' and reported as part of the core metrics. These are simply other (ad) conversions. |
Segments
Segment only fields.
JSON representation |
---|
{ "adNetworkType": enum ( |
Fields | |
---|---|
adNetworkType |
Ad network type. |
conversionActionCategory |
Conversion action category. |
conversionCustomDimensions[] |
The conversion custom dimensions. |
dayOfWeek |
Day of the week, for example, MONDAY. |
device |
Device to which metrics apply. |
keyword |
Keyword criterion. |
productChannel |
Channel of the product. |
productChannelExclusivity |
Channel exclusivity of the product. |
productCondition |
Condition of the product. |
productSoldCondition |
Condition of the product sold. |
rawEventConversionDimensions[] |
The raw event conversion dimensions. |
conversionAction |
Resource name of the conversion action. |
conversionActionName |
Conversion action name. |
date |
Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17. |
geoTargetCity |
Resource name of the geo target constant that represents a city. |
geoTargetCountry |
Resource name of the geo target constant that represents a country. |
geoTargetMetro |
Resource name of the geo target constant that represents a metro. |
geoTargetRegion |
Resource name of the geo target constant that represents a region. |
hour |
Hour of day as a number between 0 and 23, inclusive. |
month |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd. |
productBiddingCategoryLevel1 |
Bidding category (level 1) of the product. |
productBiddingCategoryLevel2 |
Bidding category (level 2) of the product. |
productBiddingCategoryLevel3 |
Bidding category (level 3) of the product. |
productBiddingCategoryLevel4 |
Bidding category (level 4) of the product. |
productBiddingCategoryLevel5 |
Bidding category (level 5) of the product. |
productBrand |
Brand of the product. |
productCountry |
Resource name of the geo target constant for the country of sale of the product. |
productCustomAttribute0 |
Custom attribute 0 of the product. |
productCustomAttribute1 |
Custom attribute 1 of the product. |
productCustomAttribute2 |
Custom attribute 2 of the product. |
productCustomAttribute3 |
Custom attribute 3 of the product. |
productCustomAttribute4 |
Custom attribute 4 of the product. |
productItemId |
Item ID of the product. |
productLanguage |
Resource name of the language constant for the language of the product. |
productSoldBiddingCategoryLevel1 |
Bidding category (level 1) of the product sold. |
productSoldBiddingCategoryLevel2 |
Bidding category (level 2) of the product sold. |
productSoldBiddingCategoryLevel3 |
Bidding category (level 3) of the product sold. |
productSoldBiddingCategoryLevel4 |
Bidding category (level 4) of the product sold. |
productSoldBiddingCategoryLevel5 |
Bidding category (level 5) of the product sold. |
productSoldBrand |
Brand of the product sold. |
productSoldCustomAttribute0 |
Custom attribute 0 of the product sold. |
productSoldCustomAttribute1 |
Custom attribute 1 of the product sold. |
productSoldCustomAttribute2 |
Custom attribute 2 of the product sold. |
productSoldCustomAttribute3 |
Custom attribute 3 of the product sold. |
productSoldCustomAttribute4 |
Custom attribute 4 of the product sold. |
productSoldItemId |
Item ID of the product sold. |
productSoldTitle |
Title of the product sold. |
productSoldTypeL1 |
Type (level 1) of the product sold. |
productSoldTypeL2 |
Type (level 2) of the product sold. |
productSoldTypeL3 |
Type (level 3) of the product sold. |
productSoldTypeL4 |
Type (level 4) of the product sold. |
productSoldTypeL5 |
Type (level 5) of the product sold. |
productStoreId |
Store ID of the product. |
productTitle |
Title of the product. |
productTypeL1 |
Type (level 1) of the product. |
productTypeL2 |
Type (level 2) of the product. |
productTypeL3 |
Type (level 3) of the product. |
productTypeL4 |
Type (level 4) of the product. |
productTypeL5 |
Type (level 5) of the product. |
quarter |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd. |
week |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd. |
year |
Year, formatted as yyyy. |
assetInteractionTarget |
Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interactionOnThisAsset is true, it means the interactions are on this specific asset and when interactionOnThisAsset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with. |
AdNetworkType
Enumerates Google Ads network types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
SEARCH |
Google search. |
SEARCH_PARTNERS |
Search partners. |
CONTENT |
Display Network. |
YOUTUBE_SEARCH |
YouTube Search. |
YOUTUBE_WATCH |
YouTube Videos |
MIXED |
Cross-network. |
Keyword
A Keyword criterion segment.
JSON representation |
---|
{
"info": {
object ( |
Fields | |
---|---|
info |
Keyword info. |
adGroupCriterion |
The AdGroupCriterion resource name. |
ProductChannelExclusivity
Enum describing the availability of a product offer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
SINGLE_CHANNEL |
The item is sold through one channel only, either local stores or online as indicated by its ProductChannel. |
MULTI_CHANNEL |
The item is matched to its online or local stores counterpart, indicating it is available for purchase in both ShoppingProductChannels. |
ProductCondition
Enum describing the condition of a product offer.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
OLD |
The product condition is old. |
NEW |
The product condition is new. |
REFURBISHED |
The product condition is refurbished. |
USED |
The product condition is used. |
AssetInteractionTarget
An AssetInteractionTarget segment.
JSON representation |
---|
{ "asset": string, "interactionOnThisAsset": boolean } |
Fields | |
---|---|
asset |
The asset resource name. |
interactionOnThisAsset |
Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. |