- 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
- AssetGroupTopCombinationView
- AssetGroupAssetCombinationData
- AssetSetTypeView
- BiddingStrategySimulation
- CallView
- CallTrackingDisplayLocation
- CallType
- GoogleVoiceCallStatus
- CampaignAudienceView
- CampaignSearchTermInsight
- 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
- CustomerSearchTermInsight
- 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
- MediaFile
- MediaType
- MediaImage
- MediaBundle
- MediaAudio
- MediaVideo
- LocalServicesEmployee
- LocalServicesEmployeeStatus
- LocalServicesEmployeeType
- UniversityDegree
- Residency
- Fellowship
- LocalServicesVerificationArtifact
- LocalServicesVerificationArtifactStatus
- LocalServicesVerificationArtifactType
- BackgroundCheckVerificationArtifact
- InsuranceVerificationArtifact
- LocalServicesInsuranceRejectionReason
- LocalServicesDocumentReadOnly
- LicenseVerificationArtifact
- LocalServicesLicenseRejectionReason
- BusinessRegistrationCheckVerificationArtifact
- LocalServicesBusinessRegistrationType
- LocalServicesBusinessRegistrationCheckRejectionReason
- BusinessRegistrationNumber
- BusinessRegistrationDocument
- MobileAppCategoryConstant
- MobileDeviceConstant
- MobileDeviceType
- OfflineConversionUploadClientSummary
- OfflineEventUploadClient
- OfflineConversionDiagnosticStatus
- OfflineConversionSummary
- OfflineConversionAlert
- OfflineConversionError
- CollectionSizeError
- ConversionAdjustmentUploadError
- ConversionUploadError
- DateError
- DistinctError
- FieldError
- MutateError
- NotAllowlistedError
- StringFormatError
- StringLengthError
- OperatingSystemVersionConstant
- OperatingSystemVersionOperatorType
- PaidOrganicSearchTermView
- QualifyingQuestion
- ParentalStatusView
- PerStoreView
- ProductCategoryConstant
- ProductCategoryState
- ProductCategoryLocalization
- ProductGroupView
- SearchTermView
- SearchTermTargetingStatus
- ShoppingPerformanceView
- SmartCampaignSearchTermView
- ThirdPartyAppAnalyticsLink
- TopicView
- TravelActivityGroupView
- TravelActivityPerformanceView
- UserInterest
- UserInterestTaxonomyType
- LifeEvent
- UserLocationView
- TopicConstant
- Video
- WebpageView
- LeadFormSubmissionData
- LeadFormSubmissionField
- CustomLeadFormSubmissionField
- LocalServicesLead
- ContactDetails
- LeadType
- LeadStatus
- Note
- CreditDetails
- CreditState
- LocalServicesLeadConversation
- ConversationType
- ParticipantType
- PhoneCallDetails
- MessageDetails
- AndroidPrivacySharedKeyGoogleAdGroup
- AndroidPrivacyInteractionType
- AndroidPrivacyNetworkType
- AndroidPrivacySharedKeyGoogleCampaign
- AndroidPrivacySharedKeyGoogleNetworkType
- Metrics
- InteractionEventType
- SearchVolumeRange
- Segments
- AdDestinationType
- AdNetworkType
- BudgetCampaignAssociationStatus
- BudgetCampaignAssociationStatus
- ClickType
- ConversionAttributionEventType
- ConversionLagBucket
- ConversionOrAdjustmentLagBucket
- ExternalConversionSource
- HotelRateType
- HotelPriceBucket
- Keyword
- SearchEngineResultsPageType
- SearchTermMatchType
- Slot
- ConversionValueRulePrimaryDimension
- SkAdNetworkUserType
- SkAdNetworkAdEventType
- SkAdNetworkSourceApp
- SkAdNetworkAttributionCredit
- SkAdNetworkSourceType
- AssetInteractionTarget
- ConvertingUserPriorEngagementTypeAndLtvBucket
A returned row from the query.
JSON representation |
---|
{ "accountBudget": { object ( |
Fields | |
---|---|
account |
The account budget in the query. |
account |
The account budget proposal referenced in the query. |
account |
The AccountLink referenced in the query. |
ad |
The ad group referenced in the query. |
ad |
The ad referenced in the query. |
ad |
The ad group ad asset combination view in the query. |
ad |
The ad group ad asset view in the query. |
ad |
The ad group ad label referenced in the query. |
ad |
The ad group asset referenced in the query. |
ad |
The ad group asset set referenced in the query. |
ad |
The ad group audience view referenced in the query. |
ad |
The bid modifier referenced in the query. |
ad |
The criterion referenced in the query. |
ad |
The ad group criterion customizer referenced in the query. |
ad |
The ad group criterion label referenced in the query. |
ad |
The ad group criterion simulation referenced in the query. |
ad |
The ad group customizer referenced in the query. |
ad |
The ad group extension setting referenced in the query. |
ad |
The ad group feed referenced in the query. |
ad |
The ad group label referenced in the query. |
ad |
The ad group simulation referenced in the query. |
ad |
The ad parameter referenced in the query. |
age |
The age range view referenced in the query. |
ad |
The ad schedule view referenced in the query. |
domain |
The domain category referenced in the query. |
asset |
The asset referenced in the query. |
asset |
The asset field type view referenced in the query. |
asset |
The asset group asset referenced in the query. |
asset |
The asset group signal referenced in the query. |
asset |
The asset group listing group filter referenced in the query. |
asset |
The asset group product group view referenced in the query. |
asset |
The asset group top combination view referenced in the query. |
asset |
The asset group referenced in the query. |
asset |
The asset set asset referenced in the query. |
asset |
The asset set referenced in the query. |
asset |
The asset set type view referenced in the query. |
batch |
The batch job referenced in the query. |
bidding |
The bidding data exclusion referenced in the query. |
bidding |
The bidding seasonality adjustment referenced in the query. |
bidding |
The bidding strategy referenced in the query. |
bidding |
The bidding strategy simulation referenced in the query. |
billing |
The billing setup referenced in the query. |
call |
The call view referenced in the query. |
campaign |
The campaign budget referenced in the query. |
campaign |
The campaign referenced in the query. |
campaign |
The campaign asset referenced in the query. |
campaign |
The campaign asset set referenced in the query. |
campaign |
The campaign audience view referenced in the query. |
campaign |
The campaign bid modifier referenced in the query. |
campaign |
The CampaignConversionGoal referenced in the query. |
campaign |
The campaign criterion referenced in the query. |
campaign |
The campaign customizer referenced in the query. |
campaign |
The campaign draft referenced in the query. |
campaign |
The campaign extension setting referenced in the query. |
campaign |
The campaign feed referenced in the query. |
campaign |
Campaign Group referenced in AWQL query. |
campaign |
The campaign label referenced in the query. |
campaign |
The campaign lifecycle goal referenced in the query. |
campaign |
The campaign search term insight referenced in the query. |
campaign |
Campaign Shared Set referenced in AWQL query. |
campaign |
The campaign simulation referenced in the query. |
carrier |
The carrier constant referenced in the query. |
change |
The ChangeEvent referenced in the query. |
change |
The ChangeStatus referenced in the query. |
combined |
The CombinedAudience referenced in the query. |
audience |
The Audience referenced in the query. |
conversion |
The conversion action referenced in the query. |
conversion |
The conversion custom variable referenced in the query. |
conversion |
The ConversionGoalCampaignConfig referenced in the query. |
conversion |
The conversion value rule referenced in the query. |
conversion |
The conversion value rule set referenced in the query. |
click |
The ClickView referenced in the query. |
currency |
The currency constant referenced in the query. |
custom |
The CustomAudience referenced in the query. |
custom |
The CustomConversionGoal referenced in the query. |
custom |
The CustomInterest referenced in the query. |
customer |
The customer referenced in the query. |
customer |
The customer asset referenced in the query. |
customer |
The customer asset set referenced in the query. |
accessible |
The accessible bidding strategy referenced in the query. |
customer |
The customer customizer referenced in the query. |
customer |
The CustomerManagerLink referenced in the query. |
customer |
The CustomerClientLink referenced in the query. |
customer |
The CustomerClient referenced in the query. |
customer |
The CustomerConversionGoal referenced in the query. |
customer |
The customer extension setting referenced in the query. |
customer |
The customer feed referenced in the query. |
customer |
The customer label referenced in the query. |
customer |
The customer lifecycle goal referenced in the query. |
customer |
The customer negative criterion referenced in the query. |
customer |
The customer search term insight referenced in the query. |
customer |
The CustomerUserAccess referenced in the query. |
customer |
The CustomerUserAccessInvitation referenced in the query. |
customizer |
The customizer attribute referenced in the query. |
detail |
The detail placement view referenced in the query. |
detailed |
The detailed demographic referenced in the query. |
display |
The display keyword view referenced in the query. |
distance |
The distance view referenced in the query. |
dynamic |
The dynamic search ads search term view referenced in the query. |
expanded |
The expanded landing page view referenced in the query. |
extension |
The extension feed item referenced in the query. |
feed |
The feed referenced in the query. |
feed |
The feed item referenced in the query. |
feed |
The feed item set referenced in the query. |
feed |
The feed item set link referenced in the query. |
feed |
The feed item target referenced in the query. |
feed |
The feed mapping referenced in the query. |
feed |
The feed placeholder view referenced in the query. |
gender |
The gender view referenced in the query. |
geo |
The geo target constant referenced in the query. |
geographic |
The geographic view referenced in the query. |
group |
The group placement view referenced in the query. |
hotel |
The hotel group view referenced in the query. |
hotel |
The hotel performance view referenced in the query. |
hotel |
The hotel reconciliation referenced in the query. |
income |
The income range view referenced in the query. |
keyword |
The keyword view referenced in the query. |
keyword |
The keyword plan referenced in the query. |
keyword |
The keyword plan campaign referenced in the query. |
keyword |
The keyword plan campaign keyword referenced in the query. |
keyword |
The keyword plan ad group referenced in the query. |
keyword |
The keyword plan ad group referenced in the query. |
keyword |
The keyword theme constant referenced in the query. |
label |
The label referenced in the query. |
landing |
The landing page view referenced in the query. |
language |
The language constant referenced in the query. |
location |
The location view referenced in the query. |
managed |
The managed placement view referenced in the query. |
media |
The media file referenced in the query. |
local |
The local services employee referenced in the query. |
local |
The local services verification artifact referenced in the query. |
mobile |
The mobile app category constant referenced in the query. |
mobile |
The mobile device constant referenced in the query. |
offline |
Offline conversion upload summary at customer level. |
offline |
The offline user data job referenced in the query. |
operating |
The operating system version constant referenced in the query. |
paid |
The paid organic search term view referenced in the query. |
qualifying |
The qualifying question referenced in the query. |
parental |
The parental status view referenced in the query. |
per |
The per store view referenced in the query. |
product |
The product category referenced in the query. |
product |
The product group view referenced in the query. |
product |
The product link referenced in the query. |
product |
The product link invitation in the query. |
recommendation |
The recommendation referenced in the query. |
recommendation |
The recommendation subscription referenced in the query. |
search |
The search term view referenced in the query. |
shared |
The shared set referenced in the query. |
shared |
The shared set referenced in the query. |
smart |
The Smart campaign setting referenced in the query. |
shopping |
The shopping performance view referenced in the query. |
smart |
The Smart campaign search term view referenced in the query. |
third |
The AccountLink referenced in the query. |
topic |
The topic view referenced in the query. |
travel |
The travel activity group view referenced in the query. |
travel |
The travel activity performance view referenced in the query. |
experiment |
The experiment referenced in the query. |
experiment |
The experiment arm referenced in the query. |
user |
The user interest referenced in the query. |
life |
The life event referenced in the query. |
user |
The user list referenced in the query. |
user |
The user location view referenced in the query. |
remarketing |
The remarketing action referenced in the query. |
topic |
The topic constant referenced in the query. |
video |
The video referenced in the query. |
webpage |
The webpage view referenced in the query. |
lead |
The lead form user submission referenced in the query. |
local |
The local services lead referenced in the query. |
local |
The local services lead conversationreferenced in the query. |
android |
The android privacy shared key google ad group referenced in the query. |
android |
The android privacy shared key google campaign referenced in the query. |
android |
The android privacy shared key google network type 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 | |
---|---|
resource |
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. |
total |
Output only. The total adjustments amount. An example of an adjustment is courtesy credits. |
amount |
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). |
pending |
Output only. The pending proposal to modify this budget, if applicable. |
id |
Output only. The ID of the account-level budget. |
billing |
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. |
proposed |
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. |
approved |
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. |
purchase |
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: |
|
proposed |
Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format. |
proposed |
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. |
|
approved |
Output only. The approved end time in yyyy-MM-dd HH:mm:ss format. |
approved |
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: |
|
proposed |
Output only. The proposed spending limit in micros. One million is equivalent to one unit. |
proposed |
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. |
|
approved |
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. |
approved |
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. |
|
adjusted |
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. |
adjusted |
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 | |
---|---|
proposal |
Output only. The type of this proposal, for example, END to end the budget associated with this proposal. |
account |
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. |
start |
Output only. The start time in yyyy-MM-dd HH:mm:ss format. |
purchase |
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. |
creation |
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: |
|
end |
Output only. The end time in yyyy-MM-dd HH:mm:ss format. |
end |
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: |
|
spending |
Output only. The spending limit in micros. One million is equivalent to one unit. |
spending |
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 | |
---|---|
resource |
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: |
served |
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. |
served |
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 | |
---|---|
resource |
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):
|
field |
Output only. Role that the asset takes in the ad. |
policy |
Output only. Policy information for the ad group ad asset. |
performance |
Output only. Performance of an asset linkage. |
pinned |
Output only. Pinned field. |
source |
Output only. Source of the ad group ad asset. |
ad |
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 | |
---|---|
policy |
Output only. The list of policy findings for the ad group ad asset. |
review |
Output only. Where in the review process this ad group ad asset is. |
approval |
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 | |
---|---|
resource |
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 | |
---|---|
resource |
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. |
modification |
Output only. How the simulation modifies the field. |
ad |
Output only. AdGroup ID of the simulation. |
criterion |
Output only. Criterion ID of the simulation. |
start |
Output only. First day on which the simulation is based, in YYYY-MM-DD format. |
end |
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: |
|
cpc |
Output only. Simulation points if the simulation type is CPC_BID. |
percent |
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 | |
---|---|
required |
Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency. |
biddable |
Projected number of biddable conversions. |
biddable |
Projected total value of biddable conversions. |
clicks |
Projected number of clicks. |
cost |
Projected cost in micros. |
impressions |
Projected number of impressions. |
top |
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: |
|
cpc |
The simulated CPC bid upon which projected metrics are based. |
cpc |
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 | |
---|---|
percent |
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]. |
biddable |
Projected number of biddable conversions. |
biddable |
Projected total value of biddable conversions in local currency. |
clicks |
Projected number of clicks. |
cost |
Projected cost in micros. |
impressions |
Projected number of impressions. |
top |
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 ( |
Fields | |
---|---|
resource |
Output only. The resource name of the ad group simulation. Ad group simulation resource names have the form:
|
type |
Output only. The field that the simulation modifies. |
modification |
Output only. How the simulation modifies the field. |
ad |
Output only. Ad group id of the simulation. |
start |
Output only. First day on which the simulation is based, in YYYY-MM-DD format. |
end |
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: |
|
cpc |
Output only. Simulation points if the simulation type is CPC_BID. |
cpv |
Output only. Simulation points if the simulation type is CPV_BID. |
target |
Output only. Simulation points if the simulation type is TARGET_CPA. |
target |
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 ( |
Fields | |
---|---|
points[] |
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 | |
---|---|
cpv |
The simulated CPV bid upon which projected metrics are based. |
cost |
Projected cost in micros. |
impressions |
Projected number of impressions. |
views |
Projected number of views. |
TargetCpaSimulationPointList
A container for simulation points for simulations of type TARGET_CPA.
JSON representation |
---|
{
"points": [
{
object ( |
Fields | |
---|---|
points[] |
Projected metrics for a series of target CPA amounts. |
TargetCpaSimulationPoint
Projected metrics for a specific target CPA amount.
JSON representation |
---|
{ "requiredBudgetAmountMicros": string, "appInstalls": number, "inAppActions": number, "biddableConversions": number, "biddableConversionsValue": number, "clicks": string, "costMicros": string, "impressions": string, "topSlotImpressions": string, "interactions": string, // Union field |
Fields | |
---|---|
required |
Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency. |
app |
Projected number of app installs. |
in |
Projected number of in-app actions. |
biddable |
Projected number of biddable conversions. |
biddable |
Projected total value of biddable conversions. |
clicks |
Projected number of clicks. |
cost |
Projected cost in micros. |
impressions |
Projected number of impressions. |
top |
Projected number of top slot impressions. Only search advertising channel type supports this field. |
interactions |
Projected number of interactions. Only discovery advertising channel type supports this field. |
Union field target_cpa_simulation_key_value . When SimulationModificationMethod = UNIFORM or DEFAULT, target_cpa_micros is set. When SimulationModificationMethod = SCALING, target_cpa_scaling_modifier is set. target_cpa_simulation_key_value can be only one of the following: |
|
target |
The simulated target CPA upon which projected metrics are based. |
target |
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 ( |
Fields | |
---|---|
points[] |
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 | |
---|---|
required |
Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency. |
target |
The simulated target ROAS upon which projected metrics are based. |
biddable |
Projected number of biddable conversions. |
biddable |
Projected total value of biddable conversions. |
clicks |
Projected number of clicks. |
cost |
Projected cost in micros. |
impressions |
Projected number of impressions. |
top |
Projected number of top slot impressions. Only Search advertising channel type supports this field. |
AgeRangeView
An age range view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the age range view. Age range view resource names have the form:
|
AdScheduleView
An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form:
|
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 | |
---|---|
resource |
Output only. The resource name of the domain category. Domain category resource names have the form:
|
campaign |
Output only. The campaign this category is recommended for. |
category |
Output only. Recommended category for the website domain, for example, if you have a website about electronics, the categories could be "cameras", "televisions", etc. |
language |
Output only. The language code specifying the language of the website, for example, "en" for English. The language can be specified in the DynamicSearchAdsSetting required for dynamic search ads. This is the language of the pages from your website that you want Google Ads to find, create ads for, and match searches with. |
domain |
Output only. The domain for the website. The domain can be specified in the DynamicSearchAdsSetting required for dynamic search ads. |
coverage |
Output only. Fraction of pages on your site that this category matches. |
category |
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. |
has |
Output only. Indicates whether this category has sub-categories. |
recommended |
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 ( |
Fields | |
---|---|
resource |
Output only. The resource name of the asset field type view. Asset field type view resource names have the form:
|
field |
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 | |
---|---|
resource |
Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form:
|
asset |
Output only. The asset group associated with the listing group filter. |
asset |
Output only. The resource name of the asset group listing group filter. |
AssetGroupTopCombinationView
A view on the usage of ad group ad asset combination.
JSON representation |
---|
{
"resourceName": string,
"assetGroupTopCombinations": [
{
object ( |
Fields | |
---|---|
resource |
Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customerId}/assetGroupTopCombinationViews/{assetGroupId}~{asset_combination_category}" |
asset |
Output only. The top combinations of assets that served together. |
AssetGroupAssetCombinationData
Asset group asset combination data
JSON representation |
---|
{
"assetCombinationServedAssets": [
{
object ( |
Fields | |
---|---|
asset |
Output only. Served assets. |
AssetSetTypeView
An asset set type view. This view reports non-overcounted metrics for each asset set type. Child asset set types are not included in this report. Their stats are aggregated under the parent asset set type.
JSON representation |
---|
{
"resourceName": string,
"assetSetType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the asset set type view. Asset set type view resource names have the form:
|
asset |
Output only. The asset set type of the asset set type view. |
BiddingStrategySimulation
A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively.
- TARGET_CPA - UNIFORM
- TARGET_ROAS - UNIFORM
JSON representation |
---|
{ "resourceName": string, "biddingStrategyId": string, "type": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the bidding strategy simulation. Bidding strategy simulation resource names have the form:
|
bidding |
Output only. Bidding strategy shared set id of the simulation. |
type |
Output only. The field that the simulation modifies. |
modification |
Output only. How the simulation modifies the field. |
start |
Output only. First day on which the simulation is based, in YYYY-MM-DD format. |
end |
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: |
|
target |
Output only. Simulation points if the simulation type is TARGET_CPA. |
target |
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 ( |
Fields | |
---|---|
resource |
Output only. The resource name of the call view. Call view resource names have the form:
|
caller |
Output only. Country code of the caller. |
caller |
Output only. Area code of the caller. Null if the call duration is shorter than 15 seconds. |
call |
Output only. The advertiser-provided call duration in seconds. |
start |
Output only. The advertiser-provided call start date time. |
end |
Output only. The advertiser-provided call end date time. |
call |
Output only. The call tracking display location. |
type |
Output only. The type of the call. |
call |
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. |
HIGH_END_MOBILE_SEARCH |
The phone call was a mobile click-to-call. |
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 | |
---|---|
resource |
Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form:
|
CampaignSearchTermInsight
A Campaign search term view. Historical data is available starting March 2023.
JSON representation |
---|
{ "resourceName": string, "categoryLabel": string, "id": string, "campaignId": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the campaign level search term insight. Campaign level search term insight resource names have the form:
|
category |
Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category. |
id |
Output only. The ID of the insight. |
campaign |
Output only. The ID of the campaign. |
CampaignSimulation
A campaign simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively.
- SEARCH - CPC_BID - UNIFORM
- SEARCH - CPC_BID - SCALING
- SEARCH - TARGET_CPA - UNIFORM
- SEARCH - TARGET_CPA - SCALING
- SEARCH - TARGET_ROAS - UNIFORM
- SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM
- SEARCH - BUDGET - UNIFORM
- SHOPPING - BUDGET - UNIFORM
- SHOPPING - TARGET_ROAS - UNIFORM
- MULTI_CHANNEL - TARGET_CPA - UNIFORM
- MULTI_CHANNEL - TARGET_ROAS - UNIFORM
- DISCOVERY - TARGET_CPA - DEFAULT
- DISPLAY - TARGET_CPA - UNIFORM
- PERFORMANCE_MAX - TARGET_CPA - UNIFORM
- PERFORMANCE_MAX - TARGET_ROAS - UNIFORM
- PERFORMANCE_MAX - BUDGET - UNIFORM
JSON representation |
---|
{ "resourceName": string, "campaignId": string, "type": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the campaign simulation. Campaign simulation resource names have the form:
|
campaign |
Output only. Campaign id of the simulation. |
type |
Output only. The field that the simulation modifies. |
modification |
Output only. How the simulation modifies the field. |
start |
Output only. First day on which the simulation is based, in YYYY-MM-DD format. |
end |
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: |
|
cpc |
Output only. Simulation points if the simulation type is CPC_BID. |
target |
Output only. Simulation points if the simulation type is TARGET_CPA. |
target |
Output only. Simulation points if the simulation type is TARGET_ROAS. |
target |
Output only. Simulation points if the simulation type is TARGET_IMPRESSION_SHARE. |
budget |
Output only. Simulation points if the simulation type is BUDGET. |
BudgetSimulationPointList
A container for simulation points for simulations of type BUDGET.
JSON representation |
---|
{
"points": [
{
object ( |
Fields | |
---|---|
points[] |
Projected metrics for a series of budget amounts. |
BudgetSimulationPoint
Projected metrics for a specific budget amount.
JSON representation |
---|
{ "budgetAmountMicros": string, "requiredCpcBidCeilingMicros": string, "biddableConversions": number, "biddableConversionsValue": number, "clicks": string, "costMicros": string, "impressions": string, "topSlotImpressions": string, "interactions": string } |
Fields | |
---|---|
budget |
The simulated budget upon which projected metrics are based. |
required |
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. |
biddable |
Projected number of biddable conversions. |
biddable |
Projected total value of biddable conversions. |
clicks |
Projected number of clicks. |
cost |
Projected cost in micros. |
impressions |
Projected number of impressions. |
top |
Projected number of top slot impressions. Only search advertising channel type supports this field. |
interactions |
Projected number of interactions. Only discovery advertising channel type supports this field. |
CarrierConstant
A carrier criterion that can be used in campaign targeting.
JSON representation |
---|
{ "resourceName": string, "id": string, "name": string, "countryCode": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the carrier criterion. Carrier criterion resource names have the form:
|
id |
Output only. The ID of the carrier criterion. |
name |
Output only. The full name of the carrier in English. |
country |
Output only. The country code of the country where the carrier is located, for example, "AR", "FR", etc. |
ChangeEvent
Describes the granular change of returned resources of certain resource types. Changes made through the UI or API in the past 30 days are included. Previous and new values of the changed fields are shown. ChangeEvent could have up to 3 minutes delay to reflect a new change.
JSON representation |
---|
{ "resourceName": string, "changeDateTime": string, "changeResourceType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the change event. Change event resource names have the form:
|
change |
Output only. Time at which the change was committed on this resource. |
change |
Output only. The type of the changed resource. This dictates what resource will be set in oldResource and newResource. |
change |
Output only. The Simply resource this change occurred on. |
client |
Output only. Where the change was made through. |
user |
Output only. The email of the user who made this change. |
old |
Output only. The old resource before the change. Only changed fields will be populated. |
new |
Output only. The new resource after the change. Only changed fields will be populated. |
resource |
Output only. The operation on the changed resource. |
changed |
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: |
campaign |
Output only. The Campaign affected by this change. |
ad |
Output only. The AdGroup affected by this change. |
feed |
Output only. The Feed affected by this change. |
feed |
Output only. The FeedItem affected by this change. |
asset |
Output only. The Asset affected by this change. |
ChangeEventResourceType
Enum listing the resource types support by the ChangeEvent resource.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
Used for return value only. Represents an unclassified resource unknown in this version. |
AD |
An Ad resource change. |
AD_GROUP |
An AdGroup resource change. |
AD_GROUP_CRITERION |
An AdGroupCriterion resource change. |
CAMPAIGN |
A Campaign resource change. |
CAMPAIGN_BUDGET |
A CampaignBudget resource change. |
AD_GROUP_BID_MODIFIER |
An AdGroupBidModifier resource change. |
CAMPAIGN_CRITERION |
A CampaignCriterion resource change. |
FEED |
A Feed resource change. |
FEED_ITEM |
A FeedItem resource change. |
CAMPAIGN_FEED |
A CampaignFeed resource change. |
AD_GROUP_FEED |
An AdGroupFeed resource change. |
AD_GROUP_AD |
An AdGroupAd resource change. |
ASSET |
An Asset resource change. |
CUSTOMER_ASSET |
A CustomerAsset resource change. |
CAMPAIGN_ASSET |
A CampaignAsset resource change. |
AD_GROUP_ASSET |
An AdGroupAsset resource change. |
ASSET_SET |
An AssetSet resource change. |
ASSET_SET_ASSET |
An AssetSetAsset resource change. |
CAMPAIGN_ASSET_SET |
A CampaignAssetSet resource change. |
ChangeClientType
The source that the changeEvent resource was made through.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
Used for return value only. Represents an unclassified client type unknown in this version. |
GOOGLE_ADS_WEB_CLIENT |
Changes made through the "ads.google.com". For example, changes made through campaign management. |
GOOGLE_ADS_AUTOMATED_RULE |
Changes made through Google Ads automated rules. |
GOOGLE_ADS_SCRIPTS |
Changes made through Google Ads scripts. |
GOOGLE_ADS_BULK_UPLOAD |
Changes made by Google Ads bulk upload. |
GOOGLE_ADS_API |
Changes made by Google Ads API. |
GOOGLE_ADS_EDITOR |
Changes made by Google Ads Editor. This value is a placeholder. The API does not return these changes. |
GOOGLE_ADS_MOBILE_APP |
Changes made by Google Ads mobile app. |
GOOGLE_ADS_RECOMMENDATIONS |
Changes made through Google Ads recommendations. |
SEARCH_ADS_360_SYNC |
Changes made through Search Ads 360 Sync. |
SEARCH_ADS_360_POST |
Changes made through Search Ads 360 Post. |
INTERNAL_TOOL |
Changes made through internal tools. For example, when a user sets a URL template on an entity like a Campaign, it's automatically wrapped with the SA360 Clickserver URL. |
OTHER |
Types of changes that are not categorized, for example, changes made by coupon redemption through Google Ads. |
GOOGLE_ADS_RECOMMENDATIONS_SUBSCRIPTION |
Changes made by subscribing to Google Ads recommendations. |
ChangedResource
A wrapper proto presenting all supported resources. Only the resource of the changeResourceType will be set.
JSON representation |
---|
{ "ad": { object ( |
Fields | |
---|---|
ad |
Output only. Set if changeResourceType == AD. |
ad |
Output only. Set if changeResourceType == AD_GROUP. |
ad |
Output only. Set if changeResourceType == AD_GROUP_CRITERION. |
campaign |
Output only. Set if changeResourceType == CAMPAIGN. |
campaign |
Output only. Set if changeResourceType == CAMPAIGN_BUDGET. |
ad |
Output only. Set if changeResourceType == AD_GROUP_BID_MODIFIER. |
campaign |
Output only. Set if changeResourceType == CAMPAIGN_CRITERION. |
feed |
Output only. Set if changeResourceType == FEED. |
feed |
Output only. Set if changeResourceType == FEED_ITEM. |
campaign |
Output only. Set if changeResourceType == CAMPAIGN_FEED. |
ad |
Output only. Set if changeResourceType == AD_GROUP_FEED. |
ad |
Output only. Set if changeResourceType == AD_GROUP_AD. |
asset |
Output only. Set if changeResourceType == ASSET. |
customer |
Output only. Set if changeResourceType == CUSTOMER_ASSET. |
campaign |
Output only. Set if changeResourceType == CAMPAIGN_ASSET. |
ad |
Output only. Set if changeResourceType == AD_GROUP_ASSET. |
asset |
Output only. Set if changeResourceType == ASSET_SET. |
asset |
Output only. Set if changeResourceType == ASSET_SET_ASSET. |
campaign |
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 ( |
Fields | |
---|---|
resource |
Output only. The resource name of the change status. Change status resource names have the form:
|
resource |
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. |
resource |
Output only. Represents the status of the changed resource. |
shared |
Output only. The SharedSet affected by this change. |
campaign |
Output only. The CampaignSharedSet affected by this change. |
asset |
Output only. The Asset affected by this change. |
customer |
Output only. The CustomerAsset affected by this change. |
campaign |
Output only. The CampaignAsset affected by this change. |
ad |
Output only. The AdGroupAsset affected by this change. |
combined |
Output only. The CombinedAudience affected by this change. |
last |
Output only. Time at which the most recent change has occurred on this resource. |
campaign |
Output only. The Campaign affected by this change. |
ad |
Output only. The AdGroup affected by this change. |
ad |
Output only. The AdGroupAd affected by this change. |
ad |
Output only. The AdGroupCriterion affected by this change. |
campaign |
Output only. The CampaignCriterion affected by this change. |
feed |
Output only. The Feed affected by this change. |
feed |
Output only. The FeedItem affected by this change. |
ad |
Output only. The AdGroupFeed affected by this change. |
campaign |
Output only. The CampaignFeed affected by this change. |
ad |
Output only. The AdGroupBidModifier affected by this change. |
ChangeStatusResourceType
Enum listing the resource types support by the ChangeStatus resource.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
Used for return value only. Represents an unclassified resource unknown in this version. |
AD_GROUP |
An AdGroup resource change. |
AD_GROUP_AD |
An AdGroupAd resource change. |
AD_GROUP_CRITERION |
An AdGroupCriterion resource change. |
CAMPAIGN |
A Campaign resource change. |
CAMPAIGN_CRITERION |
A CampaignCriterion resource change. |
FEED |
A Feed resource change. |
FEED_ITEM |
A FeedItem resource change. |
AD_GROUP_FEED |
An AdGroupFeed resource change. |
CAMPAIGN_FEED |
A CampaignFeed resource change. |
AD_GROUP_BID_MODIFIER |
An AdGroupBidModifier resource change. |
SHARED_SET |
A SharedSet resource change. |
CAMPAIGN_SHARED_SET |
A CampaignSharedSet resource change. |
ASSET |
An Asset resource change. |
CUSTOMER_ASSET |
A CustomerAsset resource change. |
CAMPAIGN_ASSET |
A CampaignAsset resource change. |
AD_GROUP_ASSET |
An AdGroupAsset resource change. |
COMBINED_AUDIENCE |
A CombinedAudience resource change. |
ChangeStatusOperation
Status of the changed resource
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
Used for return value only. Represents an unclassified resource unknown in this version. |
ADDED |
The resource was created. |
CHANGED |
The resource was modified. |
REMOVED |
The resource was removed. |
CombinedAudience
Describe a resource for combined audiences which includes different audiences.
JSON representation |
---|
{
"resourceName": string,
"id": string,
"status": enum ( |
Fields | |
---|---|
resource |
Immutable. The resource name of the combined audience. Combined audience names have the form:
|
id |
Output only. ID of the combined audience. |
status |
Output only. Status of this combined audience. Indicates whether the combined audience is enabled or removed. |
name |
Output only. Name of the combined audience. It should be unique across all combined audiences. |
description |
Output only. Description of this combined audience. |
CombinedAudienceStatus
Enum containing possible combined audience status types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Enabled status - combined audience is enabled and can be targeted. |
REMOVED |
Removed status - combined audience is removed and cannot be used for targeting. |
ClickView
A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.
JSON representation |
---|
{ "resourceName": string, "areaOfInterest": { object ( |
Fields | |
---|---|
resource |
Output only. The resource name of the click view. Click view resource names have the form:
|
area |
Output only. The location criteria matching the area of interest associated with the impression. |
location |
Output only. The location criteria matching the location of presence associated with the impression. |
keyword |
Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel. |
keyword |
Output only. Basic information about the associated keyword, if it exists. |
gclid |
Output only. The Google Click ID. |
page |
Output only. Page number in search results where the ad was shown. |
ad |
Output only. The associated ad. |
campaign |
Output only. The associated campaign location target, if one exists. |
user |
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 |
The city location criterion associated with the impression. |
country |
The country location criterion associated with the impression. |
metro |
The metro location criterion associated with the impression. |
most |
The most specific location criterion associated with the impression. |
region |
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 | |
---|---|
resource |
Output only. The resource name of the currency constant. Currency constant resource names have the form:
|
code |
Output only. ISO 4217 three-letter currency code, for example, "USD" |
name |
Output only. Full English name of the currency. |
symbol |
Output only. Standard symbol for describing this currency, for example, '$' for US Dollars. |
billable |
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 ( |
Fields | |
---|---|
resource |
Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form:
|
id |
Output only. The ID of the bidding strategy. |
name |
Output only. The name of the bidding strategy. |
type |
Output only. The type of the bidding strategy. |
owner |
Output only. The ID of the Customer which owns the bidding strategy. |
owner |
Output only. descriptiveName of the Customer which owns the bidding strategy. |
Union field Only one can be set. |
|
maximize |
Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. |
maximize |
Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. |
target |
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. |
target |
Output only. A bidding strategy that automatically optimizes towards a chosen percentage of impressions. |
target |
Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS). |
target |
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 | |
---|---|
target |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget. |
MaximizeConversions
An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
JSON representation |
---|
{ "targetCpaMicros": string } |
Fields | |
---|---|
target |
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 | |
---|---|
target |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account. |
TargetRoas
An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).
JSON representation |
---|
{ "targetRoas": number } |
Fields | |
---|---|
target |
Output only. The chosen revenue (based on conversion data) per unit of spend. |
TargetSpend
An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.
JSON representation |
---|
{ "targetSpendMicros": string, "cpcBidCeilingMicros": string } |
Fields | |
---|---|
targetSpendMicros |
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. |
cpc |
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 ( |
Fields | |
---|---|
resource |
Output only. The resource name of the customer client. CustomerClient resource names have the form: |
applied |
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:
|
status |
Output only. The status of the client customer. Read only. |
client |
Output only. The resource name of the client-customer which is linked to the given customer. Read only. |
level |
Output only. Distance between given customer and client. For self link, the level value will be 0. Read only. |
time |
Output only. Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only. |
test |
Output only. Identifies if the client is a test account. Read only. |
manager |
Output only. Identifies if the client is a manager. Read only. |
descriptive |
Output only. Descriptive name for the client. Read only. |
currency |
Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only. |
id |
Output only. The ID of the client customer. Read only. |
CustomerSearchTermInsight
A Customer search term view. Historical data is available starting March 2023.
JSON representation |
---|
{ "resourceName": string, "categoryLabel": string, "id": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the customer level search term insight. Customer level search term insight resource names have the form:
|
category |
Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category. |
id |
Output only. The ID of the insight. |
DetailPlacementView
A view with metrics aggregated by ad group and URL or YouTube video.
JSON representation |
---|
{
"resourceName": string,
"placementType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the detail placement view. Detail placement view resource names have the form:
|
placement |
Output only. Type of the placement, for example, Website, YouTube Video, and Mobile Application. |
placement |
Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID. |
display |
Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps. |
group |
Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL. |
target |
Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL. |
PlacementType
Possible placement types for a feed mapping.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
WEBSITE |
Websites(for example, 'www.flowers4sale.com'). |
MOBILE_APP_CATEGORY |
Mobile application categories(for example, 'Games'). |
MOBILE_APPLICATION |
mobile applications(for example, 'mobileapp::2-com.whatsthewordanswers'). |
YOUTUBE_VIDEO |
YouTube videos(for example, 'youtube.com/video/wtLJPvx7-ys'). |
YOUTUBE_CHANNEL |
YouTube channels(for example, 'youtube.com::L8ZULXASCc1I_oaOT0NaOQ'). |
GOOGLE_PRODUCTS |
Surfaces owned and operated by Google(for example, 'tv.google.com'). |
DetailedDemographic
A detailed demographic: a particular interest-based vertical to be targeted to reach users based on long-term life facts.
JSON representation |
---|
{
"resourceName": string,
"id": string,
"name": string,
"parent": string,
"launchedToAll": boolean,
"availabilities": [
{
object ( |
Fields | |
---|---|
resource |
Output only. The resource name of the detailed demographic. Detailed demographic resource names have the form:
|
id |
Output only. The ID of the detailed demographic. |
name |
Output only. The name of the detailed demographic. For example,"Highest Level of Educational Attainment" |
parent |
Output only. The parent of the detailedDemographic. |
launched |
Output only. True if the detailed demographic is launched to all channels and locales. |
availabilities[] |
Output only. Availability information of the detailed demographic. |
CriterionCategoryAvailability
Information of category availability, per advertising channel.
JSON representation |
---|
{ "channel": { object ( |
Fields | |
---|---|
channel |
Channel types and subtypes that are available to the category. |
locale[] |
Locales that are available to the category for the channel. |
CriterionCategoryChannelAvailability
Information of advertising channel type and subtypes a category is available in.
JSON representation |
---|
{ "availabilityMode": enum ( |
Fields | |
---|---|
availability |
Format of the channel availability. Can be ALL_CHANNELS (the rest of the fields will not be set), CHANNEL_TYPE (only advertisingChannelType type will be set, the category is available to all sub types under it) or CHANNEL_TYPE_AND_SUBTYPES (advertisingChannelType, advertisingChannelSubType, and includeDefaultChannelSubType will all be set). |
advertising |
Channel type the category is available to. |
advertising |
Channel subtypes under the channel type the category is available to. |
include |
Whether default channel sub type is included. For example, advertisingChannelType being DISPLAY and includeDefaultChannelSubType being false means that the default display campaign where channel sub type is not set is not included in this availability configuration. |
CriterionCategoryChannelAvailabilityMode
Enum containing the possible CriterionCategoryChannelAvailabilityMode.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ALL_CHANNELS |
The category is available to campaigns of all channel types and subtypes. |
CHANNEL_TYPE_AND_ALL_SUBTYPES |
The category is available to campaigns of a specific channel type, including all subtypes under it. |
CHANNEL_TYPE_AND_SUBSET_SUBTYPES |
The category is available to campaigns of a specific channel type and subtype(s). |
CriterionCategoryLocaleAvailability
Information about which locales a category is available in.
JSON representation |
---|
{
"availabilityMode": enum ( |
Fields | |
---|---|
availability |
Format of the locale availability. Can be LAUNCHED_TO_ALL (both country and language will be empty), COUNTRY (only country will be set), LANGUAGE (only language wil be set), COUNTRY_AND_LANGUAGE (both country and language will be set). |
country |
The ISO-3166-1 alpha-2 country code associated with the category. |
language |
ISO 639-1 code of the language associated with the category. |
CriterionCategoryLocaleAvailabilityMode
Enum containing the possible CriterionCategoryLocaleAvailabilityMode.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ALL_LOCALES |
The category is available to campaigns of all locales. |
COUNTRY_AND_ALL_LANGUAGES |
The category is available to campaigns within a list of countries, regardless of language. |
LANGUAGE_AND_ALL_COUNTRIES |
The category is available to campaigns within a list of languages, regardless of country. |
COUNTRY_AND_LANGUAGE |
The category is available to campaigns within a list of country, language pairs. |
DisplayKeywordView
A display keyword view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the display keyword view. Display Keyword view resource names have the form:
|
DistanceView
A distance view with metrics aggregated by the user's distance from an advertiser's location extensions. Each DistanceBucket includes all impressions that fall within its distance and a single impression will contribute to the metrics for all DistanceBuckets that include the user's distance.
JSON representation |
---|
{
"resourceName": string,
"distanceBucket": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the distance view. Distance view resource names have the form:
|
distance |
Output only. Grouping of user distance from location extensions. |
metric |
Output only. True if the DistanceBucket is using the metric system, false otherwise. |
DistanceBucket
The distance bucket for a user's distance from an advertiser's location extension.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
WITHIN_700M |
User was within 700m of the location. |
WITHIN_1KM |
User was within 1KM of the location. |
WITHIN_5KM |
User was within 5KM of the location. |
WITHIN_10KM |
User was within 10KM of the location. |
WITHIN_15KM |
User was within 15KM of the location. |
WITHIN_20KM |
User was within 20KM of the location. |
WITHIN_25KM |
User was within 25KM of the location. |
WITHIN_30KM |
User was within 30KM of the location. |
WITHIN_35KM |
User was within 35KM of the location. |
WITHIN_40KM |
User was within 40KM of the location. |
WITHIN_45KM |
User was within 45KM of the location. |
WITHIN_50KM |
User was within 50KM of the location. |
WITHIN_55KM |
User was within 55KM of the location. |
WITHIN_60KM |
User was within 60KM of the location. |
WITHIN_65KM |
User was within 65KM of the location. |
BEYOND_65KM |
User was beyond 65KM of the location. |
WITHIN_0_7MILES |
User was within 0.7 miles of the location. |
WITHIN_1MILE |
User was within 1 mile of the location. |
WITHIN_5MILES |
User was within 5 miles of the location. |
WITHIN_10MILES |
User was within 10 miles of the location. |
WITHIN_15MILES |
User was within 15 miles of the location. |
WITHIN_20MILES |
User was within 20 miles of the location. |
WITHIN_25MILES |
User was within 25 miles of the location. |
WITHIN_30MILES |
User was within 30 miles of the location. |
WITHIN_35MILES |
User was within 35 miles of the location. |
WITHIN_40MILES |
User was within 40 miles of the location. |
BEYOND_40MILES |
User was beyond 40 miles of the location. |
DynamicSearchAdsSearchTermView
A dynamic search ads search term view.
JSON representation |
---|
{ "resourceName": string, "searchTerm": string, "headline": string, "landingPage": string, "pageUrl": string, "hasNegativeKeyword": boolean, "hasMatchingKeyword": boolean, "hasNegativeUrl": boolean } |
Fields | |
---|---|
resource |
Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form:
|
search |
Output only. Search term This field is read-only. |
headline |
Output only. The dynamically generated headline of the Dynamic Search Ad. This field is read-only. |
landing |
Output only. The dynamically selected landing page URL of the impression. This field is read-only. |
page |
Output only. The URL of page feed item served for the impression. This field is read-only. |
has |
Output only. True if query matches a negative keyword. This field is read-only. |
has |
Output only. True if query is added to targeted keywords. This field is read-only. |
has |
Output only. True if query matches a negative url. This field is read-only. |
ExpandedLandingPageView
A landing page view with metrics aggregated at the expanded final URL level.
JSON representation |
---|
{ "resourceName": string, "expandedFinalUrl": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the expanded landing page view. Expanded landing page view resource names have the form:
|
expanded |
Output only. The final URL that clicks are directed to. |
FeedPlaceholderView
A feed placeholder view.
JSON representation |
---|
{
"resourceName": string,
"placeholderType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the feed placeholder view. Feed placeholder view resource names have the form:
|
placeholder |
Output only. The placeholder type of the feed placeholder view. |
GenderView
A gender view. The genderView resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in genderView with stats.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the gender view. Gender view resource names have the form:
|
GeographicView
A geographic view.
Geographic View includes all metrics aggregated at the country level, one row per country. It reports metrics at either actual physical location of the user or an area of interest. If other segment fields are used, you may get more than one row per country.
JSON representation |
---|
{
"resourceName": string,
"locationType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the geographic view. Geographic view resource names have the form:
|
location |
Output only. Type of the geo targeting of the campaign. |
country |
Output only. Criterion Id for the country. |
GeoTargetingType
The possible geo targeting types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
AREA_OF_INTEREST |
Location the user is interested in while making the query. |
LOCATION_OF_PRESENCE |
Location of the user issuing the query. |
GroupPlacementView
A group placement view.
JSON representation |
---|
{
"resourceName": string,
"placementType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the group placement view. Group placement view resource names have the form:
|
placement |
Output only. Type of the placement, for example, Website, YouTube Channel, Mobile Application. |
placement |
Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID. |
display |
Output only. Domain name for websites and YouTube channel name for YouTube channels. |
target |
Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL. |
HotelGroupView
A hotel group view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the hotel group view. Hotel Group view resource names have the form:
|
HotelPerformanceView
A hotel performance view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the hotel performance view. Hotel performance view resource names have the form:
|
HotelReconciliation
A hotel reconciliation. It contains conversion information from Hotel bookings to reconcile with advertiser records. These rows may be updated or canceled before billing through Bulk Uploads.
JSON representation |
---|
{
"resourceName": string,
"commissionId": string,
"orderId": string,
"campaign": string,
"hotelCenterId": string,
"hotelId": string,
"checkInDate": string,
"checkOutDate": string,
"reconciledValueMicros": string,
"billed": boolean,
"status": enum ( |
Fields | |
---|---|
resource |
Immutable. The resource name of the hotel reconciliation. Hotel reconciliation resource names have the form:
|
commission |
Required. Output only. The commission ID is Google's ID for this booking. Every booking event is assigned a Commission ID to help you match it to a guest stay. |
order |
Output only. The order ID is the identifier for this booking as provided in the 'transaction_id' parameter of the conversion tracking tag. |
campaign |
Output only. The resource name for the Campaign associated with the conversion. |
hotel |
Output only. Identifier for the Hotel Center account which provides the rates for the Hotel campaign. |
hotel |
Output only. Unique identifier for the booked property, as provided in the Hotel Center feed. The hotel ID comes from the 'ID' parameter of the conversion tracking tag. |
check |
Output only. Check-in date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD. |
check |
Output only. Check-out date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD. |
reconciled |
Required. Output only. Reconciled value is the final value of a booking as paid by the guest. If original booking value changes for any reason, such as itinerary changes or room upsells, the reconciled value should be the full final amount collected. If a booking is canceled, the reconciled value should include the value of any cancellation fees or non-refundable nights charged. Value is in millionths of the base unit currency. For example, $12.35 would be represented as 12350000. Currency unit is in the default customer currency. |
billed |
Output only. Whether a given booking has been billed. Once billed, a booking can't be modified. |
status |
Required. Output only. Current status of a booking with regards to reconciliation and billing. Bookings should be reconciled within 45 days after the check-out date. Any booking not reconciled within 45 days will be billed at its original value. |
HotelReconciliationStatus
Status of the hotel booking reconciliation.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
RESERVATION_ENABLED |
Bookings are for a future date, or a stay is underway but the check-out date hasn't passed. An active reservation can't be reconciled. |
RECONCILIATION_NEEDED |
Check-out has already taken place, or the booked dates have passed without cancellation. Bookings that are not reconciled within 45 days of the check-out date are billed based on the original booking price. |
RECONCILED |
These bookings have been reconciled. Reconciled bookings are billed 45 days after the check-out date. |
CANCELED |
This booking was marked as canceled. Canceled stays with a value greater than zero (due to minimum stay rules or cancellation fees) are billed 45 days after the check-out date. |
IncomeRangeView
An income range view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the income range view. Income range view resource names have the form:
|
KeywordView
A keyword view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the keyword view. Keyword view resource names have the form:
|
LandingPageView
A landing page view with metrics aggregated at the unexpanded final URL level.
JSON representation |
---|
{ "resourceName": string, "unexpandedFinalUrl": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the landing page view. Landing page view resource names have the form:
|
unexpanded |
Output only. The advertiser-specified final URL. |
LanguageConstant
A language.
JSON representation |
---|
{ "resourceName": string, "id": string, "code": string, "name": string, "targetable": boolean } |
Fields | |
---|---|
resource |
Output only. The resource name of the language constant. Language constant resource names have the form:
|
id |
Output only. The ID of the language constant. |
code |
Output only. The language code, for example, "en_US", "en_AU", "es", "fr", etc. |
name |
Output only. The full name of the language in English, for example, "English (US)", "Spanish", etc. |
targetable |
Output only. Whether the language is targetable. |
LocationView
A location view summarizes the performance of campaigns by a Location criterion. If no Location criterion is set, no results are returned; instead, use geographicView or userLocationView for visitor location data.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the location view. Location view resource names have the form:
|
ManagedPlacementView
A managed placement view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the Managed Placement view. Managed placement view resource names have the form:
|
MediaFile
A media file.
JSON representation |
---|
{ "resourceName": string, "type": enum ( |
Fields | |
---|---|
resource |
Immutable. The resource name of the media file. Media file resource names have the form:
|
type |
Immutable. Type of the media file. |
mime |
Output only. The mime type of the media file. |
id |
Output only. The ID of the media file. |
source |
Immutable. The URL of where the original media file was downloaded from (or a file name). Only used for media of type AUDIO and IMAGE. |
name |
Immutable. The name of the media file. The name can be used by clients to help identify previously uploaded media. |
file |
Output only. The size of the media file in bytes. |
Union field mediatype . The specific type of the media file. mediatype can be only one of the following: |
|
image |
Immutable. Encapsulates an Image. |
media |
Immutable. A ZIP archive media the content of which contains HTML5 assets. |
audio |
Output only. Encapsulates an Audio. |
video |
Immutable. Encapsulates a Video. |
MediaType
The type of media.
Enums | |
---|---|
UNSPECIFIED |
The media type has not been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
IMAGE |
Static image, used for image ad. |
ICON |
Small image, used for map ad. |
MEDIA_BUNDLE |
ZIP file, used in fields of template ads. |
AUDIO |
Audio file. |
VIDEO |
Video file. |
DYNAMIC_IMAGE |
Animated image, such as animated GIF. |
MediaImage
Encapsulates an Image.
JSON representation |
---|
{ "data": string, "fullSizeImageUrl": string, "previewSizeImageUrl": string } |
Fields | |
---|---|
data |
Immutable. Raw image data. A base64-encoded string. |
full |
Output only. The url to the full size version of the image. |
preview |
Output only. The url to the preview size version of the image. |
MediaBundle
Represents a ZIP archive media the content of which contains HTML5 assets.
JSON representation |
---|
{ "data": string, "url": string } |
Fields | |
---|---|
data |
Immutable. Raw zipped data. A base64-encoded string. |
url |
Output only. The url to access the uploaded zipped data. For example, https://tpc.googlesyndication.com/simgad/123 This field is read-only. |
MediaAudio
Encapsulates an Audio.
JSON representation |
---|
{ "adDurationMillis": string } |
Fields | |
---|---|
ad |
Output only. The duration of the Audio in milliseconds. |
MediaVideo
Encapsulates a Video.
JSON representation |
---|
{ "adDurationMillis": string, "youtubeVideoId": string, "advertisingIdCode": string, "isciCode": string } |
Fields | |
---|---|
ad |
Output only. The duration of the Video in milliseconds. |
youtube |
Immutable. The YouTube video ID (as seen in YouTube URLs). Adding prefix "https://www.youtube.com/watch?v=" to this ID will get the YouTube streaming URL for this video. |
advertising |
Output only. The Advertising Digital Identification code for this video, as defined by the American Association of Advertising Agencies, used mainly for television commercials. |
isci |
Output only. The Industry Standard Commercial Identifier code for this video, used mainly for television commercials. |
LocalServicesEmployee
A local services employee resource.
JSON representation |
---|
{ "resourceName": string, "creationDateTime": string, "status": enum ( |
Fields | |
---|---|
resource |
Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form:
|
creation |
Output only. Timestamp of employee creation. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" |
status |
Output only. Employee status, such as DELETED or ENABLED. |
type |
Output only. Employee type. |
university |
Output only. A list of degrees this employee has obtained, and wants to feature. |
residencies[] |
Output only. The institutions where the employee has completed their residency. |
fellowships[] |
Output only. The institutions where the employee has completed their fellowship. |
languages |
Output only. Languages that the employee speaks, represented as language tags from https://developers.google.com/admin-sdk/directory/v1/languages |
category |
Output only. Category of the employee. A list of Local Services category IDs can be found at https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids. |
id |
Output only. The ID of the employee. |
job |
Output only. Job title for this employee, such as "Senior partner" in legal verticals. |
year |
Output only. The year that this employee started practicing in this field. |
national |
Output only. NPI id associated with the employee. |
email |
Output only. Email address of the employee. |
first |
Output only. First name of the employee. |
middle |
Output only. Middle name of the employee. |
last |
Output only. Last name of the employee. |
LocalServicesEmployeeStatus
Enums describing statuses of a local services employee.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Employee is not removed, and employee status is active. |
REMOVED |
Employee is removed. Used to delete an employee from the business. |
LocalServicesEmployeeType
Enums describing types of a local services employee.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_OWNER |
Represents the owner of the business. |
EMPLOYEE |
Represents an employee of the business. |
UniversityDegree
A list of degrees this employee has obtained, and wants to feature.
JSON representation |
---|
{ "institutionName": string, "degree": string, "graduationYear": integer } |
Fields | |
---|---|
institution |
Output only. Name of the university at which the degree was obtained. |
degree |
Output only. Name of the degree obtained. |
graduation |
Output only. Year of graduation. |
Residency
Details about the employee's medical residency. Residency is a stage of graduate medical education in which a qualified medical professional practices under the supervision of a senior clinician.
JSON representation |
---|
{ "institutionName": string, "completionYear": integer } |
Fields | |
---|---|
institution |
Output only. Name of the institution at which the residency was completed. |
completion |
Output only. Year of completion. |
Fellowship
Details about the employee's medical Fellowship. Fellowship is a period of medical training that the professional undertakes after finishing their residency.
JSON representation |
---|
{ "institutionName": string, "completionYear": integer } |
Fields | |
---|---|
institution |
Output only. Name of the instutition at which the fellowship was completed. |
completion |
Output only. Year of completion. |
LocalServicesVerificationArtifact
A local services verification resource.
JSON representation |
---|
{ "resourceName": string, "creationDateTime": string, "status": enum ( |
Fields | |
---|---|
resource |
Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form:
|
creation |
Output only. The timestamp when this verification artifact was created. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" |
status |
Output only. The status of the verification artifact. |
artifact |
Output only. The type of the verification artifact. |
id |
Output only. The ID of the verification artifact. |
Union field artifact_data . The types of verification info. artifact_data can be only one of the following: |
|
background |
Output only. A background check verification artifact. |
insurance |
Output only. An insurance verification artifact. |
license |
Output only. A license verification artifact. |
business |
Output only. A business registration check verification artifact. |
LocalServicesVerificationArtifactStatus
Enums describing statuses of a local services verification artifact.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PASSED |
Artifact has passed verification. |
FAILED |
Artifact has failed verification. |
PENDING |
Artifact is in the process of verification. |
NO_SUBMISSION |
Artifact needs user to upload information before it is verified. |
CANCELLED |
Artifact has been cancelled by the user. |
LocalServicesVerificationArtifactType
Enums describing possible types of local services verification artifact.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BACKGROUND_CHECK |
Background check verification artifact. |
INSURANCE |
Insurance verification artifact. |
LICENSE |
License verification artifact. |
BUSINESS_REGISTRATION_CHECK |
Business registration check verification artifact. |
BackgroundCheckVerificationArtifact
A proto holding information specific to local services background check.
JSON representation |
---|
{ "caseUrl": string, "finalAdjudicationDateTime": string } |
Fields | |
---|---|
case |
Output only. URL to access background case. |
final |
Output only. The timestamp when this background check case result was adjudicated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" |
InsuranceVerificationArtifact
A proto holding information specific to a local services insurance.
JSON representation |
---|
{ "amountMicros": string, "rejectionReason": enum ( |
Fields | |
---|---|
amount |
Output only. Insurance amount. This is measured in "micros" of the currency mentioned in the insurance document. |
rejection |
Output only. Insurance document's rejection reason. |
insurance |
Output only. The readonly field containing the information for an uploaded insurance document. |
LocalServicesInsuranceRejectionReason
Enums describing possible rejection reasons of a local services insurance verification artifact.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_NAME_MISMATCH |
Business name doesn't match business name for the Local Services Ad. |
INSURANCE_AMOUNT_INSUFFICIENT |
Insurance amount doesn't meet requirement listed in the legal summaries documentation for that geographic + category ID combination. |
EXPIRED |
Insurance document is expired. |
NO_SIGNATURE |
Insurance document is missing a signature. |
NO_POLICY_NUMBER |
Insurance document is missing a policy number. |
NO_COMMERCIAL_GENERAL_LIABILITY |
Commercial General Liability(CGL) box is not marked in the insurance document. |
EDITABLE_FORMAT |
Insurance document is in an editable format. |
CATEGORY_MISMATCH |
Insurance document does not cover insurance for a particular category. |
MISSING_EXPIRATION_DATE |
Insurance document is missing an expiration date. |
POOR_QUALITY |
Insurance document is poor quality - blurry images, illegible, etc... |
POTENTIALLY_EDITED |
Insurance document is suspected of being edited. |
WRONG_DOCUMENT_TYPE |
Insurance document not accepted. For example, documents of insurance proposals, but missing coverages are not accepted. |
NON_FINAL |
Insurance document is not final. |
OTHER |
Insurance document has another flaw not listed explicitly. |
LocalServicesDocumentReadOnly
A Local Services Document with read only accessible data.
JSON representation |
---|
{ "documentUrl": string } |
Fields | |
---|---|
document |
URL to access an already uploaded Local Services document. |
LicenseVerificationArtifact
A proto holding information specific to a local services license.
JSON representation |
---|
{ "licenseType": string, "licenseNumber": string, "licenseeFirstName": string, "licenseeLastName": string, "rejectionReason": enum ( |
Fields | |
---|---|
license |
Output only. License type / name. |
license |
Output only. License number. |
licensee |
Output only. First name of the licensee. |
licensee |
Output only. Last name of the licensee. |
rejection |
Output only. License rejection reason. |
license |
Output only. The readonly field containing the information for an uploaded license document. |
LocalServicesLicenseRejectionReason
Enums describing possible rejection reasons of a local services license verification artifact.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_NAME_MISMATCH |
Business name doesn't match business name for the Local Services Ad. |
UNAUTHORIZED |
License is unauthorized or been revoked. |
EXPIRED |
License is expired. |
POOR_QUALITY |
License is poor quality - blurry images, illegible, etc... |
UNVERIFIABLE |
License cannot be verified due to a not legitimate image. |
WRONG_DOCUMENT_OR_ID |
License is not the requested document type or contains an invalid ID. |
OTHER |
License has another flaw not listed explicitly. |
BusinessRegistrationCheckVerificationArtifact
A proto holding information specific to a local services business registration check.
JSON representation |
---|
{ "registrationType": enum ( |
Fields | |
---|---|
registration |
Output only. The type of business registration check (number, document). |
check |
Output only. The id of the check, such as vat_tax_id, representing "VAT Tax ID" requirement. |
rejection |
Output only. Registration document rejection reason. |
Union field business_registration . Registration information for the business registration. It will be one of the following forms based on the requirement from different countries. business_registration can be only one of the following: |
|
registration |
Output only. Message storing government issued number for the business. |
registration |
Output only. Message storing document info for the business. |
LocalServicesBusinessRegistrationType
Enums describing possible registration types of a local services business registration check verification artifact.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
NUMBER |
Registration number check type. |
DOCUMENT |
Registration document check type. |
LocalServicesBusinessRegistrationCheckRejectionReason
Enums describing possible rejection reasons of a local services business registration check verification artifact.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_NAME_MISMATCH |
Business name doesn't match business name for the Local Services Ad. |
BUSINESS_DETAILS_MISMATCH |
Business details mismatch. |
ID_NOT_FOUND |
Business registration ID not found. |
POOR_DOCUMENT_IMAGE_QUALITY |
Uploaded document not clear, blurry, etc. |
DOCUMENT_EXPIRED |
Uploaded document has expired. |
DOCUMENT_INVALID |
Document revoked or annuled. |
DOCUMENT_TYPE_MISMATCH |
Document type mismatch. |
DOCUMENT_UNVERIFIABLE |
Uploaded document could not be verified as legitimate. |
OTHER |
The business registration process could not be completed due to an issue. Contact https://support.google.com/localservices to learn more. |
BusinessRegistrationNumber
A proto holding information specific to a local services business registration number.
JSON representation |
---|
{ "number": string } |
Fields | |
---|---|
number |
Output only. Government-issued number for the business. |
BusinessRegistrationDocument
A proto holding information specific to a local services business registration document.
JSON representation |
---|
{
"documentReadonly": {
object ( |
Fields | |
---|---|
document |
Output only. The readonly field containing the information for an uploaded business registration document. |
MobileAppCategoryConstant
A mobile application category constant.
JSON representation |
---|
{ "resourceName": string, "id": integer, "name": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the mobile app category constant. Mobile app category constant resource names have the form:
|
id |
Output only. The ID of the mobile app category constant. |
name |
Output only. Mobile app category name. |
MobileDeviceConstant
A mobile device constant.
JSON representation |
---|
{
"resourceName": string,
"type": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the mobile device constant. Mobile device constant resource names have the form:
|
type |
Output only. The type of mobile device. |
id |
Output only. The ID of the mobile device constant. |
name |
Output only. The name of the mobile device. |
manufacturer |
Output only. The manufacturer of the mobile device. |
operating |
Output only. The operating system of the mobile device. |
MobileDeviceType
The type of mobile device.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
MOBILE |
Mobile phones. |
TABLET |
Tablets. |
OfflineConversionUploadClientSummary
Offline conversion upload summary at customer level.
JSON representation |
---|
{ "resourceName": string, "client": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the offline conversion upload summary at customer level. Offline conversion upload client summary resource names have the form:
|
client |
Output only. Client type of the upload event. |
status |
Output only. Overall status for offline conversion client summary. Status is generated from most recent calendar day with upload stats. |
total |
Output only. Total count of uploaded events. |
successful |
Output only. Total count of successful uploaded events. |
success |
Output only. Successful rate. |
last |
Output only. Date for the latest upload batch. The format is "yyyy-mm-dd hh:mm:ss", and it's in the time zone of the Google Ads account. |
daily |
Output only. Summary of history stats by last N days. |
job |
Output only. Summary of history stats by last N jobs. |
alerts[] |
Output only. Details for each error code. Alerts are generated from most recent calendar day with upload stats. |
OfflineEventUploadClient
Type of client.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
GOOGLE_ADS_API |
Google Ads API. |
GOOGLE_ADS_WEB_CLIENT |
Google Ads web client, which could include multiple sources like Ads UI, SFTP, etc. |
ADS_DATA_CONNECTOR |
Connection platform. |
OfflineConversionDiagnosticStatus
Possible statuses of the offline ingestion setup.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
EXCELLENT |
Your offline data ingestion setup is active and optimal for downstream processing. |
GOOD |
Your offline ingestion setup is active, but there are further improvements you could make. See alerts. |
NEEDS_ATTENTION |
Your offline ingestion setup is active, but there are errors that require your attention. See alerts. |
NO_RECENT_UPLOAD |
Your offline ingestion setup has not received data in the last 28 days, there may be something wrong. |
OfflineConversionSummary
Historical upload summary, grouped by upload date or job.
JSON representation |
---|
{ "successfulCount": string, "failedCount": string, // Union field |
Fields | |
---|---|
successful |
Output only. Total count of successful event. |
failed |
Output only. Total count of failed event. |
Union field dimension_key . Dimension key for summary. dimension_key can be only one of the following: |
|
job |
Output only. Dimension key for last N jobs. |
upload |
Output only. Dimension key for last N days. |
OfflineConversionAlert
Alert for offline conversion client summary.
JSON representation |
---|
{
"error": {
object ( |
Fields | |
---|---|
error |
Output only. Error for offline conversion client alert. |
error |
Output only. Percentage of the error, the range of this field should be [0, 1.0]. |
OfflineConversionError
Possible errors for offline conversion client summary.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field error_code . Error with description. error_code can be only one of the following: |
|
collection |
Output only. Collection size error. |
conversion |
Output only. Conversion adjustment upload error. |
conversion |
Output only. Conversion upload error. |
date |
Output only. Date error. |
distinct |
Output only. Distinct error. |
field |
Output only. Field error. |
mutate |
Output only. Mutate error. |
not |
Output only. Not allowlisted error. |
string |
Output only. String format error. |
string |
Output only. String length error. |
CollectionSizeError
Enum describing possible collection size errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
TOO_FEW |
Too few. |
TOO_MANY |
Too many. |
ConversionAdjustmentUploadError
Enum describing possible conversion adjustment upload errors.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
TOO_RECENT_CONVERSION_ACTION |
Can't import events to a conversion action that was just created. Try importing again in 6 hours. |
CONVERSION_ALREADY_RETRACTED |
The conversion was already retracted. This adjustment was not processed. |
CONVERSION_NOT_FOUND |
The conversion for this conversion action and conversion identifier can't be found. Make sure your conversion identifiers are associated with the correct conversion action and try again. |
CONVERSION_EXPIRED |
Adjustment can't be made to a conversion that occurred more than 54 days ago. |
ADJUSTMENT_PRECEDES_CONVERSION |
Adjustment has an adjustmentDateTime that occurred before the associated conversion. Make sure your adjustmentDateTime is correct and try again. |
MORE_RECENT_RESTATEMENT_FOUND |
More recent adjustment adjustmentDateTime has already been reported for the associated conversion. Make sure your adjustment adjustmentDateTime is correct and try again. |
TOO_RECENT_CONVERSION |
Adjustment can't be recorded because the conversion occurred too recently. Try adjusting a conversion that occurred at least 24 hours ago. |
CANNOT_RESTATE_CONVERSION_ACTION_THAT_ALWAYS_USES_DEFAULT_CONVERSION_VALUE |
Can't make an adjustment to a conversion that is set up to use the default value. Check your conversion action value setting and try again. |
TOO_MANY_ADJUSTMENTS_IN_REQUEST |
Try uploading fewer than 2001 adjustments in a single API request. |
TOO_MANY_ADJUSTMENTS |
The conversion has already been adjusted the maximum number of times. Make sure you're only making necessary adjustment to existing conversion. |
RESTATEMENT_ALREADY_EXISTS |
The conversion has prior a restatement with the same adjustmentDateTime . Make sure your adjustment has the correct and unique adjustmentDateTime and try again. |
DUPLICATE_ADJUSTMENT_IN_REQUEST |
Imported adjustment has a duplicate conversion adjustment with same adjustmentDateTime . Make sure your adjustment has the correct adjustmentDateTime and try again. |
CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS |
Make sure you agree to the customer data processing terms in conversion settings and try again. |
CONVERSION_ACTION_NOT_ELIGIBLE_FOR_ENHANCEMENT |
Can't use enhanced conversions with the specified conversion action. |
INVALID_USER_IDENTIFIER |
Make sure you hash user provided data using SHA-256 and ensure you are normalizing according to the guidelines. |
UNSUPPORTED_USER_IDENTIFIER |
Use user provided data such as emails or phone numbers hashed using SHA-256 and try again. |
GCLID_DATE_TIME_PAIR_AND_ORDER_ID_BOTH_SET |
Cannot set both gclidDateTimePair and orderId. Use only 1 type and try again. |
CONVERSION_ALREADY_ENHANCED |
Conversion already has enhancements with the same Order ID and conversion action. Make sure your data is correctly configured and try again. |
DUPLICATE_ENHANCEMENT_IN_REQUEST |
Multiple enhancements have the same conversion action and Order ID. Make sure your data is correctly configured and try again. |
CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCEMENT |
Enhanced conversions can't be used for this account because of Google customer data policies. Contact your Google representative. |
MISSING_ORDER_ID_FOR_WEBPAGE |
Adjustment for website conversion requires Order ID (ie, transaction ID). Make sure your website tags capture Order IDs and you send the same Order IDs with your adjustment. |
ORDER_ID_CONTAINS_PII |
Can't use adjustment with Order IDs containing personally-identifiable information (PII). |
INVALID_JOB_ID |
The provided job id in the request is not within the allowed range. A job ID must be a positive integer in the range [1, 2^31). |
NO_CONVERSION_ACTION_FOUND |
The conversion action specified in the adjustment request cannot be found. Make sure it's available in this account. |
INVALID_CONVERSION_ACTION_TYPE |
The type of the conversion action specified in the adjustment request isn't supported for uploading adjustments. A conversion adjustment of type RETRACTION or RESTATEMENT is only permitted for conversion actions of type SALESFORCE , UPLOAD_CLICK or WEBPAGE . A conversion adjustment of type ENHANCEMENT is only permitted for conversion actions of type WEBPAGE . |
ConversionUploadError
Enum describing possible conversion upload errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
TOO_MANY_CONVERSIONS_IN_REQUEST |
Upload fewer than 2001 events in a single request. |
UNPARSEABLE_GCLID |
The imported gclid could not be decoded. Make sure you have not modified the click IDs. |
CONVERSION_PRECEDES_EVENT |
The imported event has a conversionDateTime that precedes the click. Make sure your conversionDateTime is correct and try again. |
EXPIRED_EVENT |
The imported event can't be recorded because its click occurred before this conversion's click-through window. Make sure you import the most recent data. |
TOO_RECENT_EVENT |
The click associated with the given identifier or iOS URL parameter occurred less than 6 hours ago. Retry after 6 hours have passed. |
EVENT_NOT_FOUND |
The imported event could not be attributed to a click. This may be because the event did not come from a Google Ads campaign. |
UNAUTHORIZED_CUSTOMER |
The click ID or call is associated with an Ads account you don't have access to. Make sure you import conversions for accounts managed by your manager account. |
TOO_RECENT_CONVERSION_ACTION |
Can't import events to a conversion action that was just created. Try importing again in 6 hours. |
CONVERSION_TRACKING_NOT_ENABLED_AT_IMPRESSION_TIME |
At the time of the click, conversion tracking was not enabled in the effective conversion account of the click's Google Ads account. |
EXTERNAL_ATTRIBUTION_DATA_SET_FOR_NON_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION |
The imported event includes external attribution data, but the conversion action isn't set up to use an external attribution model. Make sure the conversion action is correctly configured and try again. |
EXTERNAL_ATTRIBUTION_DATA_NOT_SET_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION |
The conversion action is set up to use an external attribution model, but the imported event is missing data. Make sure imported events include the external attribution credit and all necessary fields. |
ORDER_ID_NOT_PERMITTED_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION |
Order IDs can't be used for a conversion measured with an external attribution model. Make sure the conversion is correctly configured and imported events include only necessary data and try again. |
ORDER_ID_ALREADY_IN_USE |
The imported event includes an order ID that was previously recorded, so the event was not processed. |
DUPLICATE_ORDER_ID |
Imported events include multiple conversions with the same order ID and were not processed. Make sure order IDs are unique and try again. |
TOO_RECENT_CALL |
Can't import calls that occurred less than 6 hours ago. Try uploading again in 6 hours. |
EXPIRED_CALL |
The call can't be recorded because it occurred before this conversion action's lookback window. Make sure your import is configured to get the most recent data. |
CALL_NOT_FOUND |
The call or click leading to the imported event can't be found. Make sure your data source is set up to include correct identifiers. |
CONVERSION_PRECEDES_CALL |
The call has a conversionDateTime that precedes the associated click. Make sure your conversionDateTime is correct. |
CONVERSION_TRACKING_NOT_ENABLED_AT_CALL_TIME |
At the time of the imported call, conversion tracking was not enabled in the effective conversion account of the click's Google Ads account. |
UNPARSEABLE_CALLERS_PHONE_NUMBER |
Make sure phone numbers are formatted as E.164 (+16502531234), International (+64 3-331 6005), or US national number (6502531234). |
CLICK_CONVERSION_ALREADY_EXISTS |
The imported event has the same click and conversionDateTime as an existing conversion. Use a unique conversionDateTime or order ID for each unique event and try again. |
CALL_CONVERSION_ALREADY_EXISTS |
The imported call has the same conversionDateTime as an existing conversion. Make sure your conversionDateTime correctly configured and try again. |
DUPLICATE_CLICK_CONVERSION_IN_REQUEST |
Multiple events have the same click and conversionDateTime . Make sure your conversionDateTime is correctly configured and try again. |
DUPLICATE_CALL_CONVERSION_IN_REQUEST |
Multiple events have the same call and conversionDateTime . Make sure your conversionDateTime is correctly configured and try again. |
CUSTOM_VARIABLE_NOT_ENABLED |
Enable the custom variable in your conversion settings and try again. |
CUSTOM_VARIABLE_VALUE_CONTAINS_PII |
Can't import events with custom variables containing personally-identifiable information (PII). Remove these variables and try again. |
INVALID_CUSTOMER_FOR_CLICK |
The click from the imported event is associated with a different Google Ads account. Make sure you're importing to the correct account. |
INVALID_CUSTOMER_FOR_CALL |
The click from the call is associated with a different Google Ads account. Make sure you're importing to the correct account. Query conversionTrackingSetting.google_ads_conversion_customer on Customer to identify the correct account. |
CONVERSION_NOT_COMPLIANT_WITH_ATT_POLICY |
The connversion can't be imported because the conversion source didn't comply with Apple App Transparency Tracking (ATT) policies or because the customer didn't consent to tracking. |
CLICK_NOT_FOUND |
The email address or phone number for this event can't be matched to a click. This may be because it didn't come from a Google Ads campaign, and you can safely ignore this warning. If this includes more imported events than is expected, you may need to check your setup. |
INVALID_USER_IDENTIFIER |
Make sure you hash user provided data using SHA-256 and ensure you are normalizing according to the guidelines. |
EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION_NOT_PERMITTED_WITH_USER_IDENTIFIER |
User provided data can't be used with external attribution models. Use a different attribution model or omit user identifiers and try again. |
UNSUPPORTED_USER_IDENTIFIER |
The provided user identifiers are not supported. Use only hashed email or phone number and try again. |
GBRAID_WBRAID_BOTH_SET |
Can't use both gbraid and wbraid parameters. Use only 1 and try again. |
UNPARSEABLE_WBRAID |
Can't parse event import data. Check if your wbraid parameter was not modified and try again. |
UNPARSEABLE_GBRAID |
Can't parse event import data. Check if your gbraid parameter was not modified and try again. |
ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID |
Conversion actions that use one-per-click counting can't be used with gbraid or wbraid parameters. |
CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS |
Enhanced conversions can't be used for this account because of Google customer data policies. Contact your Google representative. |
CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS |
Make sure you agree to the customer data processing terms in conversion settings and try again. You can check your setting by querying conversionTrackingSetting.accepted_customer_data_terms on Customer. |
ORDER_ID_CONTAINS_PII |
Can't import events with order IDs containing personally-identifiable information (PII). |
CUSTOMER_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS |
Make sure you've turned on enhanced conversions for leads in conversion settings and try again. You can check your setting by querying conversionTrackingSetting.enhanced_conversions_for_leads_enabled on Customer. |
INVALID_JOB_ID |
The provided job id in the request is not within the allowed range. A job ID must be a positive integer in the range [1, 2^31). |
NO_CONVERSION_ACTION_FOUND |
The conversion action specified in the upload request cannot be found. Make sure it's available in this account. |
INVALID_CONVERSION_ACTION_TYPE |
The conversion action specified in the upload request isn't set up for uploading conversions. |
DateError
Enum describing possible date errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
INVALID_FIELD_VALUES_IN_DATE |
Given field values do not correspond to a valid date. |
INVALID_FIELD_VALUES_IN_DATE_TIME |
Given field values do not correspond to a valid date time. |
INVALID_STRING_DATE |
The string date's format should be yyyy-mm-dd. |
INVALID_STRING_DATE_TIME_MICROS |
The string date time's format should be yyyy-mm-dd hh:mm:ss.ssssss. |
INVALID_STRING_DATE_TIME_SECONDS |
The string date time's format should be yyyy-mm-dd hh:mm:ss. |
INVALID_STRING_DATE_TIME_SECONDS_WITH_OFFSET |
The string date time's format should be yyyy-mm-dd hh:mm:ss+|-hh:mm. |
EARLIER_THAN_MINIMUM_DATE |
Date is before allowed minimum. |
LATER_THAN_MAXIMUM_DATE |
Date is after allowed maximum. |
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE |
Date range bounds are not in order. |
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL |
Both dates in range are null. |
DistinctError
Enum describing possible distinct errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
DUPLICATE_ELEMENT |
Duplicate element. |
DUPLICATE_TYPE |
Duplicate type. |
FieldError
Enum describing possible field errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
REQUIRED |
The required field was not present. |
IMMUTABLE_FIELD |
The field attempted to be mutated is immutable. |
INVALID_VALUE |
The field's value is invalid. |
VALUE_MUST_BE_UNSET |
The field cannot be set. |
REQUIRED_NONEMPTY_LIST |
The required repeated field was empty. |
FIELD_CANNOT_BE_CLEARED |
The field cannot be cleared. |
BLOCKED_VALUE |
The field's value is on a deny-list for this field. |
FIELD_CAN_ONLY_BE_CLEARED |
The field's value cannot be modified, except for clearing. |
MutateError
Enum describing possible mutate errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
RESOURCE_NOT_FOUND |
Requested resource was not found. |
ID_EXISTS_IN_MULTIPLE_MUTATES |
Cannot mutate the same resource twice in one request. |
INCONSISTENT_FIELD_VALUES |
The field's contents don't match another field that represents the same data. |
MUTATE_NOT_ALLOWED |
Mutates are not allowed for the requested resource. |
RESOURCE_NOT_IN_GOOGLE_ADS |
The resource isn't in Google Ads. It belongs to another ads system. |
RESOURCE_ALREADY_EXISTS |
The resource being created already exists. |
RESOURCE_DOES_NOT_SUPPORT_VALIDATE_ONLY |
This resource cannot be used with "validateOnly". |
OPERATION_DOES_NOT_SUPPORT_PARTIAL_FAILURE |
This operation cannot be used with "partialFailure". |
RESOURCE_READ_ONLY |
Attempt to write to read-only fields. |
NotAllowlistedError
Enum describing possible not allowlisted errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
CUSTOMER_NOT_ALLOWLISTED_FOR_THIS_FEATURE |
Customer is not allowlisted for accessing this feature. |
StringFormatError
Enum describing possible string format errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
ILLEGAL_CHARS |
The input string value contains disallowed characters. |
INVALID_FORMAT |
The input string value is invalid for the associated field. |
StringLengthError
Enum describing possible string length errors.
Enums | |
---|---|
UNSPECIFIED |
Enum unspecified. |
UNKNOWN |
The received error code is not known in this version. |
EMPTY |
The specified field should have a least one non-whitespace character in it. |
TOO_SHORT |
Too short. |
TOO_LONG |
Too long. |
OperatingSystemVersionConstant
A mobile operating system version or a range of versions, depending on operatorType
. List of available mobile platforms at https://developers.google.com/google-ads/api/reference/data/codes-formats#mobile-platforms
JSON representation |
---|
{
"resourceName": string,
"operatorType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the operating system version constant. Operating system version constant resource names have the form:
|
operator |
Output only. Determines whether this constant represents a single version or a range of versions. |
id |
Output only. The ID of the operating system version. |
name |
Output only. Name of the operating system. |
os |
Output only. The OS Major Version number. |
os |
Output only. The OS Minor Version number. |
OperatingSystemVersionOperatorType
The type of operating system version.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
EQUALS_TO |
Equals to the specified version. |
GREATER_THAN_EQUALS_TO |
Greater than or equals to the specified version. |
PaidOrganicSearchTermView
A paid organic search term view providing a view of search stats across ads and organic listings aggregated by search term at the ad group level.
JSON representation |
---|
{ "resourceName": string, "searchTerm": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the search term view. Search term view resource names have the form:
|
search |
Output only. The search term. |
QualifyingQuestion
Qualifying Questions for Lead Form.
JSON representation |
---|
{ "resourceName": string, "qualifyingQuestionId": string, "locale": string, "text": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the qualifying question. 'qualifyingQuestions/{qualifyingQuestionId}' |
qualifying |
Output only. The id of the qualifying question. |
locale |
Output only. The locale of the qualifying question. |
text |
Output only. The qualifying question. |
ParentalStatusView
A parental status view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the parental status view. Parental Status view resource names have the form:
|
PerStoreView
A per store view. This view provides per store impression reach and local action conversion stats for advertisers.
JSON representation |
---|
{ "resourceName": string, "placeId": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the per store view. Per Store view resource names have the form:
|
place |
Output only. The place ID of the per store view. |
ProductCategoryConstant
A Product Category.
JSON representation |
---|
{ "resourceName": string, "categoryId": string, "level": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the product category. Product category resource names have the form:
|
category |
Output only. The ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436. |
level |
Output only. Level of the product category. |
state |
Output only. State of the product category. |
localizations[] |
Output only. List of all available localizations of the product category. |
product |
Output only. Resource name of the parent product category. |
ProductCategoryState
Enum describing the state of the product category.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
The category is enabled. |
OBSOLETE |
The category is obsolete. Used only for reporting purposes. |
ProductCategoryLocalization
Localization for the product category.
JSON representation |
---|
{ "regionCode": string, "languageCode": string, "value": string } |
Fields | |
---|---|
region |
Output only. Upper-case two-letter ISO 3166-1 country code of the localized category. |
language |
Output only. Two-letter ISO 639-1 language code of the localized category. |
value |
Output only. The name of the category in the specified locale. |
ProductGroupView
A product group view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the product group view. Product group view resource names have the form:
|
SearchTermView
A search term view with metrics aggregated by search term at the ad group level.
JSON representation |
---|
{
"resourceName": string,
"status": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the search term view. Search term view resource names have the form:
|
status |
Output only. Indicates whether the search term is currently one of your targeted or excluded keywords. |
search |
Output only. The search term. |
ad |
Output only. The ad group the search term served in. |
SearchTermTargetingStatus
Indicates whether the search term is one of your targeted or excluded keywords.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ADDED |
Search term is added to targeted keywords. |
EXCLUDED |
Search term matches a negative keyword. |
ADDED_EXCLUDED |
Search term has been both added and excluded. |
NONE |
Search term is neither targeted nor excluded. |
ShoppingPerformanceView
Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: |
SmartCampaignSearchTermView
A Smart campaign search term view.
JSON representation |
---|
{ "resourceName": string, "searchTerm": string, "campaign": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the Smart campaign search term view. Smart campaign search term view resource names have the form:
|
search |
Output only. The search term. |
campaign |
Output only. The Smart campaign the search term served in. |
ThirdPartyAppAnalyticsLink
A data sharing connection, allowing the import of third party app analytics into a Google Ads Customer.
JSON representation |
---|
{ "resourceName": string, "shareableLinkId": string } |
Fields | |
---|---|
resource |
Immutable. The resource name of the third party app analytics link. Third party app analytics link resource names have the form:
|
shareable |
Output only. The shareable link ID that should be provided to the third party when setting up app analytics. This is able to be regenerated using regenerate method in the ThirdPartyAppAnalyticsLinkService. |
TopicView
A topic view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the topic view. Topic view resource names have the form:
|
TravelActivityGroupView
A travel activity group view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the travel activity group view. Travel Activity Group view resource names have the form:
|
TravelActivityPerformanceView
A travel activity performance view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the travel activity performance view. Travel Activity performance view resource names have the form:
|
UserInterest
A user interest: a particular interest-based vertical to be targeted.
JSON representation |
---|
{ "resourceName": string, "taxonomyType": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the user interest. User interest resource names have the form:
|
taxonomy |
Output only. Taxonomy type of the user interest. |
availabilities[] |
Output only. Availability information of the user interest. |
user |
Output only. The ID of the user interest. |
name |
Output only. The name of the user interest. |
user |
Output only. The parent of the user interest. |
launched |
Output only. True if the user interest is launched to all channels and locales. |
UserInterestTaxonomyType
Enum containing the possible UserInterestTaxonomyTypes.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
AFFINITY |
The affinity for this user interest. |
IN_MARKET |
The market for this user interest. |
MOBILE_APP_INSTALL_USER |
Users known to have installed applications in the specified categories. |
VERTICAL_GEO |
The geographical location of the interest-based vertical. |
NEW_SMART_PHONE_USER |
User interest criteria for new smart phone users. |
LifeEvent
A life event: a particular interest-based vertical to be targeted to reach users when they are in the midst of important life milestones.
JSON representation |
---|
{
"resourceName": string,
"id": string,
"name": string,
"parent": string,
"launchedToAll": boolean,
"availabilities": [
{
object ( |
Fields | |
---|---|
resource |
Output only. The resource name of the life event. Life event resource names have the form:
|
id |
Output only. The ID of the life event. |
name |
Output only. The name of the life event, for example,"Recently Moved" |
parent |
Output only. The parent of the lifeEvent. |
launched |
Output only. True if the life event is launched to all channels and locales. |
availabilities[] |
Output only. Availability information of the life event. |
UserLocationView
A user location view.
User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.
JSON representation |
---|
{ "resourceName": string, "countryCriterionId": string, "targetingLocation": boolean } |
Fields | |
---|---|
resource |
Output only. The resource name of the user location view. UserLocation view resource names have the form:
|
country |
Output only. Criterion Id for the country. |
targeting |
Output only. Indicates whether location was targeted or not. |
TopicConstant
Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs").
JSON representation |
---|
{ "resourceName": string, "path": [ string ], "id": string, "topicConstantParent": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the topic constant. topic constant resource names have the form:
|
path[] |
Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/google-ads/api/reference/data/verticals |
id |
Output only. The ID of the topic. |
topic |
Output only. Resource name of parent of the topic constant. |
Video
A video.
JSON representation |
---|
{ "resourceName": string, "id": string, "channelId": string, "durationMillis": string, "title": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the video. Video resource names have the form:
|
id |
Output only. The ID of the video. |
channel |
Output only. The owner channel id of the video. |
duration |
Output only. The duration of the video in milliseconds. |
title |
Output only. The title of the video. |
WebpageView
A webpage view.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
Output only. The resource name of the webpage view. Webpage view resource names have the form:
|
LeadFormSubmissionData
Data from lead form submissions.
JSON representation |
---|
{ "resourceName": string, "id": string, "asset": string, "campaign": string, "leadFormSubmissionFields": [ { object ( |
Fields | |
---|---|
resource |
Output only. The resource name of the lead form submission data. Lead form submission data resource names have the form:
|
id |
Output only. ID of this lead form submission. |
asset |
Output only. Asset associated with the submitted lead form. |
campaign |
Output only. Campaign associated with the submitted lead form. |
lead |
Output only. Submission data associated with a lead form. |
custom |
Output only. Submission data associated with a custom lead form. |
ad |
Output only. AdGroup associated with the submitted lead form. |
ad |
Output only. AdGroupAd associated with the submitted lead form. |
gclid |
Output only. Google Click Id associated with the submissed lead form. |
submission |
Output only. The date and time at which the lead form was submitted. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00". |
LeadFormSubmissionField
Fields in the submitted lead form.
JSON representation |
---|
{
"fieldType": enum ( |
Fields | |
---|---|
field |
Output only. Field type for lead form fields. |
field |
Output only. Field value for lead form fields. |
CustomLeadFormSubmissionField
Fields in the submitted custom question
JSON representation |
---|
{ "questionText": string, "fieldValue": string } |
Fields | |
---|---|
question |
Output only. Question text for custom question, maximum number of characters is 300. |
field |
Output only. Field value for custom question response, maximum number of characters is 70. |
LocalServicesLead
Data from Local Services Lead. Contains details of Lead which is generated when user calls, messages or books service from advertiser. More info: https://ads.google.com/local-services-ads
JSON representation |
---|
{ "resourceName": string, "id": string, "categoryId": string, "serviceId": string, "contactDetails": { object ( |
Fields | |
---|---|
resource |
Output only. The resource name of the local services lead data. Local Services Lead resource name have the form
|
id |
Output only. ID of this Lead. |
category |
Output only. Service category of the lead. For example: |
service |
Output only. Service for the category. For example: |
contact |
Output only. Lead's contact details. |
lead |
Output only. Type of Local Services lead: phone, message, booking, etc. |
lead |
Output only. Current status of lead. |
creation |
Output only. The date time at which lead was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" |
locale |
Output only. Language used by the Local Services provider linked to lead. See https://developers.google.com/google-ads/api/data/codes-formats#locales |
lead |
Output only. True if the advertiser was charged for the lead. |
note |
Output only. Note added by advertiser for the lead. |
credit |
Output only. Credit details of the lead. |
ContactDetails
Fields containing consumer contact details.
JSON representation |
---|
{ "phoneNumber": string, "email": string, "consumerName": string } |
Fields | |
---|---|
phone |
Output only. Consumer phone number in E164 format. |
email |
Output only. Consumer email address. |
consumer |
Output only. Consumer name if consumer provided name from Message or Booking form on google.com |
LeadType
Possible types of lead.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
MESSAGE |
Message lead. |
PHONE_CALL |
Lead created by phone call. |
BOOKING |
Booking lead. |
LeadStatus
Possible statuses of lead.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
NEW |
New lead which hasn't yet been seen by advertiser. |
ACTIVE |
Lead that thas been interacted by advertiser. |
BOOKED |
Lead has been booked. |
DECLINED |
Lead was declined by advertiser. |
EXPIRED |
Lead has expired due to inactivity. |
DISABLED |
Disabled due to spam or dispute. |
CONSUMER_DECLINED |
Consumer declined the lead. |
WIPED_OUT |
Personally Identifiable Information of the lead is wiped out. |
Note
Represents a note added to a lead by the advertiser. Advertisers can edit notes, which will reset edit time and change description.
JSON representation |
---|
{ "editDateTime": string, "description": string } |
Fields | |
---|---|
edit |
Output only. The date time when lead note was edited. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" |
description |
Output only. Content of lead note. |
CreditDetails
Represents the credit details of a lead.
JSON representation |
---|
{
"creditState": enum ( |
Fields | |
---|---|
credit |
Output only. Credit state of the lead. |
credit |
Output only. The date time when the credit state of the lead was last updated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" |
CreditState
Possible credit states of a lead.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PENDING |
A credit has been filed and is being processed by Ads backend, but has not been applied to the account yet. |
CREDITED |
The credit has been issued to the Ads account. |
LocalServicesLeadConversation
Data from Local Services Lead Conversation. Contains details of Lead Conversation which is generated when user calls, messages or books service from advertiser. These are appended to a Lead. More info: https://ads.google.com/local-services-ads
JSON representation |
---|
{ "resourceName": string, "id": string, "conversationChannel": enum ( |
Fields | |
---|---|
resource |
Output only. The resource name of the local services lead conversation data. Local Services Lead Conversation resource name have the form
|
id |
Output only. ID of this Lead Conversation. |
conversation |
Output only. Type of GLS lead conversation, EMAIL, MESSAGE, PHONE_CALL, SMS, etc. |
participant |
Output only. Type of participant in the lead conversation, ADVERTISER or CONSUMER. |
lead |
Output only. Resource name of Lead associated to the Lead Conversation. |
event |
Output only. The date time at which lead conversation was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" |
phone |
Output only. Details of phone call conversation in case of PHONE_CALL. |
message |
Output only. Details of message conversation in case of EMAIL, MESSAGE or SMS. |
ConversationType
Possible types of lead conversation.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
EMAIL |
Email lead conversation. |
MESSAGE |
Message lead conversation. |
PHONE_CALL |
Phone call lead conversation. |
SMS |
SMS lead conversation. |
BOOKING |
Booking lead conversation. |
ParticipantType
Possible types of lead conversation participant.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ADVERTISER |
Local Services Ads Provider participant. |
CONSUMER |
Local Services Ads Consumer participant. |
PhoneCallDetails
Represents details of a phone call conversation.
JSON representation |
---|
{ "callDurationMillis": string, "callRecordingUrl": string } |
Fields | |
---|---|
call |
Output only. The duration (in milliseconds) of the phone call (end to end). |
call |
Output only. URL to the call recording audio file. |
MessageDetails
Represents details of text message in case of email, message or SMS.
JSON representation |
---|
{ "text": string, "attachmentUrls": [ string ] } |
Fields | |
---|---|
text |
Output only. Textual content of the message. |
attachment |
Output only. URL to the SMS or email attachments. These URLs can be used to download the contents of the attachment by using the developer token. |
AndroidPrivacyInteractionType
Enumerates interaction types
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
CLICK |
The physical click interaction type. |
ENGAGED_VIEW |
The 10 seconds engaged view interaction type. |
VIEW |
The view (ad impression) interaction type. |
AndroidPrivacyNetworkType
Enumerates network types
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
SEARCH |
Search Network. |
DISPLAY |
Display Network. |
YOUTUBE |
YouTube Network. |
Metrics
Metrics data.
JSON representation |
---|
{ "allConversionsValueByConversionDate": number, "allConversionsByConversionDate": number, "conversionsValueByConversionDate": number, "conversionsByConversionDate": number, "historicalCreativeQualityScore": enum ( |
Fields | |
---|---|
all |
The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009. |
all |
The total number of conversions. This includes all conversions regardless of the value of includeInConversionsMetric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009. |
conversions |
The value of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009. |
conversions |
The number of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009. |
historical |
The creative historical quality score. |
historical |
The quality of historical landing page experience. |
historical |
The historical search predicted click through rate (CTR). |
interaction |
The types of payable and free interactions. |
sk |
The number of iOS Store Kit Ad Network conversions. |
sk |
The total number of iOS Store Kit Ad Network conversions. |
publisher |
Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity |
publisher |
Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity |
publisher |
Clicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic" |
absolute |
Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. |
active |
Average cost of viewable impressions ( |
active |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network. |
active |
A measurement of how often your ad has become viewable on a Display Network site. |
active |
The ratio of impressions that could be measured by Active View over the number of served impressions. |
active |
The cost of the impressions you received that were measurable by Active View. |
active |
The number of times your ads are appearing on placements in positions where they can be seen. |
active |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions). |
all |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. |
all |
The value of all conversions. |
all |
All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in "allConversionsValue". See https://support.google.com/google-ads/answer/12080169 for more details. |
all |
The total number of conversions. This includes all conversions regardless of the value of includeInConversionsMetric. |
all |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). |
all |
The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only. |
all |
The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only. |
all |
The value of all conversions from interactions divided by the total number of interactions. |
all |
The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only. |
all |
The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only. |
all |
The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only. |
all |
Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only. |
all |
The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only. |
auction |
This metric is part of the Auction Insights report, and tells how often the ads of another participant showed in the most prominent position on the search results page. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available. |
auction |
This metric is part of the Auction Insights report, and tells the percentage of impressions that another participant obtained, over the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available. |
auction |
This metric is part of the Auction Insights report, and tells the percentage of impressions that your ads outranked (showed above) another participant in the auction, compared to the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available. |
auction |
This metric is part of the Auction Insights report, and tells how often another participant's ad received an impression when your ad also received an impression. This metric is not publicly available. |
auction |
This metric is part of the Auction Insights report, and tells how often another participant's ad was shown in a higher position than yours, when both of your ads were shown at the same page. This metric is not publicly available. |
auction |
This metric is part of the Auction Insights report, and tells how often the ads of another participant showed adjacent to the top organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available. |
average |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. |
average |
The total cost of all clicks divided by the total number of clicks received. |
average |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements. |
average |
Average cost-per-thousand impressions (CPM). |
average |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views. |
average |
Average number of pages viewed per session. |
average |
Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics. |
benchmark |
An indication of how other advertisers are bidding on similar products. |
biddable |
Number of app installs. |
biddable |
Number of in-app actions. |
benchmark |
An indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it. |
bounce |
Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics. |
clicks |
The number of clicks. |
combined |
The number of times your ad or your site's listing in the unpaid results was clicked. See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
combined |
The number of times your ad or your site's listing in the unpaid results was clicked (combinedClicks) divided by combinedQueries. See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
combined |
The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
content |
The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
content |
The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
conversion |
The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (for example, because the tag was fired from a browser that did not previously click an ad from an appropriate advertiser). The date/time is in the customer's time zone. |
conversion |
The date of the most recent conversion for this conversion action. The date is in the customer's time zone. |
content |
The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
conversions |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
conversions |
The value of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
new |
New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in "conversionsValue" for optimization. See https://support.google.com/google-ads/answer/12080169 for more details. |
conversions |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
conversions |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
conversions |
The number of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
cost |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. |
cost |
The cost of ad interactions divided by all conversions. |
cost |
The cost of ad interactions divided by conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
cost |
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
cross |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in allConversions. |
cross |
The sum of the value of cross-device conversions, in micros. |
ctr |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). |
current |
Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
current |
Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
current |
The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
current |
The value of current model attributed conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
current |
The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
engagement |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown. |
engagements |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics. |
hotel |
Average lead value based on clicks. |
hotel |
Commission bid rate in micros. A 20% commission is represented as 200,000. |
hotel |
Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency. |
hotel |
The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser. |
hotel |
The number of impressions that hotel partners could have had given their feed performance. |
historical |
The historical quality score. |
gmail |
The number of times the ad was forwarded to someone else as a message. |
gmail |
The number of times someone has saved your Gmail ad to their inbox as a message. |
gmail |
The number of clicks to the landing page on the expanded state of Gmail ads. |
impressions |
The number of times a store's location-based ad was shown. This metric applies to feed items only. |
impressions |
Count of how often your ad has appeared on a search results page or website on the Google Network. |
interaction |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown. |
interactions |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on. |
invalid |
The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period. |
invalid |
Number of clicks Google considers illegitimate and doesn't charge you for. |
message |
Number of message chats initiated for Click To Message impressions that were message tracking eligible. |
message |
Number of Click To Message impressions that were message tracking eligible. |
message |
Number of message chats initiated (messageChats) divided by the number of message impressions (messageImpressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate can be more than 1.0 for a given message impression. |
mobile |
The percentage of mobile clicks that go to a mobile-friendly page. |
optimization |
Total optimization score uplift of all recommendations. |
optimization |
URL for the optimization score page in the Google Ads web interface. This metric can be selected from |
organic |
The number of times someone clicked your site's listing in the unpaid results for a particular query. See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
organic |
The number of times someone clicked your site's listing in the unpaid results (organicClicks) divided by the total number of searches that returned pages from your site (organicQueries). See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
organic |
The number of listings for your site in the unpaid search results. See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
organic |
The number of times a page from your site was listed in the unpaid search results (organicImpressions) divided by the number of searches returning your site's listing in the unpaid results (organicQueries). See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
organic |
The total number of searches that returned your site's listing in the unpaid results. See the help page at https://support.google.com/google-ads/answer/3097241 for details. |
percent |
Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics. |
phone |
Number of offline phone calls. |
phone |
Number of offline phone impressions. |
phone |
Number of phone calls received (phoneCalls) divided by the number of times your phone number is shown (phoneImpressions). |
relative |
Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites. |
search |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826 for details. Any value below 0.1 is reported as 0.0999. |
search |
The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
search |
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
search |
The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
search |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
search |
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
search |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. |
search |
The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
search |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
search |
The number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. |
search |
The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. Top ads are generally above the top organic results, although they may show below the top organic results on certain queries. |
search |
Search volume range for a search term insight category. |
speed |
A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest. |
average |
The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA). |
average |
The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS). |
top |
The percent of your ad impressions that are shown adjacent to the top organic search results. |
valid |
The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page. |
value |
The value of all conversions divided by the number of all conversions. |
value |
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009. |
value |
The value of conversions divided by the number of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
value |
The value of conversions divided by the number of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009. |
value |
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
video |
Percentage of impressions where the viewer watched all of your video. |
video |
Percentage of impressions where the viewer watched 25% of your video. |
video |
Percentage of impressions where the viewer watched 50% of your video. |
video |
Percentage of impressions where the viewer watched 75% of your video. |
video |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads. |
video |
The number of times your video ads were viewed. |
view |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad. |
all |
Number of call button clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. |
all |
Number of driving directions clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. |
all |
Number of menu link clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. |
all |
Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. |
all |
Number of other types of local action clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. |
all |
Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location. |
all |
Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. |
eligible |
Number of impressions in which the store location was shown or the location was used for targeting. This measure is coming from Asset based location. |
view |
Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location. |
view |
Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location. |
view |
Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location. |
view |
Number of order clicks on any location surface after an impression. This measure is coming from Asset based location. |
view |
Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location. |
view |
Estimated number of visits to the store after an impression. This measure is coming from Asset based location. |
view |
Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location. |
orders |
Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data. |
average |
Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data. |
average |
Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data. |
cost |
Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data. |
gross |
Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data. |
gross |
Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data. |
revenue |
Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data. |
units |
Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data. |
cross |
Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. |
cross |
Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. |
cross |
Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. |
cross |
Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data. |
lead |
Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. |
lead |
Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. |
lead |
Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. |
lead |
Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data. |
unique |
The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. |
average |
The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App. |
InteractionEventType
Enum describing possible types of payable and free interactions.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
CLICK |
Click to site. In most cases, this interaction navigates to an external location, usually the advertiser's landing page. This is also the default InteractionEventType for click events. |
ENGAGEMENT |
The user's expressed intent to engage with the ad in-place. |
VIDEO_VIEW |
User viewed a video ad. |
NONE |
The default InteractionEventType for ad conversion events. This is used when an ad conversion row does NOT indicate that the free interactions (for example, the ad conversions) should be 'promoted' and reported as part of the core metrics. These are simply other (ad) conversions. |
SearchVolumeRange
Search volume range. Actual search volume falls within this range.
JSON representation |
---|
{ "min": string, "max": string } |
Fields | |
---|---|
min |
Lower bound of search volume. |
max |
Upper bound of search volume. |
Segments
Segment only fields.
JSON representation |
---|
{ "adDestinationType": enum ( |
Fields | |
---|---|
ad |
Ad Destination type. |
ad |
Ad network type. |
budget |
Budget campaign association status. |
click |
Click type. |
conversion |
Conversion action category. |
conversion |
Conversion attribution event type. |
conversion |
An enum value representing the number of days between the impression and the conversion. |
conversion |
An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion. |
day |
Day of the week, for example, MONDAY. |
device |
Device to which metrics apply. |
external |
External conversion source. |
hotel |
Hotel check-in day of week. |
hotel |
Hotel date selection type. |
hotel |
Hotel rate type. |
hotel |
Hotel price bucket. |
keyword |
Keyword criterion. |
month |
Month of the year, for example, January. |
placeholder |
Placeholder type. This is only used with feed item metrics. |
product |
Channel of the product. |
product |
Channel exclusivity of the product. |
product |
Condition of the product. |
recommendation |
Recommendation type. |
search |
Type of the search engine results page. |
search |
Match type of the keyword that triggered the ad, including variants. |
slot |
Position of the ad. |
conversion |
Primary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value rules were applied. |
sk |
iOS Store Kit Ad Network user type. |
sk |
iOS Store Kit Ad Network ad event type. |
sk |
iOS Store Kit Ad Network attribution credit |
sk |
iOS Store Kit Ad Network coarse conversion value. |
sk |
The source type where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or neither source domain nor source app were present in any postbacks sent by Apple. |
new |
This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal. |
activity |
Activity account ID. |
activity |
The city where the travel activity is available. |
activity |
The country where the travel activity is available. |
activity |
Activity rating. |
activity |
The state where the travel activity is available. |
external |
Advertiser supplied activity ID. |
ad |
Resource name of the ad group. |
asset |
Resource name of the asset group. |
auction |
Domain (visible URL) of a participant in the Auction Insights report. |
campaign |
Resource name of the campaign. |
conversion |
Resource name of the conversion action. |
conversion |
Conversion action name. |
conversion |
This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data. |
date |
Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17. |
geo |
Resource name of the geo target constant that represents an airport. |
geo |
Resource name of the geo target constant that represents a canton. |
geo |
Resource name of the geo target constant that represents a city. |
geo |
Resource name of the geo target constant that represents a country. |
geo |
Resource name of the geo target constant that represents a county. |
geo |
Resource name of the geo target constant that represents a district. |
geo |
Resource name of the geo target constant that represents a metro. |
geo |
Resource name of the geo target constant that represents the most specific location. |
geo |
Resource name of the geo target constant that represents a postal code. |
geo |
Resource name of the geo target constant that represents a province. |
geo |
Resource name of the geo target constant that represents a region. |
geo |
Resource name of the geo target constant that represents a state. |
hotel |
Hotel booking window in days. |
hotel |
Hotel center ID. |
hotel |
Hotel check-in date. Formatted as yyyy-MM-dd. |
hotel |
Hotel city. |
hotel |
Hotel class. |
hotel |
Hotel country. |
hotel |
Hotel length of stay. |
hotel |
Hotel rate rule ID. |
hotel |
Hotel state. |
hour |
Hour of day as a number between 0 and 23, inclusive. |
interaction |
Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit. |
month |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd. |
partner |
Partner hotel ID. |
product |
Aggregator ID of the product. |
product |
Category (level 1) of the product. |
product |
Category (level 2) of the product. |
product |
Category (level 3) of the product. |
product |
Category (level 4) of the product. |
product |
Category (level 5) of the product. |
product |
Brand of the product. |
product |
Resource name of the geo target constant for the country of sale of the product. |
product |
Custom attribute 0 of the product. |
product |
Custom attribute 1 of the product. |
product |
Custom attribute 2 of the product. |
product |
Custom attribute 3 of the product. |
product |
Custom attribute 4 of the product. |
product |
Feed label of the product. |
product |
Item ID of the product. |
product |
Resource name of the language constant for the language of the product. |
product |
Merchant ID of the product. |
product |
Store ID of the product. |
product |
Title of the product. |
product |
Type (level 1) of the product. |
product |
Type (level 2) of the product. |
product |
Type (level 3) of the product. |
product |
Type (level 4) of the product. |
product |
Type (level 5) of the product. |
quarter |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd. |
search |
A search term subcategory. An empty string denotes the catch-all subcategory for search terms that didn't fit into another subcategory. |
search |
A search term. |
webpage |
Resource name of the ad group criterion that represents webpage criterion. |
week |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd. |
year |
Year, formatted as yyyy. |
sk |
iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign. |
sk |
App where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple. |
sk |
Website where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple. |
sk |
iOS Store Kit Ad Network postback sequence index. |
asset |
Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interactionOnThisAsset is true, it means the interactions are on this specific asset and when interactionOnThisAsset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with. |
AdDestinationType
Enumerates Google Ads destination types
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
NOT_APPLICABLE |
Ads that don't intend to drive users off from ads to other destinations |
WEBSITE |
Website |
APP_DEEP_LINK |
App Deep Link |
APP_STORE |
iOS App Store or Play Store |
PHONE_CALL |
Call Dialer |
MAP_DIRECTIONS |
Map App |
LOCATION_LISTING |
Location Dedicated Page |
MESSAGE |
Text Message |
LEAD_FORM |
Lead Generation Form |
YOUTUBE |
YouTube |
UNMODELED_FOR_CONVERSIONS |
Ad Destination for Conversions with keys unknown |
AdNetworkType
Enumerates Google Ads network types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
SEARCH |
Google search. |
SEARCH_PARTNERS |
Search partners. |
CONTENT |
Display Network. |
MIXED |
Cross-network. |
YOUTUBE |
YouTube |
GOOGLE_TV |
Google TV |
BudgetCampaignAssociationStatus
A BudgetCampaignAssociationStatus segment.
JSON representation |
---|
{
"status": enum ( |
Fields | |
---|---|
status |
Budget campaign association status. |
campaign |
The campaign resource name. |
BudgetCampaignAssociationStatus
Possible statuses of the association between the Budget and the Campaign.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
The campaign is currently using the budget. |
REMOVED |
The campaign is no longer using the budget. |
ClickType
Enumerates Google Ads click types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
APP_DEEPLINK |
App engagement ad deep link. |
BREADCRUMBS |
Breadcrumbs. |
BROADBAND_PLAN |
Broadband Plan. |
CALL_TRACKING |
Manually dialed phone calls. |
CALLS |
Phone calls. |
CLICK_ON_ENGAGEMENT_AD |
Click on engagement ad. |
GET_DIRECTIONS |
Driving direction. |
LOCATION_EXPANSION |
Get location details. |
LOCATION_FORMAT_CALL |
Call. |
LOCATION_FORMAT_DIRECTIONS |
Directions. |
LOCATION_FORMAT_IMAGE |
Image(s). |
LOCATION_FORMAT_LANDING_PAGE |
Go to landing page. |
LOCATION_FORMAT_MAP |
Map. |
LOCATION_FORMAT_STORE_INFO |
Go to store info. |
LOCATION_FORMAT_TEXT |
Text. |
MOBILE_CALL_TRACKING |
Mobile phone calls. |
OFFER_PRINTS |
Print offer. |
OTHER |
Other. |
PRODUCT_EXTENSION_CLICKS |
Product plusbox offer. |
PRODUCT_LISTING_AD_CLICKS |
Shopping - Product - Online. |
SITELINKS |
Sitelink. |
STORE_LOCATOR |
Show nearby locations. |
URL_CLICKS |
Headline. |
VIDEO_APP_STORE_CLICKS |
App store. |
VIDEO_CALL_TO_ACTION_CLICKS |
Call-to-Action overlay. |
VIDEO_CARD_ACTION_HEADLINE_CLICKS |
Cards. |
VIDEO_END_CAP_CLICKS |
End cap. |
VIDEO_WEBSITE_CLICKS |
Website. |
VISUAL_SITELINKS |
Visual Sitelinks. |
WIRELESS_PLAN |
Wireless Plan. |
PRODUCT_LISTING_AD_LOCAL |
Shopping - Product - Local. |
PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL |
Shopping - Product - MultiChannel Local. |
PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE |
Shopping - Product - MultiChannel Online. |
PRODUCT_LISTING_ADS_COUPON |
Shopping - Product - Coupon. |
PRODUCT_LISTING_AD_TRANSACTABLE |
Shopping - Product - Sell on Google. |
PRODUCT_AD_APP_DEEPLINK |
Shopping - Product - App engagement ad deep link. |
SHOWCASE_AD_CATEGORY_LINK |
Shopping - Showcase - Category. |
SHOWCASE_AD_LOCAL_STOREFRONT_LINK |
Shopping - Showcase - Local storefront. |
SHOWCASE_AD_ONLINE_PRODUCT_LINK |
Shopping - Showcase - Online product. |
SHOWCASE_AD_LOCAL_PRODUCT_LINK |
Shopping - Showcase - Local product. |
PROMOTION_EXTENSION |
Promotion Extension. |
SWIPEABLE_GALLERY_AD_HEADLINE |
Ad Headline. |
SWIPEABLE_GALLERY_AD_SWIPES |
Swipes. |
SWIPEABLE_GALLERY_AD_SEE_MORE |
See More. |
SWIPEABLE_GALLERY_AD_SITELINK_ONE |
Sitelink 1. |
SWIPEABLE_GALLERY_AD_SITELINK_TWO |
Sitelink 2. |
SWIPEABLE_GALLERY_AD_SITELINK_THREE |
Sitelink 3. |
SWIPEABLE_GALLERY_AD_SITELINK_FOUR |
Sitelink 4. |
SWIPEABLE_GALLERY_AD_SITELINK_FIVE |
Sitelink 5. |
HOTEL_PRICE |
Hotel price. |
PRICE_EXTENSION |
Price Extension. |
HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION |
Book on Google hotel room selection. |
SHOPPING_COMPARISON_LISTING |
Shopping - Comparison Listing. |
CROSS_NETWORK |
Cross-network. From Performance Max and Discovery Campaigns. |
ConversionAttributionEventType
The event type of conversions that are attributed to.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Represents value unknown in this version. |
IMPRESSION |
The conversion is attributed to an impression. |
INTERACTION |
The conversion is attributed to an interaction. |
ConversionLagBucket
Enum representing the number of days between impression and conversion.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
LESS_THAN_ONE_DAY |
Conversion lag bucket from 0 to 1 day. 0 day is included, 1 day is not. |
ONE_TO_TWO_DAYS |
Conversion lag bucket from 1 to 2 days. 1 day is included, 2 days is not. |
TWO_TO_THREE_DAYS |
Conversion lag bucket from 2 to 3 days. 2 days is included, 3 days is not. |
THREE_TO_FOUR_DAYS |
Conversion lag bucket from 3 to 4 days. 3 days is included, 4 days is not. |
FOUR_TO_FIVE_DAYS |
Conversion lag bucket from 4 to 5 days. 4 days is included, 5 days is not. |
FIVE_TO_SIX_DAYS |
Conversion lag bucket from 5 to 6 days. 5 days is included, 6 days is not. |
SIX_TO_SEVEN_DAYS |
Conversion lag bucket from 6 to 7 days. 6 days is included, 7 days is not. |
SEVEN_TO_EIGHT_DAYS |
Conversion lag bucket from 7 to 8 days. 7 days is included, 8 days is not. |
EIGHT_TO_NINE_DAYS |
Conversion lag bucket from 8 to 9 days. 8 days is included, 9 days is not. |
NINE_TO_TEN_DAYS |
Conversion lag bucket from 9 to 10 days. 9 days is included, 10 days is not. |
TEN_TO_ELEVEN_DAYS |
Conversion lag bucket from 10 to 11 days. 10 days is included, 11 days is not. |
ELEVEN_TO_TWELVE_DAYS |
Conversion lag bucket from 11 to 12 days. 11 days is included, 12 days is not. |
TWELVE_TO_THIRTEEN_DAYS |
Conversion lag bucket from 12 to 13 days. 12 days is included, 13 days is not. |
THIRTEEN_TO_FOURTEEN_DAYS |
Conversion lag bucket from 13 to 14 days. 13 days is included, 14 days is not. |
FOURTEEN_TO_TWENTY_ONE_DAYS |
Conversion lag bucket from 14 to 21 days. 14 days is included, 21 days is not. |
TWENTY_ONE_TO_THIRTY_DAYS |
Conversion lag bucket from 21 to 30 days. 21 days is included, 30 days is not. |
THIRTY_TO_FORTY_FIVE_DAYS |
Conversion lag bucket from 30 to 45 days. 30 days is included, 45 days is not. |
FORTY_FIVE_TO_SIXTY_DAYS |
Conversion lag bucket from 45 to 60 days. 45 days is included, 60 days is not. |
SIXTY_TO_NINETY_DAYS |
Conversion lag bucket from 60 to 90 days. 60 days is included, 90 days is not. |
ConversionOrAdjustmentLagBucket
Enum representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
CONVERSION_LESS_THAN_ONE_DAY |
Conversion lag bucket from 0 to 1 day. 0 day is included, 1 day is not. |
CONVERSION_ONE_TO_TWO_DAYS |
Conversion lag bucket from 1 to 2 days. 1 day is included, 2 days is not. |
CONVERSION_TWO_TO_THREE_DAYS |
Conversion lag bucket from 2 to 3 days. 2 days is included, 3 days is not. |
CONVERSION_THREE_TO_FOUR_DAYS |
Conversion lag bucket from 3 to 4 days. 3 days is included, 4 days is not. |
CONVERSION_FOUR_TO_FIVE_DAYS |
Conversion lag bucket from 4 to 5 days. 4 days is included, 5 days is not. |
CONVERSION_FIVE_TO_SIX_DAYS |
Conversion lag bucket from 5 to 6 days. 5 days is included, 6 days is not. |
CONVERSION_SIX_TO_SEVEN_DAYS |
Conversion lag bucket from 6 to 7 days. 6 days is included, 7 days is not. |
CONVERSION_SEVEN_TO_EIGHT_DAYS |
Conversion lag bucket from 7 to 8 days. 7 days is included, 8 days is not. |
CONVERSION_EIGHT_TO_NINE_DAYS |
Conversion lag bucket from 8 to 9 days. 8 days is included, 9 days is not. |
CONVERSION_NINE_TO_TEN_DAYS |
Conversion lag bucket from 9 to 10 days. 9 days is included, 10 days is not. |
CONVERSION_TEN_TO_ELEVEN_DAYS |
Conversion lag bucket from 10 to 11 days. 10 days is included, 11 days is not. |
CONVERSION_ELEVEN_TO_TWELVE_DAYS |
Conversion lag bucket from 11 to 12 days. 11 days is included, 12 days is not. |
CONVERSION_TWELVE_TO_THIRTEEN_DAYS |
Conversion lag bucket from 12 to 13 days. 12 days is included, 13 days is not. |
CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS |
Conversion lag bucket from 13 to 14 days. 13 days is included, 14 days is not. |
CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS |
Conversion lag bucket from 14 to 21 days. 14 days is included, 21 days is not. |
CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS |
Conversion lag bucket from 21 to 30 days. 21 days is included, 30 days is not. |
CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS |
Conversion lag bucket from 30 to 45 days. 30 days is included, 45 days is not. |
CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS |
Conversion lag bucket from 45 to 60 days. 45 days is included, 60 days is not. |
CONVERSION_SIXTY_TO_NINETY_DAYS |
Conversion lag bucket from 60 to 90 days. 60 days is included, 90 days is not. |
ADJUSTMENT_LESS_THAN_ONE_DAY |
Conversion adjustment lag bucket from 0 to 1 day. 0 day is included, 1 day is not. |
ADJUSTMENT_ONE_TO_TWO_DAYS |
Conversion adjustment lag bucket from 1 to 2 days. 1 day is included, 2 days is not. |
ADJUSTMENT_TWO_TO_THREE_DAYS |
Conversion adjustment lag bucket from 2 to 3 days. 2 days is included, 3 days is not. |
ADJUSTMENT_THREE_TO_FOUR_DAYS |
Conversion adjustment lag bucket from 3 to 4 days. 3 days is included, 4 days is not. |
ADJUSTMENT_FOUR_TO_FIVE_DAYS |
Conversion adjustment lag bucket from 4 to 5 days. 4 days is included, 5 days is not. |
ADJUSTMENT_FIVE_TO_SIX_DAYS |
Conversion adjustment lag bucket from 5 to 6 days. 5 days is included, 6 days is not. |
ADJUSTMENT_SIX_TO_SEVEN_DAYS |
Conversion adjustment lag bucket from 6 to 7 days. 6 days is included, 7 days is not. |
ADJUSTMENT_SEVEN_TO_EIGHT_DAYS |
Conversion adjustment lag bucket from 7 to 8 days. 7 days is included, 8 days is not. |
ADJUSTMENT_EIGHT_TO_NINE_DAYS |
Conversion adjustment lag bucket from 8 to 9 days. 8 days is included, 9 days is not. |
ADJUSTMENT_NINE_TO_TEN_DAYS |
Conversion adjustment lag bucket from 9 to 10 days. 9 days is included, 10 days is not. |
ADJUSTMENT_TEN_TO_ELEVEN_DAYS |
Conversion adjustment lag bucket from 10 to 11 days. 10 days is included, 11 days is not. |
ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS |
Conversion adjustment lag bucket from 11 to 12 days. 11 days is included, 12 days is not. |
ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS |
Conversion adjustment lag bucket from 12 to 13 days. 12 days is included, 13 days is not. |
ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS |
Conversion adjustment lag bucket from 13 to 14 days. 13 days is included, 14 days is not. |
ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS |
Conversion adjustment lag bucket from 14 to 21 days. 14 days is included, 21 days is not. |
ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS |
Conversion adjustment lag bucket from 21 to 30 days. 21 days is included, 30 days is not. |
ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS |
Conversion adjustment lag bucket from 30 to 45 days. 30 days is included, 45 days is not. |
ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS |
Conversion adjustment lag bucket from 45 to 60 days. 45 days is included, 60 days is not. |
ADJUSTMENT_SIXTY_TO_NINETY_DAYS |
Conversion adjustment lag bucket from 60 to 90 days. 60 days is included, 90 days is not. |
ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS |
Conversion adjustment lag bucket from 90 to 145 days. 90 days is included, 145 days is not. |
CONVERSION_UNKNOWN |
Conversion lag bucket UNKNOWN. This is for dates before conversion lag bucket was available in Google Ads. |
ADJUSTMENT_UNKNOWN |
Conversion adjustment lag bucket UNKNOWN. This is for dates before conversion adjustment lag bucket was available in Google Ads. |
ExternalConversionSource
The external conversion source that is associated with a ConversionAction.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Represents value unknown in this version. |
WEBPAGE |
Conversion that occurs when a user navigates to a particular webpage after viewing an ad; Displayed in Google Ads UI as 'Website'. |
ANALYTICS |
Conversion that comes from linked Google Analytics goal or transaction; Displayed in Google Ads UI as 'Analytics'. |
UPLOAD |
Website conversion that is uploaded through ConversionUploadService; Displayed in Google Ads UI as 'Import from clicks'. |
AD_CALL_METRICS |
Conversion that occurs when a user clicks on a call extension directly on an ad; Displayed in Google Ads UI as 'Calls from ads'. |
WEBSITE_CALL_METRICS |
Conversion that occurs when a user calls a dynamically-generated phone number (by installed javascript) from an advertiser's website after clicking on an ad; Displayed in Google Ads UI as 'Calls from website'. |
STORE_VISITS |
Conversion that occurs when a user visits an advertiser's retail store after clicking on a Google ad; Displayed in Google Ads UI as 'Store visits'. |
ANDROID_IN_APP |
Conversion that occurs when a user takes an in-app action such as a purchase in an Android app; Displayed in Google Ads UI as 'Android in-app action'. |
IOS_IN_APP |
Conversion that occurs when a user takes an in-app action such as a purchase in an iOS app; Displayed in Google Ads UI as 'iOS in-app action'. |
IOS_FIRST_OPEN |
Conversion that occurs when a user opens an iOS app for the first time; Displayed in Google Ads UI as 'iOS app install (first open)'. |
APP_UNSPECIFIED |
Legacy app conversions that do not have an AppPlatform provided; Displayed in Google Ads UI as 'Mobile app'. |
ANDROID_FIRST_OPEN |
Conversion that occurs when a user opens an Android app for the first time; Displayed in Google Ads UI as 'Android app install (first open)'. |
UPLOAD_CALLS |
Call conversion that is uploaded through ConversionUploadService; Displayed in Google Ads UI as 'Import from calls'. |
FIREBASE |
Conversion that comes from a linked Firebase event; Displayed in Google Ads UI as 'Firebase'. |
CLICK_TO_CALL |
Conversion that occurs when a user clicks on a mobile phone number; Displayed in Google Ads UI as 'Phone number clicks'. |
SALESFORCE |
Conversion that comes from Salesforce; Displayed in Google Ads UI as 'Salesforce.com'. |
STORE_SALES_CRM |
Conversion that comes from in-store purchases recorded by CRM; Displayed in Google Ads UI as 'Store sales (data partner)'. |
STORE_SALES_PAYMENT_NETWORK |
Conversion that comes from in-store purchases from payment network; Displayed in Google Ads UI as 'Store sales (payment network)'. |
GOOGLE_PLAY |
Codeless Google Play conversion; Displayed in Google Ads UI as 'Google Play'. |
THIRD_PARTY_APP_ANALYTICS |
Conversion that comes from a linked third-party app analytics event; Displayed in Google Ads UI as 'Third-party app analytics'. |
GOOGLE_ATTRIBUTION |
Conversion that is controlled by Google Attribution. |
STORE_SALES_DIRECT_UPLOAD |
Store Sales conversion based on first-party or third-party merchant data uploads. Displayed in Google Ads UI as 'Store sales (direct upload)'. |
STORE_SALES |
Store Sales conversion based on first-party or third-party merchant data uploads and/or from in-store purchases using cards from payment networks. Displayed in Google Ads UI as 'Store sales'. |
SEARCH_ADS_360 |
Conversions imported from Search Ads 360 Floodlight data. |
GOOGLE_HOSTED |
Conversions that track local actions from Google's products and services after interacting with an ad. |
FLOODLIGHT |
Conversions reported by Floodlight tags. |
ANALYTICS_SEARCH_ADS_360 |
Conversions that come from Google Analytics specifically for Search Ads 360. Displayed in Google Ads UI as Analytics (SA360). |
FIREBASE_SEARCH_ADS_360 |
Conversion that comes from a linked Firebase event for Search Ads 360. |
DISPLAY_AND_VIDEO_360_FLOODLIGHT |
Conversion that is reported by Floodlight for DV360. |
HotelRateType
Enum describing possible hotel rate types.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
UNAVAILABLE |
Rate type information is unavailable. |
PUBLIC_RATE |
Rates available to everyone. |
QUALIFIED_RATE |
A membership program rate is available and satisfies basic requirements like having a public rate available. UI treatment will strikethrough the public rate and indicate that a discount is available to the user. For more on Qualified Rates, visit https://developers.google.com/hotels/hotel-ads/dev-guide/qualified-rates |
PRIVATE_RATE |
Rates available to users that satisfy some eligibility criteria, for example, all signed-in users, 20% of mobile users, all mobile users in Canada, etc. |
HotelPriceBucket
Enum describing possible hotel price buckets.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
LOWEST_UNIQUE |
Uniquely lowest price. Partner has the lowest price, and no other partners are within a small variance of that price. |
LOWEST_TIED |
Tied for lowest price. Partner is within a small variance of the lowest price. |
NOT_LOWEST |
Not lowest price. Partner is not within a small variance of the lowest price. |
ONLY_PARTNER_SHOWN |
Partner was the only one shown. |
Keyword
A Keyword criterion segment.
JSON representation |
---|
{
"info": {
object ( |
Fields | |
---|---|
info |
Keyword info. |
ad |
The AdGroupCriterion resource name. |
SearchEngineResultsPageType
The type of the search engine results page.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ADS_ONLY |
Only ads were contained in the search engine results page. |
ORGANIC_ONLY |
Only organic results were contained in the search engine results page. |
ADS_AND_ORGANIC |
Both ads and organic results were contained in the search engine results page. |
SearchTermMatchType
Possible match types for a keyword triggering an ad, including variants.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BROAD |
Broad match. |
EXACT |
Exact match. |
PHRASE |
Phrase match. |
NEAR_EXACT |
Exact match (close variant). |
NEAR_PHRASE |
Phrase match (close variant). |
Slot
Enumerates possible positions of the Ad.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
SEARCH_SIDE |
Google search: Side. |
SEARCH_TOP |
Google search: Top. |
SEARCH_OTHER |
Google search: Other. |
CONTENT |
Google Display Network. |
SEARCH_PARTNER_TOP |
Search partners: Top. |
SEARCH_PARTNER_OTHER |
Search partners: Other. |
MIXED |
Cross-network. |
ConversionValueRulePrimaryDimension
Identifies the primary dimension for conversion value rule stats.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
NO_RULE_APPLIED |
For no-value-rule-applied conversions after value rule is enabled. |
ORIGINAL |
Below are for value-rule-applied conversions: The original stats. |
NEW_VS_RETURNING_USER |
When a new or returning customer condition is satisfied. |
GEO_LOCATION |
When a query-time Geo location condition is satisfied. |
DEVICE |
When a query-time browsing device condition is satisfied. |
AUDIENCE |
When a query-time audience condition is satisfied. |
MULTIPLE |
When multiple rules are applied. |
SkAdNetworkUserType
Enumerates SkAdNetwork user types
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
UNAVAILABLE |
The value was not present in the postback or we do not have this data for other reasons. |
NEW_INSTALLER |
The user installed the app for the first time. |
REINSTALLER |
The user has previously installed the app. |
SkAdNetworkAdEventType
Enumerates SkAdNetwork ad event types
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
UNAVAILABLE |
The value was not present in the postback or we do not have this data for other reasons. |
INTERACTION |
The user interacted with the ad. |
VIEW |
The user viewed the ad. |
SkAdNetworkSourceApp
A SkAdNetworkSourceApp segment.
JSON representation |
---|
{ "skAdNetworkSourceAppId": string } |
Fields | |
---|---|
sk |
App id where the ad that drove the iOS Store Kit Ad Network install was shown. |
SkAdNetworkAttributionCredit
Enumerates SkAdNetwork attribution credits.
Enums | |
---|---|
UNSPECIFIED |
Default value. This value is equivalent to null. |
UNKNOWN |
The value is unknown in this API version. The true enum value cannot be returned in this API version or is not supported yet. |
UNAVAILABLE |
The value was not present in the postback or we do not have this data for other reasons. |
WON |
Google was the ad network that won ad attribution. |
CONTRIBUTED |
Google qualified for attribution, but didn't win. |
SkAdNetworkSourceType
Enumerates SkAdNetwork source types
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
UNAVAILABLE |
The source app ID or source domain was not present in the postback or we do not have this data for other reasons. |
WEBSITE |
The ad was shown on a webpage. |
MOBILE_APPLICATION |
The ad was shown on an app. |
AssetInteractionTarget
An AssetInteractionTarget segment.
JSON representation |
---|
{ "asset": string, "interactionOnThisAsset": boolean } |
Fields | |
---|---|
asset |
The asset resource name. |
interaction |
Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. |
ConvertingUserPriorEngagementTypeAndLtvBucket
Enumerates converting user prior engagement types and lifetime-value bucket
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
The value is unknown in this version. |
NEW |
Converting user is new to the advertiser. |
RETURNING |
Converting user is returning to the advertiser. Definition of returning differs among conversion types, such as a second store visit versus a second online purchase. |
NEW_AND_HIGH_LTV |
Converting user is new to the advertiser and has high lifetime value. |