GoogleAdsRow

A returned row from the query.

JSON representation 
{
  "accountBudget": {
    object (AccountBudget)
  },
  "accountBudgetProposal": {
    object (AccountBudgetProposal)
  },
  "accountLink": {
    object (AccountLink)
  },
  "adGroup": {
    object (AdGroup)
  },
  "adGroupAd": {
    object (AdGroupAd)
  },
  "adGroupAdAssetCombinationView": {
    object (AdGroupAdAssetCombinationView)
  },
  "adGroupAdAssetView": {
    object (AdGroupAdAssetView)
  },
  "adGroupAdLabel": {
    object (AdGroupAdLabel)
  },
  "adGroupAsset": {
    object (AdGroupAsset)
  },
  "adGroupAssetSet": {
    object (AdGroupAssetSet)
  },
  "adGroupAudienceView": {
    object (AdGroupAudienceView)
  },
  "adGroupBidModifier": {
    object (AdGroupBidModifier)
  },
  "adGroupCriterion": {
    object (AdGroupCriterion)
  },
  "adGroupCriterionCustomizer": {
    object (AdGroupCriterionCustomizer)
  },
  "adGroupCriterionLabel": {
    object (AdGroupCriterionLabel)
  },
  "adGroupCriterionSimulation": {
    object (AdGroupCriterionSimulation)
  },
  "adGroupCustomizer": {
    object (AdGroupCustomizer)
  },
  "adGroupExtensionSetting": {
    object (AdGroupExtensionSetting)
  },
  "adGroupFeed": {
    object (AdGroupFeed)
  },
  "adGroupLabel": {
    object (AdGroupLabel)
  },
  "adGroupSimulation": {
    object (AdGroupSimulation)
  },
  "adParameter": {
    object (AdParameter)
  },
  "ageRangeView": {
    object (AgeRangeView)
  },
  "adScheduleView": {
    object (AdScheduleView)
  },
  "domainCategory": {
    object (DomainCategory)
  },
  "asset": {
    object (Asset)
  },
  "assetFieldTypeView": {
    object (AssetFieldTypeView)
  },
  "assetGroupAsset": {
    object (AssetGroupAsset)
  },
  "assetGroupSignal": {
    object (AssetGroupSignal)
  },
  "assetGroupListingGroupFilter": {
    object (AssetGroupListingGroupFilter)
  },
  "assetGroupProductGroupView": {
    object (AssetGroupProductGroupView)
  },
  "assetGroupTopCombinationView": {
    object (AssetGroupTopCombinationView)
  },
  "assetGroup": {
    object (AssetGroup)
  },
  "assetSetAsset": {
    object (AssetSetAsset)
  },
  "assetSet": {
    object (AssetSet)
  },
  "assetSetTypeView": {
    object (AssetSetTypeView)
  },
  "batchJob": {
    object (BatchJob)
  },
  "biddingDataExclusion": {
    object (BiddingDataExclusion)
  },
  "biddingSeasonalityAdjustment": {
    object (BiddingSeasonalityAdjustment)
  },
  "biddingStrategy": {
    object (BiddingStrategy)
  },
  "biddingStrategySimulation": {
    object (BiddingStrategySimulation)
  },
  "billingSetup": {
    object (BillingSetup)
  },
  "callView": {
    object (CallView)
  },
  "campaignBudget": {
    object (CampaignBudget)
  },
  "campaign": {
    object (Campaign)
  },
  "campaignAsset": {
    object (CampaignAsset)
  },
  "campaignAssetSet": {
    object (CampaignAssetSet)
  },
  "campaignAudienceView": {
    object (CampaignAudienceView)
  },
  "campaignBidModifier": {
    object (CampaignBidModifier)
  },
  "campaignConversionGoal": {
    object (CampaignConversionGoal)
  },
  "campaignCriterion": {
    object (CampaignCriterion)
  },
  "campaignCustomizer": {
    object (CampaignCustomizer)
  },
  "campaignDraft": {
    object (CampaignDraft)
  },
  "campaignExtensionSetting": {
    object (CampaignExtensionSetting)
  },
  "campaignFeed": {
    object (CampaignFeed)
  },
  "campaignGroup": {
    object (CampaignGroup)
  },
  "campaignLabel": {
    object (CampaignLabel)
  },
  "campaignLifecycleGoal": {
    object (CampaignLifecycleGoal)
  },
  "campaignSearchTermInsight": {
    object (CampaignSearchTermInsight)
  },
  "campaignSharedSet": {
    object (CampaignSharedSet)
  },
  "campaignSimulation": {
    object (CampaignSimulation)
  },
  "carrierConstant": {
    object (CarrierConstant)
  },
  "changeEvent": {
    object (ChangeEvent)
  },
  "changeStatus": {
    object (ChangeStatus)
  },
  "combinedAudience": {
    object (CombinedAudience)
  },
  "audience": {
    object (Audience)
  },
  "conversionAction": {
    object (ConversionAction)
  },
  "conversionCustomVariable": {
    object (ConversionCustomVariable)
  },
  "conversionGoalCampaignConfig": {
    object (ConversionGoalCampaignConfig)
  },
  "conversionValueRule": {
    object (ConversionValueRule)
  },
  "conversionValueRuleSet": {
    object (ConversionValueRuleSet)
  },
  "clickView": {
    object (ClickView)
  },
  "currencyConstant": {
    object (CurrencyConstant)
  },
  "customAudience": {
    object (CustomAudience)
  },
  "customConversionGoal": {
    object (CustomConversionGoal)
  },
  "customInterest": {
    object (CustomInterest)
  },
  "customer": {
    object (Customer)
  },
  "customerAsset": {
    object (CustomerAsset)
  },
  "customerAssetSet": {
    object (CustomerAssetSet)
  },
  "accessibleBiddingStrategy": {
    object (AccessibleBiddingStrategy)
  },
  "customerCustomizer": {
    object (CustomerCustomizer)
  },
  "customerManagerLink": {
    object (CustomerManagerLink)
  },
  "customerClientLink": {
    object (CustomerClientLink)
  },
  "customerClient": {
    object (CustomerClient)
  },
  "customerConversionGoal": {
    object (CustomerConversionGoal)
  },
  "customerExtensionSetting": {
    object (CustomerExtensionSetting)
  },
  "customerFeed": {
    object (CustomerFeed)
  },
  "customerLabel": {
    object (CustomerLabel)
  },
  "customerLifecycleGoal": {
    object (CustomerLifecycleGoal)
  },
  "customerNegativeCriterion": {
    object (CustomerNegativeCriterion)
  },
  "customerSearchTermInsight": {
    object (CustomerSearchTermInsight)
  },
  "customerUserAccess": {
    object (CustomerUserAccess)
  },
  "customerUserAccessInvitation": {
    object (CustomerUserAccessInvitation)
  },
  "customizerAttribute": {
    object (CustomizerAttribute)
  },
  "detailPlacementView": {
    object (DetailPlacementView)
  },
  "detailedDemographic": {
    object (DetailedDemographic)
  },
  "displayKeywordView": {
    object (DisplayKeywordView)
  },
  "distanceView": {
    object (DistanceView)
  },
  "dynamicSearchAdsSearchTermView": {
    object (DynamicSearchAdsSearchTermView)
  },
  "expandedLandingPageView": {
    object (ExpandedLandingPageView)
  },
  "extensionFeedItem": {
    object (ExtensionFeedItem)
  },
  "feed": {
    object (Feed)
  },
  "feedItem": {
    object (FeedItem)
  },
  "feedItemSet": {
    object (FeedItemSet)
  },
  "feedItemSetLink": {
    object (FeedItemSetLink)
  },
  "feedItemTarget": {
    object (FeedItemTarget)
  },
  "feedMapping": {
    object (FeedMapping)
  },
  "feedPlaceholderView": {
    object (FeedPlaceholderView)
  },
  "genderView": {
    object (GenderView)
  },
  "geoTargetConstant": {
    object (GeoTargetConstant)
  },
  "geographicView": {
    object (GeographicView)
  },
  "groupPlacementView": {
    object (GroupPlacementView)
  },
  "hotelGroupView": {
    object (HotelGroupView)
  },
  "hotelPerformanceView": {
    object (HotelPerformanceView)
  },
  "hotelReconciliation": {
    object (HotelReconciliation)
  },
  "incomeRangeView": {
    object (IncomeRangeView)
  },
  "keywordView": {
    object (KeywordView)
  },
  "keywordPlan": {
    object (KeywordPlan)
  },
  "keywordPlanCampaign": {
    object (KeywordPlanCampaign)
  },
  "keywordPlanCampaignKeyword": {
    object (KeywordPlanCampaignKeyword)
  },
  "keywordPlanAdGroup": {
    object (KeywordPlanAdGroup)
  },
  "keywordPlanAdGroupKeyword": {
    object (KeywordPlanAdGroupKeyword)
  },
  "keywordThemeConstant": {
    object (KeywordThemeConstant)
  },
  "label": {
    object (Label)
  },
  "landingPageView": {
    object (LandingPageView)
  },
  "languageConstant": {
    object (LanguageConstant)
  },
  "locationView": {
    object (LocationView)
  },
  "managedPlacementView": {
    object (ManagedPlacementView)
  },
  "mediaFile": {
    object (MediaFile)
  },
  "localServicesEmployee": {
    object (LocalServicesEmployee)
  },
  "localServicesVerificationArtifact": {
    object (LocalServicesVerificationArtifact)
  },
  "mobileAppCategoryConstant": {
    object (MobileAppCategoryConstant)
  },
  "mobileDeviceConstant": {
    object (MobileDeviceConstant)
  },
  "offlineConversionUploadClientSummary": {
    object (OfflineConversionUploadClientSummary)
  },
  "offlineUserDataJob": {
    object (OfflineUserDataJob)
  },
  "operatingSystemVersionConstant": {
    object (OperatingSystemVersionConstant)
  },
  "paidOrganicSearchTermView": {
    object (PaidOrganicSearchTermView)
  },
  "qualifyingQuestion": {
    object (QualifyingQuestion)
  },
  "parentalStatusView": {
    object (ParentalStatusView)
  },
  "perStoreView": {
    object (PerStoreView)
  },
  "productCategoryConstant": {
    object (ProductCategoryConstant)
  },
  "productGroupView": {
    object (ProductGroupView)
  },
  "productLink": {
    object (ProductLink)
  },
  "productLinkInvitation": {
    object (ProductLinkInvitation)
  },
  "recommendation": {
    object (Recommendation)
  },
  "recommendationSubscription": {
    object (RecommendationSubscription)
  },
  "searchTermView": {
    object (SearchTermView)
  },
  "sharedCriterion": {
    object (SharedCriterion)
  },
  "sharedSet": {
    object (SharedSet)
  },
  "smartCampaignSetting": {
    object (SmartCampaignSetting)
  },
  "shoppingPerformanceView": {
    object (ShoppingPerformanceView)
  },
  "smartCampaignSearchTermView": {
    object (SmartCampaignSearchTermView)
  },
  "thirdPartyAppAnalyticsLink": {
    object (ThirdPartyAppAnalyticsLink)
  },
  "topicView": {
    object (TopicView)
  },
  "travelActivityGroupView": {
    object (TravelActivityGroupView)
  },
  "travelActivityPerformanceView": {
    object (TravelActivityPerformanceView)
  },
  "experiment": {
    object (Experiment)
  },
  "experimentArm": {
    object (ExperimentArm)
  },
  "userInterest": {
    object (UserInterest)
  },
  "lifeEvent": {
    object (LifeEvent)
  },
  "userList": {
    object (UserList)
  },
  "userLocationView": {
    object (UserLocationView)
  },
  "remarketingAction": {
    object (RemarketingAction)
  },
  "topicConstant": {
    object (TopicConstant)
  },
  "video": {
    object (Video)
  },
  "webpageView": {
    object (WebpageView)
  },
  "leadFormSubmissionData": {
    object (LeadFormSubmissionData)
  },
  "localServicesLead": {
    object (LocalServicesLead)
  },
  "localServicesLeadConversation": {
    object (LocalServicesLeadConversation)
  },
  "androidPrivacySharedKeyGoogleAdGroup": {
    object (AndroidPrivacySharedKeyGoogleAdGroup)
  },
  "androidPrivacySharedKeyGoogleCampaign": {
    object (AndroidPrivacySharedKeyGoogleCampaign)
  },
  "androidPrivacySharedKeyGoogleNetworkType": {
    object (AndroidPrivacySharedKeyGoogleNetworkType)
  },
  "metrics": {
    object (Metrics)
  },
  "segments": {
    object (Segments)
  }
}
Fields
accountBudget

object (AccountBudget)

The account budget in the query.
accountBudgetProposal

object (AccountBudgetProposal)

The account budget proposal referenced in the query.
adGroup

object (AdGroup)

The ad group referenced in the query.
adGroupAd

object (AdGroupAd)

The ad referenced in the query.
adGroupAdAssetCombinationView

object (AdGroupAdAssetCombinationView)

The ad group ad asset combination view in the query.
adGroupAdAssetView

object (AdGroupAdAssetView)

The ad group ad asset view in the query.
adGroupAdLabel

object (AdGroupAdLabel)

The ad group ad label referenced in the query.
adGroupAsset

object (AdGroupAsset)

The ad group asset referenced in the query.
adGroupAssetSet

object (AdGroupAssetSet)

The ad group asset set referenced in the query.
adGroupAudienceView

object (AdGroupAudienceView)

The ad group audience view referenced in the query.
adGroupBidModifier

object (AdGroupBidModifier)

The bid modifier referenced in the query.
adGroupCriterion

object (AdGroupCriterion)

The criterion referenced in the query.
adGroupCriterionCustomizer

object (AdGroupCriterionCustomizer)

The ad group criterion customizer referenced in the query.
adGroupCriterionLabel

object (AdGroupCriterionLabel)

The ad group criterion label referenced in the query.
adGroupCriterionSimulation

object (AdGroupCriterionSimulation)

The ad group criterion simulation referenced in the query.
adGroupCustomizer

object (AdGroupCustomizer)

The ad group customizer referenced in the query.
adGroupExtensionSetting

object (AdGroupExtensionSetting)

The ad group extension setting referenced in the query.
adGroupFeed

object (AdGroupFeed)

The ad group feed referenced in the query.
adGroupLabel

object (AdGroupLabel)

The ad group label referenced in the query.
adGroupSimulation

object (AdGroupSimulation)

The ad group simulation referenced in the query.
adParameter

object (AdParameter)

The ad parameter referenced in the query.
ageRangeView

object (AgeRangeView)

The age range view referenced in the query.
adScheduleView

object (AdScheduleView)

The ad schedule view referenced in the query.
domainCategory

object (DomainCategory)

The domain category referenced in the query.
asset

object (Asset)

The asset referenced in the query.
assetFieldTypeView

object (AssetFieldTypeView)

The asset field type view referenced in the query.
assetGroupAsset

object (AssetGroupAsset)

The asset group asset referenced in the query.
assetGroupSignal

object (AssetGroupSignal)

The asset group signal referenced in the query.
assetGroupListingGroupFilter

object (AssetGroupListingGroupFilter)

The asset group listing group filter referenced in the query.
assetGroupProductGroupView

object (AssetGroupProductGroupView)

The asset group product group view referenced in the query.
assetGroupTopCombinationView

object (AssetGroupTopCombinationView)

The asset group top combination view referenced in the query.
assetGroup

object (AssetGroup)

The asset group referenced in the query.
assetSetAsset

object (AssetSetAsset)

The asset set asset referenced in the query.
assetSet

object (AssetSet)

The asset set referenced in the query.
assetSetTypeView

object (AssetSetTypeView)

The asset set type view referenced in the query.
batchJob

object (BatchJob)

The batch job referenced in the query.
biddingDataExclusion

object (BiddingDataExclusion)

The bidding data exclusion referenced in the query.
biddingSeasonalityAdjustment

object (BiddingSeasonalityAdjustment)

The bidding seasonality adjustment referenced in the query.
biddingStrategy

object (BiddingStrategy)

The bidding strategy referenced in the query.
biddingStrategySimulation

object (BiddingStrategySimulation)

The bidding strategy simulation referenced in the query.
billingSetup

object (BillingSetup)

The billing setup referenced in the query.
callView

object (CallView)

The call view referenced in the query.
campaignBudget

object (CampaignBudget)

The campaign budget referenced in the query.
campaign

object (Campaign)

The campaign referenced in the query.
campaignAsset

object (CampaignAsset)

The campaign asset referenced in the query.
campaignAssetSet

object (CampaignAssetSet)

The campaign asset set referenced in the query.
campaignAudienceView

object (CampaignAudienceView)

The campaign audience view referenced in the query.
campaignBidModifier

object (CampaignBidModifier)

The campaign bid modifier referenced in the query.
campaignConversionGoal

object (CampaignConversionGoal)

The CampaignConversionGoal referenced in the query.
campaignCriterion

object (CampaignCriterion)

The campaign criterion referenced in the query.
campaignCustomizer

object (CampaignCustomizer)

The campaign customizer referenced in the query.
campaignDraft

object (CampaignDraft)

The campaign draft referenced in the query.
campaignExtensionSetting

object (CampaignExtensionSetting)

The campaign extension setting referenced in the query.
campaignFeed

object (CampaignFeed)

The campaign feed referenced in the query.
campaignGroup

object (CampaignGroup)

Campaign Group referenced in AWQL query.
campaignLabel

object (CampaignLabel)

The campaign label referenced in the query.
campaignLifecycleGoal

object (CampaignLifecycleGoal)

The campaign lifecycle goal referenced in the query.
campaignSearchTermInsight

object (CampaignSearchTermInsight)

The campaign search term insight referenced in the query.
campaignSharedSet

object (CampaignSharedSet)

Campaign Shared Set referenced in AWQL query.
campaignSimulation

object (CampaignSimulation)

The campaign simulation referenced in the query.
carrierConstant

object (CarrierConstant)

The carrier constant referenced in the query.
changeEvent

object (ChangeEvent)

The ChangeEvent referenced in the query.
changeStatus

object (ChangeStatus)

The ChangeStatus referenced in the query.
combinedAudience

object (CombinedAudience)

The CombinedAudience referenced in the query.
audience

object (Audience)

The Audience referenced in the query.
conversionAction

object (ConversionAction)

The conversion action referenced in the query.
conversionCustomVariable

object (ConversionCustomVariable)

The conversion custom variable referenced in the query.
conversionGoalCampaignConfig

object (ConversionGoalCampaignConfig)

The ConversionGoalCampaignConfig referenced in the query.
conversionValueRule

object (ConversionValueRule)

The conversion value rule referenced in the query.
conversionValueRuleSet

object (ConversionValueRuleSet)

The conversion value rule set referenced in the query.
clickView

object (ClickView)

The ClickView referenced in the query.
currencyConstant

object (CurrencyConstant)

The currency constant referenced in the query.
customAudience

object (CustomAudience)

The CustomAudience referenced in the query.
customConversionGoal

object (CustomConversionGoal)

The CustomConversionGoal referenced in the query.
customInterest

object (CustomInterest)

The CustomInterest referenced in the query.
customer

object (Customer)

The customer referenced in the query.
customerAsset

object (CustomerAsset)

The customer asset referenced in the query.
customerAssetSet

object (CustomerAssetSet)

The customer asset set referenced in the query.
accessibleBiddingStrategy

object (AccessibleBiddingStrategy)

The accessible bidding strategy referenced in the query.
customerCustomizer

object (CustomerCustomizer)

The customer customizer referenced in the query.
customerClient

object (CustomerClient)

The CustomerClient referenced in the query.
customerConversionGoal

object (CustomerConversionGoal)

The CustomerConversionGoal referenced in the query.
customerExtensionSetting

object (CustomerExtensionSetting)

The customer extension setting referenced in the query.
customerFeed

object (CustomerFeed)

The customer feed referenced in the query.
customerLabel

object (CustomerLabel)

The customer label referenced in the query.
customerLifecycleGoal

object (CustomerLifecycleGoal)

The customer lifecycle goal referenced in the query.
customerNegativeCriterion

object (CustomerNegativeCriterion)

The customer negative criterion referenced in the query.
customerSearchTermInsight

object (CustomerSearchTermInsight)

The customer search term insight referenced in the query.
customerUserAccess

object (CustomerUserAccess)

The CustomerUserAccess referenced in the query.
customerUserAccessInvitation

object (CustomerUserAccessInvitation)

The CustomerUserAccessInvitation referenced in the query.
customizerAttribute

object (CustomizerAttribute)

The customizer attribute referenced in the query.
detailPlacementView

object (DetailPlacementView)

The detail placement view referenced in the query.
detailedDemographic

object (DetailedDemographic)

The detailed demographic referenced in the query.
displayKeywordView

object (DisplayKeywordView)

The display keyword view referenced in the query.
distanceView

object (DistanceView)

The distance view referenced in the query.
dynamicSearchAdsSearchTermView

object (DynamicSearchAdsSearchTermView)

The dynamic search ads search term view referenced in the query.
expandedLandingPageView

object (ExpandedLandingPageView)

The expanded landing page view referenced in the query.
extensionFeedItem

object (ExtensionFeedItem)

The extension feed item referenced in the query.
feed

object (Feed)

The feed referenced in the query.
feedItem

object (FeedItem)

The feed item referenced in the query.
feedItemSet

object (FeedItemSet)

The feed item set referenced in the query.
feedItemTarget

object (FeedItemTarget)

The feed item target referenced in the query.
feedMapping

object (FeedMapping)

The feed mapping referenced in the query.
feedPlaceholderView

object (FeedPlaceholderView)

The feed placeholder view referenced in the query.
genderView

object (GenderView)

The gender view referenced in the query.
geoTargetConstant

object (GeoTargetConstant)

The geo target constant referenced in the query.
geographicView

object (GeographicView)

The geographic view referenced in the query.
groupPlacementView

object (GroupPlacementView)

The group placement view referenced in the query.
hotelGroupView

object (HotelGroupView)

The hotel group view referenced in the query.
hotelPerformanceView

object (HotelPerformanceView)

The hotel performance view referenced in the query.
hotelReconciliation

object (HotelReconciliation)

The hotel reconciliation referenced in the query.
incomeRangeView

object (IncomeRangeView)

The income range view referenced in the query.
keywordView

object (KeywordView)

The keyword view referenced in the query.
keywordPlan

object (KeywordPlan)

The keyword plan referenced in the query.
keywordPlanCampaign

object (KeywordPlanCampaign)

The keyword plan campaign referenced in the query.
keywordPlanCampaignKeyword

object (KeywordPlanCampaignKeyword)

The keyword plan campaign keyword referenced in the query.
keywordPlanAdGroup

object (KeywordPlanAdGroup)

The keyword plan ad group referenced in the query.
keywordPlanAdGroupKeyword

object (KeywordPlanAdGroupKeyword)

The keyword plan ad group referenced in the query.
keywordThemeConstant

object (KeywordThemeConstant)

The keyword theme constant referenced in the query.
label

object (Label)

The label referenced in the query.
landingPageView

object (LandingPageView)

The landing page view referenced in the query.
languageConstant

object (LanguageConstant)

The language constant referenced in the query.
locationView

object (LocationView)

The location view referenced in the query.
managedPlacementView

object (ManagedPlacementView)

The managed placement view referenced in the query.
mediaFile

object (MediaFile)

The media file referenced in the query.
localServicesEmployee

object (LocalServicesEmployee)

The local services employee referenced in the query.
localServicesVerificationArtifact

object (LocalServicesVerificationArtifact)

The local services verification artifact referenced in the query.
mobileAppCategoryConstant

object (MobileAppCategoryConstant)

The mobile app category constant referenced in the query.
mobileDeviceConstant

object (MobileDeviceConstant)

The mobile device constant referenced in the query.
offlineConversionUploadClientSummary

object (OfflineConversionUploadClientSummary)

Offline conversion upload client summary.
offlineUserDataJob

object (OfflineUserDataJob)

The offline user data job referenced in the query.
operatingSystemVersionConstant

object (OperatingSystemVersionConstant)

The operating system version constant referenced in the query.
paidOrganicSearchTermView

object (PaidOrganicSearchTermView)

The paid organic search term view referenced in the query.
qualifyingQuestion

object (QualifyingQuestion)

The qualifying question referenced in the query.
parentalStatusView

object (ParentalStatusView)

The parental status view referenced in the query.
perStoreView

object (PerStoreView)

The per store view referenced in the query.
productCategoryConstant

object (ProductCategoryConstant)

The product category referenced in the query.
productGroupView

object (ProductGroupView)

The product group view referenced in the query.
recommendation

object (Recommendation)

The recommendation referenced in the query.
recommendationSubscription

object (RecommendationSubscription)

The recommendation subscription referenced in the query.
searchTermView

object (SearchTermView)

The search term view referenced in the query.
sharedCriterion

object (SharedCriterion)

The shared set referenced in the query.
sharedSet

object (SharedSet)

The shared set referenced in the query.
smartCampaignSetting

object (SmartCampaignSetting)

The Smart campaign setting referenced in the query.
shoppingPerformanceView

object (ShoppingPerformanceView)

The shopping performance view referenced in the query.
smartCampaignSearchTermView

object (SmartCampaignSearchTermView)

The Smart campaign search term view referenced in the query.
topicView

object (TopicView)

The topic view referenced in the query.
travelActivityGroupView

object (TravelActivityGroupView)

The travel activity group view referenced in the query.
travelActivityPerformanceView

object (TravelActivityPerformanceView)

The travel activity performance view referenced in the query.
experiment

object (Experiment)

The experiment referenced in the query.
experimentArm

object (ExperimentArm)

The experiment arm referenced in the query.
userInterest

object (UserInterest)

The user interest referenced in the query.
lifeEvent

object (LifeEvent)

The life event referenced in the query.
userList

object (UserList)

The user list referenced in the query.
userLocationView

object (UserLocationView)

The user location view referenced in the query.
remarketingAction

object (RemarketingAction)

The remarketing action referenced in the query.
topicConstant

object (TopicConstant)

The topic constant referenced in the query.
video

object (Video)

The video referenced in the query.
webpageView

object (WebpageView)

The webpage view referenced in the query.
leadFormSubmissionData

object (LeadFormSubmissionData)

The lead form user submission referenced in the query.
localServicesLead

object (LocalServicesLead)

The local services lead referenced in the query.
localServicesLeadConversation

object (LocalServicesLeadConversation)

The local services lead conversationreferenced in the query.
androidPrivacySharedKeyGoogleAdGroup

object (AndroidPrivacySharedKeyGoogleAdGroup)

The android privacy shared key google ad group referenced in the query.
androidPrivacySharedKeyGoogleCampaign

object (AndroidPrivacySharedKeyGoogleCampaign)

The android privacy shared key google campaign referenced in the query.
androidPrivacySharedKeyGoogleNetworkType

object (AndroidPrivacySharedKeyGoogleNetworkType)

The android privacy shared key google network type referenced in the query.
metrics

object (Metrics)

The metrics.
segments

object (Segments)

The segments.

AccountBudget

An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in 'pendingProposal'. Effective details about the budget are found in fields prefixed 'approved_', 'adjusted_' and those without a prefix. Since some effective details may differ from what the user had originally requested (for example, spending limit), these differences are juxtaposed through 'proposed_', 'approved_', and possibly 'adjusted_' fields.

This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pendingProposal.

Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the 'approved' and 'adjusted' fields, which would otherwise be identical.

JSON representation 
{
  "resourceName": string,
  "status": enum (AccountBudgetStatus),
  "totalAdjustmentsMicros": string,
  "amountServedMicros": string,
  "pendingProposal": {
    object (PendingAccountBudgetProposal)
  },
  "id": string,
  "billingSetup": string,
  "name": string,
  "proposedStartDateTime": string,
  "approvedStartDateTime": string,
  "purchaseOrderNumber": string,
  "notes": string,

  // Union field proposed_end_time can be only one of the following:
  "proposedEndDateTime": string,
  "proposedEndTimeType": enum (TimeType)
  // End of list of possible types for union field proposed_end_time.

  // Union field approved_end_time can be only one of the following:
  "approvedEndDateTime": string,
  "approvedEndTimeType": enum (TimeType)
  // End of list of possible types for union field approved_end_time.

  // Union field proposed_spending_limit can be only one of the following:
  "proposedSpendingLimitMicros": string,
  "proposedSpendingLimitType": enum (SpendingLimitType)
  // End of list of possible types for union field proposed_spending_limit.

  // Union field approved_spending_limit can be only one of the following:
  "approvedSpendingLimitMicros": string,
  "approvedSpendingLimitType": enum (SpendingLimitType)
  // End of list of possible types for union field approved_spending_limit.

  // Union field adjusted_spending_limit can be only one of the following:
  "adjustedSpendingLimitMicros": string,
  "adjustedSpendingLimitType": enum (SpendingLimitType)
  // End of list of possible types for union field adjusted_spending_limit.
}
Fields
resourceName

string

Output only. The resource name of the account-level budget. AccountBudget resource names have the form:

customers/{customerId}/accountBudgets/{account_budget_id}
status

enum (AccountBudgetStatus)

Output only. The status of this account-level budget.
totalAdjustmentsMicros

string (int64 format)

Output only. The total adjustments amount.

An example of an adjustment is courtesy credits.
amountServedMicros

string (int64 format)

Output only. The value of Ads that have been served, in micros.

This includes overdelivery costs, in which case a credit might be automatically applied to the budget (see totalAdjustmentsMicros).
pendingProposal

object (PendingAccountBudgetProposal)

Output only. The pending proposal to modify this budget, if applicable.
id

string (int64 format)

Output only. The ID of the account-level budget.
billingSetup

string

Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form:

customers/{customerId}/billingSetups/{billing_setup_id}
name

string

Output only. The name of the account-level budget.
proposedStartDateTime

string

Output only. The proposed start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. If a start time type of NOW was proposed, this is the time of request.
approvedStartDateTime

string

Output only. The approved start time of the account-level budget in yyyy-MM-dd HH:mm:ss format.

For example, if a new budget is approved after the proposed start time, the approved start time is the time of approval.
purchaseOrderNumber

string

Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
notes

string

Output only. Notes associated with the budget.
Union field proposed_end_time. The proposed end time of the account-level budget. proposed_end_time can be only one of the following:
proposedEndDateTime

string

Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
proposedEndTimeType

enum (TimeType)

Output only. The proposed end time as a well-defined type, for example, FOREVER.

Union field approved_end_time. The approved end time of the account-level budget.

For example, if a budget's end time is updated and the proposal is approved after the proposed end time, the approved end time is the time of approval. approved_end_time can be only one of the following:
approvedEndDateTime

string

Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
approvedEndTimeType

enum (TimeType)

Output only. The approved end time as a well-defined type, for example, FOREVER.
Union field proposed_spending_limit. The proposed spending limit. proposed_spending_limit can be only one of the following:
proposedSpendingLimitMicros

string (int64 format)

Output only. The proposed spending limit in micros. One million is equivalent to one unit.
proposedSpendingLimitType

enum (SpendingLimitType)

Output only. The proposed spending limit as a well-defined type, for example, INFINITE.

Union field approved_spending_limit. The approved spending limit.

For example, if the amount already spent by the account exceeds the proposed spending limit at the time the proposal is approved, the approved spending limit is set to the amount already spent. approved_spending_limit can be only one of the following:
approvedSpendingLimitMicros

string (int64 format)

Output only. The approved spending limit in micros. One million is equivalent to one unit. This will only be populated if the proposed spending limit is finite, and will always be greater than or equal to the proposed spending limit.
approvedSpendingLimitType

enum (SpendingLimitType)

Output only. The approved spending limit as a well-defined type, for example, INFINITE. This will only be populated if the approved spending limit is INFINITE.

Union field adjusted_spending_limit. The spending limit after adjustments have been applied. Adjustments are stored in total_adjustments_micros.

This value has the final say on how much the account is allowed to spend. adjusted_spending_limit can be only one of the following:
adjustedSpendingLimitMicros

string (int64 format)

Output only. The adjusted spending limit in micros. One million is equivalent to one unit.

If the approved spending limit is finite, the adjusted spending limit may vary depending on the types of adjustments applied to this budget, if applicable.

The different kinds of adjustments are described here: https://support.google.com/google-ads/answer/1704323

For example, a debit adjustment reduces how much the account is allowed to spend.
adjustedSpendingLimitType

enum (SpendingLimitType)

Output only. The adjusted spending limit as a well-defined type, for example, INFINITE. This will only be populated if the adjusted spending limit is INFINITE, which is guaranteed to be true if the approved spending limit is INFINITE.

AccountBudgetStatus

The possible statuses of an AccountBudget.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The account budget is pending approval.
APPROVED The account budget has been approved.
CANCELLED The account budget has been cancelled by the user.

PendingAccountBudgetProposal

A pending proposal associated with the enclosing account-level budget, if applicable.

JSON representation 
{
  "proposalType": enum (AccountBudgetProposalType),
  "accountBudgetProposal": string,
  "name": string,
  "startDateTime": string,
  "purchaseOrderNumber": string,
  "notes": string,
  "creationDateTime": string,

  // Union field end_time can be only one of the following:
  "endDateTime": string,
  "endTimeType": enum (TimeType)
  // End of list of possible types for union field end_time.

  // Union field spending_limit can be only one of the following:
  "spendingLimitMicros": string,
  "spendingLimitType": enum (SpendingLimitType)
  // End of list of possible types for union field spending_limit.
}
Fields
proposalType

enum (AccountBudgetProposalType)

Output only. The type of this proposal, for example, END to end the budget associated with this proposal.
accountBudgetProposal

string

Output only. The resource name of the proposal. AccountBudgetProposal resource names have the form:

customers/{customerId}/accountBudgetProposals/{account_budget_proposal_id}
name

string

Output only. The name to assign to the account-level budget.
startDateTime

string

Output only. The start time in yyyy-MM-dd HH:mm:ss format.
purchaseOrderNumber

string

Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
notes

string

Output only. Notes associated with this budget.
creationDateTime

string

Output only. The time when this account-level budget proposal was created. Formatted as yyyy-MM-dd HH:mm:ss.
Union field end_time. The end time of the account-level budget. end_time can be only one of the following:
endDateTime

string

Output only. The end time in yyyy-MM-dd HH:mm:ss format.
endTimeType

enum (TimeType)

Output only. The end time as a well-defined type, for example, FOREVER.
Union field spending_limit. The spending limit. spending_limit can be only one of the following:
spendingLimitMicros

string (int64 format)

Output only. The spending limit in micros. One million is equivalent to one unit.
spendingLimitType

enum (SpendingLimitType)

Output only. The spending limit as a well-defined type, for example, INFINITE.

AdGroupAdAssetCombinationView

A view on the usage of ad group ad asset combination. Now we only support AdGroupAdAssetCombinationView for Responsive Search Ads, with more ad types planned for the future.

JSON representation 
{
  "resourceName": string,
  "servedAssets": [
    {
      object (AssetUsage)
    }
  ],
  "enabled": boolean
}
Fields
resourceName

string

Output only. The resource name of the ad group ad asset combination view. The combination ID is 128 bits long, where the upper 64 bits are stored in asset_combination_id_high, and the lower 64 bits are stored in asset_combination_id_low. AdGroupAd Asset Combination view resource names have the form: customers/{customerId}/adGroupAdAssetCombinationViews/{AdGroupAd.ad_group_id}~{AdGroupAd.ad.ad_id}~{AssetCombination.asset_combination_id_low}~{AssetCombination.asset_combination_id_high}
servedAssets[]

object (AssetUsage)

Output only. Served assets.
enabled

boolean

Output only. The status between the asset combination and the latest version of the ad. If true, the asset combination is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.

AssetUsage

Contains the usage information of the asset.

JSON representation 
{
  "asset": string,
  "servedAssetFieldType": enum (ServedAssetFieldType)
}
Fields
asset

string

Resource name of the asset.
servedAssetFieldType

enum (ServedAssetFieldType)

The served field type of the asset.

AdGroupAdAssetView

A link between an AdGroupAd and an Asset. Currently we only support AdGroupAdAssetView for AppAds and Responsive Search Ads.

JSON representation 
{
  "resourceName": string,
  "fieldType": enum (AssetFieldType),
  "policySummary": {
    object (AdGroupAdAssetPolicySummary)
  },
  "performanceLabel": enum (AssetPerformanceLabel),
  "pinnedField": enum (ServedAssetFieldType),
  "source": enum (AssetSource),
  "adGroupAd": string,
  "asset": string,
  "enabled": boolean
}
Fields
resourceName

string

Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4):

customers/{customerId}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}

Ad group ad asset view resource names have the form (Beginning from V4):

customers/{customerId}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}
fieldType

enum (AssetFieldType)

Output only. Role that the asset takes in the ad.
policySummary

object (AdGroupAdAssetPolicySummary)

Output only. Policy information for the ad group ad asset.
performanceLabel

enum (AssetPerformanceLabel)

Output only. Performance of an asset linkage.
pinnedField

enum (ServedAssetFieldType)

Output only. Pinned field.
source

enum (AssetSource)

Output only. Source of the ad group ad asset.
adGroupAd

string

Output only. The ad group ad to which the asset is linked.
asset

string

Output only. The asset which is linked to the ad group ad.
enabled

boolean

Output only. The status between the asset and the latest version of the ad. If true, the asset is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.

AdGroupAdAssetPolicySummary

Contains policy information for an ad group ad asset.

JSON representation 
{
  "policyTopicEntries": [
    {
      object (PolicyTopicEntry)
    }
  ],
  "reviewStatus": enum (PolicyReviewStatus),
  "approvalStatus": enum (PolicyApprovalStatus)
}
Fields
policyTopicEntries[]

object (PolicyTopicEntry)

Output only. The list of policy findings for the ad group ad asset.
reviewStatus

enum (PolicyReviewStatus)

Output only. Where in the review process this ad group ad asset is.
approvalStatus

enum (PolicyApprovalStatus)

Output only. The overall approval status of this ad group ad asset, calculated based on the status of its individual policy topic entries.

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

string

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

customers/{customerId}/adGroupAudienceViews/{adGroupId}~{criterionId}

AdGroupCriterionSimulation

An ad group criterion simulation. Supported combinations of advertising channel type, criterion type, simulation type, and simulation modification method are detailed below respectively. Hotel AdGroupCriterion simulation operations starting in V5.

  1. DISPLAY - KEYWORD - CPC_BID - UNIFORM
  2. SEARCH - KEYWORD - CPC_BID - UNIFORM
  3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM
  4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM
  5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
JSON representation 
{
  "resourceName": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "adGroupId": string,
  "criterionId": string,
  "startDate": string,
  "endDate": string,

  // Union field point_list can be only one of the following:
  "cpcBidPointList": {
    object (CpcBidSimulationPointList)
  },
  "percentCpcBidPointList": {
    object (PercentCpcBidSimulationPointList)
  }
  // End of list of possible types for union field point_list.
}
Fields
resourceName

string

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

customers/{customerId}/adGroupCriterionSimulations/{adGroupId}~{criterionId}~{type}~{modificationMethod}~{startDate}~{endDate}
type

enum (SimulationType)

Output only. The field that the simulation modifies.
modificationMethod

enum (SimulationModificationMethod)

Output only. How the simulation modifies the field.
adGroupId

string (int64 format)

Output only. AdGroup ID of the simulation.
criterionId

string (int64 format)

Output only. Criterion ID of the simulation.
startDate

string

Output only. First day on which the simulation is based, in YYYY-MM-DD format.
endDate

string

Output only. Last day on which the simulation is based, in YYYY-MM-DD format.
Union field point_list. List of simulation points. point_list can be only one of the following:
cpcBidPointList

object (CpcBidSimulationPointList)

Output only. Simulation points if the simulation type is CPC_BID.
percentCpcBidPointList

object (PercentCpcBidSimulationPointList)

Output only. Simulation points if the simulation type is PERCENT_CPC_BID.

SimulationType

Enum describing the field a simulation modifies.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CPC_BID The simulation is for a CPC bid.
CPV_BID The simulation is for a CPV bid.
TARGET_CPA The simulation is for a CPA target.
BID_MODIFIER The simulation is for a bid modifier.
TARGET_ROAS The simulation is for a ROAS target.
PERCENT_CPC_BID The simulation is for a percent CPC bid.
TARGET_IMPRESSION_SHARE The simulation is for an impression share target.
BUDGET The simulation is for a budget.

SimulationModificationMethod

Enum describing the method by which a simulation modifies a field.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
UNIFORM The values in a simulation were applied to all children of a given resource uniformly. Overrides on child resources were not respected.
DEFAULT The values in a simulation were applied to the given resource. Overrides on child resources were respected, and traffic estimates do not include these resources.
SCALING The values in a simulation were all scaled by the same factor. For example, in a simulated TargetCpa campaign, the campaign target and all ad group targets were scaled by a factor of X.

CpcBidSimulationPointList

A container for simulation points for simulations of type CPC_BID.

JSON representation 
{
  "points": [
    {
      object (CpcBidSimulationPoint)
    }
  ]
}
Fields
points[]

object (CpcBidSimulationPoint)

Projected metrics for a series of CPC bid amounts.

CpcBidSimulationPoint

Projected metrics for a specific CPC bid amount.

JSON representation 
{
  "requiredBudgetAmountMicros": string,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string,

  // Union field cpc_simulation_key_value can be only one of the following:
  "cpcBidMicros": string,
  "cpcBidScalingModifier": number
  // End of list of possible types for union field cpc_simulation_key_value.
}
Fields
requiredBudgetAmountMicros

string (int64 format)

Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
biddableConversions

number

Projected number of biddable conversions.
biddableConversionsValue

number

Projected total value of biddable conversions.
clicks

string (int64 format)

Projected number of clicks.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
topSlotImpressions

string (int64 format)

Projected number of top slot impressions. Only search advertising channel type supports this field.
Union field cpc_simulation_key_value. When SimulationModificationMethod = UNIFORM or DEFAULT, cpc_bid_micros is set. When SimulationModificationMethod = SCALING, cpc_bid_scaling_modifier is set. cpc_simulation_key_value can be only one of the following:
cpcBidMicros

string (int64 format)

The simulated CPC bid upon which projected metrics are based.
cpcBidScalingModifier

number

The simulated scaling modifier upon which projected metrics are based. All CPC bids relevant to the simulated entity are scaled by this modifier.

PercentCpcBidSimulationPointList

A container for simulation points for simulations of type PERCENT_CPC_BID.

JSON representation 
{
  "points": [
    {
      object (PercentCpcBidSimulationPoint)
    }
  ]
}
Fields
points[]

object (PercentCpcBidSimulationPoint)

Projected metrics for a series of percent CPC bid amounts.

PercentCpcBidSimulationPoint

Projected metrics for a specific percent CPC amount. Only Hotel advertising channel type supports this field.

JSON representation 
{
  "percentCpcBidMicros": string,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string
}
Fields
percentCpcBidMicros

string (int64 format)

The simulated percent CPC upon which projected metrics are based. Percent CPC expressed as fraction of the advertised price for some good or service. The value stored here is 1,000,000 * [fraction].
biddableConversions

number

Projected number of biddable conversions.
biddableConversionsValue

number

Projected total value of biddable conversions in local currency.
clicks

string (int64 format)

Projected number of clicks.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
topSlotImpressions

string (int64 format)

Projected number of top slot impressions.

AdGroupSimulation

An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively.

  1. SEARCH - CPC_BID - DEFAULT
  2. SEARCH - CPC_BID - UNIFORM
  3. SEARCH - TARGET_CPA - UNIFORM
  4. SEARCH - TARGET_ROAS - UNIFORM
  5. DISPLAY - CPC_BID - DEFAULT
  6. DISPLAY - CPC_BID - UNIFORM
  7. DISPLAY - TARGET_CPA - UNIFORM
JSON representation 
{
  "resourceName": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "adGroupId": string,
  "startDate": string,
  "endDate": string,

  // Union field point_list can be only one of the following:
  "cpcBidPointList": {
    object (CpcBidSimulationPointList)
  },
  "cpvBidPointList": {
    object (CpvBidSimulationPointList)
  },
  "targetCpaPointList": {
    object (TargetCpaSimulationPointList)
  },
  "targetRoasPointList": {
    object (TargetRoasSimulationPointList)
  }
  // End of list of possible types for union field point_list.
}
Fields
resourceName

string

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

customers/{customerId}/adGroupSimulations/{adGroupId}~{type}~{modificationMethod}~{startDate}~{endDate}
type

enum (SimulationType)

Output only. The field that the simulation modifies.
modificationMethod

enum (SimulationModificationMethod)

Output only. How the simulation modifies the field.
adGroupId

string (int64 format)

Output only. Ad group id of the simulation.
startDate

string

Output only. First day on which the simulation is based, in YYYY-MM-DD format.
endDate

string

Output only. Last day on which the simulation is based, in YYYY-MM-DD format
Union field point_list. List of simulation points. point_list can be only one of the following:
cpcBidPointList

object (CpcBidSimulationPointList)

Output only. Simulation points if the simulation type is CPC_BID.
cpvBidPointList

object (CpvBidSimulationPointList)

Output only. Simulation points if the simulation type is CPV_BID.
targetCpaPointList

object (TargetCpaSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_CPA.
targetRoasPointList

object (TargetRoasSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_ROAS.

CpvBidSimulationPointList

A container for simulation points for simulations of type CPV_BID.

JSON representation 
{
  "points": [
    {
      object (CpvBidSimulationPoint)
    }
  ]
}
Fields
points[]

object (CpvBidSimulationPoint)

Projected metrics for a series of CPV bid amounts.

CpvBidSimulationPoint

Projected metrics for a specific CPV bid amount.

JSON representation 
{
  "cpvBidMicros": string,
  "costMicros": string,
  "impressions": string,
  "views": string
}
Fields
cpvBidMicros

string (int64 format)

The simulated CPV bid upon which projected metrics are based.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
views

string (int64 format)

Projected number of views.

TargetCpaSimulationPointList

A container for simulation points for simulations of type TARGET_CPA.

JSON representation 
{
  "points": [
    {
      object (TargetCpaSimulationPoint)
    }
  ]
}
Fields
points[]

object (TargetCpaSimulationPoint)

Projected metrics for a series of target CPA amounts.

TargetCpaSimulationPoint

Projected metrics for a specific target CPA amount.

JSON representation 
{
  "requiredBudgetAmountMicros": string,
  "appInstalls": number,
  "inAppActions": number,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string,
  "interactions": string,

  // Union field target_cpa_simulation_key_value can be only one of the
  // following:
  "targetCpaMicros": string,
  "targetCpaScalingModifier": number
  // End of list of possible types for union field
  // target_cpa_simulation_key_value.
}
Fields
requiredBudgetAmountMicros

string (int64 format)

Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
appInstalls

number

Projected number of app installs.
inAppActions

number

Projected number of in-app actions.
biddableConversions

number

Projected number of biddable conversions.
biddableConversionsValue

number

Projected total value of biddable conversions.
clicks

string (int64 format)

Projected number of clicks.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
topSlotImpressions

string (int64 format)

Projected number of top slot impressions. Only search advertising channel type supports this field.
interactions

string (int64 format)

Projected number of interactions. Only discovery advertising channel type supports this field.
Union field target_cpa_simulation_key_value. When SimulationModificationMethod = UNIFORM or DEFAULT, target_cpa_micros is set. When SimulationModificationMethod = SCALING, target_cpa_scaling_modifier is set. target_cpa_simulation_key_value can be only one of the following:
targetCpaMicros

string (int64 format)

The simulated target CPA upon which projected metrics are based.
targetCpaScalingModifier

number

The simulated scaling modifier upon which projected metrics are based. All CPA targets relevant to the simulated entity are scaled by this modifier.

TargetRoasSimulationPointList

A container for simulation points for simulations of type TARGET_ROAS.

JSON representation 
{
  "points": [
    {
      object (TargetRoasSimulationPoint)
    }
  ]
}
Fields
points[]

object (TargetRoasSimulationPoint)

Projected metrics for a series of target ROAS amounts.

TargetRoasSimulationPoint

Projected metrics for a specific target ROAS amount.

JSON representation 
{
  "requiredBudgetAmountMicros": string,
  "targetRoas": number,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string
}
Fields
requiredBudgetAmountMicros

string (int64 format)

Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
targetRoas

number

The simulated target ROAS upon which projected metrics are based.
biddableConversions

number

Projected number of biddable conversions.
biddableConversionsValue

number

Projected total value of biddable conversions.
clicks

string (int64 format)

Projected number of clicks.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
topSlotImpressions

string (int64 format)

Projected number of top slot impressions. Only Search advertising channel type supports this field.

AgeRangeView

An age range view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

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

customers/{customerId}/ageRangeViews/{adGroupId}~{criterionId}

AdScheduleView

An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form:

customers/{customerId}/adScheduleViews/{campaignId}~{criterionId}

DomainCategory

A category generated automatically by crawling a domain. If a campaign uses the DynamicSearchAdsSetting, then domain categories will be generated for the domain. The categories can be targeted using WebpageConditionInfo. See: https://support.google.com/google-ads/answer/2471185

JSON representation 
{
  "resourceName": string,
  "campaign": string,
  "category": string,
  "languageCode": string,
  "domain": string,
  "coverageFraction": number,
  "categoryRank": string,
  "hasChildren": boolean,
  "recommendedCpcBidMicros": string
}
Fields
resourceName

string

Output only. The resource name of the domain category. Domain category resource names have the form:

customers/{customerId}/domainCategories/{campaignId}~{category_base64}~{languageCode}
campaign

string

Output only. The campaign this category is recommended for.
category

string

Output only. Recommended category for the website domain, for example, if you have a website about electronics, the categories could be "cameras", "televisions", etc.
languageCode

string

Output only. The language code specifying the language of the website, for example, "en" for English. The language can be specified in the DynamicSearchAdsSetting required for dynamic search ads. This is the language of the pages from your website that you want Google Ads to find, create ads for, and match searches with.
domain

string

Output only. The domain for the website. The domain can be specified in the DynamicSearchAdsSetting required for dynamic search ads.
coverageFraction

number

Output only. Fraction of pages on your site that this category matches.
categoryRank

string (int64 format)

Output only. The position of this category in the set of categories. Lower numbers indicate a better match for the domain. null indicates not recommended.
hasChildren

boolean

Output only. Indicates whether this category has sub-categories.
recommendedCpcBidMicros

string (int64 format)

Output only. The recommended cost per click for the category.

AssetFieldTypeView

An asset field type view. This view reports non-overcounted metrics for each asset field type when the asset is used as extension.

JSON representation 
{
  "resourceName": string,
  "fieldType": enum (AssetFieldType)
}
Fields
resourceName

string

Output only. The resource name of the asset field type view. Asset field type view resource names have the form:

customers/{customerId}/assetFieldTypeViews/{fieldType}
fieldType

enum (AssetFieldType)

Output only. The asset field type of the asset field type view.

AssetGroupProductGroupView

An asset group product group view.

JSON representation 
{
  "resourceName": string,
  "assetGroup": string,
  "assetGroupListingGroupFilter": string
}
Fields
resourceName

string

Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form:

customers/{customerId}/assetGroupProductGroupViews/{asset_group_id}~{listing_group_filter_id}
assetGroup

string

Output only. The asset group associated with the listing group filter.
assetGroupListingGroupFilter

string

Output only. The resource name of the asset group listing group filter.

AssetGroupTopCombinationView

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

JSON representation 
{
  "resourceName": string,
  "assetGroupTopCombinations": [
    {
      object (AssetGroupAssetCombinationData)
    }
  ]
}
Fields
resourceName

string

Output only. 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[]

object (AssetGroupAssetCombinationData)

Output only. The top combinations of assets that served together.

AssetGroupAssetCombinationData

Asset group asset combination data

JSON representation 
{
  "assetCombinationServedAssets": [
    {
      object (AssetUsage)
    }
  ]
}
Fields
assetCombinationServedAssets[]

object (AssetUsage)

Output only. Served assets.

AssetSetTypeView

An asset set type view. This view reports non-overcounted metrics for each asset set type. Child asset set types are not included in this report. Their stats are aggregated under the parent asset set type.

JSON representation 
{
  "resourceName": string,
  "assetSetType": enum (AssetSetType)
}
Fields
resourceName

string

Output only. The resource name of the asset set type view. Asset set type view resource names have the form:

customers/{customerId}/assetSetTypeViews/{assetSetType}
assetSetType

enum (AssetSetType)

Output only. The asset set type of the asset set type view.

BiddingStrategySimulation

A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively.

  1. TARGET_CPA - UNIFORM
  2. TARGET_ROAS - UNIFORM
JSON representation 
{
  "resourceName": string,
  "biddingStrategyId": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "startDate": string,
  "endDate": string,

  // Union field point_list can be only one of the following:
  "targetCpaPointList": {
    object (TargetCpaSimulationPointList)
  },
  "targetRoasPointList": {
    object (TargetRoasSimulationPointList)
  }
  // End of list of possible types for union field point_list.
}
Fields
resourceName

string

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

customers/{customerId}/biddingStrategySimulations/{biddingStrategyId}~{type}~{modificationMethod}~{startDate}~{endDate}
biddingStrategyId

string (int64 format)

Output only. Bidding strategy shared set id of the simulation.
type

enum (SimulationType)

Output only. The field that the simulation modifies.
modificationMethod

enum (SimulationModificationMethod)

Output only. How the simulation modifies the field.
startDate

string

Output only. First day on which the simulation is based, in YYYY-MM-DD format.
endDate

string

Output only. Last day on which the simulation is based, in YYYY-MM-DD format
Union field point_list. List of simulation points. point_list can be only one of the following:
targetCpaPointList

object (TargetCpaSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_CPA.
targetRoasPointList

object (TargetRoasSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_ROAS.

CallView

A call view that includes data for call tracking of call-only ads or call extensions.

JSON representation 
{
  "resourceName": string,
  "callerCountryCode": string,
  "callerAreaCode": string,
  "callDurationSeconds": string,
  "startCallDateTime": string,
  "endCallDateTime": string,
  "callTrackingDisplayLocation": enum (CallTrackingDisplayLocation),
  "type": enum (CallType),
  "callStatus": enum (GoogleVoiceCallStatus)
}
Fields
resourceName

string

Output only. The resource name of the call view. Call view resource names have the form:

customers/{customerId}/callViews/{call_detail_id}
callerCountryCode

string

Output only. Country code of the caller.
callerAreaCode

string

Output only. Area code of the caller. Null if the call duration is shorter than 15 seconds.
callDurationSeconds

string (int64 format)

Output only. The advertiser-provided call duration in seconds.
startCallDateTime

string

Output only. The advertiser-provided call start date time.
endCallDateTime

string

Output only. The advertiser-provided call end date time.
callTrackingDisplayLocation

enum (CallTrackingDisplayLocation)

Output only. The call tracking display location.
type

enum (CallType)

Output only. The type of the call.
callStatus

enum (GoogleVoiceCallStatus)

Output only. The status of the call.

CallTrackingDisplayLocation

Possible call tracking display locations.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AD The phone call placed from the ad.
LANDING_PAGE The phone call placed from the landing page ad points to.

CallType

Possible types of property from where the call was made.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MANUALLY_DIALED The phone call was manually dialed.

GoogleVoiceCallStatus

Possible statuses of a google voice call.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MISSED The call was missed.
RECEIVED The call was received.

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

string

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

customers/{customerId}/campaignAudienceViews/{campaignId}~{criterionId}

CampaignSearchTermInsight

A Campaign search term view. Historical data is available starting March 2023.

JSON representation 
{
  "resourceName": string,
  "categoryLabel": string,
  "id": string,
  "campaignId": string
}
Fields
resourceName

string

Output only. The resource name of the campaign level search term insight. Campaign level search term insight resource names have the form:

customers/{customerId}/campaignSearchTermInsights/{campaignId}~{categoryId}
categoryLabel

string

Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.
id

string (int64 format)

Output only. The ID of the insight.
campaignId

string (int64 format)

Output only. The ID of the campaign.

CampaignSimulation

A campaign simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively.

  • SEARCH - CPC_BID - UNIFORM
  • SEARCH - CPC_BID - SCALING
  • SEARCH - TARGET_CPA - UNIFORM
  • SEARCH - TARGET_CPA - SCALING
  • SEARCH - TARGET_ROAS - UNIFORM
  • SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM
  • SEARCH - BUDGET - UNIFORM
  • SHOPPING - BUDGET - UNIFORM
  • SHOPPING - TARGET_ROAS - UNIFORM
  • MULTI_CHANNEL - TARGET_CPA - UNIFORM
  • MULTI_CHANNEL - TARGET_ROAS - UNIFORM
  • DISCOVERY - TARGET_CPA - DEFAULT
  • DISPLAY - TARGET_CPA - UNIFORM
  • PERFORMANCE_MAX - TARGET_CPA - UNIFORM
  • PERFORMANCE_MAX - TARGET_ROAS - UNIFORM
  • PERFORMANCE_MAX - BUDGET - UNIFORM
JSON representation 
{
  "resourceName": string,
  "campaignId": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "startDate": string,
  "endDate": string,

  // Union field point_list can be only one of the following:
  "cpcBidPointList": {
    object (CpcBidSimulationPointList)
  },
  "targetCpaPointList": {
    object (TargetCpaSimulationPointList)
  },
  "targetRoasPointList": {
    object (TargetRoasSimulationPointList)
  },
  "targetImpressionSharePointList": {
    object (TargetImpressionShareSimulationPointList)
  },
  "budgetPointList": {
    object (BudgetSimulationPointList)
  }
  // End of list of possible types for union field point_list.
}
Fields
resourceName

string

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

customers/{customerId}/campaignSimulations/{campaignId}~{type}~{modificationMethod}~{startDate}~{endDate}
campaignId

string (int64 format)

Output only. Campaign id of the simulation.
type

enum (SimulationType)

Output only. The field that the simulation modifies.
modificationMethod

enum (SimulationModificationMethod)

Output only. How the simulation modifies the field.
startDate

string

Output only. First day on which the simulation is based, in YYYY-MM-DD format.
endDate

string

Output only. Last day on which the simulation is based, in YYYY-MM-DD format
Union field point_list. List of simulation points. point_list can be only one of the following:
cpcBidPointList

object (CpcBidSimulationPointList)

Output only. Simulation points if the simulation type is CPC_BID.
targetCpaPointList

object (TargetCpaSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_CPA.
targetRoasPointList

object (TargetRoasSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_ROAS.
targetImpressionSharePointList

object (TargetImpressionShareSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_IMPRESSION_SHARE.
budgetPointList

object (BudgetSimulationPointList)

Output only. Simulation points if the simulation type is BUDGET.

TargetImpressionShareSimulationPointList

A container for simulation points for simulations of type TARGET_IMPRESSION_SHARE.

JSON representation 
{
  "points": [
    {
      object (TargetImpressionShareSimulationPoint)
    }
  ]
}
Fields
points[]

object (TargetImpressionShareSimulationPoint)

Projected metrics for a specific target impression share value.

TargetImpressionShareSimulationPoint

Projected metrics for a specific target impression share value.

JSON representation 
{
  "targetImpressionShareMicros": string,
  "requiredCpcBidCeilingMicros": string,
  "requiredBudgetAmountMicros": string,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string,
  "absoluteTopImpressions": string
}
Fields
targetImpressionShareMicros

string (int64 format)

The simulated target impression share value (in micros) upon which projected metrics are based. For example, 10% impression share, which is equal to 0.1, is stored as 100_000. This value is validated and will not exceed 1M (100%).
requiredCpcBidCeilingMicros

string (int64 format)

Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency.
requiredBudgetAmountMicros

string (int64 format)

Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
biddableConversions

number

Projected number of biddable conversions.
biddableConversionsValue

number

Projected total value of biddable conversions.
clicks

string (int64 format)

Projected number of clicks.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
topSlotImpressions

string (int64 format)

Projected number of top slot impressions. Only search advertising channel type supports this field.
absoluteTopImpressions

string (int64 format)

Projected number of absolute top impressions. Only search advertising channel type supports this field.

BudgetSimulationPointList

A container for simulation points for simulations of type BUDGET.

JSON representation 
{
  "points": [
    {
      object (BudgetSimulationPoint)
    }
  ]
}
Fields
points[]

object (BudgetSimulationPoint)

Projected metrics for a series of budget amounts.

BudgetSimulationPoint

Projected metrics for a specific budget amount.

JSON representation 
{
  "budgetAmountMicros": string,
  "requiredCpcBidCeilingMicros": string,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string,
  "interactions": string
}
Fields
budgetAmountMicros

string (int64 format)

The simulated budget upon which projected metrics are based.
requiredCpcBidCeilingMicros

string (int64 format)

Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency. Only campaigns with the Target Spend bidding strategy support this field.
biddableConversions

number

Projected number of biddable conversions.
biddableConversionsValue

number

Projected total value of biddable conversions.
clicks

string (int64 format)

Projected number of clicks.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
topSlotImpressions

string (int64 format)

Projected number of top slot impressions. Only search advertising channel type supports this field.
interactions

string (int64 format)

Projected number of interactions. Only discovery advertising channel type supports this field.

CarrierConstant

A carrier criterion that can be used in campaign targeting.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "name": string,
  "countryCode": string
}
Fields
resourceName

string

Output only. The resource name of the carrier criterion. Carrier criterion resource names have the form:

carrierConstants/{criterionId}
id

string (int64 format)

Output only. The ID of the carrier criterion.
name

string

Output only. The full name of the carrier in English.
countryCode

string

Output only. The country code of the country where the carrier is located, for example, "AR", "FR", etc.

ChangeEvent

Describes the granular change of returned resources of certain resource types. Changes made through the UI or API in the past 30 days are included. Previous and new values of the changed fields are shown. ChangeEvent could have up to 3 minutes delay to reflect a new change.

JSON representation 
{
  "resourceName": string,
  "changeDateTime": string,
  "changeResourceType": enum (ChangeEventResourceType),
  "changeResourceName": string,
  "clientType": enum (ChangeClientType),
  "userEmail": string,
  "oldResource": {
    object (ChangedResource)
  },
  "newResource": {
    object (ChangedResource)
  },
  "resourceChangeOperation": enum (ResourceChangeOperation),
  "changedFields": string,
  "campaign": string,
  "adGroup": string,
  "feed": string,
  "feedItem": string,
  "asset": string
}
Fields
resourceName

string

Output only. The resource name of the change event. Change event resource names have the form:

customers/{customerId}/changeEvents/{timestamp_micros}~{command_index}~{mutate_index}
changeDateTime

string

Output only. Time at which the change was committed on this resource.
changeResourceType

enum (ChangeEventResourceType)

Output only. The type of the changed resource. This dictates what resource will be set in oldResource and newResource.
changeResourceName

string

Output only. The Simply resource this change occurred on.
clientType

enum (ChangeClientType)

Output only. Where the change was made through.
userEmail

string

Output only. The email of the user who made this change.
oldResource

object (ChangedResource)

Output only. The old resource before the change. Only changed fields will be populated.
newResource

object (ChangedResource)

Output only. The new resource after the change. Only changed fields will be populated.
resourceChangeOperation

enum (ResourceChangeOperation)

Output only. The operation on the changed resource.
changedFields

string (FieldMask format)

Output only. A list of fields that are changed in the returned resource.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
campaign

string

Output only. The Campaign affected by this change.
adGroup

string

Output only. The AdGroup affected by this change.
feed

string

Output only. The Feed affected by this change.
feedItem

string

Output only. The FeedItem affected by this change.
asset

string

Output only. The Asset affected by this change.

ChangeEventResourceType

Enum listing the resource types support by the ChangeEvent resource.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents an unclassified resource unknown in this version.
AD An Ad resource change.
AD_GROUP An AdGroup resource change.
AD_GROUP_CRITERION An AdGroupCriterion resource change.
CAMPAIGN A Campaign resource change.
CAMPAIGN_BUDGET A CampaignBudget resource change.
AD_GROUP_BID_MODIFIER An AdGroupBidModifier resource change.
CAMPAIGN_CRITERION A CampaignCriterion resource change.
FEED A Feed resource change.
FEED_ITEM A FeedItem resource change.
CAMPAIGN_FEED A CampaignFeed resource change.
AD_GROUP_FEED An AdGroupFeed resource change.
AD_GROUP_AD An AdGroupAd resource change.
ASSET An Asset resource change.
CUSTOMER_ASSET A CustomerAsset resource change.
CAMPAIGN_ASSET A CampaignAsset resource change.
AD_GROUP_ASSET An AdGroupAsset resource change.
ASSET_SET An AssetSet resource change.
ASSET_SET_ASSET An AssetSetAsset resource change.
CAMPAIGN_ASSET_SET A CampaignAssetSet resource change.

ChangeClientType

The source that the changeEvent resource was made through.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents an unclassified client type unknown in this version.
GOOGLE_ADS_WEB_CLIENT Changes made through the "ads.google.com". For example, changes made through campaign management.
GOOGLE_ADS_AUTOMATED_RULE Changes made through Google Ads automated rules.
GOOGLE_ADS_SCRIPTS Changes made through Google Ads scripts.
GOOGLE_ADS_BULK_UPLOAD Changes made by Google Ads bulk upload.
GOOGLE_ADS_API Changes made by Google Ads API.
GOOGLE_ADS_EDITOR Changes made by Google Ads Editor. This value is a placeholder. The API does not return these changes.
GOOGLE_ADS_MOBILE_APP Changes made by Google Ads mobile app.
GOOGLE_ADS_RECOMMENDATIONS Changes made through Google Ads recommendations.
SEARCH_ADS_360_SYNC Changes made through Search Ads 360 Sync.
SEARCH_ADS_360_POST Changes made through Search Ads 360 Post.
INTERNAL_TOOL Changes made through internal tools. For example, when a user sets a URL template on an entity like a Campaign, it's automatically wrapped with the SA360 Clickserver URL.
OTHER Types of changes that are not categorized, for example, changes made by coupon redemption through Google Ads.
GOOGLE_ADS_RECOMMENDATIONS_SUBSCRIPTION Changes made by subscribing to Google Ads recommendations.

ChangedResource

A wrapper proto presenting all supported resources. Only the resource of the changeResourceType will be set.

JSON representation 
{
  "ad": {
    object (Ad)
  },
  "adGroup": {
    object (AdGroup)
  },
  "adGroupCriterion": {
    object (AdGroupCriterion)
  },
  "campaign": {
    object (Campaign)
  },
  "campaignBudget": {
    object (CampaignBudget)
  },
  "adGroupBidModifier": {
    object (AdGroupBidModifier)
  },
  "campaignCriterion": {
    object (CampaignCriterion)
  },
  "feed": {
    object (Feed)
  },
  "feedItem": {
    object (FeedItem)
  },
  "campaignFeed": {
    object (CampaignFeed)
  },
  "adGroupFeed": {
    object (AdGroupFeed)
  },
  "adGroupAd": {
    object (AdGroupAd)
  },
  "asset": {
    object (Asset)
  },
  "customerAsset": {
    object (CustomerAsset)
  },
  "campaignAsset": {
    object (CampaignAsset)
  },
  "adGroupAsset": {
    object (AdGroupAsset)
  },
  "assetSet": {
    object (AssetSet)
  },
  "assetSetAsset": {
    object (AssetSetAsset)
  },
  "campaignAssetSet": {
    object (CampaignAssetSet)
  }
}
Fields
ad

object (Ad)

Output only. Set if changeResourceType == AD.
adGroup

object (AdGroup)

Output only. Set if changeResourceType == AD_GROUP.
adGroupCriterion

object (AdGroupCriterion)

Output only. Set if changeResourceType == AD_GROUP_CRITERION.
campaign

object (Campaign)

Output only. Set if changeResourceType == CAMPAIGN.
campaignBudget

object (CampaignBudget)

Output only. Set if changeResourceType == CAMPAIGN_BUDGET.
adGroupBidModifier

object (AdGroupBidModifier)

Output only. Set if changeResourceType == AD_GROUP_BID_MODIFIER.
campaignCriterion

object (CampaignCriterion)

Output only. Set if changeResourceType == CAMPAIGN_CRITERION.
feed

object (Feed)

Output only. Set if changeResourceType == FEED.
feedItem

object (FeedItem)

Output only. Set if changeResourceType == FEED_ITEM.
campaignFeed

object (CampaignFeed)

Output only. Set if changeResourceType == CAMPAIGN_FEED.
adGroupFeed

object (AdGroupFeed)

Output only. Set if changeResourceType == AD_GROUP_FEED.
adGroupAd

object (AdGroupAd)

Output only. Set if changeResourceType == AD_GROUP_AD.
asset

object (Asset)

Output only. Set if changeResourceType == ASSET.
customerAsset

object (CustomerAsset)

Output only. Set if changeResourceType == CUSTOMER_ASSET.
campaignAsset

object (CampaignAsset)

Output only. Set if changeResourceType == CAMPAIGN_ASSET.
adGroupAsset

object (AdGroupAsset)

Output only. Set if changeResourceType == AD_GROUP_ASSET.
assetSet

object (AssetSet)

Output only. Set if changeResourceType == ASSET_SET.
assetSetAsset

object (AssetSetAsset)

Output only. Set if changeResourceType == ASSET_SET_ASSET.
campaignAssetSet

object (CampaignAssetSet)

Output only. Set if changeResourceType == CAMPAIGN_ASSET_SET.

ResourceChangeOperation

The operation on the changed resource in changeEvent resource.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents an unclassified operation unknown in this version.
CREATE The resource was created.
UPDATE The resource was modified.
REMOVE The resource was removed.

ChangeStatus

Describes the status of returned resource. ChangeStatus could have up to 3 minutes delay to reflect a new change.

JSON representation 
{
  "resourceName": string,
  "resourceType": enum (ChangeStatusResourceType),
  "resourceStatus": enum (ChangeStatusOperation),
  "sharedSet": string,
  "campaignSharedSet": string,
  "asset": string,
  "customerAsset": string,
  "campaignAsset": string,
  "adGroupAsset": string,
  "combinedAudience": string,
  "lastChangeDateTime": string,
  "campaign": string,
  "adGroup": string,
  "adGroupAd": string,
  "adGroupCriterion": string,
  "campaignCriterion": string,
  "feed": string,
  "feedItem": string,
  "adGroupFeed": string,
  "campaignFeed": string,
  "adGroupBidModifier": string
}
Fields
resourceName

string

Output only. The resource name of the change status. Change status resource names have the form:

customers/{customerId}/changeStatus/{change_status_id}
resourceType

enum (ChangeStatusResourceType)

Output only. Represents the type of the changed resource. This dictates what fields will be set. For example, for AD_GROUP, campaign and adGroup fields will be set.
resourceStatus

enum (ChangeStatusOperation)

Output only. Represents the status of the changed resource.
sharedSet

string

Output only. The SharedSet affected by this change.
campaignSharedSet

string

Output only. The CampaignSharedSet affected by this change.
asset

string

Output only. The Asset affected by this change.
customerAsset

string

Output only. The CustomerAsset affected by this change.
campaignAsset

string

Output only. The CampaignAsset affected by this change.
adGroupAsset

string

Output only. The AdGroupAsset affected by this change.
combinedAudience

string

Output only. The CombinedAudience affected by this change.
lastChangeDateTime

string

Output only. Time at which the most recent change has occurred on this resource.
campaign

string

Output only. The Campaign affected by this change.
adGroup

string

Output only. The AdGroup affected by this change.
adGroupAd

string

Output only. The AdGroupAd affected by this change.
adGroupCriterion

string

Output only. The AdGroupCriterion affected by this change.
campaignCriterion

string

Output only. The CampaignCriterion affected by this change.
feed

string

Output only. The Feed affected by this change.
feedItem

string

Output only. The FeedItem affected by this change.
adGroupFeed

string

Output only. The AdGroupFeed affected by this change.
campaignFeed

string

Output only. The CampaignFeed affected by this change.
adGroupBidModifier

string

Output only. The AdGroupBidModifier affected by this change.

ChangeStatusResourceType

Enum listing the resource types support by the ChangeStatus resource.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents an unclassified resource unknown in this version.
AD_GROUP An AdGroup resource change.
AD_GROUP_AD An AdGroupAd resource change.
AD_GROUP_CRITERION An AdGroupCriterion resource change.
CAMPAIGN A Campaign resource change.
CAMPAIGN_CRITERION A CampaignCriterion resource change.
FEED A Feed resource change.
FEED_ITEM A FeedItem resource change.
AD_GROUP_FEED An AdGroupFeed resource change.
CAMPAIGN_FEED A CampaignFeed resource change.
AD_GROUP_BID_MODIFIER An AdGroupBidModifier resource change.
SHARED_SET A SharedSet resource change.
CAMPAIGN_SHARED_SET A CampaignSharedSet resource change.
ASSET An Asset resource change.
CUSTOMER_ASSET A CustomerAsset resource change.
CAMPAIGN_ASSET A CampaignAsset resource change.
AD_GROUP_ASSET An AdGroupAsset resource change.
COMBINED_AUDIENCE A CombinedAudience resource change.

ChangeStatusOperation

Status of the changed resource

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents an unclassified resource unknown in this version.
ADDED The resource was created.
CHANGED The resource was modified.
REMOVED The resource was removed.

CombinedAudience

Describe a resource for combined audiences which includes different audiences.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "status": enum (CombinedAudienceStatus),
  "name": string,
  "description": string
}
Fields
resourceName

string

Immutable. The resource name of the combined audience. Combined audience names have the form:

customers/{customerId}/combinedAudience/{combined_audience_id}
id

string (int64 format)

Output only. ID of the combined audience.
status

enum (CombinedAudienceStatus)

Output only. Status of this combined audience. Indicates whether the combined audience is enabled or removed.
name

string

Output only. Name of the combined audience. It should be unique across all combined audiences.
description

string

Output only. Description of this combined audience.

CombinedAudienceStatus

Enum containing possible combined audience status types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Enabled status - combined audience is enabled and can be targeted.
REMOVED Removed status - combined audience is removed and cannot be used for targeting.

ClickView

A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.

JSON representation 
{
  "resourceName": string,
  "areaOfInterest": {
    object (ClickLocation)
  },
  "locationOfPresence": {
    object (ClickLocation)
  },
  "keyword": string,
  "keywordInfo": {
    object (KeywordInfo)
  },
  "gclid": string,
  "pageNumber": string,
  "adGroupAd": string,
  "campaignLocationTarget": string,
  "userList": string
}
Fields
resourceName

string

Output only. The resource name of the click view. Click view resource names have the form:

customers/{customerId}/clickViews/{date (yyyy-MM-dd)}~{gclid}
areaOfInterest

object (ClickLocation)

Output only. The location criteria matching the area of interest associated with the impression.
locationOfPresence

object (ClickLocation)

Output only. The location criteria matching the location of presence associated with the impression.
keyword

string

Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel.
keywordInfo

object (KeywordInfo)

Output only. Basic information about the associated keyword, if it exists.
gclid

string

Output only. The Google Click ID.
pageNumber

string (int64 format)

Output only. Page number in search results where the ad was shown.
adGroupAd

string

Output only. The associated ad.
campaignLocationTarget

string

Output only. The associated campaign location target, if one exists.
userList

string

Output only. The associated user list, if one exists.

ClickLocation

Location criteria associated with a click.

JSON representation 
{
  "city": string,
  "country": string,
  "metro": string,
  "mostSpecific": string,
  "region": string
}
Fields
city

string

The city location criterion associated with the impression.
country

string

The country location criterion associated with the impression.
metro

string

The metro location criterion associated with the impression.
mostSpecific

string

The most specific location criterion associated with the impression.
region

string

The region location criterion associated with the impression.

CurrencyConstant

A currency constant.

JSON representation 
{
  "resourceName": string,
  "code": string,
  "name": string,
  "symbol": string,
  "billableUnitMicros": string
}
Fields
resourceName

string

Output only. The resource name of the currency constant. Currency constant resource names have the form:

currencyConstants/{code}
code

string

Output only. ISO 4217 three-letter currency code, for example, "USD"
name

string

Output only. Full English name of the currency.
symbol

string

Output only. Standard symbol for describing this currency, for example, '$' for US Dollars.
billableUnitMicros

string (int64 format)

Output only. The billable unit for this currency. Billed amounts should be multiples of this value.

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 (BiddingStrategyType),
  "ownerCustomerId": string,
  "ownerDescriptiveName": string,

  // Union field scheme can be only one of the following:
  "maximizeConversionValue": {
    object (MaximizeConversionValue)
  },
  "maximizeConversions": {
    object (MaximizeConversions)
  },
  "targetCpa": {
    object (TargetCpa)
  },
  "targetImpressionShare": {
    object (TargetImpressionShare)
  },
  "targetRoas": {
    object (TargetRoas)
  },
  "targetSpend": {
    object (TargetSpend)
  }
  // End of list of possible types for union field scheme.
}
Fields
resourceName

string

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

customers/{customerId}/accessibleBiddingStrategies/{biddingStrategyId}
id

string (int64 format)

Output only. The ID of the bidding strategy.
name

string

Output only. The name of the bidding strategy.
type

enum (BiddingStrategyType)

Output only. The type of the bidding strategy.
ownerCustomerId

string (int64 format)

Output only. The ID of the Customer which owns the bidding strategy.
ownerDescriptiveName

string

Output only. descriptiveName of the Customer which owns the bidding strategy.

Union field scheme. The bidding scheme.

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

object (MaximizeConversionValue)

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

object (MaximizeConversions)

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

object (TargetCpa)

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

object (TargetImpressionShare)

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

object (TargetRoas)

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

object (TargetSpend)

Output only. 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

number

Output only. 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 
{
  "targetCpaMicros": string
}
Fields
targetCpaMicros

string (int64 format)

Output only. 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

string (int64 format)

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

TargetImpressionShare

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

JSON representation 
{
  "location": enum (TargetImpressionShareLocation),
  "locationFractionMicros": string,
  "cpcBidCeilingMicros": string
}
Fields
location

enum (TargetImpressionShareLocation)

Output only. The targeted location on the search results page.
locationFractionMicros

string (int64 format)

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

string (int64 format)

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

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

number

Output only. 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
(deprecated)

string (int64 format)

Output only. 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

string (int64 format)

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

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 (CustomerStatus),
  "clientCustomer": string,
  "hidden": boolean,
  "level": string,
  "timeZone": string,
  "testAccount": boolean,
  "manager": boolean,
  "descriptiveName": string,
  "currencyCode": string,
  "id": string
}
Fields
resourceName

string

Output only. The resource name of the customer client. CustomerClient resource names have the form: customers/{customerId}/customerClients/{client_customer_id}
appliedLabels[]

string

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

customers/{customerId}/labels/{label_id}
status

enum (CustomerStatus)

Output only. The status of the client customer. Read only.
clientCustomer

string

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

boolean

Output only. Specifies whether this is a hidden account. Read only.
level

string (int64 format)

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

string

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

boolean

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

boolean

Output only. Identifies if the client is a manager. Read only.
descriptiveName

string

Output only. Descriptive name for the client. Read only.
currencyCode

string

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

string (int64 format)

Output only. The ID of the client customer. Read only.

CustomerSearchTermInsight

A Customer search term view. Historical data is available starting March 2023.

JSON representation 
{
  "resourceName": string,
  "categoryLabel": string,
  "id": string
}
Fields
resourceName

string

Output only. The resource name of the customer level search term insight. Customer level search term insight resource names have the form:

customers/{customerId}/customerSearchTermInsights/{categoryId}
categoryLabel

string

Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.
id

string (int64 format)

Output only. The ID of the insight.

DetailPlacementView

A view with metrics aggregated by ad group and URL or YouTube video.

JSON representation 
{
  "resourceName": string,
  "placementType": enum (PlacementType),
  "placement": string,
  "displayName": string,
  "groupPlacementTargetUrl": string,
  "targetUrl": string
}
Fields
resourceName

string

Output only. The resource name of the detail placement view. Detail placement view resource names have the form:

customers/{customerId}/detailPlacementViews/{adGroupId}~{base64_placement}
placementType

enum (PlacementType)

Output only. Type of the placement, for example, Website, YouTube Video, and Mobile Application.
placement

string

Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID.
displayName

string

Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
groupPlacementTargetUrl

string

Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL.
targetUrl

string

Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.

PlacementType

Possible placement types for a feed mapping.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
WEBSITE Websites(for example, 'www.flowers4sale.com').
MOBILE_APP_CATEGORY Mobile application categories(for example, 'Games').
MOBILE_APPLICATION mobile applications(for example, 'mobileapp::2-com.whatsthewordanswers').
YOUTUBE_VIDEO YouTube videos(for example, 'youtube.com/video/wtLJPvx7-ys').
YOUTUBE_CHANNEL YouTube channels(for example, 'youtube.com::L8ZULXASCc1I_oaOT0NaOQ').
GOOGLE_PRODUCTS Surfaces owned and operated by Google(for example, 'tv.google.com').

DetailedDemographic

A detailed demographic: a particular interest-based vertical to be targeted to reach users based on long-term life facts.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "name": string,
  "parent": string,
  "launchedToAll": boolean,
  "availabilities": [
    {
      object (CriterionCategoryAvailability)
    }
  ]
}
Fields
resourceName

string

Output only. The resource name of the detailed demographic. Detailed demographic resource names have the form:

customers/{customerId}/detailedDemographics/{detailed_demographic_id}
id

string (int64 format)

Output only. The ID of the detailed demographic.
name

string

Output only. The name of the detailed demographic. For example,"Highest Level of Educational Attainment"
parent

string

Output only. The parent of the detailedDemographic.
launchedToAll

boolean

Output only. True if the detailed demographic is launched to all channels and locales.
availabilities[]

object (CriterionCategoryAvailability)

Output only. Availability information of the detailed demographic.

CriterionCategoryAvailability

Information of category availability, per advertising channel.

JSON representation 
{
  "channel": {
    object (CriterionCategoryChannelAvailability)
  },
  "locale": [
    {
      object (CriterionCategoryLocaleAvailability)
    }
  ]
}
Fields
channel

object (CriterionCategoryChannelAvailability)

Channel types and subtypes that are available to the category.
locale[]

object (CriterionCategoryLocaleAvailability)

Locales that are available to the category for the channel.

CriterionCategoryChannelAvailability

Information of advertising channel type and subtypes a category is available in.

JSON representation 
{
  "availabilityMode": enum (CriterionCategoryChannelAvailabilityMode),
  "advertisingChannelType": enum (AdvertisingChannelType),
  "advertisingChannelSubType": [
    enum (AdvertisingChannelSubType)
  ],
  "includeDefaultChannelSubType": boolean
}
Fields
availabilityMode

enum (CriterionCategoryChannelAvailabilityMode)

Format of the channel availability. Can be ALL_CHANNELS (the rest of the fields will not be set), CHANNEL_TYPE (only advertisingChannelType type will be set, the category is available to all sub types under it) or CHANNEL_TYPE_AND_SUBTYPES (advertisingChannelType, advertisingChannelSubType, and includeDefaultChannelSubType will all be set).
advertisingChannelType

enum (AdvertisingChannelType)

Channel type the category is available to.
advertisingChannelSubType[]

enum (AdvertisingChannelSubType)

Channel subtypes under the channel type the category is available to.
includeDefaultChannelSubType

boolean

Whether default channel sub type is included. For example, advertisingChannelType being DISPLAY and includeDefaultChannelSubType being false means that the default display campaign where channel sub type is not set is not included in this availability configuration.

CriterionCategoryChannelAvailabilityMode

Enum containing the possible CriterionCategoryChannelAvailabilityMode.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ALL_CHANNELS The category is available to campaigns of all channel types and subtypes.
CHANNEL_TYPE_AND_ALL_SUBTYPES The category is available to campaigns of a specific channel type, including all subtypes under it.
CHANNEL_TYPE_AND_SUBSET_SUBTYPES The category is available to campaigns of a specific channel type and subtype(s).

CriterionCategoryLocaleAvailability

Information about which locales a category is available in.

JSON representation 
{
  "availabilityMode": enum (CriterionCategoryLocaleAvailabilityMode),
  "countryCode": string,
  "languageCode": string
}
Fields
availabilityMode

enum (CriterionCategoryLocaleAvailabilityMode)

Format of the locale availability. Can be LAUNCHED_TO_ALL (both country and language will be empty), COUNTRY (only country will be set), LANGUAGE (only language wil be set), COUNTRY_AND_LANGUAGE (both country and language will be set).
countryCode

string

The ISO-3166-1 alpha-2 country code associated with the category.
languageCode

string

ISO 639-1 code of the language associated with the category.

CriterionCategoryLocaleAvailabilityMode

Enum containing the possible CriterionCategoryLocaleAvailabilityMode.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ALL_LOCALES The category is available to campaigns of all locales.
COUNTRY_AND_ALL_LANGUAGES The category is available to campaigns within a list of countries, regardless of language.
LANGUAGE_AND_ALL_COUNTRIES The category is available to campaigns within a list of languages, regardless of country.
COUNTRY_AND_LANGUAGE The category is available to campaigns within a list of country, language pairs.

DisplayKeywordView

A display keyword view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the display keyword view. Display Keyword view resource names have the form:

customers/{customerId}/displayKeywordViews/{adGroupId}~{criterionId}

DistanceView

A distance view with metrics aggregated by the user's distance from an advertiser's location extensions. Each DistanceBucket includes all impressions that fall within its distance and a single impression will contribute to the metrics for all DistanceBuckets that include the user's distance.

JSON representation 
{
  "resourceName": string,
  "distanceBucket": enum (DistanceBucket),
  "metricSystem": boolean
}
Fields
resourceName

string

Output only. The resource name of the distance view. Distance view resource names have the form:

customers/{customerId}/distanceViews/1~{distanceBucket}
distanceBucket

enum (DistanceBucket)

Output only. Grouping of user distance from location extensions.
metricSystem

boolean

Output only. True if the DistanceBucket is using the metric system, false otherwise.

DistanceBucket

The distance bucket for a user's distance from an advertiser's location extension.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
WITHIN_700M User was within 700m of the location.
WITHIN_1KM User was within 1KM of the location.
WITHIN_5KM User was within 5KM of the location.
WITHIN_10KM User was within 10KM of the location.
WITHIN_15KM User was within 15KM of the location.
WITHIN_20KM User was within 20KM of the location.
WITHIN_25KM User was within 25KM of the location.
WITHIN_30KM User was within 30KM of the location.
WITHIN_35KM User was within 35KM of the location.
WITHIN_40KM User was within 40KM of the location.
WITHIN_45KM User was within 45KM of the location.
WITHIN_50KM User was within 50KM of the location.
WITHIN_55KM User was within 55KM of the location.
WITHIN_60KM User was within 60KM of the location.
WITHIN_65KM User was within 65KM of the location.
BEYOND_65KM User was beyond 65KM of the location.
WITHIN_0_7MILES User was within 0.7 miles of the location.
WITHIN_1MILE User was within 1 mile of the location.
WITHIN_5MILES User was within 5 miles of the location.
WITHIN_10MILES User was within 10 miles of the location.
WITHIN_15MILES User was within 15 miles of the location.
WITHIN_20MILES User was within 20 miles of the location.
WITHIN_25MILES User was within 25 miles of the location.
WITHIN_30MILES User was within 30 miles of the location.
WITHIN_35MILES User was within 35 miles of the location.
WITHIN_40MILES User was within 40 miles of the location.
BEYOND_40MILES User was beyond 40 miles of the location.

DynamicSearchAdsSearchTermView

A dynamic search ads search term view.

JSON representation 
{
  "resourceName": string,
  "searchTerm": string,
  "headline": string,
  "landingPage": string,
  "pageUrl": string,
  "hasNegativeKeyword": boolean,
  "hasMatchingKeyword": boolean,
  "hasNegativeUrl": boolean
}
Fields
resourceName

string

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

customers/{customerId}/dynamicSearchAdsSearchTermViews/{adGroupId}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}
searchTerm

string

Output only. Search term

This field is read-only.
headline

string

Output only. The dynamically generated headline of the Dynamic Search Ad.

This field is read-only.
landingPage

string

Output only. The dynamically selected landing page URL of the impression.

This field is read-only.
pageUrl

string

Output only. The URL of page feed item served for the impression.

This field is read-only.
hasNegativeKeyword

boolean

Output only. True if query matches a negative keyword.

This field is read-only.
hasMatchingKeyword

boolean

Output only. True if query is added to targeted keywords.

This field is read-only.
hasNegativeUrl

boolean

Output only. True if query matches a negative url.

This field is read-only.

ExpandedLandingPageView

A landing page view with metrics aggregated at the expanded final URL level.

JSON representation 
{
  "resourceName": string,
  "expandedFinalUrl": string
}
Fields
resourceName

string

Output only. The resource name of the expanded landing page view. Expanded landing page view resource names have the form:

customers/{customerId}/expandedLandingPageViews/{expanded_final_url_fingerprint}
expandedFinalUrl

string

Output only. The final URL that clicks are directed to.

FeedPlaceholderView

A feed placeholder view.

JSON representation 
{
  "resourceName": string,
  "placeholderType": enum (PlaceholderType)
}
Fields
resourceName

string

Output only. The resource name of the feed placeholder view. Feed placeholder view resource names have the form:

customers/{customerId}/feedPlaceholderViews/{placeholderType}
placeholderType

enum (PlaceholderType)

Output only. The placeholder type of the feed placeholder view.

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

string

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

customers/{customerId}/genderViews/{adGroupId}~{criterionId}

GeographicView

A geographic view.

Geographic View includes all metrics aggregated at the country level, one row per country. It reports metrics at either actual physical location of the user or an area of interest. If other segment fields are used, you may get more than one row per country.

JSON representation 
{
  "resourceName": string,
  "locationType": enum (GeoTargetingType),
  "countryCriterionId": string
}
Fields
resourceName

string

Output only. The resource name of the geographic view. Geographic view resource names have the form:

customers/{customerId}/geographicViews/{countryCriterionId}~{locationType}
locationType

enum (GeoTargetingType)

Output only. Type of the geo targeting of the campaign.
countryCriterionId

string (int64 format)

Output only. Criterion Id for the country.

GeoTargetingType

The possible geo targeting types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
AREA_OF_INTEREST Location the user is interested in while making the query.
LOCATION_OF_PRESENCE Location of the user issuing the query.

GroupPlacementView

A group placement view.

JSON representation 
{
  "resourceName": string,
  "placementType": enum (PlacementType),
  "placement": string,
  "displayName": string,
  "targetUrl": string
}
Fields
resourceName

string

Output only. The resource name of the group placement view. Group placement view resource names have the form:

customers/{customerId}/groupPlacementViews/{adGroupId}~{base64_placement}
placementType

enum (PlacementType)

Output only. Type of the placement, for example, Website, YouTube Channel, Mobile Application.
placement

string

Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID.
displayName

string

Output only. Domain name for websites and YouTube channel name for YouTube channels.
targetUrl

string

Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL.

HotelGroupView

A hotel group view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the hotel group view. Hotel Group view resource names have the form:

customers/{customerId}/hotelGroupViews/{adGroupId}~{criterionId}

HotelPerformanceView

A hotel performance view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the hotel performance view. Hotel performance view resource names have the form:

customers/{customerId}/hotelPerformanceView

HotelReconciliation

A hotel reconciliation. It contains conversion information from Hotel bookings to reconcile with advertiser records. These rows may be updated or canceled before billing through Bulk Uploads.

JSON representation 
{
  "resourceName": string,
  "commissionId": string,
  "orderId": string,
  "campaign": string,
  "hotelCenterId": string,
  "hotelId": string,
  "checkInDate": string,
  "checkOutDate": string,
  "reconciledValueMicros": string,
  "billed": boolean,
  "status": enum (HotelReconciliationStatus)
}
Fields
resourceName

string

Immutable. The resource name of the hotel reconciliation. Hotel reconciliation resource names have the form:

customers/{customerId}/hotelReconciliations/{commissionId}
commissionId

string

Required. Output only. The commission ID is Google's ID for this booking. Every booking event is assigned a Commission ID to help you match it to a guest stay.
orderId

string

Output only. The order ID is the identifier for this booking as provided in the 'transaction_id' parameter of the conversion tracking tag.
campaign

string

Output only. The resource name for the Campaign associated with the conversion.
hotelCenterId

string (int64 format)

Output only. Identifier for the Hotel Center account which provides the rates for the Hotel campaign.
hotelId

string

Output only. Unique identifier for the booked property, as provided in the Hotel Center feed. The hotel ID comes from the 'ID' parameter of the conversion tracking tag.
checkInDate

string

Output only. Check-in date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.
checkOutDate

string

Output only. Check-out date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.
reconciledValueMicros

string (int64 format)

Required. Output only. Reconciled value is the final value of a booking as paid by the guest. If original booking value changes for any reason, such as itinerary changes or room upsells, the reconciled value should be the full final amount collected. If a booking is canceled, the reconciled value should include the value of any cancellation fees or non-refundable nights charged. Value is in millionths of the base unit currency. For example, $12.35 would be represented as 12350000. Currency unit is in the default customer currency.
billed

boolean

Output only. Whether a given booking has been billed. Once billed, a booking can't be modified.
status

enum (HotelReconciliationStatus)

Required. Output only. Current status of a booking with regards to reconciliation and billing. Bookings should be reconciled within 45 days after the check-out date. Any booking not reconciled within 45 days will be billed at its original value.

HotelReconciliationStatus

Status of the hotel booking reconciliation.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
RESERVATION_ENABLED Bookings are for a future date, or a stay is underway but the check-out date hasn't passed. An active reservation can't be reconciled.
RECONCILIATION_NEEDED Check-out has already taken place, or the booked dates have passed without cancellation. Bookings that are not reconciled within 45 days of the check-out date are billed based on the original booking price.
RECONCILED These bookings have been reconciled. Reconciled bookings are billed 45 days after the check-out date.
CANCELED This booking was marked as canceled. Canceled stays with a value greater than zero (due to minimum stay rules or cancellation fees) are billed 45 days after the check-out date.

IncomeRangeView

An income range view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the income range view. Income range view resource names have the form:

customers/{customerId}/incomeRangeViews/{adGroupId}~{criterionId}

KeywordView

A keyword view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

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

customers/{customerId}/keywordViews/{adGroupId}~{criterionId}

LandingPageView

A landing page view with metrics aggregated at the unexpanded final URL level.

JSON representation 
{
  "resourceName": string,
  "unexpandedFinalUrl": string
}
Fields
resourceName

string

Output only. The resource name of the landing page view. Landing page view resource names have the form:

customers/{customerId}/landingPageViews/{unexpanded_final_url_fingerprint}
unexpandedFinalUrl

string

Output only. The advertiser-specified final URL.

LanguageConstant

A language.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "code": string,
  "name": string,
  "targetable": boolean
}
Fields
resourceName

string

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

languageConstants/{criterionId}
id

string (int64 format)

Output only. The ID of the language constant.
code

string

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

string

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

boolean

Output only. Whether the language is targetable.

LocationView

A location view summarizes the performance of campaigns by a Location criterion. If no Location criterion is set, no results are returned; instead, use geographicView or userLocationView for visitor location data.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

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

customers/{customerId}/locationViews/{campaignId}~{criterionId}

ManagedPlacementView

A managed placement view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the Managed Placement view. Managed placement view resource names have the form:

customers/{customerId}/managedPlacementViews/{adGroupId}~{criterionId}

MediaFile

A media file.

JSON representation 
{
  "resourceName": string,
  "type": enum (MediaType),
  "mimeType": enum (MimeType),
  "id": string,
  "sourceUrl": string,
  "name": string,
  "fileSize": string,

  // Union field mediatype can be only one of the following:
  "image": {
    object (MediaImage)
  },
  "mediaBundle": {
    object (MediaBundle)
  },
  "audio": {
    object (MediaAudio)
  },
  "video": {
    object (MediaVideo)
  }
  // End of list of possible types for union field mediatype.
}
Fields
resourceName

string

Immutable. The resource name of the media file. Media file resource names have the form:

customers/{customerId}/mediaFiles/{media_file_id}
type

enum (MediaType)

Immutable. Type of the media file.
mimeType

enum (MimeType)

Output only. The mime type of the media file.
id

string (int64 format)

Output only. The ID of the media file.
sourceUrl

string

Immutable. The URL of where the original media file was downloaded from (or a file name). Only used for media of type AUDIO and IMAGE.
name

string

Immutable. The name of the media file. The name can be used by clients to help identify previously uploaded media.
fileSize

string (int64 format)

Output only. The size of the media file in bytes.
Union field mediatype. The specific type of the media file. mediatype can be only one of the following:
image

object (MediaImage)

Immutable. Encapsulates an Image.
mediaBundle

object (MediaBundle)

Immutable. A ZIP archive media the content of which contains HTML5 assets.
audio

object (MediaAudio)

Output only. Encapsulates an Audio.
video

object (MediaVideo)

Immutable. Encapsulates a Video.

MediaType

The type of media.

Enums
UNSPECIFIED The media type has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
IMAGE Static image, used for image ad.
ICON Small image, used for map ad.
MEDIA_BUNDLE ZIP file, used in fields of template ads.
AUDIO Audio file.
VIDEO Video file.
DYNAMIC_IMAGE Animated image, such as animated GIF.

MediaImage

Encapsulates an Image.

JSON representation 
{
  "data": string,
  "fullSizeImageUrl": string,
  "previewSizeImageUrl": string
}
Fields
data

string (bytes format)

Immutable. Raw image data.

A base64-encoded string.
fullSizeImageUrl

string

Output only. The url to the full size version of the image.
previewSizeImageUrl

string

Output only. The url to the preview size version of the image.

MediaBundle

Represents a ZIP archive media the content of which contains HTML5 assets.

JSON representation 
{
  "data": string,
  "url": string
}
Fields
data

string (bytes format)

Immutable. Raw zipped data.

A base64-encoded string.
url

string

Output only. The url to access the uploaded zipped data. For example, https://tpc.googlesyndication.com/simgad/123 This field is read-only.

MediaAudio

Encapsulates an Audio.

JSON representation 
{
  "adDurationMillis": string
}
Fields
adDurationMillis

string (int64 format)

Output only. The duration of the Audio in milliseconds.

MediaVideo

Encapsulates a Video.

JSON representation 
{
  "adDurationMillis": string,
  "youtubeVideoId": string,
  "advertisingIdCode": string,
  "isciCode": string
}
Fields
adDurationMillis

string (int64 format)

Output only. The duration of the Video in milliseconds.
youtubeVideoId

string

Immutable. The YouTube video ID (as seen in YouTube URLs). Adding prefix "https://www.youtube.com/watch?v=" to this ID will get the YouTube streaming URL for this video.
advertisingIdCode

string

Output only. The Advertising Digital Identification code for this video, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
isciCode

string

Output only. The Industry Standard Commercial Identifier code for this video, used mainly for television commercials.

LocalServicesEmployee

A local services employee resource.

JSON representation 
{
  "resourceName": string,
  "creationDateTime": string,
  "status": enum (LocalServicesEmployeeStatus),
  "type": enum (LocalServicesEmployeeType),
  "universityDegrees": [
    {
      object (UniversityDegree)
    }
  ],
  "residencies": [
    {
      object (Residency)
    }
  ],
  "fellowships": [
    {
      object (Fellowship)
    }
  ],
  "languagesSpoken": [
    string
  ],
  "categoryIds": [
    string
  ],
  "id": string,
  "jobTitle": string,
  "yearStartedPracticing": integer,
  "nationalProviderIdNumber": string,
  "emailAddress": string,
  "firstName": string,
  "middleName": string,
  "lastName": string
}
Fields
resourceName

string

Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form:

customers/{customerId}/localServicesEmployees/{gls_employee_id}
creationDateTime

string

Output only. Timestamp of employee creation. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
status

enum (LocalServicesEmployeeStatus)

Output only. Employee status, such as DELETED or ENABLED.
type

enum (LocalServicesEmployeeType)

Output only. Employee type.
universityDegrees[]

object (UniversityDegree)

Output only. A list of degrees this employee has obtained, and wants to feature.
residencies[]

object (Residency)

Output only. The institutions where the employee has completed their residency.
fellowships[]

object (Fellowship)

Output only. The institutions where the employee has completed their fellowship.
languagesSpoken[]

string

Output only. Languages that the employee speaks, represented as language tags from https://developers.google.com/admin-sdk/directory/v1/languages
categoryIds[]

string

Output only. Category of the employee. A list of Local Services category IDs can be found at https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids.
id

string (int64 format)

Output only. The ID of the employee.
jobTitle

string

Output only. Job title for this employee, such as "Senior partner" in legal verticals.
yearStartedPracticing

integer

Output only. The year that this employee started practicing in this field.
nationalProviderIdNumber

string

Output only. NPI id associated with the employee.
emailAddress

string

Output only. Email address of the employee.
firstName

string

Output only. First name of the employee.
middleName

string

Output only. Middle name of the employee.
lastName

string

Output only. Last name of the employee.

LocalServicesEmployeeStatus

Enums describing statuses of a local services employee.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Employee is not removed, and employee status is active.
REMOVED Employee is removed. Used to delete an employee from the business.

LocalServicesEmployeeType

Enums describing types of a local services employee.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BUSINESS_OWNER Represents the owner of the business.
EMPLOYEE Represents an employee of the business.

UniversityDegree

A list of degrees this employee has obtained, and wants to feature.

JSON representation 
{
  "institutionName": string,
  "degree": string,
  "graduationYear": integer
}
Fields
institutionName

string

Output only. Name of the university at which the degree was obtained.
degree

string

Output only. Name of the degree obtained.
graduationYear

integer

Output only. Year of graduation.

Residency

Details about the employee's medical residency. Residency is a stage of graduate medical education in which a qualified medical professional practices under the supervision of a senior clinician.

JSON representation 
{
  "institutionName": string,
  "completionYear": integer
}
Fields
institutionName

string

Output only. Name of the institution at which the residency was completed.
completionYear

integer

Output only. Year of completion.

Fellowship

Details about the employee's medical Fellowship. Fellowship is a period of medical training that the professional undertakes after finishing their residency.

JSON representation 
{
  "institutionName": string,
  "completionYear": integer
}
Fields
institutionName

string

Output only. Name of the instutition at which the fellowship was completed.
completionYear

integer

Output only. Year of completion.

LocalServicesVerificationArtifact

A local services verification resource.

JSON representation 
{
  "resourceName": string,
  "creationDateTime": string,
  "status": enum (LocalServicesVerificationArtifactStatus),
  "artifactType": enum (LocalServicesVerificationArtifactType),
  "id": string,

  // Union field artifact_data can be only one of the following:
  "backgroundCheckVerificationArtifact": {
    object (BackgroundCheckVerificationArtifact)
  },
  "insuranceVerificationArtifact": {
    object (InsuranceVerificationArtifact)
  },
  "licenseVerificationArtifact": {
    object (LicenseVerificationArtifact)
  },
  "businessRegistrationCheckVerificationArtifact": {
    object (BusinessRegistrationCheckVerificationArtifact)
  }
  // End of list of possible types for union field artifact_data.
}
Fields
resourceName

string

Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form:

customers/{customerId}/localServicesVerificationArtifacts/{verification_artifact_id}
creationDateTime

string

Output only. The timestamp when this verification artifact was created. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
status

enum (LocalServicesVerificationArtifactStatus)

Output only. The status of the verification artifact.
artifactType

enum (LocalServicesVerificationArtifactType)

Output only. The type of the verification artifact.
id

string (int64 format)

Output only. The ID of the verification artifact.
Union field artifact_data. The types of verification info. artifact_data can be only one of the following:
backgroundCheckVerificationArtifact

object (BackgroundCheckVerificationArtifact)

Output only. A background check verification artifact.
insuranceVerificationArtifact

object (InsuranceVerificationArtifact)

Output only. An insurance verification artifact.
licenseVerificationArtifact

object (LicenseVerificationArtifact)

Output only. A license verification artifact.
businessRegistrationCheckVerificationArtifact

object (BusinessRegistrationCheckVerificationArtifact)

Output only. A business registration check verification artifact.

LocalServicesVerificationArtifactStatus

Enums describing statuses of a local services verification artifact.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PASSED Artifact has passed verification.
FAILED Artifact has failed verification.
PENDING Artifact is in the process of verification.
NO_SUBMISSION Artifact needs user to upload information before it is verified.
CANCELLED Artifact has been cancelled by the user.

LocalServicesVerificationArtifactType

Enums describing possible types of local services verification artifact.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BACKGROUND_CHECK Background check verification artifact.
INSURANCE Insurance verification artifact.
LICENSE License verification artifact.
BUSINESS_REGISTRATION_CHECK Business registration check verification artifact.

BackgroundCheckVerificationArtifact

A proto holding information specific to local services background check.

JSON representation 
{
  "caseUrl": string,
  "finalAdjudicationDateTime": string
}
Fields
caseUrl

string

Output only. URL to access background case.
finalAdjudicationDateTime

string

Output only. The timestamp when this background check case result was adjudicated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

InsuranceVerificationArtifact

A proto holding information specific to a local services insurance.

JSON representation 
{
  "amountMicros": string,
  "rejectionReason": enum (LocalServicesInsuranceRejectionReason),
  "insuranceDocumentReadonly": {
    object (LocalServicesDocumentReadOnly)
  }
}
Fields
amountMicros

string (int64 format)

Output only. Insurance amount. This is measured in "micros" of the currency mentioned in the insurance document.
rejectionReason

enum (LocalServicesInsuranceRejectionReason)

Output only. Insurance document's rejection reason.
insuranceDocumentReadonly

object (LocalServicesDocumentReadOnly)

Output only. The readonly field containing the information for an uploaded insurance document.

LocalServicesInsuranceRejectionReason

Enums describing possible rejection reasons of a local services insurance verification artifact.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BUSINESS_NAME_MISMATCH Business name doesn't match business name for the Local Services Ad.
INSURANCE_AMOUNT_INSUFFICIENT Insurance amount doesn't meet requirement listed in the legal summaries documentation for that geographic + category ID combination.
EXPIRED Insurance document is expired.
NO_SIGNATURE Insurance document is missing a signature.
NO_POLICY_NUMBER Insurance document is missing a policy number.
NO_COMMERCIAL_GENERAL_LIABILITY Commercial General Liability(CGL) box is not marked in the insurance document.
EDITABLE_FORMAT Insurance document is in an editable format.
CATEGORY_MISMATCH Insurance document does not cover insurance for a particular category.
MISSING_EXPIRATION_DATE Insurance document is missing an expiration date.
POOR_QUALITY Insurance document is poor quality - blurry images, illegible, etc...
POTENTIALLY_EDITED Insurance document is suspected of being edited.
WRONG_DOCUMENT_TYPE Insurance document not accepted. For example, documents of insurance proposals, but missing coverages are not accepted.
NON_FINAL Insurance document is not final.
OTHER Insurance document has another flaw not listed explicitly.

LocalServicesDocumentReadOnly

A Local Services Document with read only accessible data.

JSON representation 
{
  "documentUrl": string
}
Fields
documentUrl

string

URL to access an already uploaded Local Services document.

LicenseVerificationArtifact

A proto holding information specific to a local services license.

JSON representation 
{
  "licenseType": string,
  "licenseNumber": string,
  "licenseeFirstName": string,
  "licenseeLastName": string,
  "rejectionReason": enum (LocalServicesLicenseRejectionReason),
  "licenseDocumentReadonly": {
    object (LocalServicesDocumentReadOnly)
  }
}
Fields
licenseType

string

Output only. License type / name.
licenseNumber

string

Output only. License number.
licenseeFirstName

string

Output only. First name of the licensee.
licenseeLastName

string

Output only. Last name of the licensee.
rejectionReason

enum (LocalServicesLicenseRejectionReason)

Output only. License rejection reason.
licenseDocumentReadonly

object (LocalServicesDocumentReadOnly)

Output only. The readonly field containing the information for an uploaded license document.

LocalServicesLicenseRejectionReason

Enums describing possible rejection reasons of a local services license verification artifact.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BUSINESS_NAME_MISMATCH Business name doesn't match business name for the Local Services Ad.
UNAUTHORIZED License is unauthorized or been revoked.
EXPIRED License is expired.
POOR_QUALITY License is poor quality - blurry images, illegible, etc...
UNVERIFIABLE License cannot be verified due to a not legitimate image.
WRONG_DOCUMENT_OR_ID License is not the requested document type or contains an invalid ID.
OTHER License has another flaw not listed explicitly.

BusinessRegistrationCheckVerificationArtifact

A proto holding information specific to a local services business registration check.

JSON representation 
{
  "registrationType": enum (LocalServicesBusinessRegistrationType),
  "checkId": string,
  "rejectionReason": enum (LocalServicesBusinessRegistrationCheckRejectionReason),

  // Union field business_registration can be only one of the following:
  "registrationNumber": {
    object (BusinessRegistrationNumber)
  },
  "registrationDocument": {
    object (BusinessRegistrationDocument)
  }
  // End of list of possible types for union field business_registration.
}
Fields
registrationType

enum (LocalServicesBusinessRegistrationType)

Output only. The type of business registration check (number, document).
checkId

string

Output only. The id of the check, such as vat_tax_id, representing "VAT Tax ID" requirement.
rejectionReason

enum (LocalServicesBusinessRegistrationCheckRejectionReason)

Output only. Registration document rejection reason.
Union field business_registration. Registration information for the business registration. It will be one of the following forms based on the requirement from different countries. business_registration can be only one of the following:
registrationNumber

object (BusinessRegistrationNumber)

Output only. Message storing government issued number for the business.
registrationDocument

object (BusinessRegistrationDocument)

Output only. Message storing document info for the business.

LocalServicesBusinessRegistrationType

Enums describing possible registration types of a local services business registration check verification artifact.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NUMBER Registration number check type.
DOCUMENT Registration document check type.

LocalServicesBusinessRegistrationCheckRejectionReason

Enums describing possible rejection reasons of a local services business registration check verification artifact.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BUSINESS_NAME_MISMATCH Business name doesn't match business name for the Local Services Ad.
BUSINESS_DETAILS_MISMATCH Business details mismatch.
ID_NOT_FOUND Business registration ID not found.
POOR_DOCUMENT_IMAGE_QUALITY Uploaded document not clear, blurry, etc.
DOCUMENT_EXPIRED Uploaded document has expired.
DOCUMENT_INVALID Document revoked or annuled.
DOCUMENT_TYPE_MISMATCH Document type mismatch.
DOCUMENT_UNVERIFIABLE Uploaded document could not be verified as legitimate.
OTHER The business registration process could not be completed due to an issue. Contact https://support.google.com/localservices to learn more.

BusinessRegistrationNumber

A proto holding information specific to a local services business registration number.

JSON representation 
{
  "number": string
}
Fields
number

string

Output only. Government-issued number for the business.

BusinessRegistrationDocument

A proto holding information specific to a local services business registration document.

JSON representation 
{
  "documentReadonly": {
    object (LocalServicesDocumentReadOnly)
  }
}
Fields
documentReadonly

object (LocalServicesDocumentReadOnly)

Output only. The readonly field containing the information for an uploaded business registration document.

MobileAppCategoryConstant

A mobile application category constant.

JSON representation 
{
  "resourceName": string,
  "id": integer,
  "name": string
}
Fields
resourceName

string

Output only. The resource name of the mobile app category constant. Mobile app category constant resource names have the form:

mobileAppCategoryConstants/{mobile_app_category_id}
id

integer

Output only. The ID of the mobile app category constant.
name

string

Output only. Mobile app category name.

MobileDeviceConstant

A mobile device constant.

JSON representation 
{
  "resourceName": string,
  "type": enum (MobileDeviceType),
  "id": string,
  "name": string,
  "manufacturerName": string,
  "operatingSystemName": string
}
Fields
resourceName

string

Output only. The resource name of the mobile device constant. Mobile device constant resource names have the form:

mobileDeviceConstants/{criterionId}
type

enum (MobileDeviceType)

Output only. The type of mobile device.
id

string (int64 format)

Output only. The ID of the mobile device constant.
name

string

Output only. The name of the mobile device.
manufacturerName

string

Output only. The manufacturer of the mobile device.
operatingSystemName

string

Output only. The operating system of the mobile device.

MobileDeviceType

The type of mobile device.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MOBILE Mobile phones.
TABLET Tablets.

OfflineConversionUploadClientSummary

Offline conversion upload client summary.

JSON representation 
{
  "resourceName": string,
  "client": enum (OfflineEventUploadClient),
  "status": enum (OfflineConversionDiagnosticStatus),
  "totalEventCount": string,
  "successfulEventCount": string,
  "successRate": number,
  "lastUploadDateTime": string,
  "dailySummaries": [
    {
      object (OfflineConversionSummary)
    }
  ],
  "jobSummaries": [
    {
      object (OfflineConversionSummary)
    }
  ],
  "alerts": [
    {
      object (OfflineConversionAlert)
    }
  ]
}
Fields
resourceName

string

Output only. The resource name of the offline conversion upload client summary. Offline conversion upload client summary resource names have the form:

customers/{customerId}/offlineConversionUploadClientSummaries/{client}
client

enum (OfflineEventUploadClient)

Output only. Client type of the upload event.
status

enum (OfflineConversionDiagnosticStatus)

Output only. Overall status for offline conversion client summary. Status is generated from most recent calendar day with upload stats
totalEventCount

string (int64 format)

Output only. Total count of uploaded events.
successfulEventCount

string (int64 format)

Output only. Total count of successful uploaded events.
successRate

number

Output only. Successful rate.
lastUploadDateTime

string

Output only. Date for the latest upload batch. The format is "yyyy-mm-dd hh:mm:ss", and it's in the time zone of the Google Ads account.
dailySummaries[]

object (OfflineConversionSummary)

Output only. Summary of history stats by last N days.
jobSummaries[]

object (OfflineConversionSummary)

Output only. Summary of history stats by last N jobs.
alerts[]

object (OfflineConversionAlert)

Output only. Details for each error code. Alerts are generated from most recent calendar day with upload stats.

OfflineEventUploadClient

Type of client.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
GOOGLE_ADS_API Google Ads API.
GOOGLE_ADS_WEB_CLIENT Google Ads web client, which could include multiple sources like Ads UI, SFTP, etc.
ADS_DATA_CONNECTOR Connection platform.

OfflineConversionDiagnosticStatus

Possible statuses of the offline ingestion setup.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
EXCELLENT Your offline data ingestion setup is active and optimal for downstream processing.
GOOD Your offline ingestion setup is active, but there are further improvements you could make. See alerts.
NEEDS_ATTENTION Your offline ingestion setup is active, but there are errors that require your attention. See alerts.
NO_RECENT_UPLOAD Your offline ingestion setup has not received data in the last 28 days, there may be something wrong.

OfflineConversionSummary

Historical upload summary, grouped by upload date or job.

JSON representation 
{
  "successfulCount": string,
  "failedCount": string,

  // Union field dimension_key can be only one of the following:
  "jobId": string,
  "uploadDate": string
  // End of list of possible types for union field dimension_key.
}
Fields
successfulCount

string (int64 format)

Output only. Total count of successful event.
failedCount

string (int64 format)

Output only. Total count of failed event.
Union field dimension_key. Dimension key for summary. dimension_key can be only one of the following:
jobId

string (int64 format)

Output only. Dimension key for last N jobs.
uploadDate

string

Output only. Dimension key for last N days.

OfflineConversionAlert

Alert for offline conversion client summary.

JSON representation 
{
  "error": {
    object (OfflineConversionError)
  },
  "errorPercentage": number
}
Fields
error

object (OfflineConversionError)

Output only. Error for offline conversion client alert.
errorPercentage

number

Output only. Percentage of the error, the range of this field should be [0, 1.0].

OfflineConversionError

Possible errors for offline conversion client summary.

JSON representation 
{

  // Union field error_code can be only one of the following:
  "collectionSizeError": enum (CollectionSizeError),
  "conversionAdjustmentUploadError": enum (ConversionAdjustmentUploadError),
  "conversionUploadError": enum (ConversionUploadError),
  "dateError": enum (DateError),
  "distinctError": enum (DistinctError),
  "fieldError": enum (FieldError),
  "mutateError": enum (MutateError),
  "notAllowlistedError": enum (NotAllowlistedError),
  "stringFormatError": enum (StringFormatError),
  "stringLengthError": enum (StringLengthError)
  // End of list of possible types for union field error_code.
}
Fields
Union field error_code. Error with description. error_code can be only one of the following:
collectionSizeError

enum (CollectionSizeError)

Output only. Collection size error.
conversionAdjustmentUploadError

enum (ConversionAdjustmentUploadError)

Output only. Conversion adjustment upload error.
conversionUploadError

enum (ConversionUploadError)

Output only. Conversion upload error.
dateError

enum (DateError)

Output only. Date error.
distinctError

enum (DistinctError)

Output only. Distinct error.
fieldError

enum (FieldError)

Output only. Field error.
mutateError

enum (MutateError)

Output only. Mutate error.
notAllowlistedError

enum (NotAllowlistedError)

Output only. Not allowlisted error.
stringFormatError

enum (StringFormatError)

Output only. String format error.
stringLengthError

enum (StringLengthError)

Output only. String length error.

CollectionSizeError

Enum describing possible collection size errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
TOO_FEW Too few.
TOO_MANY Too many.

ConversionAdjustmentUploadError

Enum describing possible conversion adjustment upload errors.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
TOO_RECENT_CONVERSION_ACTION Can't import events to a conversion action that was just created. Try importing again in 6 hours.
CONVERSION_ALREADY_RETRACTED The conversion was already retracted. This adjustment was not processed.
CONVERSION_NOT_FOUND The conversion for this conversion action and conversion identifier can't be found. Make sure your conversion identifiers are associated with the correct conversion action and try again.
CONVERSION_EXPIRED Adjustment can't be made to a conversion that occurred more than 54 days ago.
ADJUSTMENT_PRECEDES_CONVERSION Adjustment has an adjustmentDateTime that occurred before the associated conversion. Make sure your adjustmentDateTime is correct and try again.
MORE_RECENT_RESTATEMENT_FOUND More recent adjustment adjustmentDateTime has already been reported for the associated conversion. Make sure your adjustment adjustmentDateTime is correct and try again.
TOO_RECENT_CONVERSION Adjustment can't be recorded because the conversion occurred too recently. Try adjusting a conversion that occurred at least 24 hours ago.
CANNOT_RESTATE_CONVERSION_ACTION_THAT_ALWAYS_USES_DEFAULT_CONVERSION_VALUE Can't make an adjustment to a conversion that is set up to use the default value. Check your conversion action value setting and try again.
TOO_MANY_ADJUSTMENTS_IN_REQUEST Try uploading fewer than 2001 adjustments in a single API request.
TOO_MANY_ADJUSTMENTS The conversion has already been adjusted the maximum number of times. Make sure you're only making necessary adjustment to existing conversion.
RESTATEMENT_ALREADY_EXISTS The conversion has prior a restatement with the same adjustmentDateTime. Make sure your adjustment has the correct and unique adjustmentDateTime and try again.
DUPLICATE_ADJUSTMENT_IN_REQUEST Imported adjustment has a duplicate conversion adjustment with same adjustmentDateTime. Make sure your adjustment has the correct adjustmentDateTime and try again.
CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS Make sure you agree to the customer data processing terms in conversion settings and try again.
CONVERSION_ACTION_NOT_ELIGIBLE_FOR_ENHANCEMENT Can't use enhanced conversions with the specified conversion action.
INVALID_USER_IDENTIFIER Make sure you hash user provided data using SHA-256 and ensure you are normalizing according to the guidelines.
UNSUPPORTED_USER_IDENTIFIER Use user provided data such as emails or phone numbers hashed using SHA-256 and try again.
GCLID_DATE_TIME_PAIR_AND_ORDER_ID_BOTH_SET Cannot set both gclidDateTimePair and orderId. Use only 1 type and try again.
CONVERSION_ALREADY_ENHANCED Conversion already has enhancements with the same Order ID and conversion action. Make sure your data is correctly configured and try again.
DUPLICATE_ENHANCEMENT_IN_REQUEST Multiple enhancements have the same conversion action and Order ID. Make sure your data is correctly configured and try again.
CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCEMENT Enhanced conversions can't be used for this account because of Google customer data policies. Contact your Google representative.
MISSING_ORDER_ID_FOR_WEBPAGE Adjustment for website conversion requires Order ID (ie, transaction ID). Make sure your website tags capture Order IDs and you send the same Order IDs with your adjustment.
ORDER_ID_CONTAINS_PII Can't use adjustment with Order IDs containing personally-identifiable information (PII).
INVALID_JOB_ID The provided job id in the request is not within the allowed range. A job ID must be a positive integer in the range [1, 2^31).
NO_CONVERSION_ACTION_FOUND The conversion action specified in the adjustment request cannot be found. Make sure it's available in this account.
INVALID_CONVERSION_ACTION_TYPE The type of the conversion action specified in the adjustment request isn't supported for uploading adjustments. A conversion adjustment of type RETRACTION or RESTATEMENT is only permitted for conversion actions of type SALESFORCE, UPLOAD_CLICK or WEBPAGE. A conversion adjustment of type ENHANCEMENT is only permitted for conversion actions of type WEBPAGE.

ConversionUploadError

Enum describing possible conversion upload errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN Used for return value only. Represents value unknown in this version.
TOO_MANY_CONVERSIONS_IN_REQUEST Upload fewer than 2001 events in a single request.
UNPARSEABLE_GCLID The imported gclid could not be decoded. Make sure you have not modified the click IDs.
CONVERSION_PRECEDES_EVENT The imported event has a conversionDateTime that precedes the click. Make sure your conversionDateTime is correct and try again.
EXPIRED_EVENT The imported event can't be recorded because its click occurred before this conversion's click-through window. Make sure you import the most recent data.
TOO_RECENT_EVENT The click associated with the given identifier or iOS URL parameter occurred less than 6 hours ago. Retry after 6 hours have passed.
EVENT_NOT_FOUND The imported event could not be attributed to a click. This may be because the event did not come from a Google Ads campaign.
UNAUTHORIZED_CUSTOMER The click ID or call is associated with an Ads account you don't have access to. Make sure you import conversions for accounts managed by your manager account.
TOO_RECENT_CONVERSION_ACTION Can't import events to a conversion action that was just created. Try importing again in 6 hours.
CONVERSION_TRACKING_NOT_ENABLED_AT_IMPRESSION_TIME At the time of the click, conversion tracking was not enabled in the effective conversion account of the click's Google Ads account.
EXTERNAL_ATTRIBUTION_DATA_SET_FOR_NON_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION The imported event includes external attribution data, but the conversion action isn't set up to use an external attribution model. Make sure the conversion action is correctly configured and try again.
EXTERNAL_ATTRIBUTION_DATA_NOT_SET_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION The conversion action is set up to use an external attribution model, but the imported event is missing data. Make sure imported events include the external attribution credit and all necessary fields.
ORDER_ID_NOT_PERMITTED_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION Order IDs can't be used for a conversion measured with an external attribution model. Make sure the conversion is correctly configured and imported events include only necessary data and try again.
ORDER_ID_ALREADY_IN_USE The imported event includes an order ID that was previously recorded, so the event was not processed.
DUPLICATE_ORDER_ID Imported events include multiple conversions with the same order ID and were not processed. Make sure order IDs are unique and try again.
TOO_RECENT_CALL Can't import calls that occurred less than 6 hours ago. Try uploading again in 6 hours.
EXPIRED_CALL The call can't be recorded because it occurred before this conversion action's lookback window. Make sure your import is configured to get the most recent data.
CALL_NOT_FOUND The call or click leading to the imported event can't be found. Make sure your data source is set up to include correct identifiers.
CONVERSION_PRECEDES_CALL The call has a conversionDateTime that precedes the associated click. Make sure your conversionDateTime is correct.
CONVERSION_TRACKING_NOT_ENABLED_AT_CALL_TIME At the time of the imported call, conversion tracking was not enabled in the effective conversion account of the click's Google Ads account.
UNPARSEABLE_CALLERS_PHONE_NUMBER Make sure phone numbers are formatted as E.164 (+16502531234), International (+64 3-331 6005), or US national number (6502531234).
CLICK_CONVERSION_ALREADY_EXISTS The imported event has the same click and conversionDateTime as an existing conversion. Use a unique conversionDateTime or order ID for each unique event and try again.
CALL_CONVERSION_ALREADY_EXISTS The imported call has the same conversionDateTime as an existing conversion. Make sure your conversionDateTime correctly configured and try again.
DUPLICATE_CLICK_CONVERSION_IN_REQUEST Multiple events have the same click and conversionDateTime. Make sure your conversionDateTime is correctly configured and try again.
DUPLICATE_CALL_CONVERSION_IN_REQUEST Multiple events have the same call and conversionDateTime. Make sure your conversionDateTime is correctly configured and try again.
CUSTOM_VARIABLE_NOT_ENABLED Enable the custom variable in your conversion settings and try again.
CUSTOM_VARIABLE_VALUE_CONTAINS_PII Can't import events with custom variables containing personally-identifiable information (PII). Remove these variables and try again.
INVALID_CUSTOMER_FOR_CLICK The click from the imported event is associated with a different Google Ads account. Make sure you're importing to the correct account.
INVALID_CUSTOMER_FOR_CALL The click from the call is associated with a different Google Ads account. Make sure you're importing to the correct account. Query conversionTrackingSetting.google_ads_conversion_customer on Customer to identify the correct account.
CONVERSION_NOT_COMPLIANT_WITH_ATT_POLICY The connversion can't be imported because the conversion source didn't comply with Apple App Transparency Tracking (ATT) policies or because the customer didn't consent to tracking.
CLICK_NOT_FOUND The email address or phone number for this event can't be matched to a click. This may be because it didn't come from a Google Ads campaign, and you can safely ignore this warning. If this includes more imported events than is expected, you may need to check your setup.
INVALID_USER_IDENTIFIER Make sure you hash user provided data using SHA-256 and ensure you are normalizing according to the guidelines.
EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION_NOT_PERMITTED_WITH_USER_IDENTIFIER User provided data can't be used with external attribution models. Use a different attribution model or omit user identifiers and try again.
UNSUPPORTED_USER_IDENTIFIER The provided user identifiers are not supported. Use only hashed email or phone number and try again.
GBRAID_WBRAID_BOTH_SET Can't use both gbraid and wbraid parameters. Use only 1 and try again.
UNPARSEABLE_WBRAID Can't parse event import data. Check if your wbraid parameter was not modified and try again.
UNPARSEABLE_GBRAID Can't parse event import data. Check if your gbraid parameter was not modified and try again.
ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID Conversion actions that use one-per-click counting can't be used with gbraid or wbraid parameters.
CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Enhanced conversions can't be used for this account because of Google customer data policies. Contact your Google representative.
CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS Make sure you agree to the customer data processing terms in conversion settings and try again. You can check your setting by querying conversionTrackingSetting.accepted_customer_data_terms on Customer.
ORDER_ID_CONTAINS_PII Can't import events with order IDs containing personally-identifiable information (PII).
CUSTOMER_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS Make sure you've turned on enhanced conversions for leads in conversion settings and try again. You can check your setting by querying conversionTrackingSetting.enhanced_conversions_for_leads_enabled on Customer.
INVALID_JOB_ID The provided job id in the request is not within the allowed range. A job ID must be a positive integer in the range [1, 2^31).
NO_CONVERSION_ACTION_FOUND The conversion action specified in the upload request cannot be found. Make sure it's available in this account.
INVALID_CONVERSION_ACTION_TYPE The conversion action specified in the upload request isn't set up for uploading conversions.

DateError

Enum describing possible date errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
INVALID_FIELD_VALUES_IN_DATE Given field values do not correspond to a valid date.
INVALID_FIELD_VALUES_IN_DATE_TIME Given field values do not correspond to a valid date time.
INVALID_STRING_DATE The string date's format should be yyyy-mm-dd.
INVALID_STRING_DATE_TIME_MICROS The string date time's format should be yyyy-mm-dd hh:mm:ss.ssssss.
INVALID_STRING_DATE_TIME_SECONDS The string date time's format should be yyyy-mm-dd hh:mm:ss.
INVALID_STRING_DATE_TIME_SECONDS_WITH_OFFSET The string date time's format should be yyyy-mm-dd hh:mm:ss+|-hh:mm.
EARLIER_THAN_MINIMUM_DATE Date is before allowed minimum.
LATER_THAN_MAXIMUM_DATE Date is after allowed maximum.
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE Date range bounds are not in order.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL Both dates in range are null.

DistinctError

Enum describing possible distinct errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
DUPLICATE_ELEMENT Duplicate element.
DUPLICATE_TYPE Duplicate type.

FieldError

Enum describing possible field errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
REQUIRED The required field was not present.
IMMUTABLE_FIELD The field attempted to be mutated is immutable.
INVALID_VALUE The field's value is invalid.
VALUE_MUST_BE_UNSET The field cannot be set.
REQUIRED_NONEMPTY_LIST The required repeated field was empty.
FIELD_CANNOT_BE_CLEARED The field cannot be cleared.
BLOCKED_VALUE The field's value is on a deny-list for this field.
FIELD_CAN_ONLY_BE_CLEARED The field's value cannot be modified, except for clearing.

MutateError

Enum describing possible mutate errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
RESOURCE_NOT_FOUND Requested resource was not found.
ID_EXISTS_IN_MULTIPLE_MUTATES Cannot mutate the same resource twice in one request.
INCONSISTENT_FIELD_VALUES The field's contents don't match another field that represents the same data.
MUTATE_NOT_ALLOWED Mutates are not allowed for the requested resource.
RESOURCE_NOT_IN_GOOGLE_ADS The resource isn't in Google Ads. It belongs to another ads system.
RESOURCE_ALREADY_EXISTS The resource being created already exists.
RESOURCE_DOES_NOT_SUPPORT_VALIDATE_ONLY This resource cannot be used with "validateOnly".
OPERATION_DOES_NOT_SUPPORT_PARTIAL_FAILURE This operation cannot be used with "partialFailure".
RESOURCE_READ_ONLY Attempt to write to read-only fields.

NotAllowlistedError

Enum describing possible not allowlisted errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
CUSTOMER_NOT_ALLOWLISTED_FOR_THIS_FEATURE Customer is not allowlisted for accessing this feature.

StringFormatError

Enum describing possible string format errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
ILLEGAL_CHARS The input string value contains disallowed characters.
INVALID_FORMAT The input string value is invalid for the associated field.

StringLengthError

Enum describing possible string length errors.

Enums
UNSPECIFIED Enum unspecified.
UNKNOWN The received error code is not known in this version.
EMPTY The specified field should have a least one non-whitespace character in it.
TOO_SHORT Too short.
TOO_LONG Too long.

OperatingSystemVersionConstant

A mobile operating system version or a range of versions, depending on operatorType. List of available mobile platforms at https://developers.google.com/google-ads/api/reference/data/codes-formats#mobile-platforms

JSON representation 
{
  "resourceName": string,
  "operatorType": enum (OperatingSystemVersionOperatorType),
  "id": string,
  "name": string,
  "osMajorVersion": integer,
  "osMinorVersion": integer
}
Fields
resourceName

string

Output only. The resource name of the operating system version constant. Operating system version constant resource names have the form:

operatingSystemVersionConstants/{criterionId}
operatorType

enum (OperatingSystemVersionOperatorType)

Output only. Determines whether this constant represents a single version or a range of versions.
id

string (int64 format)

Output only. The ID of the operating system version.
name

string

Output only. Name of the operating system.
osMajorVersion

integer

Output only. The OS Major Version number.
osMinorVersion

integer

Output only. The OS Minor Version number.

OperatingSystemVersionOperatorType

The type of operating system version.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
EQUALS_TO Equals to the specified version.
GREATER_THAN_EQUALS_TO Greater than or equals to the specified version.

PaidOrganicSearchTermView

A paid organic search term view providing a view of search stats across ads and organic listings aggregated by search term at the ad group level.

JSON representation 
{
  "resourceName": string,
  "searchTerm": string
}
Fields
resourceName

string

Output only. The resource name of the search term view. Search term view resource names have the form:

customers/{customerId}/paidOrganicSearchTermViews/{campaignId}~ {adGroupId}~{URL-base64 search term}
searchTerm

string

Output only. The search term.

QualifyingQuestion

Qualifying Questions for Lead Form.

JSON representation 
{
  "resourceName": string,
  "qualifyingQuestionId": string,
  "locale": string,
  "text": string
}
Fields
resourceName

string

Output only. The resource name of the qualifying question.

'qualifyingQuestions/{qualifyingQuestionId}'
qualifyingQuestionId

string (int64 format)

Output only. The id of the qualifying question.
locale

string

Output only. The locale of the qualifying question.
text

string

Output only. The qualifying question.

ParentalStatusView

A parental status view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the parental status view. Parental Status view resource names have the form:

customers/{customerId}/parentalStatusViews/{adGroupId}~{criterionId}

PerStoreView

A per store view. This view provides per store impression reach and local action conversion stats for advertisers.

JSON representation 
{
  "resourceName": string,
  "placeId": string
}
Fields
resourceName

string

Output only. The resource name of the per store view. Per Store view resource names have the form:

customers/{customerId}/perStoreViews/{placeId}
placeId

string

Output only. The place ID of the per store view.

ProductCategoryConstant

A Product Category.

JSON representation 
{
  "resourceName": string,
  "categoryId": string,
  "level": enum (ProductCategoryLevel),
  "state": enum (ProductCategoryState),
  "localizations": [
    {
      object (ProductCategoryLocalization)
    }
  ],
  "productCategoryConstantParent": string
}
Fields
resourceName

string

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

productCategoryConstants/{level}~{categoryId}
categoryId

string (int64 format)

Output only. The ID of the product category.

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

enum (ProductCategoryLevel)

Output only. Level of the product category.
state

enum (ProductCategoryState)

Output only. State of the product category.
localizations[]

object (ProductCategoryLocalization)

Output only. List of all available localizations of the product category.
productCategoryConstantParent

string

Output only. Resource name of the parent product category.

ProductCategoryState

Enum describing the state of the product category.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The category is enabled.
OBSOLETE The category is obsolete. Used only for reporting purposes.

ProductCategoryLocalization

Localization for the product category.

JSON representation 
{
  "regionCode": string,
  "languageCode": string,
  "value": string
}
Fields
regionCode

string

Output only. Upper-case two-letter ISO 3166-1 country code of the localized category.
languageCode

string

Output only. Two-letter ISO 639-1 language code of the localized category.
value

string

Output only. The name of the category in the specified locale.

ProductGroupView

A product group view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

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

customers/{customerId}/productGroupViews/{adGroupId}~{criterionId}

SearchTermView

A search term view with metrics aggregated by search term at the ad group level.

JSON representation 
{
  "resourceName": string,
  "status": enum (SearchTermTargetingStatus),
  "searchTerm": string,
  "adGroup": string
}
Fields
resourceName

string

Output only. The resource name of the search term view. Search term view resource names have the form:

customers/{customerId}/searchTermViews/{campaignId}~{adGroupId}~{URL-base64_search_term}
status

enum (SearchTermTargetingStatus)

Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.
searchTerm

string

Output only. The search term.
adGroup

string

Output only. The ad group the search term served in.

SearchTermTargetingStatus

Indicates whether the search term is one of your targeted or excluded keywords.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADDED Search term is added to targeted keywords.
EXCLUDED Search term matches a negative keyword.
ADDED_EXCLUDED Search term has been both added and excluded.
NONE Search term is neither targeted nor excluded.

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

string

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

SmartCampaignSearchTermView

A Smart campaign search term view.

JSON representation 
{
  "resourceName": string,
  "searchTerm": string,
  "campaign": string
}
Fields
resourceName

string

Output only. The resource name of the Smart campaign search term view. Smart campaign search term view resource names have the form:

customers/{customerId}/smartCampaignSearchTermViews/{campaignId}~{URL-base64_search_term}
searchTerm

string

Output only. The search term.
campaign

string

Output only. The Smart campaign the search term served in.

TopicView

A topic view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the topic view. Topic view resource names have the form:

customers/{customerId}/topicViews/{adGroupId}~{criterionId}

TravelActivityGroupView

A travel activity group view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the travel activity group view. Travel Activity Group view resource names have the form:

customers/{customerId}/travelActivityGroupViews/{adGroupId}~{criterionId}

TravelActivityPerformanceView

A travel activity performance view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Output only. The resource name of the travel activity performance view. Travel Activity performance view resource names have the form:

customers/{customerId}/travelActivityPerformanceView

UserInterest

A user interest: a particular interest-based vertical to be targeted.

JSON representation 
{
  "resourceName": string,
  "taxonomyType": enum (UserInterestTaxonomyType),
  "availabilities": [
    {
      object (CriterionCategoryAvailability)
    }
  ],
  "userInterestId": string,
  "name": string,
  "userInterestParent": string,
  "launchedToAll": boolean
}
Fields
resourceName

string

Output only. The resource name of the user interest. User interest resource names have the form:

customers/{customerId}/userInterests/{userInterestId}
taxonomyType

enum (UserInterestTaxonomyType)

Output only. Taxonomy type of the user interest.
availabilities[]

object (CriterionCategoryAvailability)

Output only. Availability information of the user interest.
userInterestId

string (int64 format)

Output only. The ID of the user interest.
name

string

Output only. The name of the user interest.
userInterestParent

string

Output only. The parent of the user interest.
launchedToAll

boolean

Output only. True if the user interest is launched to all channels and locales.

UserInterestTaxonomyType

Enum containing the possible UserInterestTaxonomyTypes.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AFFINITY The affinity for this user interest.
IN_MARKET The market for this user interest.
MOBILE_APP_INSTALL_USER Users known to have installed applications in the specified categories.
VERTICAL_GEO The geographical location of the interest-based vertical.
NEW_SMART_PHONE_USER User interest criteria for new smart phone users.

LifeEvent

A life event: a particular interest-based vertical to be targeted to reach users when they are in the midst of important life milestones.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "name": string,
  "parent": string,
  "launchedToAll": boolean,
  "availabilities": [
    {
      object (CriterionCategoryAvailability)
    }
  ]
}
Fields
resourceName

string

Output only. The resource name of the life event. Life event resource names have the form:

customers/{customerId}/lifeEvents/{lifeEventId}
id

string (int64 format)

Output only. The ID of the life event.
name

string

Output only. The name of the life event, for example,"Recently Moved"
parent

string

Output only. The parent of the lifeEvent.
launchedToAll

boolean

Output only. True if the life event is launched to all channels and locales.
availabilities[]

object (CriterionCategoryAvailability)

Output only. Availability information of the life event.

UserLocationView

A user location view.

User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.

JSON representation 
{
  "resourceName": string,
  "countryCriterionId": string,
  "targetingLocation": boolean
}
Fields
resourceName

string

Output only. The resource name of the user location view. UserLocation view resource names have the form:

customers/{customerId}/userLocationViews/{countryCriterionId}~{targetingLocation}
countryCriterionId

string (int64 format)

Output only. Criterion Id for the country.
targetingLocation

boolean

Output only. Indicates whether location was targeted or not.

TopicConstant

Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs").

JSON representation 
{
  "resourceName": string,
  "path": [
    string
  ],
  "id": string,
  "topicConstantParent": string
}
Fields
resourceName

string

Output only. The resource name of the topic constant. topic constant resource names have the form:

topicConstants/{topic_id}
path[]

string

Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/google-ads/api/reference/data/verticals
id

string (int64 format)

Output only. The ID of the topic.
topicConstantParent

string

Output only. Resource name of parent of the topic constant.

Video

A video.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "channelId": string,
  "durationMillis": string,
  "title": string
}
Fields
resourceName

string

Output only. The resource name of the video. Video resource names have the form:

customers/{customerId}/videos/{videoId}
id

string

Output only. The ID of the video.
channelId

string

Output only. The owner channel id of the video.
durationMillis

string (int64 format)

Output only. The duration of the video in milliseconds.
title

string

Output only. The title of the video.

WebpageView

A webpage view.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

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

customers/{customerId}/webpageViews/{adGroupId}~{criterionId}

LeadFormSubmissionData

Data from lead form submissions.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "asset": string,
  "campaign": string,
  "leadFormSubmissionFields": [
    {
      object (LeadFormSubmissionField)
    }
  ],
  "customLeadFormSubmissionFields": [
    {
      object (CustomLeadFormSubmissionField)
    }
  ],
  "adGroup": string,
  "adGroupAd": string,
  "gclid": string,
  "submissionDateTime": string
}
Fields
resourceName

string

Output only. The resource name of the lead form submission data. Lead form submission data resource names have the form:

customers/{customerId}/leadFormSubmissionData/{lead_form_submission_data_id}
id

string

Output only. ID of this lead form submission.
asset

string

Output only. Asset associated with the submitted lead form.
campaign

string

Output only. Campaign associated with the submitted lead form.
leadFormSubmissionFields[]

object (LeadFormSubmissionField)

Output only. Submission data associated with a lead form.
customLeadFormSubmissionFields[]

object (CustomLeadFormSubmissionField)

Output only. Submission data associated with a custom lead form.
adGroup

string

Output only. AdGroup associated with the submitted lead form.
adGroupAd

string

Output only. AdGroupAd associated with the submitted lead form.
gclid

string

Output only. Google Click Id associated with the submissed lead form.
submissionDateTime

string

Output only. The date and time at which the lead form was submitted. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".

LeadFormSubmissionField

Fields in the submitted lead form.

JSON representation 
{
  "fieldType": enum (LeadFormFieldUserInputType),
  "fieldValue": string
}
Fields
fieldType

enum (LeadFormFieldUserInputType)

Output only. Field type for lead form fields.
fieldValue

string

Output only. Field value for lead form fields.

CustomLeadFormSubmissionField

Fields in the submitted custom question

JSON representation 
{
  "questionText": string,
  "fieldValue": string
}
Fields
questionText

string

Output only. Question text for custom question, maximum number of characters is 300.
fieldValue

string

Output only. Field value for custom question response, maximum number of characters is 70.

LocalServicesLead

Data from Local Services Lead. Contains details of Lead which is generated when user calls, messages or books service from advertiser. More info: https://ads.google.com/local-services-ads

JSON representation 
{
  "resourceName": string,
  "id": string,
  "categoryId": string,
  "serviceId": string,
  "contactDetails": {
    object (ContactDetails)
  },
  "leadType": enum (LeadType),
  "leadStatus": enum (LeadStatus),
  "creationDateTime": string,
  "locale": string,
  "leadCharged": boolean,
  "note": {
    object (Note)
  },
  "creditDetails": {
    object (CreditDetails)
  }
}
Fields
resourceName

string

Output only. The resource name of the local services lead data. Local Services Lead resource name have the form

customers/{customerId}/localServicesLead/{local_services_lead_id}
id

string (int64 format)

Output only. ID of this Lead.
categoryId

string

Output only. Service category of the lead. For example: xcat:service_area_business_hvac, xcat:service_area_business_real_estate_agent, etc. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
serviceId

string

Output only. Service for the category. For example: buyer_agent, seller_agent for the category of xcat:service_area_business_real_estate_agent.
contactDetails

object (ContactDetails)

Output only. Lead's contact details.
leadType

enum (LeadType)

Output only. Type of Local Services lead: phone, message, booking, etc.
leadStatus

enum (LeadStatus)

Output only. Current status of lead.
creationDateTime

string

Output only. The date time at which lead was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
locale

string

Output only. Language used by the Local Services provider linked to lead. See https://developers.google.com/google-ads/api/data/codes-formats#locales
leadCharged

boolean

Output only. True if the advertiser was charged for the lead.
note

object (Note)

Output only. Note added by advertiser for the lead.
creditDetails

object (CreditDetails)

Output only. Credit details of the lead.

ContactDetails

Fields containing consumer contact details.

JSON representation 
{
  "phoneNumber": string,
  "email": string,
  "consumerName": string
}
Fields
phoneNumber

string

Output only. Consumer phone number in E164 format.
email

string

Output only. Consumer email address.
consumerName

string

Output only. Consumer name if consumer provided name from Message or Booking form on google.com

LeadType

Possible types of lead.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MESSAGE Message lead.
PHONE_CALL Lead created by phone call.
BOOKING Booking lead.

LeadStatus

Possible statuses of lead.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NEW New lead which hasn't yet been seen by advertiser.
ACTIVE Lead that thas been interacted by advertiser.
BOOKED Lead has been booked.
DECLINED Lead was declined by advertiser.
EXPIRED Lead has expired due to inactivity.
DISABLED Disabled due to spam or dispute.
CONSUMER_DECLINED Consumer declined the lead.
WIPED_OUT Personally Identifiable Information of the lead is wiped out.

Note

Represents a note added to a lead by the advertiser. Advertisers can edit notes, which will reset edit time and change description.

JSON representation 
{
  "editDateTime": string,
  "description": string
}
Fields
editDateTime

string

Output only. The date time when lead note was edited. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
description

string

Output only. Content of lead note.

CreditDetails

Represents the credit details of a lead.

JSON representation 
{
  "creditState": enum (CreditState),
  "creditStateLastUpdateDateTime": string
}
Fields
creditState

enum (CreditState)

Output only. Credit state of the lead.
creditStateLastUpdateDateTime

string

Output only. The date time when the credit state of the lead was last updated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

CreditState

Possible credit states of a lead.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING Credit is pending.
CREDITED Credit request is complete.

LocalServicesLeadConversation

Data from Local Services Lead Conversation. Contains details of Lead Conversation which is generated when user calls, messages or books service from advertiser. These are appended to a Lead. More info: https://ads.google.com/local-services-ads

JSON representation 
{
  "resourceName": string,
  "id": string,
  "conversationChannel": enum (ConversationType),
  "participantType": enum (ParticipantType),
  "lead": string,
  "eventDateTime": string,
  "phoneCallDetails": {
    object (PhoneCallDetails)
  },
  "messageDetails": {
    object (MessageDetails)
  }
}
Fields
resourceName

string

Output only. The resource name of the local services lead conversation data. Local Services Lead Conversation resource name have the form

customers/{customerId}/localServicesLeadConversation/{local_services_lead_conversation_id}
id

string (int64 format)

Output only. ID of this Lead Conversation.
conversationChannel

enum (ConversationType)

Output only. Type of GLS lead conversation, EMAIL, MESSAGE, PHONE_CALL, SMS, etc.
participantType

enum (ParticipantType)

Output only. Type of participant in the lead conversation, ADVERTISER or CONSUMER.
lead

string

Output only. Resource name of Lead associated to the Lead Conversation.
eventDateTime

string

Output only. The date time at which lead conversation was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
phoneCallDetails

object (PhoneCallDetails)

Output only. Details of phone call conversation in case of PHONE_CALL.
messageDetails

object (MessageDetails)

Output only. Details of message conversation in case of EMAIL, MESSAGE or SMS.

ConversationType

Possible types of lead conversation.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
EMAIL Email lead conversation.
MESSAGE Message lead conversation.
PHONE_CALL Phone call lead conversation.
SMS SMS lead conversation.
BOOKING Booking lead conversation.

ParticipantType

Possible types of lead conversation participant.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADVERTISER Local Services Ads Provider participant.
CONSUMER Local Services Ads Consumer participant.

PhoneCallDetails

Represents details of a phone call conversation.

JSON representation 
{
  "callDurationMillis": string,
  "callRecordingUrl": string
}
Fields
callDurationMillis

string (int64 format)

Output only. The duration (in milliseconds) of the phone call (end to end).
callRecordingUrl

string

Output only. URL to the call recording audio file.

MessageDetails

Represents details of text message in case of email, message or SMS.

JSON representation 
{
  "text": string,
  "attachmentUrls": [
    string
  ]
}
Fields
text

string

Output only. Textual content of the message.
attachmentUrls[]

string

Output only. URL to the SMS or email attachments. These URLs can be used to download the contents of the attachment by using the developer token.

AndroidPrivacySharedKeyGoogleAdGroup

An Android privacy shared key view for Google ad group key.

JSON representation 
{
  "resourceName": string,
  "campaignId": string,
  "androidPrivacyInteractionType": enum (AndroidPrivacyInteractionType),
  "androidPrivacyInteractionDate": string,
  "androidPrivacyNetworkType": enum (AndroidPrivacyNetworkType),
  "adGroupId": string,
  "sharedAdGroupKey": string
}
Fields
resourceName

string

Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form:

customers/{customerId}/androidPrivacySharedKeyGoogleAdGroups/{campaignId}~{adGroupId}~{androidPrivacyInteractionType}~{androidPrivacyNetworkType}~{androidPrivacyInteractionDate(yyyy-mm-dd)}
campaignId

string (int64 format)

Output only. The campaign ID used in the share key encoding.
androidPrivacyInteractionType

enum (AndroidPrivacyInteractionType)

Output only. The interaction type enum used in the share key encoding.
androidPrivacyInteractionDate

string

Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
androidPrivacyNetworkType

enum (AndroidPrivacyNetworkType)

Output only. The network type enum used in the share key encoding.
adGroupId

string (int64 format)

Output only. The ad group ID used in the share key encoding.
sharedAdGroupKey

string

Output only. 128 bit hex string of the encoded shared ad group key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.

AndroidPrivacyInteractionType

Enumerates interaction types

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
CLICK The physical click interaction type.
ENGAGED_VIEW The 10 seconds engaged view interaction type.
VIEW The view (ad impression) interaction type.

AndroidPrivacyNetworkType

Enumerates network types

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
SEARCH Search Network.
DISPLAY Display Network.
YOUTUBE YouTube Network.

AndroidPrivacySharedKeyGoogleCampaign

An Android privacy shared key view for Google campaign key.

JSON representation 
{
  "resourceName": string,
  "campaignId": string,
  "androidPrivacyInteractionType": enum (AndroidPrivacyInteractionType),
  "androidPrivacyInteractionDate": string,
  "sharedCampaignKey": string
}
Fields
resourceName

string

Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form:

customers/{customerId}/androidPrivacySharedKeyGoogleCampaigns/{campaignId}~{androidPrivacyInteractionType}~{androidPrivacyInteractionDate(yyyy-mm-dd)}
campaignId

string (int64 format)

Output only. The campaign ID used in the share key encoding.
androidPrivacyInteractionType

enum (AndroidPrivacyInteractionType)

Output only. The interaction type enum used in the share key encoding.
androidPrivacyInteractionDate

string

Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
sharedCampaignKey

string

Output only. 128 bit hex string of the encoded shared campaign key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.

AndroidPrivacySharedKeyGoogleNetworkType

An Android privacy shared key view for Google network type key.

JSON representation 
{
  "resourceName": string,
  "campaignId": string,
  "androidPrivacyInteractionType": enum (AndroidPrivacyInteractionType),
  "androidPrivacyInteractionDate": string,
  "androidPrivacyNetworkType": enum (AndroidPrivacyNetworkType),
  "sharedNetworkTypeKey": string
}
Fields
resourceName

string

Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form:

customers/{customerId}/androidPrivacySharedKeyGoogleNetworkTypes/{campaignId}~{androidPrivacyInteractionType}~{androidPrivacyNetworkType}~{androidPrivacyInteractionDate(yyyy-mm-dd)}
campaignId

string (int64 format)

Output only. The campaign ID used in the share key encoding.
androidPrivacyInteractionType

enum (AndroidPrivacyInteractionType)

Output only. The interaction type enum used in the share key encoding.
androidPrivacyInteractionDate

string

Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
androidPrivacyNetworkType

enum (AndroidPrivacyNetworkType)

Output only. The network type enum used in the share key encoding.
sharedNetworkTypeKey

string

Output only. 128 bit hex string of the encoded shared network type key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.

Metrics

Metrics data.

JSON representation 
{
  "allConversionsValueByConversionDate": number,
  "allConversionsByConversionDate": number,
  "conversionsValueByConversionDate": number,
  "conversionsByConversionDate": number,
  "historicalCreativeQualityScore": enum (QualityScoreBucket),
  "historicalLandingPageQualityScore": enum (QualityScoreBucket),
  "historicalSearchPredictedCtr": enum (QualityScoreBucket),
  "interactionEventTypes": [
    enum (InteractionEventType)
  ],
  "skAdNetworkInstalls": string,
  "skAdNetworkTotalConversions": string,
  "publisherPurchasedClicks": string,
  "publisherOrganicClicks": string,
  "publisherUnknownClicks": string,
  "absoluteTopImpressionPercentage": number,
  "activeViewCpm": number,
  "activeViewCtr": number,
  "activeViewImpressions": string,
  "activeViewMeasurability": number,
  "activeViewMeasurableCostMicros": string,
  "activeViewMeasurableImpressions": string,
  "activeViewViewability": number,
  "allConversionsFromInteractionsRate": number,
  "allConversionsValue": number,
  "allNewCustomerLifetimeValue": number,
  "allConversions": number,
  "allConversionsValuePerCost": number,
  "allConversionsFromClickToCall": number,
  "allConversionsFromDirections": number,
  "allConversionsFromInteractionsValuePerInteraction": number,
  "allConversionsFromMenu": number,
  "allConversionsFromOrder": number,
  "allConversionsFromOtherEngagement": number,
  "allConversionsFromStoreVisit": number,
  "allConversionsFromStoreWebsite": number,
  "auctionInsightSearchAbsoluteTopImpressionPercentage": number,
  "auctionInsightSearchImpressionShare": number,
  "auctionInsightSearchOutrankingShare": number,
  "auctionInsightSearchOverlapRate": number,
  "auctionInsightSearchPositionAboveRate": number,
  "auctionInsightSearchTopImpressionPercentage": number,
  "averageCost": number,
  "averageCpc": number,
  "averageCpe": number,
  "averageCpm": number,
  "averageCpv": number,
  "averagePageViews": number,
  "averageTimeOnSite": number,
  "benchmarkAverageMaxCpc": number,
  "biddableAppInstallConversions": number,
  "biddableAppPostInstallConversions": number,
  "benchmarkCtr": number,
  "bounceRate": number,
  "clicks": string,
  "combinedClicks": string,
  "combinedClicksPerQuery": number,
  "combinedQueries": string,
  "contentBudgetLostImpressionShare": number,
  "contentImpressionShare": number,
  "conversionLastReceivedRequestDateTime": string,
  "conversionLastConversionDate": string,
  "contentRankLostImpressionShare": number,
  "conversionsFromInteractionsRate": number,
  "conversionsValue": number,
  "newCustomerLifetimeValue": number,
  "conversionsValuePerCost": number,
  "conversionsFromInteractionsValuePerInteraction": number,
  "conversions": number,
  "costMicros": string,
  "costPerAllConversions": number,
  "costPerConversion": number,
  "costPerCurrentModelAttributedConversion": number,
  "crossDeviceConversions": number,
  "crossDeviceConversionsValueMicros": string,
  "ctr": number,
  "currentModelAttributedConversions": number,
  "currentModelAttributedConversionsFromInteractionsRate": number,
  "currentModelAttributedConversionsFromInteractionsValuePerInteraction": number,
  "currentModelAttributedConversionsValue": number,
  "currentModelAttributedConversionsValuePerCost": number,
  "engagementRate": number,
  "engagements": string,
  "hotelAverageLeadValueMicros": number,
  "hotelCommissionRateMicros": string,
  "hotelExpectedCommissionCost": number,
  "hotelPriceDifferencePercentage": number,
  "hotelEligibleImpressions": string,
  "historicalQualityScore": string,
  "gmailForwards": string,
  "gmailSaves": string,
  "gmailSecondaryClicks": string,
  "impressionsFromStoreReach": string,
  "impressions": string,
  "interactionRate": number,
  "interactions": string,
  "invalidClickRate": number,
  "invalidClicks": string,
  "messageChats": string,
  "messageImpressions": string,
  "messageChatRate": number,
  "mobileFriendlyClicksPercentage": number,
  "optimizationScoreUplift": number,
  "optimizationScoreUrl": string,
  "organicClicks": string,
  "organicClicksPerQuery": number,
  "organicImpressions": string,
  "organicImpressionsPerQuery": number,
  "organicQueries": string,
  "percentNewVisitors": number,
  "phoneCalls": string,
  "phoneImpressions": string,
  "phoneThroughRate": number,
  "relativeCtr": number,
  "searchAbsoluteTopImpressionShare": number,
  "searchBudgetLostAbsoluteTopImpressionShare": number,
  "searchBudgetLostImpressionShare": number,
  "searchBudgetLostTopImpressionShare": number,
  "searchClickShare": number,
  "searchExactMatchImpressionShare": number,
  "searchImpressionShare": number,
  "searchRankLostAbsoluteTopImpressionShare": number,
  "searchRankLostImpressionShare": number,
  "searchRankLostTopImpressionShare": number,
  "searchTopImpressionShare": number,
  "searchVolume": {
    object (SearchVolumeRange)
  },
  "speedScore": string,
  "averageTargetCpaMicros": string,
  "averageTargetRoas": number,
  "topImpressionPercentage": number,
  "validAcceleratedMobilePagesClicksPercentage": number,
  "valuePerAllConversions": number,
  "valuePerAllConversionsByConversionDate": number,
  "valuePerConversion": number,
  "valuePerConversionsByConversionDate": number,
  "valuePerCurrentModelAttributedConversion": number,
  "videoQuartileP100Rate": number,
  "videoQuartileP25Rate": number,
  "videoQuartileP50Rate": number,
  "videoQuartileP75Rate": number,
  "videoViewRate": number,
  "videoViews": string,
  "viewThroughConversions": string,
  "allConversionsFromLocationAssetClickToCall": number,
  "allConversionsFromLocationAssetDirections": number,
  "allConversionsFromLocationAssetMenu": number,
  "allConversionsFromLocationAssetOrder": number,
  "allConversionsFromLocationAssetOtherEngagement": number,
  "allConversionsFromLocationAssetStoreVisits": number,
  "allConversionsFromLocationAssetWebsite": number,
  "eligibleImpressionsFromLocationAssetStoreReach": string,
  "viewThroughConversionsFromLocationAssetClickToCall": number,
  "viewThroughConversionsFromLocationAssetDirections": number,
  "viewThroughConversionsFromLocationAssetMenu": number,
  "viewThroughConversionsFromLocationAssetOrder": number,
  "viewThroughConversionsFromLocationAssetOtherEngagement": number,
  "viewThroughConversionsFromLocationAssetStoreVisits": number,
  "viewThroughConversionsFromLocationAssetWebsite": number,
  "orders": number,
  "averageOrderValueMicros": string,
  "averageCartSize": number,
  "costOfGoodsSoldMicros": string,
  "grossProfitMicros": string,
  "grossProfitMargin": number,
  "revenueMicros": string,
  "unitsSold": number,
  "crossSellCostOfGoodsSoldMicros": string,
  "crossSellGrossProfitMicros": string,
  "crossSellRevenueMicros": string,
  "crossSellUnitsSold": number,
  "leadCostOfGoodsSoldMicros": string,
  "leadGrossProfitMicros": string,
  "leadRevenueMicros": string,
  "leadUnitsSold": number,
  "uniqueUsers": string,
  "averageImpressionFrequencyPerUser": number
}
Fields
allConversionsValueByConversionDate

number

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/google-ads/answer/9549009.
allConversionsByConversionDate

number

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/google-ads/answer/9549009.
conversionsValueByConversionDate

number

The value 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. 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/google-ads/answer/9549009.
conversionsByConversionDate

number

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. 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/google-ads/answer/9549009.
historicalCreativeQualityScore

enum (QualityScoreBucket)

The creative historical quality score.
historicalLandingPageQualityScore

enum (QualityScoreBucket)

The quality of historical landing page experience.
historicalSearchPredictedCtr

enum (QualityScoreBucket)

The historical search predicted click through rate (CTR).
interactionEventTypes[]

enum (InteractionEventType)

The types of payable and free interactions.
skAdNetworkInstalls

string (int64 format)

The number of iOS Store Kit Ad Network conversions.
skAdNetworkTotalConversions

string (int64 format)

The total number of iOS Store Kit Ad Network conversions.
publisherPurchasedClicks

string (int64 format)

Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity
publisherOrganicClicks

string (int64 format)

Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity
publisherUnknownClicks

string (int64 format)

Clicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic"
absoluteTopImpressionPercentage

number

Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
activeViewCpm

number

Average cost of viewable impressions (activeViewImpressions).
activeViewCtr

number

Active view measurable clicks divided by active view viewable impressions.

This metric is reported only for the Display Network.
activeViewImpressions

string (int64 format)

A measurement of how often your ad has become viewable on a Display Network site.
activeViewMeasurability

number

The ratio of impressions that could be measured by Active View over the number of served impressions.
activeViewMeasurableCostMicros

string (int64 format)

The cost of the impressions you received that were measurable by Active View.
activeViewMeasurableImpressions

string (int64 format)

The number of times your ads are appearing on placements in positions where they can be seen.
activeViewViewability

number

The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
allConversionsFromInteractionsRate

number

All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
allConversionsValue

number

The value of all conversions.
allNewCustomerLifetimeValue

number

All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in "allConversionsValue". See https://support.google.com/google-ads/answer/12080169 for more details.
allConversions

number

The total number of conversions. This includes all conversions regardless of the value of includeInConversionsMetric.
allConversionsValuePerCost

number

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

number

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

number

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

number

The value of all conversions from interactions divided by the total number of interactions.
allConversionsFromMenu

number

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

number

The number of times people placed an order at a store after clicking an ad.

This metric applies to feed items only.
allConversionsFromOtherEngagement

number

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

number

Estimated number of times people visited a store after clicking an ad.

This metric applies to feed items only.
allConversionsFromStoreWebsite

number

The number of times that people were taken to a store's URL after clicking an ad.

This metric applies to feed items only.
auctionInsightSearchAbsoluteTopImpressionPercentage

number

This metric is part of the Auction Insights report, and tells how often the ads of another participant showed in the most prominent position on the search results page. This percentage is computed only over the auctions that you appeared in the page.

This metric is not publicly available.
auctionInsightSearchImpressionShare

number

This metric is part of the Auction Insights report, and tells the percentage of impressions that another participant obtained, over the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999.

This metric is not publicly available.
auctionInsightSearchOutrankingShare

number

This metric is part of the Auction Insights report, and tells the percentage of impressions that your ads outranked (showed above) another participant in the auction, compared to the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999.

This metric is not publicly available.
auctionInsightSearchOverlapRate

number

This metric is part of the Auction Insights report, and tells how often another participant's ad received an impression when your ad also received an impression.

This metric is not publicly available.
auctionInsightSearchPositionAboveRate

number

This metric is part of the Auction Insights report, and tells how often another participant's ad was shown in a higher position than yours, when both of your ads were shown at the same page.

This metric is not publicly available.
auctionInsightSearchTopImpressionPercentage

number

This metric is part of the Auction Insights report, and tells how often the ads of another participant showed adjacent to the top organic search results. This percentage is computed only over the auctions that you appeared in the page.

This metric is not publicly available.
averageCost

number

The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
averageCpc

number

The total cost of all clicks divided by the total number of clicks received.
averageCpe

number

The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
averageCpm

number

Average cost-per-thousand impressions (CPM).
averageCpv

number

The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
averagePageViews

number

Average number of pages viewed per session.
averageTimeOnSite

number

Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
benchmarkAverageMaxCpc

number

An indication of how other advertisers are bidding on similar products.
biddableAppInstallConversions

number

Number of app installs.
biddableAppPostInstallConversions

number

Number of in-app actions.
benchmarkCtr

number

An indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it.
bounceRate

number

Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
clicks

string (int64 format)

The number of clicks.
combinedClicks

string (int64 format)

The number of times your ad or your site's listing in the unpaid results was clicked. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
combinedClicksPerQuery

number

The number of times your ad or your site's listing in the unpaid results was clicked (combinedClicks) divided by combinedQueries. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
combinedQueries

string (int64 format)

The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
contentBudgetLostImpressionShare

number

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

number

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

string

The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (for example, because the tag was fired from a browser that did not previously click an ad from an appropriate advertiser). The date/time is in the customer's time zone.
conversionLastConversionDate

string

The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
contentRankLostImpressionShare

number

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

number

Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
conversionsValue

number

The value 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.
newCustomerLifetimeValue

number

New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in "conversionsValue" for optimization. See https://support.google.com/google-ads/answer/12080169 for more details.
conversionsValuePerCost

number

The value of conversions divided by the cost 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.
conversionsFromInteractionsValuePerInteraction

number

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

number

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

string (int64 format)

The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
costPerAllConversions

number

The cost of ad interactions divided by all conversions.
costPerConversion

number

The cost of ad interactions divided by 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.
costPerCurrentModelAttributedConversion

number

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

number

Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in allConversions.
crossDeviceConversionsValueMicros

string (int64 format)

The sum of the value of cross-device conversions, in micros.
ctr

number

The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
currentModelAttributedConversions

number

Shows how your historic conversions data would look under the attribution model you've currently selected. 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.
currentModelAttributedConversionsFromInteractionsRate

number

Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
currentModelAttributedConversionsFromInteractionsValuePerInteraction

number

The value of current model attributed 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.
currentModelAttributedConversionsValue

number

The value of 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.
currentModelAttributedConversionsValuePerCost

number

The value of current model attributed conversions divided by the cost 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.
engagementRate

number

How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
engagements

string (int64 format)

The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
hotelAverageLeadValueMicros

number

Average lead value based on clicks.
hotelCommissionRateMicros

string (int64 format)

Commission bid rate in micros. A 20% commission is represented as 200,000.
hotelExpectedCommissionCost

number

Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency.
hotelPriceDifferencePercentage

number

The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
hotelEligibleImpressions

string (int64 format)

The number of impressions that hotel partners could have had given their feed performance.
historicalQualityScore

string (int64 format)

The historical quality score.
gmailForwards

string (int64 format)

The number of times the ad was forwarded to someone else as a message.
gmailSaves

string (int64 format)

The number of times someone has saved your Gmail ad to their inbox as a message.
gmailSecondaryClicks

string (int64 format)

The number of clicks to the landing page on the expanded state of Gmail ads.
impressionsFromStoreReach

string (int64 format)

The number of times a store's location-based ad was shown.

This metric applies to feed items only.
impressions

string (int64 format)

Count of how often your ad has appeared on a search results page or website on the Google Network.
interactionRate

number

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

string (int64 format)

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

number

The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
invalidClicks

string (int64 format)

Number of clicks Google considers illegitimate and doesn't charge you for.
messageChats

string (int64 format)

Number of message chats initiated for Click To Message impressions that were message tracking eligible.
messageImpressions

string (int64 format)

Number of Click To Message impressions that were message tracking eligible.
messageChatRate

number

Number of message chats initiated (messageChats) divided by the number of message impressions (messageImpressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate can be more than 1.0 for a given message impression.
mobileFriendlyClicksPercentage

number

The percentage of mobile clicks that go to a mobile-friendly page.
optimizationScoreUplift

number

Total optimization score uplift of all recommendations.
optimizationScoreUrl

string

URL for the optimization score page in the Google Ads web interface. This metric can be selected from customer or campaign, and can be segmented by segments.recommendation_type. For example, SELECT metrics.optimization_score_url, segments.recommendation_type FROM customer will return a URL for each unique (customer, recommendationType) combination.
organicClicks

string (int64 format)

The number of times someone clicked your site's listing in the unpaid results for a particular query. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
organicClicksPerQuery

number

The number of times someone clicked your site's listing in the unpaid results (organicClicks) divided by the total number of searches that returned pages from your site (organicQueries). See the help page at https://support.google.com/google-ads/answer/3097241 for details.
organicImpressions

string (int64 format)

The number of listings for your site in the unpaid search results. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
organicImpressionsPerQuery

number

The number of times a page from your site was listed in the unpaid search results (organicImpressions) divided by the number of searches returning your site's listing in the unpaid results (organicQueries). See the help page at https://support.google.com/google-ads/answer/3097241 for details.
organicQueries

string (int64 format)

The total number of searches that returned your site's listing in the unpaid results. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
percentNewVisitors

number

Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
phoneCalls

string (int64 format)

Number of offline phone calls.
phoneImpressions

string (int64 format)

Number of offline phone impressions.
phoneThroughRate

number

Number of phone calls received (phoneCalls) divided by the number of times your phone number is shown (phoneImpressions).
relativeCtr

number

Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites.
searchAbsoluteTopImpressionShare

number

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/google-ads/answer/7501826 for details. Any value below 0.1 is reported as 0.0999.
searchBudgetLostAbsoluteTopImpressionShare

number

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

object (SearchVolumeRange)

Search volume range for a search term insight category.
speedScore

string (int64 format)

A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest.
averageTargetCpaMicros

string (int64 format)

The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
averageTargetRoas

number

The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
topImpressionPercentage

number

The percent of your ad impressions that are shown adjacent to the top organic search results.
validAcceleratedMobilePagesClicksPercentage

number

The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
valuePerAllConversions

number

The value of all conversions divided by the number of all conversions.
valuePerAllConversionsByConversionDate

number

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/google-ads/answer/9549009.
valuePerConversion

number

The value of conversions divided by 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.
valuePerConversionsByConversionDate

number

The value of conversions divided by 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. 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/google-ads/answer/9549009.
valuePerCurrentModelAttributedConversion

number

The value of current model attributed conversions divided by the number of the 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.
videoQuartileP100Rate

number

Percentage of impressions where the viewer watched all of your video.
videoQuartileP25Rate

number

Percentage of impressions where the viewer watched 25% of your video.
videoQuartileP50Rate

number

Percentage of impressions where the viewer watched 50% of your video.
videoQuartileP75Rate

number

Percentage of impressions where the viewer watched 75% of your video.
videoViewRate

number

The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
videoViews

string (int64 format)

The number of times your video ads were viewed.
viewThroughConversions

string (int64 format)

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

number

Number of call button clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
allConversionsFromLocationAssetDirections

number

Number of driving directions clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
allConversionsFromLocationAssetMenu

number

Number of menu link clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
allConversionsFromLocationAssetOrder

number

Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
allConversionsFromLocationAssetOtherEngagement

number

Number of other types of local action clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
allConversionsFromLocationAssetStoreVisits

number

Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location.
allConversionsFromLocationAssetWebsite

number

Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
eligibleImpressionsFromLocationAssetStoreReach

string (int64 format)

Number of impressions in which the store location was shown or the location was used for targeting. This measure is coming from Asset based location.
viewThroughConversionsFromLocationAssetClickToCall

number

Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
viewThroughConversionsFromLocationAssetDirections

number

Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
viewThroughConversionsFromLocationAssetMenu

number

Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
viewThroughConversionsFromLocationAssetOrder

number

Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
viewThroughConversionsFromLocationAssetOtherEngagement

number

Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
viewThroughConversionsFromLocationAssetStoreVisits

number

Estimated number of visits to the store after an impression. This measure is coming from Asset based location.
viewThroughConversionsFromLocationAssetWebsite

number

Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
orders

number

Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.
averageOrderValueMicros

string (int64 format)

Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
averageCartSize

number

Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
costOfGoodsSoldMicros

string (int64 format)

Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. 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 cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.
grossProfitMicros

string (int64 format)

Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.
grossProfitMargin

number

Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data.
revenueMicros

string (int64 format)

Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data.
unitsSold

number

Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold 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 units sold in this order is 3. This metric is only available if you report conversions with cart data.
crossSellCostOfGoodsSoldMicros

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

number

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

number

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

string (int64 format)

The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.
averageImpressionFrequencyPerUser

number

The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.

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.

SearchVolumeRange

Search volume range. Actual search volume falls within this range.

JSON representation 
{
  "min": string,
  "max": string
}
Fields
min

string (int64 format)

Lower bound of search volume.
max

string (int64 format)

Upper bound of search volume.

Segments

Segment only fields.

JSON representation 
{
  "adDestinationType": enum (AdDestinationType),
  "adNetworkType": enum (AdNetworkType),
  "budgetCampaignAssociationStatus": {
    object (BudgetCampaignAssociationStatus)
  },
  "clickType": enum (ClickType),
  "conversionActionCategory": enum (ConversionActionCategory),
  "conversionAttributionEventType": enum (ConversionAttributionEventType),
  "conversionLagBucket": enum (ConversionLagBucket),
  "conversionOrAdjustmentLagBucket": enum (ConversionOrAdjustmentLagBucket),
  "dayOfWeek": enum (DayOfWeek),
  "device": enum (Device),
  "externalConversionSource": enum (ExternalConversionSource),
  "hotelCheckInDayOfWeek": enum (DayOfWeek),
  "hotelDateSelectionType": enum (HotelDateSelectionType),
  "hotelRateType": enum (HotelRateType),
  "hotelPriceBucket": enum (HotelPriceBucket),
  "keyword": {
    object (Keyword)
  },
  "monthOfYear": enum (MonthOfYear),
  "placeholderType": enum (PlaceholderType),
  "productChannel": enum (ProductChannel),
  "productChannelExclusivity": enum (ProductChannelExclusivity),
  "productCondition": enum (ProductCondition),
  "recommendationType": enum (RecommendationType),
  "searchEngineResultsPageType": enum (SearchEngineResultsPageType),
  "searchTermMatchType": enum (SearchTermMatchType),
  "slot": enum (Slot),
  "conversionValueRulePrimaryDimension": enum (ConversionValueRulePrimaryDimension),
  "skAdNetworkUserType": enum (SkAdNetworkUserType),
  "skAdNetworkAdEventType": enum (SkAdNetworkAdEventType),
  "skAdNetworkAttributionCredit": enum (SkAdNetworkAttributionCredit),
  "skAdNetworkCoarseConversionValue": enum (SkAdNetworkCoarseConversionValue),
  "skAdNetworkSourceType": enum (SkAdNetworkSourceType),
  "newVersusReturningCustomers": enum (ConvertingUserPriorEngagementTypeAndLtvBucket),
  "activityAccountId": string,
  "activityCity": string,
  "activityCountry": string,
  "activityRating": string,
  "activityState": string,
  "externalActivityId": string,
  "adGroup": string,
  "assetGroup": string,
  "auctionInsightDomain": string,
  "campaign": string,
  "conversionAction": string,
  "conversionActionName": string,
  "conversionAdjustment": boolean,
  "date": string,
  "geoTargetAirport": string,
  "geoTargetCanton": string,
  "geoTargetCity": string,
  "geoTargetCountry": string,
  "geoTargetCounty": string,
  "geoTargetDistrict": string,
  "geoTargetMetro": string,
  "geoTargetMostSpecificLocation": string,
  "geoTargetPostalCode": string,
  "geoTargetProvince": string,
  "geoTargetRegion": string,
  "geoTargetState": string,
  "hotelBookingWindowDays": string,
  "hotelCenterId": string,
  "hotelCheckInDate": string,
  "hotelCity": string,
  "hotelClass": integer,
  "hotelCountry": string,
  "hotelLengthOfStay": integer,
  "hotelRateRuleId": string,
  "hotelState": string,
  "hour": integer,
  "interactionOnThisExtension": boolean,
  "month": string,
  "partnerHotelId": string,
  "productAggregatorId": string,
  "productCategoryLevel1": string,
  "productCategoryLevel2": string,
  "productCategoryLevel3": string,
  "productCategoryLevel4": string,
  "productCategoryLevel5": string,
  "productBrand": string,
  "productCountry": string,
  "productCustomAttribute0": string,
  "productCustomAttribute1": string,
  "productCustomAttribute2": string,
  "productCustomAttribute3": string,
  "productCustomAttribute4": string,
  "productFeedLabel": string,
  "productItemId": string,
  "productLanguage": string,
  "productMerchantId": string,
  "productStoreId": string,
  "productTitle": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "quarter": string,
  "searchSubcategory": string,
  "searchTerm": string,
  "webpage": string,
  "week": string,
  "year": integer,
  "skAdNetworkConversionValue": string,
  "skAdNetworkSourceApp": {
    object (SkAdNetworkSourceApp)
  },
  "skAdNetworkSourceDomain": string,
  "skAdNetworkPostbackSequenceIndex": string,
  "assetInteractionTarget": {
    object (AssetInteractionTarget)
  }
}
Fields
adDestinationType

enum (AdDestinationType)

Ad Destination type.
adNetworkType

enum (AdNetworkType)

Ad network type.
budgetCampaignAssociationStatus

object (BudgetCampaignAssociationStatus)

Budget campaign association status.
clickType

enum (ClickType)

Click type.
conversionActionCategory

enum (ConversionActionCategory)

Conversion action category.
conversionAttributionEventType

enum (ConversionAttributionEventType)

Conversion attribution event type.
conversionLagBucket

enum (ConversionLagBucket)

An enum value representing the number of days between the impression and the conversion.
conversionOrAdjustmentLagBucket

enum (ConversionOrAdjustmentLagBucket)

An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
dayOfWeek

enum (DayOfWeek)

Day of the week, for example, MONDAY.
device

enum (Device)

Device to which metrics apply.
externalConversionSource

enum (ExternalConversionSource)

External conversion source.
hotelCheckInDayOfWeek

enum (DayOfWeek)

Hotel check-in day of week.
hotelDateSelectionType

enum (HotelDateSelectionType)

Hotel date selection type.
hotelRateType

enum (HotelRateType)

Hotel rate type.
hotelPriceBucket

enum (HotelPriceBucket)

Hotel price bucket.
keyword

object (Keyword)

Keyword criterion.
monthOfYear

enum (MonthOfYear)

Month of the year, for example, January.
placeholderType

enum (PlaceholderType)

Placeholder type. This is only used with feed item metrics.
productChannel

enum (ProductChannel)

Channel of the product.
productChannelExclusivity

enum (ProductChannelExclusivity)

Channel exclusivity of the product.
productCondition

enum (ProductCondition)

Condition of the product.
recommendationType

enum (RecommendationType)

Recommendation type.
searchEngineResultsPageType

enum (SearchEngineResultsPageType)

Type of the search engine results page.
searchTermMatchType

enum (SearchTermMatchType)

Match type of the keyword that triggered the ad, including variants.
slot

enum (Slot)

Position of the ad.
conversionValueRulePrimaryDimension

enum (ConversionValueRulePrimaryDimension)

Primary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value rules were applied.
skAdNetworkUserType

enum (SkAdNetworkUserType)

iOS Store Kit Ad Network user type.
skAdNetworkAdEventType

enum (SkAdNetworkAdEventType)

iOS Store Kit Ad Network ad event type.
skAdNetworkAttributionCredit

enum (SkAdNetworkAttributionCredit)

iOS Store Kit Ad Network attribution credit
skAdNetworkCoarseConversionValue

enum (SkAdNetworkCoarseConversionValue)

iOS Store Kit Ad Network coarse conversion value.
skAdNetworkSourceType

enum (SkAdNetworkSourceType)

The source type where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or neither source domain nor source app were present in any postbacks sent by Apple.
newVersusReturningCustomers

enum (ConvertingUserPriorEngagementTypeAndLtvBucket)

This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal.
activityAccountId

string (int64 format)

Activity account ID.
activityCity

string

The city where the travel activity is available.
activityCountry

string

The country where the travel activity is available.
activityRating

string (int64 format)

Activity rating.
activityState

string

The state where the travel activity is available.
externalActivityId

string

Advertiser supplied activity ID.
adGroup

string

Resource name of the ad group.
assetGroup

string

Resource name of the asset group.
auctionInsightDomain

string

Domain (visible URL) of a participant in the Auction Insights report.
campaign

string

Resource name of the campaign.
conversionAction

string

Resource name of the conversion action.
conversionActionName

string

Conversion action name.
conversionAdjustment

boolean

This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
date

string

Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
geoTargetAirport

string

Resource name of the geo target constant that represents an airport.
geoTargetCanton

string

Resource name of the geo target constant that represents a canton.
geoTargetCity

string

Resource name of the geo target constant that represents a city.
geoTargetCountry

string

Resource name of the geo target constant that represents a country.
geoTargetCounty

string

Resource name of the geo target constant that represents a county.
geoTargetDistrict

string

Resource name of the geo target constant that represents a district.
geoTargetMetro

string

Resource name of the geo target constant that represents a metro.
geoTargetMostSpecificLocation

string

Resource name of the geo target constant that represents the most specific location.
geoTargetPostalCode

string

Resource name of the geo target constant that represents a postal code.
geoTargetProvince

string

Resource name of the geo target constant that represents a province.
geoTargetRegion

string

Resource name of the geo target constant that represents a region.
geoTargetState

string

Resource name of the geo target constant that represents a state.
hotelBookingWindowDays

string (int64 format)

Hotel booking window in days.
hotelCenterId

string (int64 format)

Hotel center ID.
hotelCheckInDate

string

Hotel check-in date. Formatted as yyyy-MM-dd.
hotelCity

string

Hotel city.
hotelClass

integer

Hotel class.
hotelCountry

string

Hotel country.
hotelLengthOfStay

integer

Hotel length of stay.
hotelRateRuleId

string

Hotel rate rule ID.
hotelState

string

Hotel state.
hour

integer

Hour of day as a number between 0 and 23, inclusive.
interactionOnThisExtension

boolean

Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
month

string

Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
partnerHotelId

string

Partner hotel ID.
productAggregatorId

string (int64 format)

Aggregator ID of the product.
productCategoryLevel1

string

Category (level 1) of the product.
productCategoryLevel2

string

Category (level 2) of the product.
productCategoryLevel3

string

Category (level 3) of the product.
productCategoryLevel4

string

Category (level 4) of the product.
productCategoryLevel5

string

Category (level 5) of the product.
productBrand

string

Brand of the product.
productCountry

string

Resource name of the geo target constant for the country of sale of the product.
productCustomAttribute0

string

Custom attribute 0 of the product.
productCustomAttribute1

string

Custom attribute 1 of the product.
productCustomAttribute2

string

Custom attribute 2 of the product.
productCustomAttribute3

string

Custom attribute 3 of the product.
productCustomAttribute4

string

Custom attribute 4 of the product.
productFeedLabel

string

Feed label of the product.
productItemId

string

Item ID of the product.
productLanguage

string

Resource name of the language constant for the language of the product.
productMerchantId

string (int64 format)

Merchant ID of the product.
productStoreId

string

Store ID of the product.
productTitle

string

Title of the product.
productTypeL1

string

Type (level 1) of the product.
productTypeL2

string

Type (level 2) of the product.
productTypeL3

string

Type (level 3) of the product.
productTypeL4

string

Type (level 4) of the product.
productTypeL5

string

Type (level 5) of the product.
quarter

string

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

string

A search term subcategory. An empty string denotes the catch-all subcategory for search terms that didn't fit into another subcategory.
searchTerm

string

A search term.
webpage

string

Resource name of the ad group criterion that represents webpage criterion.
week

string

Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
year

integer

Year, formatted as yyyy.
skAdNetworkConversionValue

string (int64 format)

iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign.
skAdNetworkSourceApp

object (SkAdNetworkSourceApp)

App where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.
skAdNetworkSourceDomain

string

Website where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.
skAdNetworkPostbackSequenceIndex

string (int64 format)

iOS Store Kit Ad Network postback sequence index.
assetInteractionTarget

object (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.

AdDestinationType

Enumerates Google Ads destination types

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
NOT_APPLICABLE Ads that don't intend to drive users off from ads to other destinations
WEBSITE Website
APP_STORE iOS App Store or Play Store
PHONE_CALL Call Dialer
MAP_DIRECTIONS Map App
LOCATION_LISTING Location Dedicated Page
MESSAGE Text Message
LEAD_FORM Lead Generation Form
YOUTUBE YouTube
UNMODELED_FOR_CONVERSIONS Ad Destination for Conversions with keys unknown

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.
MIXED Cross-network.
YOUTUBE YouTube
GOOGLE_TV Google TV

BudgetCampaignAssociationStatus

A BudgetCampaignAssociationStatus segment.

JSON representation 
{
  "status": enum (BudgetCampaignAssociationStatus),
  "campaign": string
}
Fields
status

enum (BudgetCampaignAssociationStatus)

Budget campaign association status.
campaign

string

The campaign resource name.

BudgetCampaignAssociationStatus

Possible statuses of the association between the Budget and the Campaign.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The campaign is currently using the budget.
REMOVED The campaign is no longer using the budget.

ClickType

Enumerates Google Ads click types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
BREADCRUMBS Breadcrumbs.
BROADBAND_PLAN Broadband Plan.
CALL_TRACKING Manually dialed phone calls.
CALLS Phone calls.
CLICK_ON_ENGAGEMENT_AD Click on engagement ad.
GET_DIRECTIONS Driving direction.
LOCATION_EXPANSION Get location details.
LOCATION_FORMAT_CALL Call.
LOCATION_FORMAT_DIRECTIONS Directions.
LOCATION_FORMAT_IMAGE Image(s).
LOCATION_FORMAT_LANDING_PAGE Go to landing page.
LOCATION_FORMAT_MAP Map.
LOCATION_FORMAT_STORE_INFO Go to store info.
LOCATION_FORMAT_TEXT Text.
MOBILE_CALL_TRACKING Mobile phone calls.
OFFER_PRINTS Print offer.
OTHER Other.
PRODUCT_EXTENSION_CLICKS Product plusbox offer.
PRODUCT_LISTING_AD_CLICKS Shopping - Product - Online.
STORE_LOCATOR Show nearby locations.
URL_CLICKS Headline.
VIDEO_APP_STORE_CLICKS App store.
VIDEO_CALL_TO_ACTION_CLICKS Call-to-Action overlay.
VIDEO_CARD_ACTION_HEADLINE_CLICKS Cards.
VIDEO_END_CAP_CLICKS End cap.
VIDEO_WEBSITE_CLICKS Website.
WIRELESS_PLAN Wireless Plan.
PRODUCT_LISTING_AD_LOCAL Shopping - Product - Local.
PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL Shopping - Product - MultiChannel Local.
PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE Shopping - Product - MultiChannel Online.
PRODUCT_LISTING_ADS_COUPON Shopping - Product - Coupon.
PRODUCT_LISTING_AD_TRANSACTABLE Shopping - Product - Sell on Google.
PROMOTION_EXTENSION Promotion Extension.
HOTEL_PRICE Hotel price.
PRICE_EXTENSION Price Extension.
HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION Book on Google hotel room selection.
SHOPPING_COMPARISON_LISTING Shopping - Comparison Listing.
CROSS_NETWORK Cross-network. From Performance Max and Discovery Campaigns.

ConversionAttributionEventType

The event type of conversions that are attributed to.

Enums
UNSPECIFIED Not specified.
UNKNOWN Represents value unknown in this version.
IMPRESSION The conversion is attributed to an impression.
INTERACTION The conversion is attributed to an interaction.

ConversionLagBucket

Enum representing the number of days between impression and conversion.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LESS_THAN_ONE_DAY Conversion lag bucket from 0 to 1 day. 0 day is included, 1 day is not.
ONE_TO_TWO_DAYS Conversion lag bucket from 1 to 2 days. 1 day is included, 2 days is not.
TWO_TO_THREE_DAYS Conversion lag bucket from 2 to 3 days. 2 days is included, 3 days is not.
THREE_TO_FOUR_DAYS Conversion lag bucket from 3 to 4 days. 3 days is included, 4 days is not.
FOUR_TO_FIVE_DAYS Conversion lag bucket from 4 to 5 days. 4 days is included, 5 days is not.
FIVE_TO_SIX_DAYS Conversion lag bucket from 5 to 6 days. 5 days is included, 6 days is not.
SIX_TO_SEVEN_DAYS Conversion lag bucket from 6 to 7 days. 6 days is included, 7 days is not.
SEVEN_TO_EIGHT_DAYS Conversion lag bucket from 7 to 8 days. 7 days is included, 8 days is not.
EIGHT_TO_NINE_DAYS Conversion lag bucket from 8 to 9 days. 8 days is included, 9 days is not.
NINE_TO_TEN_DAYS Conversion lag bucket from 9 to 10 days. 9 days is included, 10 days is not.
TEN_TO_ELEVEN_DAYS Conversion lag bucket from 10 to 11 days. 10 days is included, 11 days is not.
ELEVEN_TO_TWELVE_DAYS Conversion lag bucket from 11 to 12 days. 11 days is included, 12 days is not.
TWELVE_TO_THIRTEEN_DAYS Conversion lag bucket from 12 to 13 days. 12 days is included, 13 days is not.
THIRTEEN_TO_FOURTEEN_DAYS Conversion lag bucket from 13 to 14 days. 13 days is included, 14 days is not.
FOURTEEN_TO_TWENTY_ONE_DAYS Conversion lag bucket from 14 to 21 days. 14 days is included, 21 days is not.
TWENTY_ONE_TO_THIRTY_DAYS Conversion lag bucket from 21 to 30 days. 21 days is included, 30 days is not.
THIRTY_TO_FORTY_FIVE_DAYS Conversion lag bucket from 30 to 45 days. 30 days is included, 45 days is not.
FORTY_FIVE_TO_SIXTY_DAYS Conversion lag bucket from 45 to 60 days. 45 days is included, 60 days is not.
SIXTY_TO_NINETY_DAYS Conversion lag bucket from 60 to 90 days. 60 days is included, 90 days is not.

ConversionOrAdjustmentLagBucket

Enum representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CONVERSION_LESS_THAN_ONE_DAY Conversion lag bucket from 0 to 1 day. 0 day is included, 1 day is not.
CONVERSION_ONE_TO_TWO_DAYS Conversion lag bucket from 1 to 2 days. 1 day is included, 2 days is not.
CONVERSION_TWO_TO_THREE_DAYS Conversion lag bucket from 2 to 3 days. 2 days is included, 3 days is not.
CONVERSION_THREE_TO_FOUR_DAYS Conversion lag bucket from 3 to 4 days. 3 days is included, 4 days is not.
CONVERSION_FOUR_TO_FIVE_DAYS Conversion lag bucket from 4 to 5 days. 4 days is included, 5 days is not.
CONVERSION_FIVE_TO_SIX_DAYS Conversion lag bucket from 5 to 6 days. 5 days is included, 6 days is not.
CONVERSION_SIX_TO_SEVEN_DAYS Conversion lag bucket from 6 to 7 days. 6 days is included, 7 days is not.
CONVERSION_SEVEN_TO_EIGHT_DAYS Conversion lag bucket from 7 to 8 days. 7 days is included, 8 days is not.
CONVERSION_EIGHT_TO_NINE_DAYS Conversion lag bucket from 8 to 9 days. 8 days is included, 9 days is not.
CONVERSION_NINE_TO_TEN_DAYS Conversion lag bucket from 9 to 10 days. 9 days is included, 10 days is not.
CONVERSION_TEN_TO_ELEVEN_DAYS Conversion lag bucket from 10 to 11 days. 10 days is included, 11 days is not.
CONVERSION_ELEVEN_TO_TWELVE_DAYS Conversion lag bucket from 11 to 12 days. 11 days is included, 12 days is not.
CONVERSION_TWELVE_TO_THIRTEEN_DAYS Conversion lag bucket from 12 to 13 days. 12 days is included, 13 days is not.
CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS Conversion lag bucket from 13 to 14 days. 13 days is included, 14 days is not.
CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS Conversion lag bucket from 14 to 21 days. 14 days is included, 21 days is not.
CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS Conversion lag bucket from 21 to 30 days. 21 days is included, 30 days is not.
CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS Conversion lag bucket from 30 to 45 days. 30 days is included, 45 days is not.
CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS Conversion lag bucket from 45 to 60 days. 45 days is included, 60 days is not.
CONVERSION_SIXTY_TO_NINETY_DAYS Conversion lag bucket from 60 to 90 days. 60 days is included, 90 days is not.
ADJUSTMENT_LESS_THAN_ONE_DAY Conversion adjustment lag bucket from 0 to 1 day. 0 day is included, 1 day is not.
ADJUSTMENT_ONE_TO_TWO_DAYS Conversion adjustment lag bucket from 1 to 2 days. 1 day is included, 2 days is not.
ADJUSTMENT_TWO_TO_THREE_DAYS Conversion adjustment lag bucket from 2 to 3 days. 2 days is included, 3 days is not.
ADJUSTMENT_THREE_TO_FOUR_DAYS Conversion adjustment lag bucket from 3 to 4 days. 3 days is included, 4 days is not.
ADJUSTMENT_FOUR_TO_FIVE_DAYS Conversion adjustment lag bucket from 4 to 5 days. 4 days is included, 5 days is not.
ADJUSTMENT_FIVE_TO_SIX_DAYS Conversion adjustment lag bucket from 5 to 6 days. 5 days is included, 6 days is not.
ADJUSTMENT_SIX_TO_SEVEN_DAYS Conversion adjustment lag bucket from 6 to 7 days. 6 days is included, 7 days is not.
ADJUSTMENT_SEVEN_TO_EIGHT_DAYS Conversion adjustment lag bucket from 7 to 8 days. 7 days is included, 8 days is not.
ADJUSTMENT_EIGHT_TO_NINE_DAYS Conversion adjustment lag bucket from 8 to 9 days. 8 days is included, 9 days is not.
ADJUSTMENT_NINE_TO_TEN_DAYS Conversion adjustment lag bucket from 9 to 10 days. 9 days is included, 10 days is not.
ADJUSTMENT_TEN_TO_ELEVEN_DAYS Conversion adjustment lag bucket from 10 to 11 days. 10 days is included, 11 days is not.
ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS Conversion adjustment lag bucket from 11 to 12 days. 11 days is included, 12 days is not.
ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS Conversion adjustment lag bucket from 12 to 13 days. 12 days is included, 13 days is not.
ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS Conversion adjustment lag bucket from 13 to 14 days. 13 days is included, 14 days is not.
ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS Conversion adjustment lag bucket from 14 to 21 days. 14 days is included, 21 days is not.
ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS Conversion adjustment lag bucket from 21 to 30 days. 21 days is included, 30 days is not.
ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS Conversion adjustment lag bucket from 30 to 45 days. 30 days is included, 45 days is not.
ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS Conversion adjustment lag bucket from 45 to 60 days. 45 days is included, 60 days is not.
ADJUSTMENT_SIXTY_TO_NINETY_DAYS Conversion adjustment lag bucket from 60 to 90 days. 60 days is included, 90 days is not.
ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS Conversion adjustment lag bucket from 90 to 145 days. 90 days is included, 145 days is not.
CONVERSION_UNKNOWN Conversion lag bucket UNKNOWN. This is for dates before conversion lag bucket was available in Google Ads.
ADJUSTMENT_UNKNOWN Conversion adjustment lag bucket UNKNOWN. This is for dates before conversion adjustment lag bucket was available in Google Ads.

ExternalConversionSource

The external conversion source that is associated with a ConversionAction.

Enums
UNSPECIFIED Not specified.
UNKNOWN Represents value unknown in this version.
WEBPAGE Conversion that occurs when a user navigates to a particular webpage after viewing an ad; Displayed in Google Ads UI as 'Website'.
ANALYTICS Conversion that comes from linked Google Analytics goal or transaction; Displayed in Google Ads UI as 'Analytics'.
UPLOAD Website conversion that is uploaded through ConversionUploadService; Displayed in Google Ads UI as 'Import from clicks'.
AD_CALL_METRICS Conversion that occurs when a user clicks on a call extension directly on an ad; Displayed in Google Ads UI as 'Calls from ads'.
WEBSITE_CALL_METRICS Conversion that occurs when a user calls a dynamically-generated phone number (by installed javascript) from an advertiser's website after clicking on an ad; Displayed in Google Ads UI as 'Calls from website'.
STORE_VISITS Conversion that occurs when a user visits an advertiser's retail store after clicking on a Google ad; Displayed in Google Ads UI as 'Store visits'.
ANDROID_IN_APP Conversion that occurs when a user takes an in-app action such as a purchase in an Android app; Displayed in Google Ads UI as 'Android in-app action'.
IOS_IN_APP Conversion that occurs when a user takes an in-app action such as a purchase in an iOS app; Displayed in Google Ads UI as 'iOS in-app action'.
IOS_FIRST_OPEN Conversion that occurs when a user opens an iOS app for the first time; Displayed in Google Ads UI as 'iOS app install (first open)'.
APP_UNSPECIFIED Legacy app conversions that do not have an AppPlatform provided; Displayed in Google Ads UI as 'Mobile app'.
ANDROID_FIRST_OPEN Conversion that occurs when a user opens an Android app for the first time; Displayed in Google Ads UI as 'Android app install (first open)'.
UPLOAD_CALLS Call conversion that is uploaded through ConversionUploadService; Displayed in Google Ads UI as 'Import from calls'.
FIREBASE Conversion that comes from a linked Firebase event; Displayed in Google Ads UI as 'Firebase'.
CLICK_TO_CALL Conversion that occurs when a user clicks on a mobile phone number; Displayed in Google Ads UI as 'Phone number clicks'.
SALESFORCE Conversion that comes from Salesforce; Displayed in Google Ads UI as 'Salesforce.com'.
STORE_SALES_CRM Conversion that comes from in-store purchases recorded by CRM; Displayed in Google Ads UI as 'Store sales (data partner)'.
STORE_SALES_PAYMENT_NETWORK Conversion that comes from in-store purchases from payment network; Displayed in Google Ads UI as 'Store sales (payment network)'.
GOOGLE_PLAY Codeless Google Play conversion; Displayed in Google Ads UI as 'Google Play'.
THIRD_PARTY_APP_ANALYTICS Conversion that comes from a linked third-party app analytics event; Displayed in Google Ads UI as 'Third-party app analytics'.
GOOGLE_ATTRIBUTION Conversion that is controlled by Google Attribution.
STORE_SALES_DIRECT_UPLOAD Store Sales conversion based on first-party or third-party merchant data uploads. Displayed in Google Ads UI as 'Store sales (direct upload)'.
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. Displayed in Google Ads UI as 'Store sales'.
SEARCH_ADS_360 Conversions imported from Search Ads 360 Floodlight data.
GOOGLE_HOSTED Conversions that track local actions from Google's products and services after interacting with an ad.
FLOODLIGHT Conversions reported by Floodlight tags.
ANALYTICS_SEARCH_ADS_360 Conversions that come from Google Analytics specifically for Search Ads 360. Displayed in Google Ads UI as Analytics (SA360).
FIREBASE_SEARCH_ADS_360 Conversion that comes from a linked Firebase event for Search Ads 360.
DISPLAY_AND_VIDEO_360_FLOODLIGHT Conversion that is reported by Floodlight for DV360.

HotelRateType

Enum describing possible hotel rate types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
UNAVAILABLE Rate type information is unavailable.
PUBLIC_RATE Rates available to everyone.
QUALIFIED_RATE A membership program rate is available and satisfies basic requirements like having a public rate available. UI treatment will strikethrough the public rate and indicate that a discount is available to the user. For more on Qualified Rates, visit https://developers.google.com/hotels/hotel-ads/dev-guide/qualified-rates
PRIVATE_RATE Rates available to users that satisfy some eligibility criteria, for example, all signed-in users, 20% of mobile users, all mobile users in Canada, etc.

HotelPriceBucket

Enum describing possible hotel price buckets.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
LOWEST_UNIQUE Uniquely lowest price. Partner has the lowest price, and no other partners are within a small variance of that price.
LOWEST_TIED Tied for lowest price. Partner is within a small variance of the lowest price.
NOT_LOWEST Not lowest price. Partner is not within a small variance of the lowest price.
ONLY_PARTNER_SHOWN Partner was the only one shown.

Keyword

A Keyword criterion segment.

JSON representation 
{
  "info": {
    object (KeywordInfo)
  },
  "adGroupCriterion": string
}
Fields
info

object (KeywordInfo)

Keyword info.
adGroupCriterion

string

The AdGroupCriterion resource name.

SearchEngineResultsPageType

The type of the search engine results page.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADS_ONLY Only ads were contained in the search engine results page.
ORGANIC_ONLY Only organic results were contained in the search engine results page.
ADS_AND_ORGANIC Both ads and organic results were contained in the search engine results page.

SearchTermMatchType

Possible match types for a keyword triggering an ad, including variants.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BROAD Broad match.
EXACT Exact match.
PHRASE Phrase match.
NEAR_EXACT Exact match (close variant).
NEAR_PHRASE Phrase match (close variant).

Slot

Enumerates possible positions of the Ad.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
SEARCH_SIDE Google search: Side.
SEARCH_TOP Google search: Top.
SEARCH_OTHER Google search: Other.
CONTENT Google Display Network.
SEARCH_PARTNER_TOP Search partners: Top.
SEARCH_PARTNER_OTHER Search partners: Other.
MIXED Cross-network.

ConversionValueRulePrimaryDimension

Identifies the primary dimension for conversion value rule stats.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NO_RULE_APPLIED For no-value-rule-applied conversions after value rule is enabled.
ORIGINAL Below are for value-rule-applied conversions: The original stats.
NEW_VS_RETURNING_USER When a new or returning customer condition is satisfied.
GEO_LOCATION When a query-time Geo location condition is satisfied.
DEVICE When a query-time browsing device condition is satisfied.
AUDIENCE When a query-time audience condition is satisfied.
MULTIPLE When multiple rules are applied.

SkAdNetworkUserType

Enumerates SkAdNetwork user types

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
UNAVAILABLE The value was not present in the postback or we do not have this data for other reasons.
NEW_INSTALLER The user installed the app for the first time.
REINSTALLER The user has previously installed the app.

SkAdNetworkAdEventType

Enumerates SkAdNetwork ad event types

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
UNAVAILABLE The value was not present in the postback or we do not have this data for other reasons.
INTERACTION The user interacted with the ad.
VIEW The user viewed the ad.

SkAdNetworkSourceApp

A SkAdNetworkSourceApp segment.

JSON representation 
{
  "skAdNetworkSourceAppId": string
}
Fields
skAdNetworkSourceAppId

string

App id where the ad that drove the iOS Store Kit Ad Network install was shown.

SkAdNetworkAttributionCredit

Enumerates SkAdNetwork attribution credits.

Enums
UNSPECIFIED Default value. This value is equivalent to null.
UNKNOWN The value is unknown in this API version. The true enum value cannot be returned in this API version or is not supported yet.
UNAVAILABLE The value was not present in the postback or we do not have this data for other reasons.
WON Google was the ad network that won ad attribution.
CONTRIBUTED Google qualified for attribution, but didn't win.

SkAdNetworkSourceType

Enumerates SkAdNetwork source types

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
UNAVAILABLE The source app ID or source domain was not present in the postback or we do not have this data for other reasons.
WEBSITE The ad was shown on a webpage.
MOBILE_APPLICATION The ad was shown on an app.

AssetInteractionTarget

An AssetInteractionTarget segment.

JSON representation 
{
  "asset": string,
  "interactionOnThisAsset": boolean
}
Fields
asset

string

The asset resource name.
interactionOnThisAsset

boolean

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.

ConvertingUserPriorEngagementTypeAndLtvBucket

Enumerates converting user prior engagement types and lifetime-value bucket

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
NEW Converting user is new to the advertiser.
RETURNING Converting user is returning to the advertiser. Definition of returning differs among conversion types, such as a second store visit versus a second online purchase.
NEW_AND_HIGH_LTV Converting user is new to the advertiser and has high lifetime value.