Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

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)
  },
  "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)
  },
  "assetGroup": {
    object (AssetGroup)
  },
  "assetSetAsset": {
    object (AssetSetAsset)
  },
  "assetSet": {
    object (AssetSet)
  },
  "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)
  },
  "campaignCriterionSimulation": {
    object (CampaignCriterionSimulation)
  },
  "campaignCustomizer": {
    object (CampaignCustomizer)
  },
  "campaignDraft": {
    object (CampaignDraft)
  },
  "campaignExperiment": {
    object (CampaignExperiment)
  },
  "campaignExtensionSetting": {
    object (CampaignExtensionSetting)
  },
  "campaignFeed": {
    object (CampaignFeed)
  },
  "campaignGroup": {
    object (CampaignGroup)
  },
  "campaignLabel": {
    object (CampaignLabel)
  },
  "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)
  },
  "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)
  },
  "customerNegativeCriterion": {
    object (CustomerNegativeCriterion)
  },
  "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)
  },
  "mobileAppCategoryConstant": {
    object (MobileAppCategoryConstant)
  },
  "mobileDeviceConstant": {
    object (MobileDeviceConstant)
  },
  "offlineUserDataJob": {
    object (OfflineUserDataJob)
  },
  "operatingSystemVersionConstant": {
    object (OperatingSystemVersionConstant)
  },
  "paidOrganicSearchTermView": {
    object (PaidOrganicSearchTermView)
  },
  "parentalStatusView": {
    object (ParentalStatusView)
  },
  "productBiddingCategoryConstant": {
    object (ProductBiddingCategoryConstant)
  },
  "productGroupView": {
    object (ProductGroupView)
  },
  "recommendation": {
    object (Recommendation)
  },
  "searchTermView": {
    object (SearchTermView)
  },
  "sharedCriterion": {
    object (SharedCriterion)
  },
  "sharedSet": {
    object (SharedSet)
  },
  "smartCampaignSetting": {
    object (SmartCampaignSetting)
  },
  "shoppingPerformanceView": {
    object (ShoppingPerformanceView)
  },
  "smartCampaignSearchTermView": {
    object (SmartCampaignSearchTermView)
  },
  "thirdPartyAppAnalyticsLink": {
    object (ThirdPartyAppAnalyticsLink)
  },
  "topicView": {
    object (TopicView)
  },
  "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)
  },
  "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.

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.

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.

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.

campaignCriterionSimulation

object (CampaignCriterionSimulation)

The campaign criterion simulation referenced in the query.

campaignCustomizer

object (CampaignCustomizer)

The campaign customizer referenced in the query.

campaignDraft

object (CampaignDraft)

The campaign draft referenced in the query.

campaignExperiment

object (CampaignExperiment)

The campaign experiment 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.

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.

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.

customerNegativeCriterion

object (CustomerNegativeCriterion)

The customer negative criterion 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.

mobileAppCategoryConstant

object (MobileAppCategoryConstant)

The mobile app category constant referenced in the query.

mobileDeviceConstant

object (MobileDeviceConstant)

The mobile device constant referenced in the query.

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.

parentalStatusView

object (ParentalStatusView)

The parental status view referenced in the query.

productBiddingCategoryConstant

object (ProductBiddingCategoryConstant)

The Product Bidding 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.

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.

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.

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 (e.g. spending limit), these differences are juxtaposed via '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, e.g. 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, e.g. 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, e.g. 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, e.g. 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, e.g. 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, e.g. 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, e.g. 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, e.g. INFINITE.

AdGroupAdAssetCombinationView

A view on the usage of ad group ad asset combination. Now we only support AdGroupAdAssetCombinationView for Responsive googleAds.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.

JSON representation
{
  "resourceName": string,
  "fieldType": enum (AssetFieldType),
  "policySummary": {
    object (AdGroupAdAssetPolicySummary)
  },
  "performanceLabel": enum (AssetPerformanceLabel),
  "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.

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,

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

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 googleAds.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. e.g. 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. e.g. "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.

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}

CampaignCriterionSimulation

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

  1. SEARCH - 30000,30001,30002 - BID_MODIFIER - UNIFORM
  2. DISPLAY - 30001 - BID_MODIFIER - UNIFORM
JSON representation
{
  "resourceName": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "campaignId": string,
  "criterionId": string,
  "startDate": string,
  "endDate": string,
  "bidModifierPointList": {
    object (BidModifierSimulationPointList)
  }
}
Fields
resourceName

string

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

customers/{customerId}/campaignCriterionSimulations/{campaignId}~{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.

campaignId

string (int64 format)

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

bidModifierPointList

object (BidModifierSimulationPointList)

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

BidModifierSimulationPointList

A container for simulation points for simulations of type BID_MODIFIER.

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

object (BidModifierSimulationPoint)

Projected metrics for a series of bid modifier amounts.

BidModifierSimulationPoint

Projected metrics for a specific bid modifier amount.

JSON representation
{
  "bidModifier": number,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string,
  "parentBiddableConversions": number,
  "parentBiddableConversionsValue": number,
  "parentClicks": string,
  "parentCostMicros": string,
  "parentImpressions": string,
  "parentTopSlotImpressions": string,
  "parentRequiredBudgetMicros": string
}
Fields
bidModifier

number

The simulated bid modifier upon which projected metrics are based.

biddableConversions

number

Projected number of biddable conversions. Only search advertising channel type supports this field.

biddableConversionsValue

number

Projected total value of biddable conversions. Only search advertising channel type supports this field.

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.

parentBiddableConversions

number

Projected number of biddable conversions for the parent resource. Only search advertising channel type supports this field.

parentBiddableConversionsValue

number

Projected total value of biddable conversions for the parent resource. Only search advertising channel type supports this field.

parentClicks

string (int64 format)

Projected number of clicks for the parent resource.

parentCostMicros

string (int64 format)

Projected cost in micros for the parent resource.

parentImpressions

string (int64 format)

Projected number of impressions for the parent resource.

parentTopSlotImpressions

string (int64 format)

Projected number of top slot impressions for the parent resource. Only search advertising channel type supports this field.

parentRequiredBudgetMicros

string (int64 format)

Projected minimum daily budget that must be available to the parent resource to realize this simulation.

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 MULTIPLE - TARGET_CPA - UNIFORM OWNED_AND_OPERATED - TARGET_CPA - DEFAULT DISPLAY - TARGET_CPA - 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. E.g. 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
}
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.

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, e.g., "AR", "FR", etc.

ChangeEvent

Describes the granular change of returned resource of certain resource types. Changes made through UI, API and new versions of Editor by external users (including external users, and internal users that can be shown externally) in the past 30 days will be shown. The change shows the old values of the changed fields before the change and the new values right after the change. 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.
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 googleAds.search Ads 360 Sync.
SEARCH_ADS_360_POST Changes made through googleAds.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.

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

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.

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-googleAds.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, e.g. "USD"

name

string

Output only. Full English name of the currency.

symbol

string

Output only. Standard symbol for describing this currency, e.g. '$' 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 desired 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
{
  "targetCpa": string
}
Fields
targetCpa

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 desired fraction of ads to be shown in the targeted location in micros. E.g. 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 desired 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, e.g. 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 (e.g. 'USD', 'EUR') for the client. Read only.

id

string (int64 format)

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

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, e.g. 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, e.g. domain, link to the mobile application in app store, or a YouTube channel URL.

targetUrl

string

Output only. URL of the placement, e.g. 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