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)
  },
  "adGroupAssetSet": {
    object (AdGroupAssetSet)
  },
  "adGroupAudienceView": {
    object (AdGroupAudienceView)
  },
  "adGroupBidModifier": {
    object (AdGroupBidModifier)
  },
  "adGroupCriterion": {
    object (AdGroupCriterion)
  },
  "adGroupCriterionCustomizer": {
    object (AdGroupCriterionCustomizer)
  },
  "adGroupCriterionLabel": {
    object (AdGroupCriterionLabel)
  },
  "adGroupCriterionSimulation": {
    object (AdGroupCriterionSimulation)
  },
  "adGroupCustomizer": {
    object (AdGroupCustomizer)
  },
  "adGroupExtensionSetting": {
    object (AdGroupExtensionSetting)
  },
  "adGroupFeed": {
    object (AdGroupFeed)
  },
  "adGroupLabel": {
    object (AdGroupLabel)
  },
  "adGroupSimulation": {
    object (AdGroupSimulation)
  },
  "adParameter": {
    object (AdParameter)
  },
  "ageRangeView": {
    object (AgeRangeView)
  },
  "adScheduleView": {
    object (AdScheduleView)
  },
  "domainCategory": {
    object (DomainCategory)
  },
  "asset": {
    object (Asset)
  },
  "assetFieldTypeView": {
    object (AssetFieldTypeView)
  },
  "assetGroupAsset": {
    object (AssetGroupAsset)
  },
  "assetGroupSignal": {
    object (AssetGroupSignal)
  },
  "assetGroupListingGroupFilter": {
    object (AssetGroupListingGroupFilter)
  },
  "assetGroupProductGroupView": {
    object (AssetGroupProductGroupView)
  },
  "assetGroup": {
    object (AssetGroup)
  },
  "assetSetAsset": {
    object (AssetSetAsset)
  },
  "assetSet": {
    object (AssetSet)
  },
  "assetSetTypeView": {
    object (AssetSetTypeView)
  },
  "batchJob": {
    object (BatchJob)
  },
  "biddingDataExclusion": {
    object (BiddingDataExclusion)
  },
  "biddingSeasonalityAdjustment": {
    object (BiddingSeasonalityAdjustment)
  },
  "biddingStrategy": {
    object (BiddingStrategy)
  },
  "biddingStrategySimulation": {
    object (BiddingStrategySimulation)
  },
  "billingSetup": {
    object (BillingSetup)
  },
  "callView": {
    object (CallView)
  },
  "campaignBudget": {
    object (CampaignBudget)
  },
  "campaign": {
    object (Campaign)
  },
  "campaignAsset": {
    object (CampaignAsset)
  },
  "campaignAssetSet": {
    object (CampaignAssetSet)
  },
  "campaignAudienceView": {
    object (CampaignAudienceView)
  },
  "campaignBidModifier": {
    object (CampaignBidModifier)
  },
  "campaignConversionGoal": {
    object (CampaignConversionGoal)
  },
  "campaignCriterion": {
    object (CampaignCriterion)
  },
  "campaignCriterionSimulation": {
    object (CampaignCriterionSimulation)
  },
  "campaignCustomizer": {
    object (CampaignCustomizer)
  },
  "campaignDraft": {
    object (CampaignDraft)
  },
  "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)
  },
  "customerAssetSet": {
    object (CustomerAssetSet)
  },
  "accessibleBiddingStrategy": {
    object (AccessibleBiddingStrategy)
  },
  "customerCustomizer": {
    object (CustomerCustomizer)
  },
  "customerManagerLink": {
    object (CustomerManagerLink)
  },
  "customerClientLink": {
    object (CustomerClientLink)
  },
  "customerClient": {
    object (CustomerClient)
  },
  "customerConversionGoal": {
    object (CustomerConversionGoal)
  },
  "customerExtensionSetting": {
    object (CustomerExtensionSetting)
  },
  "customerFeed": {
    object (CustomerFeed)
  },
  "customerLabel": {
    object (CustomerLabel)
  },
  "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)
  },
  "perStoreView": {
    object (PerStoreView)
  },
  "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.

adGroupAssetSet

object (AdGroupAssetSet)

The ad group asset set referenced in the query.

adGroupAudienceView

object (AdGroupAudienceView)

The ad group audience view referenced in the query.

adGroupBidModifier

object (AdGroupBidModifier)

The bid modifier referenced in the query.

adGroupCriterion

object (AdGroupCriterion)

The criterion referenced in the query.

adGroupCriterionCustomizer

object (AdGroupCriterionCustomizer)

The ad group criterion customizer referenced in the query.

adGroupCriterionLabel

object (AdGroupCriterionLabel)

The ad group criterion label referenced in the query.

adGroupCriterionSimulation

object (AdGroupCriterionSimulation)

The ad group criterion simulation referenced in the query.

adGroupCustomizer

object (AdGroupCustomizer)

The ad group customizer referenced in the query.

adGroupExtensionSetting

object (AdGroupExtensionSetting)

The ad group extension setting referenced in the query.

adGroupFeed

object (AdGroupFeed)

The ad group feed referenced in the query.

adGroupLabel

object (AdGroupLabel)

The ad group label referenced in the query.

adGroupSimulation

object (AdGroupSimulation)

The ad group simulation referenced in the query.

adParameter

object (AdParameter)

The ad parameter referenced in the query.

ageRangeView

object (AgeRangeView)

The age range view referenced in the query.

adScheduleView

object (AdScheduleView)

The ad schedule view referenced in the query.

domainCategory

object (DomainCategory)

The domain category referenced in the query.

asset

object (Asset)

The asset referenced in the query.

assetFieldTypeView

object (AssetFieldTypeView)

The asset field type view referenced in the query.

assetGroupAsset

object (AssetGroupAsset)

The asset group asset referenced in the query.

assetGroupSignal

object (AssetGroupSignal)

The asset group signal referenced in the query.

assetGroupListingGroupFilter

object (AssetGroupListingGroupFilter)

The asset group listing group filter referenced in the query.

assetGroupProductGroupView

object (AssetGroupProductGroupView)

The asset group product group view referenced in the query.

assetGroup

object (AssetGroup)

The asset group referenced in the query.

assetSetAsset

object (AssetSetAsset)

The asset set asset referenced in the query.

assetSet

object (AssetSet)

The asset set referenced in the query.

assetSetTypeView

object (AssetSetTypeView)

The asset set type view referenced in the query.

batchJob

object (BatchJob)

The batch job referenced in the query.

biddingDataExclusion

object (BiddingDataExclusion)

The bidding data exclusion referenced in the query.

biddingSeasonalityAdjustment

object (BiddingSeasonalityAdjustment)

The bidding seasonality adjustment referenced in the query.

biddingStrategy

object (BiddingStrategy)

The bidding strategy referenced in the query.

biddingStrategySimulation

object (BiddingStrategySimulation)

The bidding strategy simulation referenced in the query.

billingSetup

object (BillingSetup)

The billing setup referenced in the query.

callView

object (CallView)

The call view referenced in the query.

campaignBudget

object (CampaignBudget)

The campaign budget referenced in the query.

campaign

object (Campaign)

The campaign referenced in the query.

campaignAsset

object (CampaignAsset)

The campaign asset referenced in the query.

campaignAssetSet

object (CampaignAssetSet)

The campaign asset set referenced in the query.

campaignAudienceView

object (CampaignAudienceView)

The campaign audience view referenced in the query.

campaignBidModifier

object (CampaignBidModifier)

The campaign bid modifier referenced in the query.

campaignConversionGoal

object (CampaignConversionGoal)

The CampaignConversionGoal referenced in the query.

campaignCriterion

object (CampaignCriterion)

The campaign criterion referenced in the query.

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.

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.

customerAssetSet

object (CustomerAssetSet)

The customer asset set referenced in the query.

accessibleBiddingStrategy

object (AccessibleBiddingStrategy)

The accessible bidding strategy referenced in the query.

customerCustomizer

object (CustomerCustomizer)

The customer customizer referenced in the query.

customerClient

object (CustomerClient)

The CustomerClient referenced in the query.

customerConversionGoal

object (CustomerConversionGoal)

The CustomerConversionGoal referenced in the query.

customerExtensionSetting

object (CustomerExtensionSetting)

The customer extension setting referenced in the query.

customerFeed

object (CustomerFeed)

The customer feed referenced in the query.

customerLabel

object (CustomerLabel)

The customer label referenced in the query.

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.

perStoreView

object (PerStoreView)

The per store 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 (for example, spending limit), these differences are juxtaposed through 'proposed_', 'approved_', and possibly 'adjusted_' fields.

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

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

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

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

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

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

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

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

string

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

customers/{customerId}/accountBudgets/{account_budget_id}

status

enum (AccountBudgetStatus)

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

totalAdjustmentsMicros

string (int64 format)

Output only. The total adjustments amount.

An example of an adjustment is courtesy credits.

amountServedMicros

string (int64 format)

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

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

pendingProposal

object (PendingAccountBudgetProposal)

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

id

string (int64 format)

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

billingSetup

string

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

customers/{customerId}/billingSetups/{billing_setup_id}

name

string

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

proposedStartDateTime

string

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

approvedStartDateTime

string

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

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

purchaseOrderNumber

string

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

notes

string

Output only. Notes associated with the budget.

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

string

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

proposedEndTimeType

enum (TimeType)

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

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

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

approvedEndDateTime

string

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

approvedEndTimeType

enum (TimeType)

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

Union field proposed_spending_limit. The proposed spending limit. proposed_spending_limit can be only one of the following:
proposedSpendingLimitMicros

string (int64 format)

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

proposedSpendingLimitType

enum (SpendingLimitType)

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

Union field approved_spending_limit. The approved spending limit.

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

approvedSpendingLimitMicros

string (int64 format)

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

approvedSpendingLimitType

enum (SpendingLimitType)

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

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

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

adjustedSpendingLimitMicros

string (int64 format)

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

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

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

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

adjustedSpendingLimitType

enum (SpendingLimitType)

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

AccountBudgetStatus

The possible statuses of an AccountBudget.

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

PendingAccountBudgetProposal

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

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

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

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

enum (AccountBudgetProposalType)

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

accountBudgetProposal

string

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

customers/{customerId}/accountBudgetProposals/{account_budget_proposal_id}

name

string

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

startDateTime

string

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

purchaseOrderNumber

string

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

notes

string

Output only. Notes associated with this budget.

creationDateTime

string

Output only. The time when this account-level budget proposal was created. Formatted as yyyy-MM-dd HH:mm:ss.

Union field end_time. The end time of the account-level budget. end_time can be only one of the following:
endDateTime

string

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

endTimeType

enum (TimeType)

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

Union field spending_limit. The spending limit. spending_limit can be only one of the following:
spendingLimitMicros

string (int64 format)

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

spendingLimitType

enum (SpendingLimitType)

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

AdGroupAdAssetCombinationView

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

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

string

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

servedAssets[]

object (AssetUsage)

Output only. Served assets.

enabled

boolean

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

AssetUsage

Contains the usage information of the asset.

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

string

Resource name of the asset.

servedAssetFieldType

enum (ServedAssetFieldType)

The served field type of the asset.

AdGroupAdAssetView

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

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

string

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

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

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

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

fieldType

enum (AssetFieldType)

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

policySummary

object (AdGroupAdAssetPolicySummary)

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

performanceLabel

enum (AssetPerformanceLabel)

Output only. Performance of an asset linkage.

pinnedField

enum (ServedAssetFieldType)

Output only. Pinned field.

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.