- JSON representation
- AccountBudget
- AccountBudgetStatus
- PendingAccountBudgetProposal
- AdGroupAdAssetCombinationView
- AssetUsage
- AdGroupAdAssetView
- AdGroupAdAssetPolicySummary
- AdGroupAudienceView
- AdGroupCriterionSimulation
- SimulationType
- SimulationModificationMethod
- CpcBidSimulationPointList
- CpcBidSimulationPoint
- PercentCpcBidSimulationPointList
- PercentCpcBidSimulationPoint
- AdGroupSimulation
- CpvBidSimulationPointList
- CpvBidSimulationPoint
- TargetCpaSimulationPointList
- TargetCpaSimulationPoint
- TargetRoasSimulationPointList
- TargetRoasSimulationPoint
- AgeRangeView
- AdScheduleView
- DomainCategory
- AssetFieldTypeView
- AssetGroupProductGroupView
- AssetSetTypeView
- BiddingStrategySimulation
- CallView
- CallTrackingDisplayLocation
- CallType
- GoogleVoiceCallStatus
- CampaignAudienceView
- CampaignCriterionSimulation
- BidModifierSimulationPointList
- BidModifierSimulationPoint
- CampaignSimulation
- TargetImpressionShareSimulationPointList
- TargetImpressionShareSimulationPoint
- BudgetSimulationPointList
- BudgetSimulationPoint
- CarrierConstant
- ChangeEvent
- ChangeEventResourceType
- ChangeClientType
- ChangedResource
- ResourceChangeOperation
- ChangeStatus
- ChangeStatusResourceType
- ChangeStatusOperation
- CombinedAudience
- CombinedAudienceStatus
- ClickView
- ClickLocation
- CurrencyConstant
- AccessibleBiddingStrategy
- MaximizeConversionValue
- MaximizeConversions
- TargetCpa
- TargetImpressionShare
- TargetRoas
- TargetSpend
- CustomerClient
- DetailPlacementView
- PlacementType
- DetailedDemographic
- CriterionCategoryAvailability
- CriterionCategoryChannelAvailability
- CriterionCategoryChannelAvailabilityMode
- CriterionCategoryLocaleAvailability
- CriterionCategoryLocaleAvailabilityMode
- DisplayKeywordView
- DistanceView
- DistanceBucket
- DynamicSearchAdsSearchTermView
- ExpandedLandingPageView
- FeedPlaceholderView
- GenderView
- GeographicView
- GeoTargetingType
- GroupPlacementView
- HotelGroupView
- HotelPerformanceView
- HotelReconciliation
- HotelReconciliationStatus
- IncomeRangeView
- KeywordView
- LandingPageView
- LanguageConstant
- LocationView
- ManagedPlacementView
- MobileAppCategoryConstant
- MobileDeviceConstant
- MobileDeviceType
- OperatingSystemVersionConstant
- OperatingSystemVersionOperatorType
- PaidOrganicSearchTermView
- QualifyingQuestion
- ParentalStatusView
- PerStoreView
- ProductBiddingCategoryConstant
- ProductBiddingCategoryStatus
- ProductGroupView
- Recommendation
- RecommendationType
- RecommendationImpact
- RecommendationMetrics
- CampaignBudgetRecommendation
- CampaignBudgetRecommendationOption
- KeywordRecommendation
- TextAdRecommendation
- TargetCpaOptInRecommendation
- TargetCpaOptInRecommendationOption
- TargetCpaOptInRecommendationGoal
- MaximizeConversionsOptInRecommendation
- EnhancedCpcOptInRecommendation
- SearchPartnersOptInRecommendation
- MaximizeClicksOptInRecommendation
- OptimizeAdRotationRecommendation
- KeywordMatchTypeRecommendation
- MoveUnusedBudgetRecommendation
- TargetRoasOptInRecommendation
- ResponsiveSearchAdRecommendation
- UseBroadMatchKeywordRecommendation
- ResponsiveSearchAdAssetRecommendation
- UpgradeSmartShoppingCampaignToPerformanceMaxRecommendation
- ResponsiveSearchAdImproveAdStrengthRecommendation
- DisplayExpansionOptInRecommendation
- UpgradeLocalCampaignToPerformanceMaxRecommendation
- RaiseTargetCpaBidTooLowRecommendation
- ForecastingSetTargetRoasRecommendation
- CampaignBudget
- CalloutAssetRecommendation
- SitelinkAssetRecommendation
- CallAssetRecommendation
- ShoppingOfferAttributeRecommendation
- MerchantInfo
- ShoppingAddProductsToCampaignRecommendation
- Reason
- ShoppingFixDisapprovedProductsRecommendation
- ShoppingTargetAllOffersRecommendation
- ShoppingMerchantCenterAccountSuspensionRecommendation
- ShoppingMigrateRegularShoppingCampaignOffersToPerformanceMaxRecommendation
- SearchTermView
- SearchTermTargetingStatus
- ShoppingPerformanceView
- SmartCampaignSearchTermView
- ThirdPartyAppAnalyticsLink
- TopicView
- TravelActivityGroupView
- TravelActivityPerformanceView
- UserInterest
- UserInterestTaxonomyType
- LifeEvent
- UserLocationView
- TopicConstant
- Video
- WebpageView
- LeadFormSubmissionData
- LeadFormSubmissionField
- CustomLeadFormSubmissionField
- Metrics
- InteractionEventType
- Segments
- AdDestinationType
- AdNetworkType
- BudgetCampaignAssociationStatus
- BudgetCampaignAssociationStatus
- ClickType
- ConversionAttributionEventType
- ConversionLagBucket
- ConversionOrAdjustmentLagBucket
- ExternalConversionSource
- HotelRateType
- HotelPriceBucket
- Keyword
- SearchEngineResultsPageType
- SearchTermMatchType
- Slot
- ConversionValueRulePrimaryDimension
- SkAdNetworkUserType
- SkAdNetworkAdEventType
- SkAdNetworkSourceApp
- SkAdNetworkAttributionCredit
- AssetInteractionTarget
A returned row from the query.
JSON representation |
---|
{ "accountBudget": { object ( |
Fields | |
---|---|
accountBudget |
The account budget in the query. |
accountBudgetProposal |
The account budget proposal referenced in the query. |
accountLink |
The AccountLink referenced in the query. |
adGroup |
The ad group referenced in the query. |
adGroupAd |
The ad referenced in the query. |
adGroupAdAssetCombinationView |
The ad group ad asset combination view in the query. |
adGroupAdAssetView |
The ad group ad asset view in the query. |
adGroupAdLabel |
The ad group ad label referenced in the query. |
adGroupAsset |
The ad group asset referenced in the query. |
adGroupAssetSet |
The ad group asset set referenced in the query. |
adGroupAudienceView |
The ad group audience view referenced in the query. |
adGroupBidModifier |
The bid modifier referenced in the query. |
adGroupCriterion |
The criterion referenced in the query. |
adGroupCriterionCustomizer |
The ad group criterion customizer referenced in the query. |
adGroupCriterionLabel |
The ad group criterion label referenced in the query. |
adGroupCriterionSimulation |
The ad group criterion simulation referenced in the query. |
adGroupCustomizer |
The ad group customizer referenced in the query. |
adGroupExtensionSetting |
The ad group extension setting referenced in the query. |
adGroupFeed |
The ad group feed referenced in the query. |
adGroupLabel |
The ad group label referenced in the query. |
adGroupSimulation |
The ad group simulation referenced in the query. |
adParameter |
The ad parameter referenced in the query. |
ageRangeView |
The age range view referenced in the query. |
adScheduleView |
The ad schedule view referenced in the query. |
domainCategory |
The domain category referenced in the query. |
asset |
The asset referenced in the query. |
assetFieldTypeView |
The asset field type view referenced in the query. |
assetGroupAsset |
The asset group asset referenced in the query. |
assetGroupSignal |
The asset group signal referenced in the query. |
assetGroupListingGroupFilter |
The asset group listing group filter referenced in the query. |
assetGroupProductGroupView |
The asset group product group view referenced in the query. |
assetGroup |
The asset group referenced in the query. |
assetSetAsset |
The asset set asset referenced in the query. |
assetSet |
The asset set referenced in the query. |
assetSetTypeView |
The asset set type view referenced in the query. |
batchJob |
The batch job referenced in the query. |
biddingDataExclusion |
The bidding data exclusion referenced in the query. |
biddingSeasonalityAdjustment |
The bidding seasonality adjustment referenced in the query. |
biddingStrategy |
The bidding strategy referenced in the query. |
biddingStrategySimulation |
The bidding strategy simulation referenced in the query. |
billingSetup |
The billing setup referenced in the query. |
callView |
The call view referenced in the query. |
campaignBudget |
The campaign budget referenced in the query. |
campaign |
The campaign referenced in the query. |
campaignAsset |
The campaign asset referenced in the query. |
campaignAssetSet |
The campaign asset set referenced in the query. |
campaignAudienceView |
The campaign audience view referenced in the query. |
campaignBidModifier |
The campaign bid modifier referenced in the query. |
campaignConversionGoal |
The CampaignConversionGoal referenced in the query. |
campaignCriterion |
The campaign criterion referenced in the query. |
campaignCriterionSimulation |
The campaign criterion simulation referenced in the query. |
campaignCustomizer |
The campaign customizer referenced in the query. |
campaignDraft |
The campaign draft referenced in the query. |
campaignExtensionSetting |
The campaign extension setting referenced in the query. |
campaignFeed |
The campaign feed referenced in the query. |
campaignGroup |
Campaign Group referenced in AWQL query. |
campaignLabel |
The campaign label referenced in the query. |
campaignSharedSet |
Campaign Shared Set referenced in AWQL query. |
campaignSimulation |
The campaign simulation referenced in the query. |
carrierConstant |
The carrier constant referenced in the query. |
changeEvent |
The ChangeEvent referenced in the query. |
changeStatus |
The ChangeStatus referenced in the query. |
combinedAudience |
The CombinedAudience referenced in the query. |
audience |
The Audience referenced in the query. |
conversionAction |
The conversion action referenced in the query. |
conversionCustomVariable |
The conversion custom variable referenced in the query. |
conversionGoalCampaignConfig |
The ConversionGoalCampaignConfig referenced in the query. |
conversionValueRule |
The conversion value rule referenced in the query. |
conversionValueRuleSet |
The conversion value rule set referenced in the query. |
clickView |
The ClickView referenced in the query. |
currencyConstant |
The currency constant referenced in the query. |
customAudience |
The CustomAudience referenced in the query. |
customConversionGoal |
The CustomConversionGoal referenced in the query. |
customInterest |
The CustomInterest referenced in the query. |
customer |
The customer referenced in the query. |
customerAsset |
The customer asset referenced in the query. |
customerAssetSet |
The customer asset set referenced in the query. |
accessibleBiddingStrategy |
The accessible bidding strategy referenced in the query. |
customerCustomizer |
The customer customizer referenced in the query. |
customerManagerLink |
The CustomerManagerLink referenced in the query. |
customerClientLink |
The CustomerClientLink referenced in the query. |
customerClient |
The CustomerClient referenced in the query. |
customerConversionGoal |
The CustomerConversionGoal referenced in the query. |
customerExtensionSetting |
The customer extension setting referenced in the query. |
customerFeed |
The customer feed referenced in the query. |
customerLabel |
The customer label referenced in the query. |
customerNegativeCriterion |
The customer negative criterion referenced in the query. |
customerUserAccess |
The CustomerUserAccess referenced in the query. |
customerUserAccessInvitation |
The CustomerUserAccessInvitation referenced in the query. |
customizerAttribute |
The customizer attribute referenced in the query. |
detailPlacementView |
The detail placement view referenced in the query. |
detailedDemographic |
The detailed demographic referenced in the query. |
displayKeywordView |
The display keyword view referenced in the query. |
distanceView |
The distance view referenced in the query. |
dynamicSearchAdsSearchTermView |
The dynamic search ads search term view referenced in the query. |
expandedLandingPageView |
The expanded landing page view referenced in the query. |
extensionFeedItem |
The extension feed item referenced in the query. |
feed |
The feed referenced in the query. |
feedItem |
The feed item referenced in the query. |
feedItemSet |
The feed item set referenced in the query. |
feedItemSetLink |
The feed item set link referenced in the query. |
feedItemTarget |
The feed item target referenced in the query. |
feedMapping |
The feed mapping referenced in the query. |
feedPlaceholderView |
The feed placeholder view referenced in the query. |
genderView |
The gender view referenced in the query. |
geoTargetConstant |
The geo target constant referenced in the query. |
geographicView |
The geographic view referenced in the query. |
groupPlacementView |
The group placement view referenced in the query. |
hotelGroupView |
The hotel group view referenced in the query. |
hotelPerformanceView |
The hotel performance view referenced in the query. |
hotelReconciliation |
The hotel reconciliation referenced in the query. |
incomeRangeView |
The income range view referenced in the query. |
keywordView |
The keyword view referenced in the query. |
keywordPlan |
The keyword plan referenced in the query. |
keywordPlanCampaign |
The keyword plan campaign referenced in the query. |
keywordPlanCampaignKeyword |
The keyword plan campaign keyword referenced in the query. |
keywordPlanAdGroup |
The keyword plan ad group referenced in the query. |
keywordPlanAdGroupKeyword |
The keyword plan ad group referenced in the query. |
keywordThemeConstant |
The keyword theme constant referenced in the query. |
label |
The label referenced in the query. |
landingPageView |
The landing page view referenced in the query. |
languageConstant |
The language constant referenced in the query. |
locationView |
The location view referenced in the query. |
managedPlacementView |
The managed placement view referenced in the query. |
mediaFile |
The media file referenced in the query. |
mobileAppCategoryConstant |
The mobile app category constant referenced in the query. |
mobileDeviceConstant |
The mobile device constant referenced in the query. |
offlineUserDataJob |
The offline user data job referenced in the query. |
operatingSystemVersionConstant |
The operating system version constant referenced in the query. |
paidOrganicSearchTermView |
The paid organic search term view referenced in the query. |
qualifyingQuestion |
The qualifying question referenced in the query. |
parentalStatusView |
The parental status view referenced in the query. |
perStoreView |
The per store view referenced in the query. |
productBiddingCategoryConstant |
The Product Bidding Category referenced in the query. |
productGroupView |
The product group view referenced in the query. |
productLink |
The product link referenced in the query. |
recommendation |
The recommendation referenced in the query. |
searchTermView |
The search term view referenced in the query. |
sharedCriterion |
The shared set referenced in the query. |
sharedSet |
The shared set referenced in the query. |
smartCampaignSetting |
The Smart campaign setting referenced in the query. |
shoppingPerformanceView |
The shopping performance view referenced in the query. |
smartCampaignSearchTermView |
The Smart campaign search term view referenced in the query. |
thirdPartyAppAnalyticsLink |
The AccountLink referenced in the query. |
topicView |
The topic view referenced in the query. |
travelActivityGroupView |
The travel activity group view referenced in the query. |
travelActivityPerformanceView |
The travel activity performance view referenced in the query. |
experiment |
The experiment referenced in the query. |
experimentArm |
The experiment arm referenced in the query. |
userInterest |
The user interest referenced in the query. |
lifeEvent |
The life event referenced in the query. |
userList |
The user list referenced in the query. |
userLocationView |
The user location view referenced in the query. |
remarketingAction |
The remarketing action referenced in the query. |
topicConstant |
The topic constant referenced in the query. |
video |
The video referenced in the query. |
webpageView |
The webpage view referenced in the query. |
leadFormSubmissionData |
The lead form user submission referenced in the query. |
metrics |
The metrics. |
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 ( |
Fields | |
---|---|
resourceName |
Output only. The resource name of the account-level budget. AccountBudget resource names have the form:
|
status |
Output only. The status of this account-level budget. |
totalAdjustmentsMicros |
Output only. The total adjustments amount. An example of an adjustment is courtesy credits. |
amountServedMicros |
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 |
Output only. The pending proposal to modify this budget, if applicable. |
id |
Output only. The ID of the account-level budget. |
billingSetup |
Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form:
|
name |
Output only. The name of the account-level budget. |
proposedStartDateTime |
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 |
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 |
Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices. |
notes |
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 |
Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format. |
proposedEndTimeType |
Output only. The proposed end time as a well-defined type, for example, FOREVER. |
Union field 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. |
|
approvedEndDateTime |
Output only. The approved end time in yyyy-MM-dd HH:mm:ss format. |
approvedEndTimeType |
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 |
Output only. The proposed spending limit in micros. One million is equivalent to one unit. |
proposedSpendingLimitType |
Output only. The proposed spending limit as a well-defined type, for example, INFINITE. |
Union field 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. |
|
approvedSpendingLimitMicros |
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 |
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 This value has the final say on how much the account is allowed to spend. |
|
adjustedSpendingLimitMicros |
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 |
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 ( |
Fields | |
---|---|
proposalType |
Output only. The type of this proposal, for example, END to end the budget associated with this proposal. |
accountBudgetProposal |
Output only. The resource name of the proposal. AccountBudgetProposal resource names have the form:
|
name |
Output only. The name to assign to the account-level budget. |
startDateTime |
Output only. The start time in yyyy-MM-dd HH:mm:ss format. |
purchaseOrderNumber |
Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices. |
notes |
Output only. Notes associated with this budget. |
creationDateTime |
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 |
Output only. The end time in yyyy-MM-dd HH:mm:ss format. |
endTimeType |
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 |
Output only. The spending limit in micros. One million is equivalent to one unit. |
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 ( |
Fields | |
---|---|
resourceName |
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: |
servedAssets[] |
Output only. Served assets. |
enabled |
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 ( |
Fields | |
---|---|
asset |
Resource name of the asset. |
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 ( |
Fields | |
---|---|
resourceName |
Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4):
Ad group ad asset view resource names have the form (Beginning from V4):
|
fieldType |
Output only. Role that the asset takes in the ad. |
policySummary |
Output only. Policy information for the ad group ad asset. |
performanceLabel |
Output only. Performance of an asset linkage. |
pinnedField |
Output only. Pinned field. |
adGroupAd |
Output only. The ad group ad to which the asset is linked. |
asset |
Output only. The asset which is linked to the ad group ad. |
enabled |
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 ( |
Fields | |
---|---|
policyTopicEntries[] |
Output only. The list of policy findings for the ad group ad asset. |
reviewStatus |
Output only. Where in the review process this ad group ad asset is. |
approvalStatus |
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 |
Output only. The resource name of the ad group audience view. Ad group audience view resource names have the form:
|
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.
- DISPLAY - KEYWORD - CPC_BID - UNIFORM
- SEARCH - KEYWORD - CPC_BID - UNIFORM
- SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM
- HOTEL - LISTING_GROUP - CPC_BID - UNIFORM
- HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
JSON representation |
---|
{ "resourceName": string, "type": enum ( |
Fields | |
---|---|
resourceName |
Output only. The resource name of the ad group criterion simulation. Ad group criterion simulation resource names have the form:
|
type |
Output only. The field that the simulation modifies. |
modificationMethod |
Output only. How the simulation modifies the field. |
adGroupId |
Output only. AdGroup ID of the simulation. |
criterionId |
Output only. Criterion ID of the simulation. |
startDate |
Output only. First day on which the simulation is based, in YYYY-MM-DD format. |
endDate |
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 |
Output only. Simulation points if the simulation type is CPC_BID. |
percentCpcBidPointList |
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 ( |
Fields | |
---|---|
points[] |
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 |
Fields | |
---|---|
requiredBudgetAmountMicros |
Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency. |
biddableConversions |
Projected number of biddable conversions. |
biddableConversionsValue |
Projected total value of biddable conversions. |
clicks |
Projected number of clicks. |
costMicros |
Projected cost in micros. |
impressions |
Projected number of impressions. |
topSlotImpressions |
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 |
The simulated CPC bid upon which projected metrics are based. |
cpcBidScalingModifier |
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 ( |
Fields | |
---|---|
points[] |
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 |
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 |
Projected number of biddable conversions. |
biddableConversionsValue |
Projected total value of biddable conversions in local currency. |
clicks |
Projected number of clicks. |
costMicros |
Projected cost in micros. |
impressions |
Projected number of impressions. |
topSlotImpressions |
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.
- SEARCH - CPC_BID - DEFAULT
- SEARCH - CPC_BID - UNIFORM
- SEARCH - TARGET_CPA - UNIFORM
- SEARCH - TARGET_ROAS - UNIFORM
- DISPLAY - CPC_BID - DEFAULT
- DISPLAY - CPC_BID - UNIFORM
- DISPLAY - TARGET_CPA - UNIFORM
JSON representation |
---|
{ "resourceName": string, "type": enum ( |