Write lifecycle
type: Class
comment: Provider operations that accept a property; absence means not classified.

write lifecycle
type: Property
domain: PropertyShape
range: Write lifecycle

Writable
type: Write lifecycle
comment: Accepted during create and update operations.

Create only
type: Write lifecycle
comment: Accepted during create and rejected during update.

Read only
type: Write lifecycle
comment: Returned by the provider and rejected during create and update.

shapes
type: ShapeGeneration
shape reference chain limit: 5
omitted shape reference count: 28
omitted shape reference:
  reference from: AppAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: AppEngagementAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: AppPreRegistrationAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: AssetShape
  reference to: AssetFieldTypePolicySummaryShape
  omitted because: over-long
omitted shape reference:
  reference from: ChangeEventChangedResourceShape
  reference to: AdGroupAdShape
  omitted because: over-long
omitted shape reference:
  reference from: ChangeEventChangedResourceShape
  reference to: AssetShape
  omitted because: over-long
omitted shape reference:
  reference from: ChangeEventShape
  reference to: ChangeEventChangedResourceShape
  omitted because: over-long
omitted shape reference:
  reference from: DemandGenCarouselAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: DemandGenMultiAssetAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: DemandGenProductAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: DemandGenVideoResponsiveAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: GoogleAdsRowShape
  reference to: AdGroupAdAssetViewShape
  omitted because: over-long
omitted shape reference:
  reference from: GoogleAdsRowShape
  reference to: AdGroupAdShape
  omitted because: over-long
omitted shape reference:
  reference from: GoogleAdsRowShape
  reference to: AssetGroupAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: GoogleAdsRowShape
  reference to: AssetShape
  omitted because: over-long
omitted shape reference:
  reference from: GoogleAdsRowShape
  reference to: RecommendationShape
  omitted because: over-long
omitted shape reference:
  reference from: LocalAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: RecommendationCalloutAssetRecommendationShape
  reference to: AssetShape
  omitted because: over-long
omitted shape reference:
  reference from: RecommendationShape
  reference to: RecommendationResponsiveSearchAdAssetRecommendationShape
  omitted because: over-long
omitted shape reference:
  reference from: RecommendationShape
  reference to: RecommendationResponsiveSearchAdImproveAdStrengthRecommendationShape
  omitted because: over-long
omitted shape reference:
  reference from: RecommendationShape
  reference to: RecommendationResponsiveSearchAdRecommendationShape
  omitted because: over-long
omitted shape reference:
  reference from: RecommendationShape
  reference to: RecommendationTextAdRecommendationShape
  omitted because: over-long
omitted shape reference:
  reference from: RecommendationSitelinkAssetRecommendationShape
  reference to: AssetShape
  omitted because: over-long
omitted shape reference:
  reference from: ResponsiveDisplayAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: ResponsiveSearchAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: RuleBasedUserListInfoShape
  reference to: FlexibleRuleUserListInfoShape
  omitted because: over-long
omitted shape reference:
  reference from: SmartCampaignAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long
omitted shape reference:
  reference from: VideoResponsiveAdInfoShape
  reference to: AdTextAssetShape
  omitted because: over-long

AccessibleBiddingStrategyShape
type: NodeShape
target class: AccessibleBiddingStrategy
property:
  path: maximizeConversions
  name: maximize conversions
  description: Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
  write lifecycle: Read only
  node: AccessibleBiddingStrategyMaximizeConversionsShape
  class: AccessibleBiddingStrategyMaximizeConversions
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: ownerDescriptiveName
  name: owner descriptive name
  description: Output only. descriptive_name of the Customer which owns the bidding strategy.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: ownerCustomerId
  name: owner customer id
  description: Output only. The ID of the Customer which owns the bidding strategy.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name of the bidding strategy.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
  write lifecycle: Read only
  node: AccessibleBiddingStrategyTargetRoasShape
  class: AccessibleBiddingStrategyTargetRoas
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: maximizeConversionValue
  name: maximize conversion value
  description: Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
  write lifecycle: Read only
  node: AccessibleBiddingStrategyMaximizeConversionValueShape
  class: AccessibleBiddingStrategyMaximizeConversionValue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the bidding strategy.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: COMMISSION
  in: ENHANCED_CPC
  in: FIXED_CPM
  in: FIXED_SHARE_OF_VOICE
  in: INVALID
  in: MANUAL_CPA
  in: MANUAL_CPC
  in: MANUAL_CPM
  in: MANUAL_CPV
  in: MAXIMIZE_CONVERSIONS
  in: MAXIMIZE_CONVERSION_VALUE
  in: PAGE_ONE_PROMOTED
  in: PERCENT_CPC
  in: TARGET_CPA
  in: TARGET_CPC
  in: TARGET_CPM
  in: TARGET_CPV
  in: TARGET_IMPRESSION_SHARE
  in: TARGET_OUTRANK_SHARE
  in: TARGET_ROAS
  in: TARGET_SPEND
property:
  path: targetImpressionShare
  name: target impression share
  description: Output only. A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
  write lifecycle: Read only
  node: AccessibleBiddingStrategyTargetImpressionShareShape
  class: AccessibleBiddingStrategyTargetImpressionShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetSpend
  name: target spend
  description: Output only. A bid strategy that sets your bids to help get as many clicks as possible within your budget.
  write lifecycle: Read only
  node: AccessibleBiddingStrategyTargetSpendShape
  class: AccessibleBiddingStrategyTargetSpend
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: `customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetCpa
  name: target cpa
  description: 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.
  write lifecycle: Read only
  node: AccessibleBiddingStrategyTargetCpaShape
  class: AccessibleBiddingStrategyTargetCpa
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the bidding strategy.
  write lifecycle: Read only
  datatype: long
  max count: 1

AccessibleBiddingStrategyMaximizeConversionsShape
type: NodeShape
target class: AccessibleBiddingStrategyMaximizeConversions
property:
  path: targetCpaMicros
  name: target cpa micros
  description: Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
  write lifecycle: Read only
  datatype: long
  max count: 1

AccessibleBiddingStrategyTargetRoasShape
type: NodeShape
target class: AccessibleBiddingStrategyTargetRoas
property:
  path: targetRoas
  name: target roas
  description: Output only. The chosen revenue (based on conversion data) per unit of spend.
  write lifecycle: Read only
  datatype: double
  max count: 1

AccessibleBiddingStrategyMaximizeConversionValueShape
type: NodeShape
target class: AccessibleBiddingStrategyMaximizeConversionValue
property:
  path: targetRoas
  name: target roas
  description: 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.
  write lifecycle: Read only
  datatype: double
  max count: 1

AccessibleBiddingStrategyTargetImpressionShareShape
type: NodeShape
target class: AccessibleBiddingStrategyTargetImpressionShare
property:
  path: locationFractionMicros
  name: location fraction micros
  description: The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
  datatype: long
  max count: 1
property:
  path: location
  name: location
  description: Output only. The targeted location on the search results page.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ANYWHERE_ON_PAGE
  in: TOP_OF_PAGE
  in: ABSOLUTE_TOP_OF_PAGE
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
  write lifecycle: Read only
  datatype: long
  max count: 1

AccessibleBiddingStrategyTargetSpendShape
type: NodeShape
target class: AccessibleBiddingStrategyTargetSpend
property:
  path: targetSpendMicros
  name: target spend micros
  description: 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.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
  write lifecycle: Read only
  datatype: long
  max count: 1

AccessibleBiddingStrategyTargetCpaShape
type: NodeShape
target class: AccessibleBiddingStrategyTargetCpa
property:
  path: targetCpaMicros
  name: target cpa micros
  description: Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
  write lifecycle: Read only
  datatype: long
  max count: 1

AccountBudgetShape
type: NodeShape
target class: AccountBudget
property:
  path: proposedEndDateTime
  name: proposed end date time
  description: Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: approvedStartDateTime
  name: approved start date time
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adjustedSpendingLimitMicros
  name: adjusted spending limit micros
  description: 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.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: adjustedSpendingLimitType
  name: adjusted spending limit type
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INFINITE
property:
  path: id
  name: id
  description: Output only. The ID of the account-level budget.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of this account-level budget.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: APPROVED
  in: CANCELLED
property:
  path: approvedEndDateTime
  name: approved end date time
  description: Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: amountServedMicros
  name: amount served micros
  description: 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 total_adjustments_micros).
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: pendingProposal
  name: pending proposal
  description: Output only. The pending proposal to modify this budget, if applicable.
  write lifecycle: Read only
  node: AccountBudgetPendingAccountBudgetProposalShape
  class: AccountBudgetPendingAccountBudgetProposal
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: proposedSpendingLimitMicros
  name: proposed spending limit micros
  description: Output only. The proposed spending limit in micros. One million is equivalent to one unit.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: proposedStartDateTime
  name: proposed start date time
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name of the account-level budget.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: proposedSpendingLimitType
  name: proposed spending limit type
  description: Output only. The proposed spending limit as a well-defined type, for example, INFINITE.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INFINITE
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the account-level budget. AccountBudget resource names have the form: `customers/{customer_id}/accountBudgets/{account_budget_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: notes
  name: notes
  description: Output only. Notes associated with the budget.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: approvedEndTimeType
  name: approved end time type
  description: Output only. The approved end time as a well-defined type, for example, FOREVER.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER
property:
  path: totalAdjustmentsMicros
  name: total adjustments micros
  description: Output only. The total adjustments amount. An example of an adjustment is courtesy credits.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: approvedSpendingLimitMicros
  name: approved spending limit micros
  description: 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.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: billingSetup
  name: billing setup
  description: Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: purchaseOrderNumber
  name: purchase order number
  description: Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: approvedSpendingLimitType
  name: approved spending limit type
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INFINITE
property:
  path: proposedEndTimeType
  name: proposed end time type
  description: Output only. The proposed end time as a well-defined type, for example, FOREVER.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER

AccountBudgetPendingAccountBudgetProposalShape
type: NodeShape
target class: AccountBudgetPendingAccountBudgetProposal
property:
  path: spendingLimitType
  name: spending limit type
  description: Output only. The spending limit as a well-defined type, for example, INFINITE.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INFINITE
property:
  path: purchaseOrderNumber
  name: purchase order number
  description: Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: proposalType
  name: proposal type
  description: Output only. The type of this proposal, for example, END to end the budget associated with this proposal.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CREATE
  in: UPDATE
  in: END
  in: REMOVE
property:
  path: creationDateTime
  name: creation date time
  description: Output only. The time when this account-level budget proposal was created. Formatted as yyyy-MM-dd HH:mm:ss.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name to assign to the account-level budget.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: startDateTime
  name: start date time
  description: Output only. The start time in yyyy-MM-dd HH:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: notes
  name: notes
  description: Output only. Notes associated with this budget.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: endDateTime
  name: end date time
  description: Output only. The end time in yyyy-MM-dd HH:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: accountBudgetProposal
  name: account budget proposal
  description: Output only. The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: endTimeType
  name: end time type
  description: Output only. The end time as a well-defined type, for example, FOREVER.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER
property:
  path: spendingLimitMicros
  name: spending limit micros
  description: Output only. The spending limit in micros. One million is equivalent to one unit.
  write lifecycle: Read only
  datatype: long
  max count: 1

AccountBudgetProposalShape
type: NodeShape
target class: AccountBudgetProposal
property:
  path: proposedName
  name: proposed name
  description: Immutable. The name to assign to the account-level budget.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: proposedEndTimeType
  name: proposed end time type
  description: Immutable. The proposed end date time as a well-defined type, for example, FOREVER.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER
property:
  path: proposedStartTimeType
  name: proposed start time type
  description: Immutable. The proposed start date time as a well-defined type, for example, NOW.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER
property:
  path: billingSetup
  name: billing setup
  description: Immutable. The resource name of the billing setup associated with this proposal.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: approvedSpendingLimitType
  name: approved spending limit type
  description: Output only. The approved spending limit as a well-defined type, for example, INFINITE.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INFINITE
property:
  path: accountBudget
  name: account budget
  description: Immutable. The resource name of the account-level budget associated with this proposal.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: approvedSpendingLimitMicros
  name: approved spending limit micros
  description: Output only. The approved spending limit in micros. One million is equivalent to one unit.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: proposedNotes
  name: proposed notes
  description: Immutable. Notes associated with this budget.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: proposedSpendingLimitType
  name: proposed spending limit type
  description: Immutable. The proposed spending limit as a well-defined type, for example, INFINITE.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INFINITE
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: approvedEndTimeType
  name: approved end time type
  description: Output only. The approved end date time as a well-defined type, for example, FOREVER.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER
property:
  path: proposalType
  name: proposal type
  description: Immutable. The type of this proposal, for example, END to end the budget associated with this proposal.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CREATE
  in: UPDATE
  in: END
  in: REMOVE
property:
  path: proposedPurchaseOrderNumber
  name: proposed purchase order number
  description: Immutable. A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: creationDateTime
  name: creation date time
  description: Output only. The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: proposedSpendingLimitMicros
  name: proposed spending limit micros
  description: Immutable. The proposed spending limit in micros. One million is equivalent to one unit.
  write lifecycle: Create only
  datatype: long
  max count: 1
property:
  path: proposedStartDateTime
  name: proposed start date time
  description: Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: approvedEndDateTime
  name: approved end date time
  description: Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: approvedStartDateTime
  name: approved start date time
  description: Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the proposal.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of this proposal. When a new proposal is created, the status defaults to PENDING.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: APPROVED_HELD
  in: APPROVED
  in: CANCELLED
  in: REJECTED
property:
  path: approvalDateTime
  name: approval date time
  description: Output only. The date time when this account-level budget was approved, if applicable.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: proposedEndDateTime
  name: proposed end date time
  description: Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format.
  write lifecycle: Create only
  datatype: string
  max count: 1

AccountLinkShape
type: NodeShape
target class: AccountLink
property:
  path: status
  name: status
  description: The status of the link.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: REQUESTED
  in: PENDING_APPROVAL
  in: REJECTED
  in: REVOKED
property:
  path: thirdPartyAppAnalytics
  name: third party app analytics
  description: Immutable. A third party app analytics link.
  write lifecycle: Create only
  node: ThirdPartyAppAnalyticsLinkIdentifierShape
  class: ThirdPartyAppAnalyticsLinkIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: accountLinkId
  name: account link id
  description: Output only. The ID of the link. This field is read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the linked account.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: THIRD_PARTY_APP_ANALYTICS
property:
  path: resourceName
  name: resource name
  description: Immutable. Resource name of the account link. AccountLink resource names have the form: `customers/{customer_id}/accountLinks/{account_link_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1

ThirdPartyAppAnalyticsLinkIdentifierShape
type: NodeShape
target class: ThirdPartyAppAnalyticsLinkIdentifier
property:
  path: appAnalyticsProviderId
  name: app analytics provider id
  description: Immutable. The ID of the app analytics provider. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
  write lifecycle: Create only
  datatype: long
  max count: 1
property:
  path: appId
  name: app id
  description: Immutable. A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "422689480" for "Gmail" whose App Store link is https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For Android, the ID string is the application's package name (for example, "com.google.android.gm" for "Gmail" given Google Play link https://play.google.com/store/apps/details?id=com.google.android.gm) This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: appVendor
  name: app vendor
  description: Immutable. The vendor of the app. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPLE_APP_STORE
  in: GOOGLE_APP_STORE

ActivityCityInfoShape
type: NodeShape
target class: ActivityCityInfo
property:
  path: value
  name: value
  description: String value of the activity city. The Geo Target Constant resource name.
  datatype: string
  max count: 1

ActivityCountryInfoShape
type: NodeShape
target class: ActivityCountryInfo
property:
  path: value
  name: value
  description: String value of the activity country. The Geo Target Constant resource name.
  datatype: string
  max count: 1

ActivityIdInfoShape
type: NodeShape
target class: ActivityIdInfo
property:
  path: value
  name: value
  description: String value of the activity ID.
  datatype: string
  max count: 1

ActivityRatingInfoShape
type: NodeShape
target class: ActivityRatingInfo
property:
  path: value
  name: value
  description: Long value of the activity rating.
  datatype: long
  max count: 1

ActivityStateInfoShape
type: NodeShape
target class: ActivityStateInfo
property:
  path: value
  name: value
  description: String value of the activity state. The Geo Target Constant resource name.
  datatype: string
  max count: 1

AdShape
type: NodeShape
target class: Ad
property:
  path: addedByGoogleAds
  name: added by google ads
  description: Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: demandGenVideoResponsiveAd
  name: demand gen video responsive ad
  description: Details pertaining to a Demand Gen video responsive ad.
  node: DemandGenVideoResponsiveAdInfoShape
  class: DemandGenVideoResponsiveAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: displayUploadAd
  name: display upload ad
  description: Details pertaining to a display upload ad.
  node: DisplayUploadAdInfoShape
  class: DisplayUploadAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: The list of mappings that can be used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`. For mutates, use url custom parameter operations.
  node: CustomParameterShape
  class: CustomParameter
  node kind: BlankNodeOrIRI
property:
  path: id
  name: id
  description: Output only. The ID of the ad.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: displayUrl
  name: display url
  description: The URL that appears in the ad description for some ad formats.
  datatype: string
  max count: 1
property:
  path: devicePreference
  name: device preference
  description: The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, for example, if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MOBILE
  in: TABLET
  in: DESKTOP
  in: CONNECTED_TV
  in: OTHER
property:
  path: imageAd
  name: image ad
  description: Immutable. Details pertaining to an Image ad.
  write lifecycle: Create only
  node: ImageAdInfoShape
  class: ImageAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: systemManagedResourceSource
  name: system managed resource source
  description: Output only. If this ad is system managed, then this field will indicate the source. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AD_VARIATIONS
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: demandGenCarouselAd
  name: demand gen carousel ad
  description: Details pertaining to a Demand Gen carousel ad.
  node: DemandGenCarouselAdInfoShape
  class: DemandGenCarouselAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: videoAd
  name: video ad
  description: Details pertaining to a Video ad.
  node: VideoAdInfoShape
  class: VideoAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shoppingSmartAd
  name: shopping smart ad
  description: Details pertaining to a Smart Shopping ad.
  node: ShoppingSmartAdInfoShape
  class: ShoppingSmartAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shoppingComparisonListingAd
  name: shopping comparison listing ad
  description: Details pertaining to a Shopping Comparison Listing ad.
  node: ShoppingComparisonListingAdInfoShape
  class: ShoppingComparisonListingAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: smartCampaignAd
  name: smart campaign ad
  description: Details pertaining to a Smart campaign ad.
  node: SmartCampaignAdInfoShape
  class: SmartCampaignAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: appEngagementAd
  name: app engagement ad
  description: Details pertaining to an app engagement ad.
  node: AppEngagementAdInfoShape
  class: AppEngagementAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: demandGenMultiAssetAd
  name: demand gen multi asset ad
  description: Details pertaining to a Demand Gen multi asset ad.
  node: DemandGenMultiAssetAdInfoShape
  class: DemandGenMultiAssetAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: legacyAppInstallAd
  name: legacy app install ad
  description: Immutable. Details pertaining to a legacy app install ad.
  write lifecycle: Create only
  node: LegacyAppInstallAdInfoShape
  class: LegacyAppInstallAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: name
  name: name
  description: Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, LegacyAppInstallAd, ShoppingComparisonListingAd, VideoAd, VideoResponsiveAd and DemandGen ads.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: responsiveSearchAd
  name: responsive search ad
  description: Details pertaining to a responsive search ad.
  node: ResponsiveSearchAdInfoShape
  class: ResponsiveSearchAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of ad.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TEXT_AD
  in: EXPANDED_TEXT_AD
  in: EXPANDED_DYNAMIC_SEARCH_AD
  in: HOTEL_AD
  in: SHOPPING_SMART_AD
  in: SHOPPING_PRODUCT_AD
  in: VIDEO_AD
  in: IMAGE_AD
  in: RESPONSIVE_SEARCH_AD
  in: LEGACY_RESPONSIVE_DISPLAY_AD
  in: APP_AD
  in: LEGACY_APP_INSTALL_AD
  in: RESPONSIVE_DISPLAY_AD
  in: LOCAL_AD
  in: HTML5_UPLOAD_AD
  in: DYNAMIC_HTML5_AD
  in: APP_ENGAGEMENT_AD
  in: SHOPPING_COMPARISON_LISTING_AD
  in: VIDEO_BUMPER_AD
  in: VIDEO_NON_SKIPPABLE_IN_STREAM_AD
  in: VIDEO_TRUEVIEW_IN_STREAM_AD
  in: VIDEO_RESPONSIVE_AD
  in: SMART_CAMPAIGN_AD
  in: CALL_AD
  in: APP_PRE_REGISTRATION_AD
  in: IN_FEED_VIDEO_AD
  in: DEMAND_GEN_MULTI_ASSET_AD
  in: DEMAND_GEN_CAROUSEL_AD
  in: TRAVEL_AD
  in: DEMAND_GEN_VIDEO_RESPONSIVE_AD
  in: DEMAND_GEN_PRODUCT_AD
  in: YOUTUBE_AUDIO_AD

DemandGenVideoResponsiveAdInfoShape
type: NodeShape
target class: DemandGenVideoResponsiveAdInfo
property:
  path: headlines
  name: headlines
  description: List of text assets used for the short headline.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: videos
  name: videos
  description: Required. List of YouTube video assets used for the ad.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI
property:
  path: longHeadlines
  name: long headlines
  description: List of text assets used for the long headline.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: companionBanners
  name: companion banners
  description: List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: breadcrumb2
  name: breadcrumb2
  description: Second part of text that appears in the ad with the displayed URL.
  datatype: string
  max count: 1
property:
  path: descriptions
  name: descriptions
  description: List of text assets used for the description.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: callToActions
  name: call to actions
  description: Assets of type CallToActionAsset used for the "Call To Action" button.
  node: AdCallToActionAssetShape
  class: AdCallToActionAsset
  node kind: BlankNodeOrIRI
property:
  path: breadcrumb1
  name: breadcrumb1
  description: First part of text that appears in the ad with the displayed URL.
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  description: Required. The advertiser/brand name.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: logoImages
  name: logo images
  description: Required. Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI

AdTextAssetShape
type: NodeShape
target class: AdTextAsset
property:
  path: policySummaryInfo
  name: policy summary info
  description: The policy summary of this text asset.
  node: AdAssetPolicySummaryShape
  class: AdAssetPolicySummary
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: text
  name: text
  description: Asset text.
  datatype: string
  max count: 1
property:
  path: pinnedField
  name: pinned field
  description: The pinned field of the asset. This restricts the asset to only serve within this field. Multiple assets can be pinned to the same field. An asset that is unpinned or pinned to a different field will not serve in a field where some other asset has been pinned.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE_1
  in: HEADLINE_2
  in: HEADLINE_3
  in: DESCRIPTION_1
  in: DESCRIPTION_2
  in: HEADLINE
  in: HEADLINE_IN_PORTRAIT
  in: LONG_HEADLINE
  in: DESCRIPTION
  in: DESCRIPTION_IN_PORTRAIT
  in: BUSINESS_NAME_IN_PORTRAIT
  in: BUSINESS_NAME
  in: MARKETING_IMAGE
  in: MARKETING_IMAGE_IN_PORTRAIT
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: CALL_TO_ACTION
  in: YOU_TUBE_VIDEO
  in: SITELINK
  in: CALL
  in: MOBILE_APP
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: PRICE
  in: PROMOTION
  in: AD_IMAGE
  in: LEAD_FORM
  in: BUSINESS_LOGO
  in: DESCRIPTION_PREFIX
  in: HEADLINE_AS_SITELINK_POSITION_ONE
  in: HEADLINE_AS_SITELINK_POSITION_TWO
  in: DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_ONE
  in: DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_TWO
property:
  path: assetPerformanceLabel
  name: asset performance label
  description: The performance label of this text asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: LEARNING
  in: LOW
  in: GOOD
  in: BEST
  in: NOT_APPLICABLE

AdAssetPolicySummaryShape
type: NodeShape
target class: AdAssetPolicySummary
property:
  path: policyTopicEntries
  name: policy topic entries
  description: The list of policy findings for this asset.
  node: PolicyTopicEntryShape
  class: PolicyTopicEntry
  node kind: BlankNodeOrIRI
property:
  path: reviewStatus
  name: review status
  description: Where in the review process this asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REVIEW_IN_PROGRESS
  in: REVIEWED
  in: UNDER_APPEAL
  in: ELIGIBLE_MAY_SERVE
property:
  path: approvalStatus
  name: approval status
  description: The overall approval status of this asset, which is calculated based on the status of its individual policy topic entries.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISAPPROVED
  in: APPROVED_LIMITED
  in: APPROVED
  in: AREA_OF_INTEREST_ONLY

PolicyTopicEntryShape
type: NodeShape
target class: PolicyTopicEntry
property:
  path: type
  name: type
  description: Describes the negative or positive effect this policy will have on serving.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PROHIBITED
  in: LIMITED
  in: FULLY_LIMITED
  in: DESCRIPTIVE
  in: BROADENING
  in: AREA_OF_INTEREST_ONLY
property:
  path: topic
  name: topic
  description: Policy topic this finding refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time.
  datatype: string
  max count: 1
property:
  path: evidences
  name: evidences
  description: Additional information that explains policy finding (for example, the brand name for a trademark finding).
  node: PolicyTopicEvidenceShape
  class: PolicyTopicEvidence
  node kind: BlankNodeOrIRI
property:
  path: constraints
  name: constraints
  description: Indicates how serving of this resource may be affected (for example, not serving in a country).
  node: PolicyTopicConstraintShape
  class: PolicyTopicConstraint
  node kind: BlankNodeOrIRI

PolicyTopicEvidenceShape
type: NodeShape
target class: PolicyTopicEvidence
property:
  path: websiteList
  name: website list
  description: List of websites linked with this resource.
  node: PolicyTopicEvidenceWebsiteListShape
  class: PolicyTopicEvidenceWebsiteList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: textList
  name: text list
  description: List of evidence found in the text of a resource.
  node: PolicyTopicEvidenceTextListShape
  class: PolicyTopicEvidenceTextList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: destinationMismatch
  name: destination mismatch
  description: Mismatch between the destinations of a resource's URLs.
  node: PolicyTopicEvidenceDestinationMismatchShape
  class: PolicyTopicEvidenceDestinationMismatch
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: destinationNotWorking
  name: destination not working
  description: Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
  node: PolicyTopicEvidenceDestinationNotWorkingShape
  class: PolicyTopicEvidenceDestinationNotWorking
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: languageCode
  name: language code
  description: The language the resource was detected to be written in. This is an IETF language tag such as "en-US".
  datatype: string
  max count: 1
property:
  path: destinationTextList
  name: destination text list
  description: The text in the destination of the resource that is causing a policy finding.
  node: PolicyTopicEvidenceDestinationTextListShape
  class: PolicyTopicEvidenceDestinationTextList
  node kind: BlankNodeOrIRI
  max count: 1

PolicyTopicEvidenceWebsiteListShape
type: NodeShape
target class: PolicyTopicEvidenceWebsiteList
property:
  path: websites
  name: websites
  description: Websites that caused the policy finding.
  datatype: string

PolicyTopicEvidenceTextListShape
type: NodeShape
target class: PolicyTopicEvidenceTextList
property:
  path: texts
  name: texts
  description: The fragments of text from the resource that caused the policy finding.
  datatype: string

PolicyTopicEvidenceDestinationMismatchShape
type: NodeShape
target class: PolicyTopicEvidenceDestinationMismatch
property:
  path: urlTypes
  name: url types
  description: The set of URLs that did not match each other.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISPLAY_URL
  in: FINAL_URL
  in: FINAL_MOBILE_URL
  in: TRACKING_URL
  in: MOBILE_TRACKING_URL

PolicyTopicEvidenceDestinationNotWorkingShape
type: NodeShape
target class: PolicyTopicEvidenceDestinationNotWorking
property:
  path: dnsErrorType
  name: dns error type
  description: The type of DNS error.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HOSTNAME_NOT_FOUND
  in: GOOGLE_CRAWLER_DNS_ISSUE
property:
  path: lastCheckedDateTime
  name: last checked date time
  description: The time the URL was last checked. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
  datatype: string
  max count: 1
property:
  path: device
  name: device
  description: The type of device that failed to load the URL.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DESKTOP
  in: ANDROID
  in: IOS
property:
  path: httpErrorCode
  name: http error code
  description: The HTTP error code.
  datatype: long
  max count: 1
property:
  path: expandedUrl
  name: expanded url
  description: The full URL that didn't work.
  datatype: string
  max count: 1

PolicyTopicEvidenceDestinationTextListShape
type: NodeShape
target class: PolicyTopicEvidenceDestinationTextList
property:
  path: destinationTexts
  name: destination texts
  description: List of text found in the resource's destination page.
  datatype: string

PolicyTopicConstraintShape
type: NodeShape
target class: PolicyTopicConstraint
property:
  path: countryConstraintList
  name: country constraint list
  description: Countries where the resource cannot serve.
  node: PolicyTopicConstraintCountryConstraintListShape
  class: PolicyTopicConstraintCountryConstraintList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: certificateMissingInCountryList
  name: certificate missing in country list
  description: Countries where a certificate is required for serving.
  node: PolicyTopicConstraintCountryConstraintListShape
  class: PolicyTopicConstraintCountryConstraintList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: certificateDomainMismatchInCountryList
  name: certificate domain mismatch in country list
  description: Countries where the resource's domain is not covered by the certificates associated with it.
  node: PolicyTopicConstraintCountryConstraintListShape
  class: PolicyTopicConstraintCountryConstraintList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resellerConstraint
  name: reseller constraint
  description: Reseller constraint.
  node: PolicyTopicConstraintResellerConstraintShape
  class: PolicyTopicConstraintResellerConstraint
  node kind: BlankNodeOrIRI
  max count: 1

PolicyTopicConstraintCountryConstraintListShape
type: NodeShape
target class: PolicyTopicConstraintCountryConstraintList
property:
  path: totalTargetedCountries
  name: total targeted countries
  description: Total number of countries targeted by the resource.
  datatype: int
  max count: 1
property:
  path: countries
  name: countries
  description: Countries in which serving is restricted.
  node: PolicyTopicConstraintCountryConstraintShape
  class: PolicyTopicConstraintCountryConstraint
  node kind: BlankNodeOrIRI

PolicyTopicConstraintCountryConstraintShape
type: NodeShape
target class: PolicyTopicConstraintCountryConstraint
property:
  path: countryCriterion
  name: country criterion
  description: Geo target constant resource name of the country in which serving is constrained.
  datatype: string
  max count: 1

AdVideoAssetShape
type: NodeShape
target class: AdVideoAsset
property:
  path: asset
  name: asset
  description: The Asset resource name of this video.
  datatype: string
  max count: 1
property:
  path: adVideoAssetInfo
  name: ad video asset info
  description: Contains info fields for this AdVideoAsset.
  node: AdVideoAssetInfoShape
  class: AdVideoAssetInfo
  node kind: BlankNodeOrIRI
  max count: 1

AdVideoAssetInfoShape
type: NodeShape
target class: AdVideoAssetInfo
property:
  path: adVideoAssetFeatureControl
  name: ad video asset feature control
  description: Defines feature controls for this AdVideoAsset during serving time. For example, whether YouTube comments should be enabled for Partnership Ads served on YouTube Shorts.
  node: AdVideoAssetLinkFeatureControlShape
  class: AdVideoAssetLinkFeatureControl
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adVideoAssetInventoryPreferences
  name: ad video asset inventory preferences
  description: List of inventory preferences for this AdVideoAsset. This field can only be set for DiscoveryVideoResponsiveAd. The video assets with an inventory asset preference set will be preferred over other videos from the same ad during serving time. For example, consider this ad being served for a specific inventory. The server will first try to match an eligible video with a matching preference for that inventory. Videos with no preferences are chosen only when a video with matching preference and eligible for a given ad slot can be found.
  node: AdVideoAssetInventoryPreferencesShape
  class: AdVideoAssetInventoryPreferences
  node kind: BlankNodeOrIRI
  max count: 1

AdVideoAssetLinkFeatureControlShape
type: NodeShape
target class: AdVideoAssetLinkFeatureControl
property:
  path: allowYoutubeComments
  name: allow youtube comments
  description: Defines if YouTube comments should be enabled for the creative using this YouTube video asset served on YouTube Shorts.
  datatype: boolean
  max count: 1

AdVideoAssetInventoryPreferencesShape
type: NodeShape
target class: AdVideoAssetInventoryPreferences
property:
  path: inStreamPreference
  name: in stream preference
  description: When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve In Stream.
  datatype: boolean
  max count: 1
property:
  path: inFeedPreference
  name: in feed preference
  description: When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve In Feed.
  datatype: boolean
  max count: 1
property:
  path: shortsPreference
  name: shorts preference
  description: When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve on YouTube Shorts.
  datatype: boolean
  max count: 1

AdImageAssetShape
type: NodeShape
target class: AdImageAsset
property:
  path: asset
  name: asset
  description: The Asset resource name of this image.
  datatype: string
  max count: 1

AdCallToActionAssetShape
type: NodeShape
target class: AdCallToActionAsset
property:
  path: asset
  name: asset
  description: The Asset resource name of this call to action asset.
  datatype: string
  max count: 1

DisplayUploadAdInfoShape
type: NodeShape
target class: DisplayUploadAdInfo
property:
  path: mediaBundle
  name: media bundle
  description: A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898 for more information.
  node: AdMediaBundleAssetShape
  class: AdMediaBundleAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: displayUploadProductType
  name: display upload product type
  description: The product type of this ad. See comments on the enum for details.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HTML5_UPLOAD_AD
  in: DYNAMIC_HTML5_EDUCATION_AD
  in: DYNAMIC_HTML5_FLIGHT_AD
  in: DYNAMIC_HTML5_HOTEL_RENTAL_AD
  in: DYNAMIC_HTML5_JOB_AD
  in: DYNAMIC_HTML5_LOCAL_AD
  in: DYNAMIC_HTML5_REAL_ESTATE_AD
  in: DYNAMIC_HTML5_CUSTOM_AD
  in: DYNAMIC_HTML5_TRAVEL_AD
  in: DYNAMIC_HTML5_HOTEL_AD

AdMediaBundleAssetShape
type: NodeShape
target class: AdMediaBundleAsset
property:
  path: asset
  name: asset
  description: The Asset resource name of this media bundle.
  datatype: string
  max count: 1

CustomParameterShape
type: NodeShape
target class: CustomParameter
property:
  path: key
  name: key
  description: The key matching the parameter tag name.
  datatype: string
  max count: 1
property:
  path: value
  name: value
  description: The value to be substituted.
  datatype: string
  max count: 1

ImageAdInfoShape
type: NodeShape
target class: ImageAdInfo
property:
  path: data
  name: data
  description: Raw image data as bytes.
  datatype: base64Binary
  max count: 1
property:
  path: adIdToCopyImageFrom
  name: ad id to copy image from
  description: An ad ID to copy the image from.
  datatype: long
  max count: 1
property:
  path: pixelHeight
  name: pixel height
  description: Height in pixels of the full size image.
  datatype: long
  max count: 1
property:
  path: mimeType
  name: mime type
  description: The mime type of the image.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: IMAGE_JPEG
  in: IMAGE_GIF
  in: IMAGE_PNG
  in: FLASH
  in: TEXT_HTML
  in: PDF
  in: MSWORD
  in: MSEXCEL
  in: RTF
  in: AUDIO_WAV
  in: AUDIO_MP3
  in: HTML5_AD_ZIP
property:
  path: previewPixelHeight
  name: preview pixel height
  description: Height in pixels of the preview size image.
  datatype: long
  max count: 1
property:
  path: imageUrl
  name: image url
  description: URL of the full size image.
  datatype: string
  max count: 1
property:
  path: pixelWidth
  name: pixel width
  description: Width in pixels of the full size image.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty.
  datatype: string
  max count: 1
property:
  path: previewImageUrl
  name: preview image url
  description: URL of the preview size image.
  datatype: string
  max count: 1
property:
  path: imageAsset
  name: image asset
  description: The image assets used for the ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: previewPixelWidth
  name: preview pixel width
  description: Width in pixels of the preview size image.
  datatype: long
  max count: 1

DemandGenCarouselAdInfoShape
type: NodeShape
target class: DemandGenCarouselAdInfo
property:
  path: headline
  name: headline
  description: Required. Headline of the ad.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: callToActionText
  name: call to action text
  description: Call to action text.
  datatype: string
  max count: 1
property:
  path: carouselCards
  name: carousel cards
  description: Required. Carousel cards that will display with the ad. Min 2 max 10.
  node: AdDemandGenCarouselCardAssetShape
  class: AdDemandGenCarouselCardAsset
  node kind: BlankNodeOrIRI
property:
  path: description
  name: description
  description: Required. The descriptive text of the ad.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: businessName
  name: business name
  description: Required. The Advertiser/brand name.
  datatype: string
  max count: 1
property:
  path: logoImage
  name: logo image
  description: Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
  max count: 1

AdDemandGenCarouselCardAssetShape
type: NodeShape
target class: AdDemandGenCarouselCardAsset
property:
  path: asset
  name: asset
  description: The Asset resource name of this discovery carousel card.
  datatype: string
  max count: 1

VideoAdInfoShape
type: NodeShape
target class: VideoAdInfo
property:
  path: inFeed
  name: in feed
  description: In-feed video ad format.
  node: InFeedVideoAdInfoShape
  class: InFeedVideoAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audio
  name: audio
  description: YouTube Audio ad format.
  node: YouTubeAudioAdInfoShape
  class: YouTubeAudioAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: bumper
  name: bumper
  description: Video bumper in-stream ad format.
  node: VideoBumperInStreamAdInfoShape
  class: VideoBumperInStreamAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: inStream
  name: in stream
  description: Video TrueView in-stream ad format.
  node: VideoTrueViewInStreamAdInfoShape
  class: VideoTrueViewInStreamAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: nonSkippable
  name: non skippable
  description: Video non-skippable in-stream ad format.
  node: VideoNonSkippableInStreamAdInfoShape
  class: VideoNonSkippableInStreamAdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: video
  name: video
  description: The YouTube video assets used for the ad.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: outStream
  name: out stream
  description: Video out-stream ad format.
  node: VideoOutstreamAdInfoShape
  class: VideoOutstreamAdInfo
  node kind: BlankNodeOrIRI
  max count: 1

InFeedVideoAdInfoShape
type: NodeShape
target class: InFeedVideoAdInfo
property:
  path: description1
  name: description1
  description: First text line for the ad.
  datatype: string
  max count: 1
property:
  path: description2
  name: description2
  description: Second text line for the ad.
  datatype: string
  max count: 1
property:
  path: thumbnail
  name: thumbnail
  description: Video thumbnail image to use.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DEFAULT_THUMBNAIL
  in: THUMBNAIL_1
  in: THUMBNAIL_2
  in: THUMBNAIL_3
property:
  path: headline
  name: headline
  description: The headline of the ad.
  datatype: string
  max count: 1

VideoBumperInStreamAdInfoShape
type: NodeShape
target class: VideoBumperInStreamAdInfo
property:
  path: companionBanner
  name: companion banner
  description: The image assets of the companion banner used with the ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: actionButtonLabel
  name: action button label
  description: Label on the "Call To Action" button taking the user to the video ad's final URL.
  datatype: string
  max count: 1
property:
  path: actionHeadline
  name: action headline
  description: Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
  datatype: string
  max count: 1

VideoTrueViewInStreamAdInfoShape
type: NodeShape
target class: VideoTrueViewInStreamAdInfo
property:
  path: companionBanner
  name: companion banner
  description: The image assets of the companion banner used with the ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: actionButtonLabel
  name: action button label
  description: Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise.
  datatype: string
  max count: 1
property:
  path: actionHeadline
  name: action headline
  description: Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
  datatype: string
  max count: 1

VideoNonSkippableInStreamAdInfoShape
type: NodeShape
target class: VideoNonSkippableInStreamAdInfo
property:
  path: companionBanner
  name: companion banner
  description: The image assets of the companion banner used with the ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: actionButtonLabel
  name: action button label
  description: Label on the "Call To Action" button taking the user to the video ad's final URL.
  datatype: string
  max count: 1
property:
  path: actionHeadline
  name: action headline
  description: Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button.
  datatype: string
  max count: 1

VideoOutstreamAdInfoShape
type: NodeShape
target class: VideoOutstreamAdInfo
property:
  path: headline
  name: headline
  description: The headline of the ad.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description line.
  datatype: string
  max count: 1

ShoppingComparisonListingAdInfoShape
type: NodeShape
target class: ShoppingComparisonListingAdInfo
property:
  path: headline
  name: headline
  description: Headline of the ad. This field is required. Allowed length is between 25 and 45 characters.
  datatype: string
  max count: 1

SmartCampaignAdInfoShape
type: NodeShape
target class: SmartCampaignAdInfo
property:
  path: headlines
  name: headlines
  description: List of text assets, each of which corresponds to a headline when the ad serves. This list consists of a minimum of 3 and up to 15 text assets.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: descriptions
  name: descriptions
  description: List of text assets, each of which corresponds to a description when the ad serves. This list consists of a minimum of 2 and up to 4 text assets.
  class: AdTextAsset
  node kind: BlankNodeOrIRI

AppEngagementAdInfoShape
type: NodeShape
target class: AppEngagementAdInfo
property:
  path: descriptions
  name: descriptions
  description: List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: headlines
  name: headlines
  description: List of text assets for headlines. When the ad serves the headlines will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: images
  name: images
  description: List of image assets that may be displayed with the ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: videos
  name: videos
  description: List of video assets that may be displayed with the ad.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI

DemandGenMultiAssetAdInfoShape
type: NodeShape
target class: DemandGenMultiAssetAdInfo
property:
  path: logoImages
  name: logo images
  description: Logo image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). At least 1 and max 5 logo images can be specified.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: businessName
  name: business name
  description: The Advertiser/brand name. Maximum display width is 25. Required.
  datatype: string
  max count: 1
property:
  path: tallPortraitMarketingImages
  name: tall portrait marketing images
  description: Tall portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x1067 and the aspect ratio must be 9:16 (+-1%). Combined with `marketing_images`, `square_marketing_images`, and `portrait_marketing_images`, the maximum is 20.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: marketingImages
  name: marketing images
  description: Marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). Required if square_marketing_images is not present. Combined with `square_marketing_images`, `portrait_marketing_images`, and `tall_portrait_marketing_images` the maximum is 20.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: portraitMarketingImages
  name: portrait marketing images
  description: Portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must be 4:5 (+-1%). Combined with `marketing_images`, `square_marketing_images`, and `tall_portrait_marketing_images` the maximum is 20.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: descriptions
  name: descriptions
  description: The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: classicDisplayImages
  name: classic display images
  description: Classic display image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. At most 20 classic display images can be specified per ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: squareMarketingImages
  name: square marketing images
  description: Square marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). Required if marketing_images is not present. Combined with `marketing_images`, `portrait_marketing_images`, and `tall_portrait_marketing_images` the maximum is 20.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: callToActionText
  name: call to action text
  description: Call to action text.
  datatype: string
  max count: 1
property:
  path: headlines
  name: headlines
  description: Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.
  class: AdTextAsset
  node kind: BlankNodeOrIRI

LegacyAppInstallAdInfoShape
type: NodeShape
target class: LegacyAppInstallAdInfo
property:
  path: description1
  name: description1
  description: The first description line of the ad.
  datatype: string
  max count: 1
property:
  path: description2
  name: description2
  description: The second description line of the ad.
  datatype: string
  max count: 1
property:
  path: appStore
  name: app store
  description: The app store the mobile app is available in.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPLE_APP_STORE
  in: GOOGLE_PLAY
  in: WINDOWS_STORE
  in: WINDOWS_PHONE_STORE
  in: CN_APP_STORE
property:
  path: appId
  name: app id
  description: The ID of the mobile app.
  datatype: string
  max count: 1
property:
  path: headline
  name: headline
  description: The headline of the ad.
  datatype: string
  max count: 1

ResponsiveSearchAdInfoShape
type: NodeShape
target class: ResponsiveSearchAdInfo
property:
  path: headlines
  name: headlines
  description: List of text assets for headlines. When the ad serves the headlines will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: path1
  name: path1
  description: First part of text that can be appended to the URL in the ad.
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  description: Second part of text that can be appended to the URL in the ad. This field can only be set when `path1` is also set.
  datatype: string
  max count: 1
property:
  path: descriptions
  name: descriptions
  description: List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI

DemandGenProductAdInfoShape
type: NodeShape
target class: DemandGenProductAdInfo
property:
  path: breadcrumb2
  name: breadcrumb2
  description: Second part of text that appears in the ad with the displayed URL.
  datatype: string
  max count: 1
property:
  path: callToAction
  name: call to action
  description: Asset of type CallToActionAsset used for the "Call To Action" button.
  node: AdCallToActionAssetShape
  class: AdCallToActionAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: logoImage
  name: logo image
  description: Required. Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: breadcrumb1
  name: breadcrumb1
  description: First part of text that appears in the ad with the displayed URL.
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  description: Required. The advertiser/brand name.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: headline
  name: headline
  description: Required. Text asset used for the short headline.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  description: Required. Text asset used for the description.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1

SyntheticContentInfoShape
type: NodeShape
target class: SyntheticContentInfo
property:
  path: systemAttestation
  name: system attestation
  description: Output only. Information about synthetic content generated by Google's systems.
  write lifecycle: Read only
  node: SyntheticContentAttestationShape
  class: SyntheticContentAttestation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: advertiserAttestation
  name: advertiser attestation
  description: Input provided by the advertiser.
  node: SyntheticContentAttestationShape
  class: SyntheticContentAttestation
  node kind: BlankNodeOrIRI
  max count: 1

SyntheticContentAttestationShape
type: NodeShape
target class: SyntheticContentAttestation
property:
  path: status
  name: status
  description: Indicates whether the content is considered synthetic by this source.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOT_SYNTHETIC
  in: IS_SYNTHETIC
property:
  path: source
  name: source
  description: The source of the synthetic content attestation.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER_ATTESTED
  in: GOOGLE_GENERATED_ADVERTISER_REVIEWED
  in: GOOGLE_GENERATED_FULLY_AUTOMATED

VideoResponsiveAdInfoShape
type: NodeShape
target class: VideoResponsiveAdInfo
property:
  path: breadcrumb2
  name: breadcrumb2
  description: Second part of text that appears in the ad with the displayed URL.
  datatype: string
  max count: 1
property:
  path: companionBanners
  name: companion banners
  description: List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: descriptions
  name: descriptions
  description: List of text assets used for the description. Currently, only a single value for the description is supported.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: headlines
  name: headlines
  description: List of text assets used for the short headline. Currently, only a single value for the short headline is supported.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: videos
  name: videos
  description: Required. List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI
property:
  path: longHeadlines
  name: long headlines
  description: List of text assets used for the long headline. Currently, only a single value for the long headline is supported.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: businessName
  name: business name
  description: Required. Advertiser/brand name. Maximum display width is 25 characters.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: breadcrumb1
  name: breadcrumb1
  description: First part of text that appears in the ad with the displayed URL.
  datatype: string
  max count: 1
property:
  path: logoImages
  name: logo images
  description: Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%).
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: callToActions
  name: call to actions
  description: List of text assets used for the button, for example, the "Call To Action" button. Currently, only a single value for the button is supported.
  class: AdTextAsset
  node kind: BlankNodeOrIRI

UrlCollectionShape
type: NodeShape
target class: UrlCollection
property:
  path: urlCollectionId
  name: url collection id
  description: Unique identifier for this UrlCollection instance.
  datatype: string
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: A list of possible final URLs.
  datatype: string
property:
  path: finalMobileUrls
  name: final mobile urls
  description: A list of possible final mobile URLs.
  datatype: string
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: URL template for constructing a tracking URL.
  datatype: string
  max count: 1

AppPreRegistrationAdInfoShape
type: NodeShape
target class: AppPreRegistrationAdInfo
property:
  path: youtubeVideos
  name: youtube videos
  description: List of YouTube video asset IDs whose videos may be displayed with the ad.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI
property:
  path: descriptions
  name: descriptions
  description: List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: headlines
  name: headlines
  description: List of text assets for headlines. When the ad serves the headlines will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: images
  name: images
  description: List of image asset IDs whose images may be displayed with the ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI

LegacyResponsiveDisplayAdInfoShape
type: NodeShape
target class: LegacyResponsiveDisplayAdInfo
property:
  path: businessName
  name: business name
  description: The business name in the ad.
  datatype: string
  max count: 1
property:
  path: squareLogoImage
  name: square logo image
  description: The MediaFile resource name of the square logo image used in the ad.
  datatype: string
  max count: 1
property:
  path: longHeadline
  name: long headline
  description: The long version of the ad's headline.
  datatype: string
  max count: 1
property:
  path: squareMarketingImage
  name: square marketing image
  description: The MediaFile resource name of the square marketing image used in the ad.
  datatype: string
  max count: 1
property:
  path: formatSetting
  name: format setting
  description: Specifies which format the ad will be served in. Default is ALL_FORMATS.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ALL_FORMATS
  in: NON_NATIVE
  in: NATIVE
property:
  path: mainColor
  name: main color
  description: The main color of the ad in hexadecimal, for example, #ffffff for white. If one of `main_color` and `accent_color` is set, the other is required as well.
  datatype: string
  max count: 1
property:
  path: callToActionText
  name: call to action text
  description: The call-to-action text for the ad.
  datatype: string
  max count: 1
property:
  path: accentColor
  name: accent color
  description: The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of `main_color` and `accent_color` is set, the other is required as well.
  datatype: string
  max count: 1
property:
  path: pricePrefix
  name: price prefix
  description: Prefix before price. For example, 'as low as'.
  datatype: string
  max count: 1
property:
  path: logoImage
  name: logo image
  description: The MediaFile resource name of the logo image used in the ad.
  datatype: string
  max count: 1
property:
  path: promoText
  name: promo text
  description: Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the ad.
  datatype: string
  max count: 1
property:
  path: marketingImage
  name: marketing image
  description: The MediaFile resource name of the marketing image used in the ad.
  datatype: string
  max count: 1
property:
  path: allowFlexibleColor
  name: allow flexible color
  description: Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is `true`. Must be true if `main_color` and `accent_color` are not set.
  datatype: boolean
  max count: 1
property:
  path: shortHeadline
  name: short headline
  description: The short version of the ad's headline.
  datatype: string
  max count: 1

AppAdInfoShape
type: NodeShape
target class: AppAdInfo
property:
  path: mandatoryAdText
  name: mandatory ad text
  description: Mandatory ad text.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeVideos
  name: youtube videos
  description: List of YouTube video assets that may be displayed with the ad.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI
property:
  path: headlines
  name: headlines
  description: List of text assets for headlines. When the ad serves the headlines will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: images
  name: images
  description: List of image assets that may be displayed with the ad.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: descriptions
  name: descriptions
  description: List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: html5MediaBundles
  name: html5media bundles
  description: List of media bundle assets that may be used with the ad.
  node: AdMediaBundleAssetShape
  class: AdMediaBundleAsset
  node kind: BlankNodeOrIRI
property:
  path: appDeepLink
  name: app deep link
  description: An app deep link asset that may be used with the ad.
  node: AdAppDeepLinkAssetShape
  class: AdAppDeepLinkAsset
  node kind: BlankNodeOrIRI
  max count: 1

AdAppDeepLinkAssetShape
type: NodeShape
target class: AdAppDeepLinkAsset
property:
  path: asset
  name: asset
  description: The Asset resource name of this app deep link asset.
  datatype: string
  max count: 1

ExpandedDynamicSearchAdInfoShape
type: NodeShape
target class: ExpandedDynamicSearchAdInfo
property:
  path: description
  name: description
  description: The description of the ad.
  datatype: string
  max count: 1
property:
  path: description2
  name: description2
  description: The second description of the ad.
  datatype: string
  max count: 1

FinalAppUrlShape
type: NodeShape
target class: FinalAppUrl
property:
  path: osType
  name: os type
  description: The operating system targeted by this URL. Required.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: IOS
  in: ANDROID
property:
  path: url
  name: url
  description: The app deep link URL. Deep links specify a location in an app that corresponds to the content you'd like to show, and should be of the form {scheme}://{host_path} The scheme identifies which app to open. For your app, you can use a custom scheme that starts with the app's name. The host and path specify the unique location in the app where your content exists. Example: "exampleapp://productid_1234". Required.
  datatype: string
  max count: 1

TextAdInfoShape
type: NodeShape
target class: TextAdInfo
property:
  path: description2
  name: description2
  description: The second line of the ad's description.
  datatype: string
  max count: 1
property:
  path: description1
  name: description1
  description: The first line of the ad's description.
  datatype: string
  max count: 1
property:
  path: headline
  name: headline
  description: The headline of the ad.
  datatype: string
  max count: 1

LocalAdInfoShape
type: NodeShape
target class: LocalAdInfo
property:
  path: callToActions
  name: call to actions
  description: List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. At least 1 and at most 5 call-to-actions must be specified.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: headlines
  name: headlines
  description: List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: videos
  name: videos
  description: List of YouTube video assets that may be displayed with the ad. At least 1 and at most 20 video assets must be specified.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI
property:
  path: path2
  name: path2
  description: Second part of optional text that can be appended to the URL in the ad. This field can only be set when `path1` is also set.
  datatype: string
  max count: 1
property:
  path: descriptions
  name: descriptions
  description: List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: marketingImages
  name: marketing images
  description: List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: logoImages
  name: logo images
  description: List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: path1
  name: path1
  description: First part of optional text that can be appended to the URL in the ad.
  datatype: string
  max count: 1

ExpandedTextAdInfoShape
type: NodeShape
target class: ExpandedTextAdInfo
property:
  path: headlinePart2
  name: headline part2
  description: The second part of the ad's headline.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the ad.
  datatype: string
  max count: 1
property:
  path: description2
  name: description2
  description: The second description of the ad.
  datatype: string
  max count: 1
property:
  path: path2
  name: path2
  description: Additional text that can appear alongside the ad's displayed URL.
  datatype: string
  max count: 1
property:
  path: headlinePart1
  name: headline part1
  description: The first part of the ad's headline.
  datatype: string
  max count: 1
property:
  path: headlinePart3
  name: headline part3
  description: The third part of the ad's headline.
  datatype: string
  max count: 1
property:
  path: path1
  name: path1
  description: The text that can appear alongside the ad's displayed URL.
  datatype: string
  max count: 1

ResponsiveDisplayAdInfoShape
type: NodeShape
target class: ResponsiveDisplayAdInfo
property:
  path: businessName
  name: business name
  description: The advertiser/brand name. Maximum display width is 25.
  datatype: string
  max count: 1
property:
  path: longHeadline
  name: long headline
  description: A required long format headline. The maximum length is 90 characters.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: formatSetting
  name: format setting
  description: Specifies which format the ad will be served in. Default is ALL_FORMATS.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ALL_FORMATS
  in: NON_NATIVE
  in: NATIVE
property:
  path: squareLogoImages
  name: square logo images
  description: Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with `logo_images`, the maximum is 5.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: marketingImages
  name: marketing images
  description: Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined with `square_marketing_images`, the maximum is 15.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: mainColor
  name: main color
  description: The main color of the ad in hexadecimal, for example, #ffffff for white. If one of `main_color` and `accent_color` is set, the other is required as well.
  datatype: string
  max count: 1
property:
  path: controlSpec
  name: control spec
  description: Specification for various creative controls.
  node: ResponsiveDisplayAdControlSpecShape
  class: ResponsiveDisplayAdControlSpec
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: callToActionText
  name: call to action text
  description: The call-to-action text for the ad. Maximum display width is 30.
  datatype: string
  max count: 1
property:
  path: logoImages
  name: logo images
  description: Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: accentColor
  name: accent color
  description: The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of `main_color` and `accent_color` is set, the other is required as well.
  datatype: string
  max count: 1
property:
  path: pricePrefix
  name: price prefix
  description: Prefix before price. For example, 'as low as'.
  datatype: string
  max count: 1
property:
  path: descriptions
  name: descriptions
  description: Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.
  class: AdTextAsset
  node kind: BlankNodeOrIRI
property:
  path: promoText
  name: promo text
  description: Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
  datatype: string
  max count: 1
property:
  path: squareMarketingImages
  name: square marketing images
  description: Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square `marketing_image` is required. Combined with `marketing_images`, the maximum is 15.
  node: AdImageAssetShape
  class: AdImageAsset
  node kind: BlankNodeOrIRI
property:
  path: youtubeVideos
  name: youtube videos
  description: Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI
property:
  path: allowFlexibleColor
  name: allow flexible color
  description: Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is `true`. Must be true if `main_color` and `accent_color` are not set.
  datatype: boolean
  max count: 1
property:
  path: headlines
  name: headlines
  description: Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.
  class: AdTextAsset
  node kind: BlankNodeOrIRI

ResponsiveDisplayAdControlSpecShape
type: NodeShape
target class: ResponsiveDisplayAdControlSpec
property:
  path: enableAutogenVideo
  name: enable autogen video
  description: Whether the advertiser has opted into auto-gen video feature.
  datatype: boolean
  max count: 1
property:
  path: enableAssetEnhancements
  name: enable asset enhancements
  description: Whether the advertiser has opted into the asset enhancements feature.
  datatype: boolean
  max count: 1

AddressInfoShape
type: NodeShape
target class: AddressInfo
property:
  path: streetAddress
  name: street address
  description: Street address line 1.
  datatype: string
  max count: 1
property:
  path: provinceCode
  name: province code
  description: Province or state code.
  datatype: string
  max count: 1
property:
  path: cityName
  name: city name
  description: Name of the city.
  datatype: string
  max count: 1
property:
  path: postalCode
  name: postal code
  description: Postal code.
  datatype: string
  max count: 1
property:
  path: provinceName
  name: province name
  description: Province or state name.
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: Country code.
  datatype: string
  max count: 1
property:
  path: streetAddress2
  name: street address2
  description: Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.
  datatype: string
  max count: 1

AdGroupShape
type: NodeShape
target class: AdGroup
property:
  path: adRotationMode
  name: ad rotation mode
  description: The ad rotation mode of the ad group.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: OPTIMIZE
  in: ROTATE_FOREVER
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The URL template for constructing a tracking URL.
  datatype: string
  max count: 1
property:
  path: targetCpmMicros
  name: target cpm micros
  description: Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
  datatype: long
  max count: 1
property:
  path: fixedCpmMicros
  name: fixed cpm micros
  description: The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
  datatype: long
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: URL template for appending params to Final URL.
  datatype: string
  max count: 1
property:
  path: aiMaxAdGroupSetting
  name: ai max ad group setting
  description: Settings for AI Max feature in standard search adgroups.
  node: AdGroupAiMaxAdGroupSettingShape
  class: AdGroupAiMaxAdGroupSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: primaryStatus
  name: primary status
  description: Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: PENDING
  in: NOT_ELIGIBLE
  in: LIMITED
property:
  path: effectiveTargetRoasSource
  name: effective target roas source
  description: Output only. Source of the effective target ROAS. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_BIDDING_STRATEGY
  in: AD_GROUP
  in: AD_GROUP_CRITERION
property:
  path: excludeDemographicExpansion
  name: exclude demographic expansion
  description: When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.
  datatype: boolean
  max count: 1
property:
  path: targetCpaMicros
  name: target cpa micros
  description: The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.
  datatype: long
  max count: 1
property:
  path: optimizedTargetingEnabled
  name: optimized targeting enabled
  description: True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
  datatype: boolean
  max count: 1
property:
  path: labels
  name: labels
  description: Output only. The resource names of labels attached to this ad group.
  write lifecycle: Read only
  datatype: string
property:
  path: effectiveCpcBidMicros
  name: effective cpc bid micros
  description: Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: excludedParentAssetFieldTypes
  name: excluded parent asset field types
  description: The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: targetCpcMicros
  name: target cpc micros
  description: Average amount in micros that the advertiser is willing to pay for every ad click. Overrides the target CPC configured at the campaign level.
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
  datatype: string
  max count: 1
property:
  path: effectiveTargetCpaSource
  name: effective target cpa source
  description: Output only. Source of the effective target CPA. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_BIDDING_STRATEGY
  in: AD_GROUP
  in: AD_GROUP_CRITERION
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. Provides reasons for why an ad group is not serving or not serving optimally.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_REMOVED
  in: CAMPAIGN_PAUSED
  in: CAMPAIGN_PENDING
  in: CAMPAIGN_ENDED
  in: AD_GROUP_PAUSED
  in: AD_GROUP_REMOVED
  in: AD_GROUP_INCOMPLETE
  in: KEYWORDS_PAUSED
  in: NO_KEYWORDS
  in: AD_GROUP_ADS_PAUSED
  in: NO_AD_GROUP_ADS
  in: HAS_ADS_DISAPPROVED
  in: HAS_ADS_LIMITED_BY_POLICY
  in: MOST_ADS_UNDER_REVIEW
  in: CAMPAIGN_DRAFT
  in: AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY
property:
  path: targetRoas
  name: target roas
  description: The target ROAS (return-on-ad-spend) for this ad group. This field lets you override the target ROAS specified in the campaign's bidding strategy, but only if the campaign is using a standard (not portfolio) `TargetRoas` strategy or a standard `MaximizeConversionValue` strategy with its `target_roas` field set. If the campaign is using a portfolio bidding strategy, this field cannot be set and attempting to do so will result in an error. For any other bidding strategies, this value is ignored. To see the actual target ROAS being used by the ad group, considering potential overrides, query the `effective_target_roas` and `effective_target_roas_source` fields.
  datatype: double
  max count: 1
property:
  path: type
  name: type
  description: Immutable. The type of the ad group.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH_STANDARD
  in: DISPLAY_STANDARD
  in: SHOPPING_PRODUCT_ADS
  in: HOTEL_ADS
  in: SHOPPING_SMART_ADS
  in: VIDEO_BUMPER
  in: VIDEO_TRUE_VIEW_IN_STREAM
  in: VIDEO_TRUE_VIEW_IN_DISPLAY
  in: VIDEO_NON_SKIPPABLE_IN_STREAM
  in: SEARCH_DYNAMIC_ADS
  in: SHOPPING_COMPARISON_LISTING_ADS
  in: PROMOTED_HOTEL_ADS
  in: VIDEO_RESPONSIVE
  in: VIDEO_EFFICIENT_REACH
  in: SMART_CAMPAIGN_ADS
  in: TRAVEL_ADS
  in: YOUTUBE_AUDIO

AdGroupAiMaxAdGroupSettingShape
type: NodeShape
target class: AdGroupAiMaxAdGroupSetting
property:
  path: disableSearchTermMatching
  name: disable search term matching
  description: Disable search term matching for this adgroup when AI Max is enabled. Search term matching uses broad match, asset-based, and landing page-based technology to improve reach.
  datatype: boolean
  max count: 1

TargetingSettingShape
type: NodeShape
target class: TargetingSetting
property:
  path: targetRestrictions
  name: target restrictions
  description: The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
  node: TargetRestrictionShape
  class: TargetRestriction
  node kind: BlankNodeOrIRI
property:
  path: targetRestrictionOperations
  name: target restriction operations
  description: The list of operations changing the target restrictions. Adding a target restriction with a targeting dimension that already exists causes the existing target restriction to be replaced with the new value.
  node: TargetRestrictionOperationShape
  class: TargetRestrictionOperation
  node kind: BlankNodeOrIRI

TargetRestrictionShape
type: NodeShape
target class: TargetRestriction
property:
  path: targetingDimension
  name: targeting dimension
  description: The targeting dimension that these settings apply to.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: KEYWORD
  in: AUDIENCE
  in: TOPIC
  in: GENDER
  in: AGE_RANGE
  in: PLACEMENT
  in: PARENTAL_STATUS
  in: INCOME_RANGE
property:
  path: bidOnly
  name: bid only
  description: Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
  datatype: boolean
  max count: 1

TargetRestrictionOperationShape
type: NodeShape
target class: TargetRestrictionOperation
property:
  path: operator
  name: operator
  description: Type of list operation to perform.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADD
  in: REMOVE
property:
  path: value
  name: value
  description: The target restriction being added to or removed from the list.
  node: TargetRestrictionShape
  class: TargetRestriction
  node kind: BlankNodeOrIRI
  max count: 1

AdGroupVideoAdGroupSettingsShape
type: NodeShape
target class: AdGroupVideoAdGroupSettings
property:
  path: videoAdSequence
  name: video ad sequence
  description: The video ads sequence step settings containing step ID.
  node: AdGroupVideoAdGroupSettingsVideoAdSequenceStepSettingShape
  class: AdGroupVideoAdGroupSettingsVideoAdSequenceStepSetting
  node kind: BlankNodeOrIRI
  max count: 1

AdGroupVideoAdGroupSettingsVideoAdSequenceStepSettingShape
type: NodeShape
target class: AdGroupVideoAdGroupSettingsVideoAdSequenceStepSetting
property:
  path: stepId
  name: step id
  description: The ID of this sequence step from an existing `campaign.video_campaign_settings.video_ad_sequence` definition. Only one Ad Group can point to a given `step_id`.
  datatype: long
  max count: 1

AdGroupAudienceSettingShape
type: NodeShape
target class: AdGroupAudienceSetting
property:
  path: useAudienceGrouped
  name: use audience grouped
  description: Immutable. If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.
  write lifecycle: Create only
  datatype: boolean
  max count: 1

AdGroupDemandGenAdGroupSettingsShape
type: NodeShape
target class: AdGroupDemandGenAdGroupSettings
property:
  path: channelControls
  name: channel controls
  description: Channel controls for Demand Gen ad groups.
  node: AdGroupDemandGenAdGroupSettingsDemandGenChannelControlsShape
  class: AdGroupDemandGenAdGroupSettingsDemandGenChannelControls
  node kind: BlankNodeOrIRI
  max count: 1

AdGroupDemandGenAdGroupSettingsDemandGenChannelControlsShape
type: NodeShape
target class: AdGroupDemandGenAdGroupSettingsDemandGenChannelControls
property:
  path: selectedChannels
  name: selected channels
  description: Explicitly selected channels. This field should be set with at least one true value when present.
  node: AdGroupDemandGenAdGroupSettingsDemandGenChannelControlsDemandGenSelectedChannelsShape
  class: AdGroupDemandGenAdGroupSettingsDemandGenChannelControlsDemandGenSelectedChannels
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: channelConfig
  name: channel config
  description: Output only. Channel configuration reflecting which field in the oneof is populated.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CHANNEL_STRATEGY
  in: SELECTED_CHANNELS
property:
  path: channelStrategy
  name: channel strategy
  description: High level channel strategy.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ALL_CHANNELS
  in: ALL_OWNED_AND_OPERATED_CHANNELS

AdGroupDemandGenAdGroupSettingsDemandGenChannelControlsDemandGenSelectedChannelsShape
type: NodeShape
target class: AdGroupDemandGenAdGroupSettingsDemandGenChannelControlsDemandGenSelectedChannels
property:
  path: youtubeInStream
  name: youtube in stream
  description: Whether to enable ads on the YouTube In-Stream channel.
  datatype: boolean
  max count: 1
property:
  path: gmail
  name: gmail
  description: Whether to enable ads on the Gmail channel.
  datatype: boolean
  max count: 1
property:
  path: youtubeInFeed
  name: youtube in feed
  description: Whether to enable ads on the YouTube In-Feed channel.
  datatype: boolean
  max count: 1
property:
  path: youtubeShorts
  name: youtube shorts
  description: Whether to enable ads on the YouTube Shorts channel.
  datatype: boolean
  max count: 1
property:
  path: discover
  name: discover
  description: Whether to enable ads on the Discover channel.
  datatype: boolean
  max count: 1
property:
  path: maps
  name: maps
  description: Whether to enable ads on the Maps channel.
  datatype: boolean
  max count: 1
property:
  path: display
  name: display
  description: Whether to enable ads on the Display channel.
  datatype: boolean
  max count: 1

AdGroupVerticalAdsFormatSettingShape
type: NodeShape
target class: AdGroupVerticalAdsFormatSetting
property:
  path: enableVerticalPromotionAds
  name: enable vertical promotion ads
  description: If true, vertical promotion ads will be enabled for this ad group.
  datatype: boolean
  max count: 1
property:
  path: disableTextAds
  name: disable text ads
  description: If true, text ads will be disabled for this ad group.
  datatype: boolean
  max count: 1
property:
  path: enableBookingLinks
  name: enable booking links
  description: If true, booking links will be enabled for this ad group.
  datatype: boolean
  max count: 1

AdGroupAdShape
type: NodeShape
target class: AdGroupAd
property:
  path: ad
  name: ad
  description: Immutable. The ad.
  write lifecycle: Create only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: primaryStatus
  name: primary status
  description: Output only. Provides aggregated view into why an ad group ad is not serving or not serving optimally.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: PENDING
  in: LIMITED
  in: NOT_ELIGIBLE
property:
  path: adGroup
  name: ad group
  description: Immutable. The ad group to which the ad belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: adStrength
  name: ad strength
  description: Output only. Overall ad strength for this ad group ad.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: NO_ADS
  in: POOR
  in: AVERAGE
  in: GOOD
  in: EXCELLENT
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad. Ad group ad resource names have the form: `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: labels
  name: labels
  description: Output only. The resource names of labels attached to this ad group ad.
  write lifecycle: Read only
  datatype: string
property:
  path: startDateTime
  name: start date time
  description: The date and time when ad group ad starts serving. This is added on top of the campaign's start date and time, if present, to further restrict the duration of an ad group ad. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Only supported for some ad types.
  datatype: string
  max count: 1
property:
  path: policySummary
  name: policy summary
  description: Output only. Policy information for the ad.
  write lifecycle: Read only
  node: AdGroupAdPolicySummaryShape
  class: AdGroupAdPolicySummary
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. Provides reasons for why an ad group ad is not serving or not serving optimally.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_REMOVED
  in: CAMPAIGN_PAUSED
  in: CAMPAIGN_PENDING
  in: CAMPAIGN_ENDED
  in: AD_GROUP_PAUSED
  in: AD_GROUP_REMOVED
  in: AD_GROUP_AD_PAUSED
  in: AD_GROUP_AD_REMOVED
  in: AD_GROUP_AD_DISAPPROVED
  in: AD_GROUP_AD_UNDER_REVIEW
  in: AD_GROUP_AD_POOR_QUALITY
  in: AD_GROUP_AD_NO_ADS
  in: AD_GROUP_AD_APPROVED_LABELED
  in: AD_GROUP_AD_AREA_OF_INTEREST_ONLY
  in: AD_GROUP_AD_UNDER_APPEAL
property:
  path: endDateTime
  name: end date time
  description: The last day and time when ad group ad serves. This is added on top of the campaign's end date and time, if present, to further restrict the duration of an ad group ad. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Only supported for some ad types.
  datatype: string
  max count: 1
property:
  path: adGroupAdAssetAutomationSettings
  name: ad group ad asset automation settings
  description: Settings that control the types of asset automation. See the AssetAutomationTypeEnum documentation for the default opt in/out behavior of each type.
  node: AdGroupAdAssetAutomationSettingShape
  class: AdGroupAdAssetAutomationSetting
  node kind: BlankNodeOrIRI
property:
  path: actionItems
  name: action items
  description: Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Try adding a few more unique headlines or unpinning some assets.".
  write lifecycle: Read only
  datatype: string
property:
  path: status
  name: status
  description: The status of the ad.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: PAUSED
  in: REMOVED

AdGroupAdPolicySummaryShape
type: NodeShape
target class: AdGroupAdPolicySummary
property:
  path: approvalStatus
  name: approval status
  description: Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISAPPROVED
  in: APPROVED_LIMITED
  in: APPROVED
  in: AREA_OF_INTEREST_ONLY
property:
  path: policyTopicEntries
  name: policy topic entries
  description: Output only. The list of policy findings for this ad.
  write lifecycle: Read only
  node: PolicyTopicEntryShape
  class: PolicyTopicEntry
  node kind: BlankNodeOrIRI
property:
  path: reviewStatus
  name: review status
  description: Output only. Where in the review process this ad is.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REVIEW_IN_PROGRESS
  in: REVIEWED
  in: UNDER_APPEAL
  in: ELIGIBLE_MAY_SERVE

AdGroupAdAssetAutomationSettingShape
type: NodeShape
target class: AdGroupAdAssetAutomationSetting
property:
  path: assetAutomationType
  name: asset automation type
  description: The asset automation type that this setting configures.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TEXT_ASSET_AUTOMATION
  in: GENERATE_VERTICAL_YOUTUBE_VIDEOS
  in: GENERATE_SHORTER_YOUTUBE_VIDEOS
  in: GENERATE_LANDING_PAGE_PREVIEW
  in: GENERATE_LANDING_PAGE_TEXT
  in: GENERATE_ENHANCED_YOUTUBE_VIDEOS
  in: GENERATE_IMAGE_ENHANCEMENT
  in: GENERATE_IMAGE_EXTRACTION
  in: GENERATE_DESIGN_VERSIONS_FOR_IMAGES
  in: FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION
  in: GENERATE_VIDEOS_FROM_OTHER_ASSETS
property:
  path: assetAutomationStatus
  name: asset automation status
  description: The opt-in/out status for the specified asset automation type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: OPTED_IN
  in: OPTED_OUT

AdGroupAdAssetCombinationViewShape
type: NodeShape
target class: AdGroupAdAssetCombinationView
property:
  path: enabled
  name: enabled
  description: 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.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the ad group ad asset combination view. The combination ID is 128 bits long, where the upper 64 bits are stored in asset_combination_id_high, and the lower 64 bits are stored in asset_combination_id_low. AdGroupAd Asset Combination view resource names have the form: `customers/{customer_id}/adGroupAdAssetCombinationViews/{AdGroupAd.ad_group_id}~{AdGroupAd.ad.ad_id}~{AssetCombination.asset_combination_id_low}~{AssetCombination.asset_combination_id_high}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: servedAssets
  name: served assets
  description: Output only. Served assets.
  write lifecycle: Read only
  node: AssetUsageShape
  class: AssetUsage
  node kind: BlankNodeOrIRI

AssetUsageShape
type: NodeShape
target class: AssetUsage
property:
  path: asset
  name: asset
  description: Resource name of the asset.
  datatype: string
  max count: 1
property:
  path: servedAssetFieldType
  name: served asset field type
  description: The served field type of the asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE_1
  in: HEADLINE_2
  in: HEADLINE_3
  in: DESCRIPTION_1
  in: DESCRIPTION_2
  in: HEADLINE
  in: HEADLINE_IN_PORTRAIT
  in: LONG_HEADLINE
  in: DESCRIPTION
  in: DESCRIPTION_IN_PORTRAIT
  in: BUSINESS_NAME_IN_PORTRAIT
  in: BUSINESS_NAME
  in: MARKETING_IMAGE
  in: MARKETING_IMAGE_IN_PORTRAIT
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: CALL_TO_ACTION
  in: YOU_TUBE_VIDEO
  in: SITELINK
  in: CALL
  in: MOBILE_APP
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: PRICE
  in: PROMOTION
  in: AD_IMAGE
  in: LEAD_FORM
  in: BUSINESS_LOGO
  in: DESCRIPTION_PREFIX
  in: HEADLINE_AS_SITELINK_POSITION_ONE
  in: HEADLINE_AS_SITELINK_POSITION_TWO
  in: DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_ONE
  in: DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_TWO

AdGroupAdAssetPolicySummaryShape
type: NodeShape
target class: AdGroupAdAssetPolicySummary
property:
  path: approvalStatus
  name: approval status
  description: Output only. The overall approval status of this ad group ad asset, calculated based on the status of its individual policy topic entries.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISAPPROVED
  in: APPROVED_LIMITED
  in: APPROVED
  in: AREA_OF_INTEREST_ONLY
property:
  path: policyTopicEntries
  name: policy topic entries
  description: Output only. The list of policy findings for the ad group ad asset.
  write lifecycle: Read only
  node: PolicyTopicEntryShape
  class: PolicyTopicEntry
  node kind: BlankNodeOrIRI
property:
  path: reviewStatus
  name: review status
  description: Output only. Where in the review process this ad group ad asset is.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REVIEW_IN_PROGRESS
  in: REVIEWED
  in: UNDER_APPEAL
  in: ELIGIBLE_MAY_SERVE

AdGroupAdAssetViewShape
type: NodeShape
target class: AdGroupAdAssetView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4): `customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}` Ad group ad asset view resource names have the form (Beginning from V4): `customers/{customer_id}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: Output only. Role that the asset takes in the ad.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: enabled
  name: enabled
  description: 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.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: pinnedField
  name: pinned field
  description: Output only. Pinned field.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE_1
  in: HEADLINE_2
  in: HEADLINE_3
  in: DESCRIPTION_1
  in: DESCRIPTION_2
  in: HEADLINE
  in: HEADLINE_IN_PORTRAIT
  in: LONG_HEADLINE
  in: DESCRIPTION
  in: DESCRIPTION_IN_PORTRAIT
  in: BUSINESS_NAME_IN_PORTRAIT
  in: BUSINESS_NAME
  in: MARKETING_IMAGE
  in: MARKETING_IMAGE_IN_PORTRAIT
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: CALL_TO_ACTION
  in: YOU_TUBE_VIDEO
  in: SITELINK
  in: CALL
  in: MOBILE_APP
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: PRICE
  in: PROMOTION
  in: AD_IMAGE
  in: LEAD_FORM
  in: BUSINESS_LOGO
  in: DESCRIPTION_PREFIX
  in: HEADLINE_AS_SITELINK_POSITION_ONE
  in: HEADLINE_AS_SITELINK_POSITION_TWO
  in: DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_ONE
  in: DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_TWO
property:
  path: asset
  name: asset
  description: Output only. The asset which is linked to the ad group ad.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: performanceLabel
  name: performance label
  description: Output only. Performance of an asset linkage.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: LEARNING
  in: LOW
  in: GOOD
  in: BEST
  in: NOT_APPLICABLE
property:
  path: source
  name: source
  description: Output only. Source of the ad group ad asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: adGroupAd
  name: ad group ad
  description: Output only. The ad group ad to which the asset is linked.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: policySummary
  name: policy summary
  description: Output only. Policy information for the ad group ad asset.
  write lifecycle: Read only
  node: AdGroupAdAssetPolicySummaryShape
  class: AdGroupAdAssetPolicySummary
  node kind: BlankNodeOrIRI
  max count: 1

AdGroupAdLabelShape
type: NodeShape
target class: AdGroupAdLabel
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: adGroupAd
  name: ad group ad
  description: Immutable. The ad group ad to which the label is attached.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: label
  name: label
  description: Immutable. The label assigned to the ad group ad.
  write lifecycle: Create only
  datatype: string
  max count: 1

AdGroupAssetShape
type: NodeShape
target class: AdGroupAsset
property:
  path: asset
  name: asset
  description: Required. Immutable. The asset which is linked to the ad group.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: source
  name: source
  description: Output only. Source of the adgroup asset link.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: primaryStatus
  name: primary status
  description: Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: PENDING
  in: LIMITED
  in: NOT_ELIGIBLE
property:
  path: primaryStatusDetails
  name: primary status details
  description: Output only. Provides the details of the primary status and its associated reasons.
  write lifecycle: Read only
  node: AssetLinkPrimaryStatusDetailsShape
  class: AssetLinkPrimaryStatusDetails
  node kind: BlankNodeOrIRI
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: ASSET_LINK_PAUSED
  in: ASSET_LINK_REMOVED
  in: ASSET_DISAPPROVED
  in: ASSET_UNDER_REVIEW
  in: ASSET_APPROVED_LABELED
property:
  path: adGroup
  name: ad group
  description: Required. Immutable. The ad group to which the asset is linked.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group asset. AdGroupAsset resource names have the form: `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: Required. Immutable. Role that the asset takes under the linked ad group.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: status
  name: status
  description: Status of the ad group asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: PAUSED

AssetLinkPrimaryStatusDetailsShape
type: NodeShape
target class: AssetLinkPrimaryStatusDetails
property:
  path: assetDisapproved
  name: asset disapproved
  description: Provides the details for AssetLinkPrimaryStatusReason.ASSET_DISAPPROVED
  node: AssetDisapprovedShape
  class: AssetDisapproved
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: status
  name: status
  description: Provides the PrimaryStatus of this status detail.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: PENDING
  in: LIMITED
  in: NOT_ELIGIBLE
property:
  path: reason
  name: reason
  description: Provides the reason of this PrimaryStatus.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ASSET_LINK_PAUSED
  in: ASSET_LINK_REMOVED
  in: ASSET_DISAPPROVED
  in: ASSET_UNDER_REVIEW
  in: ASSET_APPROVED_LABELED

AssetDisapprovedShape
type: NodeShape
target class: AssetDisapproved
property:
  path: offlineEvaluationErrorReasons
  name: offline evaluation error reasons
  description: Provides the quality evaluation disapproval reason of an asset.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: PRICE_ASSET_DESCRIPTION_REPEATS_ROW_HEADER
  in: PRICE_ASSET_REPETITIVE_HEADERS
  in: PRICE_ASSET_HEADER_INCOMPATIBLE_WITH_PRICE_TYPE
  in: PRICE_ASSET_DESCRIPTION_INCOMPATIBLE_WITH_ITEM_HEADER
  in: PRICE_ASSET_DESCRIPTION_HAS_PRICE_QUALIFIER
  in: PRICE_ASSET_UNSUPPORTED_LANGUAGE
  in: PRICE_ASSET_OTHER_ERROR

AdGroupAssetSetShape
type: NodeShape
target class: AdGroupAssetSet
property:
  path: adGroup
  name: ad group
  description: Immutable. The ad group to which this asset set is linked.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group asset set. Ad group asset set resource names have the form: `customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: assetSet
  name: asset set
  description: Immutable. The asset set which is linked to the ad group.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the ad group asset set. Read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED

AdGroupAudienceViewShape
type: NodeShape
target class: AdGroupAudienceView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the ad group audience view. Ad group audience view resource names have the form: `customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

AdGroupBidModifierShape
type: NodeShape
target class: AdGroupBidModifier
property:
  path: hotelLengthOfStay
  name: hotel length of stay
  description: Immutable. Criterion for length of hotel stay in nights.
  write lifecycle: Create only
  node: HotelLengthOfStayInfoShape
  class: HotelLengthOfStayInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: bidModifierSource
  name: bid modifier source
  description: Output only. Bid modifier source.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN
  in: AD_GROUP
property:
  path: hotelAdvanceBookingWindow
  name: hotel advance booking window
  description: Immutable. Criterion for number of days prior to the stay the booking is being made.
  write lifecycle: Create only
  node: HotelAdvanceBookingWindowInfoShape
  class: HotelAdvanceBookingWindowInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelCheckInDay
  name: hotel check in day
  description: Immutable. Criterion for day of the week the booking is for.
  write lifecycle: Create only
  node: HotelCheckInDayInfoShape
  class: HotelCheckInDayInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: device
  name: device
  description: Immutable. A device criterion.
  write lifecycle: Create only
  node: DeviceInfoShape
  class: DeviceInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelDateSelectionType
  name: hotel date selection type
  description: Immutable. Criterion for hotel date selection (default dates versus user selected).
  write lifecycle: Create only
  node: HotelDateSelectionTypeInfoShape
  class: HotelDateSelectionTypeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelCheckInDateRange
  name: hotel check in date range
  description: Immutable. Criterion for a hotel check-in date range.
  write lifecycle: Create only
  node: HotelCheckInDateRangeInfoShape
  class: HotelCheckInDateRangeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: criterionId
  name: criterion id
  description: Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: bidModifier
  name: bid modifier
  description: The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Use 0 to opt out of a Device type.
  datatype: double
  max count: 1
property:
  path: adGroup
  name: ad group
  description: Immutable. The ad group to which this criterion belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: baseAdGroup
  name: base ad group
  description: Output only. The base ad group from which this draft/trial adgroup bid modifier was created. If ad_group is a base ad group then this field will be equal to ad_group. If the ad group was created in the draft or trial and has no corresponding base ad group, then this field will be null. This field is readonly.
  write lifecycle: Read only
  datatype: string
  max count: 1

HotelLengthOfStayInfoShape
type: NodeShape
target class: HotelLengthOfStayInfo
property:
  path: minNights
  name: min nights
  description: Low end of the number of nights in the stay.
  datatype: long
  max count: 1
property:
  path: maxNights
  name: max nights
  description: High end of the number of nights in the stay.
  datatype: long
  max count: 1

HotelAdvanceBookingWindowInfoShape
type: NodeShape
target class: HotelAdvanceBookingWindowInfo
property:
  path: minDays
  name: min days
  description: Low end of the number of days prior to the stay.
  datatype: long
  max count: 1
property:
  path: maxDays
  name: max days
  description: High end of the number of days prior to the stay.
  datatype: long
  max count: 1

HotelCheckInDayInfoShape
type: NodeShape
target class: HotelCheckInDayInfo
property:
  path: dayOfWeek
  name: day of week
  description: The day of the week.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MONDAY
  in: TUESDAY
  in: WEDNESDAY
  in: THURSDAY
  in: FRIDAY
  in: SATURDAY
  in: SUNDAY

DeviceInfoShape
type: NodeShape
target class: DeviceInfo
property:
  path: type
  name: type
  description: Type of the device.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MOBILE
  in: TABLET
  in: DESKTOP
  in: CONNECTED_TV
  in: OTHER

HotelDateSelectionTypeInfoShape
type: NodeShape
target class: HotelDateSelectionTypeInfo
property:
  path: type
  name: type
  description: Type of the hotel date selection
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DEFAULT_SELECTION
  in: USER_SELECTED

HotelCheckInDateRangeInfoShape
type: NodeShape
target class: HotelCheckInDateRangeInfo
property:
  path: startDate
  name: start date
  description: Start date in the YYYY-MM-DD format.
  datatype: string
  max count: 1
property:
  path: endDate
  name: end date
  description: End date in the YYYY-MM-DD format.
  datatype: string
  max count: 1

AdGroupCreativeAssetCombinationDataShape
type: NodeShape
target class: AdGroupCreativeAssetCombinationData
property:
  path: assetCombinationServedAssets
  name: asset combination served assets
  description: Output only. Served assets.
  write lifecycle: Read only
  node: AssetUsageShape
  class: AssetUsage
  node kind: BlankNodeOrIRI

AdGroupCriterionShape
type: NodeShape
target class: AdGroupCriterion
property:
  path: language
  name: language
  description: Immutable. Language.
  write lifecycle: Create only
  node: LanguageInfoShape
  class: LanguageInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cpvBidMicros
  name: cpv bid micros
  description: The CPV (cost-per-view) bid.
  datatype: long
  max count: 1
property:
  path: brandList
  name: brand list
  description: Immutable. Brand list criterion.
  write lifecycle: Create only
  node: BrandListInfoShape
  class: BrandListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: topic
  name: topic
  description: Immutable. Topic.
  write lifecycle: Create only
  node: TopicInfoShape
  class: TopicInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mobileAppCategory
  name: mobile app category
  description: Immutable. Mobile app category.
  write lifecycle: Create only
  node: MobileAppCategoryInfoShape
  class: MobileAppCategoryInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cpcBidMicros
  name: cpc bid micros
  description: The CPC (cost-per-click) bid.
  datatype: long
  max count: 1
property:
  path: displayName
  name: display name
  description: Output only. The display name of the criterion. This field is ignored for mutates.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroup
  name: ad group
  description: Immutable. The ad group to which the criterion belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: cpmBidMicros
  name: cpm bid micros
  description: The CPM (cost-per-thousand viewable impressions) bid.
  datatype: long
  max count: 1
property:
  path: ageRange
  name: age range
  description: Immutable. Age range.
  write lifecycle: Create only
  node: AgeRangeInfoShape
  class: AgeRangeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: qualityInfo
  name: quality info
  description: Output only. Information regarding the quality of the criterion.
  write lifecycle: Read only
  node: AdGroupCriterionQualityInfoShape
  class: AdGroupCriterionQualityInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: keyword
  name: keyword
  description: Immutable. Keyword.
  write lifecycle: Create only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: extendedDemographic
  name: extended demographic
  description: Immutable. Extended demographic criterion.
  write lifecycle: Create only
  node: ExtendedDemographicInfoShape
  class: ExtendedDemographicInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: listingGroup
  name: listing group
  description: Immutable. Listing group.
  write lifecycle: Create only
  node: ListingGroupInfoShape
  class: ListingGroupInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: effectiveCpvBidSource
  name: effective cpv bid source
  description: Output only. Source of the effective CPV bid.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_BIDDING_STRATEGY
  in: AD_GROUP
  in: AD_GROUP_CRITERION
property:
  path: trackingUrlTemplate
  name: tracking url template
  description: The URL template for constructing a tracking URL.
  datatype: string
  max count: 1
property:
  path: effectivePercentCpcBidSource
  name: effective percent cpc bid source
  description: Output only. Source of the effective Percent CPC bid.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_BIDDING_STRATEGY
  in: AD_GROUP
  in: AD_GROUP_CRITERION
property:
  path: labels
  name: labels
  description: Output only. The resource names of labels attached to this ad group criterion.
  write lifecycle: Read only
  datatype: string
property:
  path: disapprovalReasons
  name: disapproval reasons
  description: Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942 This field is read-only.
  write lifecycle: Read only
  datatype: string
property:
  path: mobileApplication
  name: mobile application
  description: Immutable. Mobile application.
  write lifecycle: Create only
  node: MobileApplicationInfoShape
  class: MobileApplicationInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalMobileUrls
  name: final mobile urls
  description: The list of possible final mobile URLs after all cross-domain redirects.
  datatype: string
property:
  path: userList
  name: user list
  description: Immutable. User List.
  write lifecycle: Create only
  node: UserListInfoShape
  class: UserListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: effectiveCpcBidSource
  name: effective cpc bid source
  description: Output only. Source of the effective CPC bid.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_BIDDING_STRATEGY
  in: AD_GROUP
  in: AD_GROUP_CRITERION
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. The primary status reasons for the ad group criterion.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_PENDING
  in: CAMPAIGN_CRITERION_NEGATIVE
  in: CAMPAIGN_PAUSED
  in: CAMPAIGN_REMOVED
  in: CAMPAIGN_ENDED
  in: AD_GROUP_PAUSED
  in: AD_GROUP_REMOVED
  in: AD_GROUP_CRITERION_DISAPPROVED
  in: AD_GROUP_CRITERION_RARELY_SERVED
  in: AD_GROUP_CRITERION_LOW_QUALITY
  in: AD_GROUP_CRITERION_UNDER_REVIEW
  in: AD_GROUP_CRITERION_PENDING_REVIEW
  in: AD_GROUP_CRITERION_BELOW_FIRST_PAGE_BID
  in: AD_GROUP_CRITERION_NEGATIVE
  in: AD_GROUP_CRITERION_RESTRICTED
  in: AD_GROUP_CRITERION_PAUSED
  in: AD_GROUP_CRITERION_PAUSED_DUE_TO_LOW_ACTIVITY
  in: AD_GROUP_CRITERION_REMOVED

LanguageInfoShape
type: NodeShape
target class: LanguageInfo
property:
  path: languageConstant
  name: language constant
  description: The language constant resource name.
  datatype: string
  max count: 1

BrandListInfoShape
type: NodeShape
target class: BrandListInfo
property:
  path: sharedSet
  name: shared set
  description: Shared set resource name of the brand list.
  datatype: string
  max count: 1

TopicInfoShape
type: NodeShape
target class: TopicInfo
property:
  path: topicConstant
  name: topic constant
  description: The Topic Constant resource name.
  datatype: string
  max count: 1
property:
  path: path
  name: path
  description: 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.
  datatype: string

MobileAppCategoryInfoShape
type: NodeShape
target class: MobileAppCategoryInfo
property:
  path: mobileAppCategoryConstant
  name: mobile app category constant
  description: The mobile app category constant resource name.
  datatype: string
  max count: 1

AgeRangeInfoShape
type: NodeShape
target class: AgeRangeInfo
property:
  path: type
  name: type
  description: Type of the age range.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AGE_RANGE_18_24
  in: AGE_RANGE_25_34
  in: AGE_RANGE_35_44
  in: AGE_RANGE_45_54
  in: AGE_RANGE_55_64
  in: AGE_RANGE_65_UP
  in: AGE_RANGE_UNDETERMINED

AdGroupCriterionQualityInfoShape
type: NodeShape
target class: AdGroupCriterionQualityInfo
property:
  path: creativeQualityScore
  name: creative quality score
  description: Output only. The performance of the ad compared to other advertisers.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BELOW_AVERAGE
  in: AVERAGE
  in: ABOVE_AVERAGE
property:
  path: searchPredictedCtr
  name: search predicted ctr
  description: Output only. The click-through rate compared to that of other advertisers.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BELOW_AVERAGE
  in: AVERAGE
  in: ABOVE_AVERAGE
property:
  path: qualityScore
  name: quality score
  description: Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: postClickQualityScore
  name: post click quality score
  description: Output only. The quality score of the landing page.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BELOW_AVERAGE
  in: AVERAGE
  in: ABOVE_AVERAGE

KeywordInfoShape
type: NodeShape
target class: KeywordInfo
property:
  path: matchType
  name: match type
  description: The match type of the keyword.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXACT
  in: PHRASE
  in: BROAD
property:
  path: text
  name: text
  description: The text of the keyword (at most 80 characters and 10 words).
  datatype: string
  max count: 1

ExtendedDemographicInfoShape
type: NodeShape
target class: ExtendedDemographicInfo
property:
  path: extendedDemographicId
  name: extended demographic id
  description: Taxonomy id of the extended demographic group.
  datatype: long
  max count: 1

ListingGroupInfoShape
type: NodeShape
target class: ListingGroupInfo
property:
  path: type
  name: type
  description: Type of the listing group.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SUBDIVISION
  in: UNIT
property:
  path: caseValue
  name: case value
  description: Dimension value with which this listing group is refining its parent. Undefined for the root group.
  node: ListingDimensionInfoShape
  class: ListingDimensionInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: parentAdGroupCriterion
  name: parent ad group criterion
  description: Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
  datatype: string
  max count: 1
property:
  path: path
  name: path
  description: The path of dimensions defining this listing group.
  node: ListingDimensionPathShape
  class: ListingDimensionPath
  node kind: BlankNodeOrIRI
  max count: 1

ListingDimensionInfoShape
type: NodeShape
target class: ListingDimensionInfo
property:
  path: productChannel
  name: product channel
  description: Locality of a product offer.
  node: ProductChannelInfoShape
  class: ProductChannelInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: unknownListingDimension
  name: unknown listing dimension
  description: Unknown dimension. Set when no other listing dimension is set.
  node: UnknownListingDimensionInfoShape
  class: UnknownListingDimensionInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: activityId
  name: activity id
  description: Advertiser-specific activity ID.
  node: ActivityIdInfoShape
  class: ActivityIdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelId
  name: hotel id
  description: Advertiser-specific hotel ID.
  node: HotelIdInfoShape
  class: HotelIdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productCategory
  name: product category
  description: Category of a product offer.
  node: ProductCategoryInfoShape
  class: ProductCategoryInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: activityCountry
  name: activity country
  description: The country where the travel activity is available.
  node: ActivityCountryInfoShape
  class: ActivityCountryInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productLegacyCondition
  name: product legacy condition
  description: Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
  node: ProductLegacyConditionInfoShape
  class: ProductLegacyConditionInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelState
  name: hotel state
  description: State the hotel is located in.
  node: HotelStateInfoShape
  class: HotelStateInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productLabels
  name: product labels
  description: Labels of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
  node: ProductLabelsInfoShape
  class: ProductLabelsInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productItemId
  name: product item id
  description: Item id of a product offer.
  node: ProductItemIdInfoShape
  class: ProductItemIdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelClass
  name: hotel class
  description: Class of the hotel as a number of stars 1 to 5.
  node: HotelClassInfoShape
  class: HotelClassInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productCondition
  name: product condition
  description: Condition of a product offer.
  node: ProductConditionInfoShape
  class: ProductConditionInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productChannelExclusivity
  name: product channel exclusivity
  description: Availability of a product offer.
  node: ProductChannelExclusivityInfoShape
  class: ProductChannelExclusivityInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: activityState
  name: activity state
  description: The state where the travel activity is available.
  node: ActivityStateInfoShape
  class: ActivityStateInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productType
  name: product type
  description: Type of a product offer.
  node: ProductTypeInfoShape
  class: ProductTypeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: activityCity
  name: activity city
  description: The city where the travel activity is available.
  node: ActivityCityInfoShape
  class: ActivityCityInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productBrand
  name: product brand
  description: Brand of a product offer.
  node: ProductBrandInfoShape
  class: ProductBrandInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productGrouping
  name: product grouping
  description: Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
  node: ProductGroupingInfoShape
  class: ProductGroupingInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelCountryRegion
  name: hotel country region
  description: Country or Region the hotel is located in.
  node: HotelCountryRegionInfoShape
  class: HotelCountryRegionInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelCity
  name: hotel city
  description: City the hotel is located in.
  node: HotelCityInfoShape
  class: HotelCityInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productCustomAttribute
  name: product custom attribute
  description: Custom attribute of a product offer.
  node: ProductCustomAttributeInfoShape
  class: ProductCustomAttributeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: activityRating
  name: activity rating
  description: Rating of the activity as a number 1 to 5, where 5 is the best.
  node: ActivityRatingInfoShape
  class: ActivityRatingInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productTypeFull
  name: product type full
  description: Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
  node: ProductTypeFullInfoShape
  class: ProductTypeFullInfo
  node kind: BlankNodeOrIRI
  max count: 1

ProductChannelInfoShape
type: NodeShape
target class: ProductChannelInfo
property:
  path: channel
  name: channel
  description: Value of the locality.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ONLINE
  in: LOCAL

HotelIdInfoShape
type: NodeShape
target class: HotelIdInfo
property:
  path: value
  name: value
  description: String value of the hotel ID.
  datatype: string
  max count: 1

ProductCategoryInfoShape
type: NodeShape
target class: ProductCategoryInfo
property:
  path: categoryId
  name: category id
  description: 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
  datatype: long
  max count: 1
property:
  path: level
  name: level
  description: Level of the product category.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LEVEL1
  in: LEVEL2
  in: LEVEL3
  in: LEVEL4
  in: LEVEL5

ProductLegacyConditionInfoShape
type: NodeShape
target class: ProductLegacyConditionInfo
property:
  path: value
  name: value
  description: String value of the product legacy condition.
  datatype: string
  max count: 1

HotelStateInfoShape
type: NodeShape
target class: HotelStateInfo
property:
  path: stateCriterion
  name: state criterion
  description: The Geo Target Constant resource name.
  datatype: string
  max count: 1

ProductLabelsInfoShape
type: NodeShape
target class: ProductLabelsInfo
property:
  path: value
  name: value
  description: String value of the product labels.
  datatype: string
  max count: 1

ProductItemIdInfoShape
type: NodeShape
target class: ProductItemIdInfo
property:
  path: value
  name: value
  description: Value of the id.
  datatype: string
  max count: 1

HotelClassInfoShape
type: NodeShape
target class: HotelClassInfo
property:
  path: value
  name: value
  description: Long value of the hotel class.
  datatype: long
  max count: 1

ProductConditionInfoShape
type: NodeShape
target class: ProductConditionInfo
property:
  path: condition
  name: condition
  description: Value of the condition.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEW
  in: REFURBISHED
  in: USED

ProductChannelExclusivityInfoShape
type: NodeShape
target class: ProductChannelExclusivityInfo
property:
  path: channelExclusivity
  name: channel exclusivity
  description: Value of the availability.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SINGLE_CHANNEL
  in: MULTI_CHANNEL

ProductTypeInfoShape
type: NodeShape
target class: ProductTypeInfo
property:
  path: value
  name: value
  description: Value of the type.
  datatype: string
  max count: 1
property:
  path: level
  name: level
  description: Level of the type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LEVEL1
  in: LEVEL2
  in: LEVEL3
  in: LEVEL4
  in: LEVEL5

ProductBrandInfoShape
type: NodeShape
target class: ProductBrandInfo
property:
  path: value
  name: value
  description: String value of the product brand.
  datatype: string
  max count: 1

ProductGroupingInfoShape
type: NodeShape
target class: ProductGroupingInfo
property:
  path: value
  name: value
  description: String value of the product grouping.
  datatype: string
  max count: 1

HotelCountryRegionInfoShape
type: NodeShape
target class: HotelCountryRegionInfo
property:
  path: countryRegionCriterion
  name: country region criterion
  description: The Geo Target Constant resource name.
  datatype: string
  max count: 1

HotelCityInfoShape
type: NodeShape
target class: HotelCityInfo
property:
  path: cityCriterion
  name: city criterion
  description: The Geo Target Constant resource name.
  datatype: string
  max count: 1

ProductCustomAttributeInfoShape
type: NodeShape
target class: ProductCustomAttributeInfo
property:
  path: value
  name: value
  description: String value of the product custom attribute.
  datatype: string
  max count: 1
property:
  path: index
  name: index
  description: Indicates the index of the custom attribute.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INDEX0
  in: INDEX1
  in: INDEX2
  in: INDEX3
  in: INDEX4

ProductTypeFullInfoShape
type: NodeShape
target class: ProductTypeFullInfo
property:
  path: value
  name: value
  description: String value of the product full type.
  datatype: string
  max count: 1

ListingDimensionPathShape
type: NodeShape
target class: ListingDimensionPath
property:
  path: dimensions
  name: dimensions
  description: The complete path of dimensions through the listing group hierarchy, from the root (excluding the root itself) to this listing group.
  node: ListingDimensionInfoShape
  class: ListingDimensionInfo
  node kind: BlankNodeOrIRI

MobileApplicationInfoShape
type: NodeShape
target class: MobileApplicationInfo
property:
  path: appId
  name: app id
  description: A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations.
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Name of this mobile application.
  datatype: string
  max count: 1

UserListInfoShape
type: NodeShape
target class: UserListInfo
property:
  path: userList
  name: user list
  description: The User List resource name.
  datatype: string
  max count: 1

AppPaymentModelInfoShape
type: NodeShape
target class: AppPaymentModelInfo
property:
  path: type
  name: type
  description: Type of the app payment model.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PAID

CustomIntentInfoShape
type: NodeShape
target class: CustomIntentInfo
property:
  path: customIntent
  name: custom intent
  description: The CustomInterest resource name.
  datatype: string
  max count: 1

CustomAudienceInfoShape
type: NodeShape
target class: CustomAudienceInfo
property:
  path: customAudience
  name: custom audience
  description: The CustomAudience resource name.
  datatype: string
  max count: 1

YouTubeChannelInfoShape
type: NodeShape
target class: YouTubeChannelInfo
property:
  path: channelId
  name: channel id
  description: The YouTube uploader channel id or the channel code of a YouTube channel.
  datatype: string
  max count: 1

WebpageInfoShape
type: NodeShape
target class: WebpageInfo
property:
  path: criterionName
  name: criterion name
  description: The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
  datatype: string
  max count: 1
property:
  path: coveragePercentage
  name: coverage percentage
  description: Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
  datatype: double
  max count: 1
property:
  path: sample
  name: sample
  description: List of sample urls that match the website target. This field is read-only.
  node: WebpageSampleInfoShape
  class: WebpageSampleInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conditions
  name: conditions
  description: Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
  node: WebpageConditionInfoShape
  class: WebpageConditionInfo
  node kind: BlankNodeOrIRI

WebpageSampleInfoShape
type: NodeShape
target class: WebpageSampleInfo
property:
  path: sampleUrls
  name: sample urls
  description: Webpage sample urls
  datatype: string

WebpageConditionInfoShape
type: NodeShape
target class: WebpageConditionInfo
property:
  path: operand
  name: operand
  description: Operand of webpage targeting condition.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: URL
  in: CATEGORY
  in: PAGE_TITLE
  in: PAGE_CONTENT
  in: CUSTOM_LABEL
property:
  path: operator
  name: operator
  description: Operator of webpage targeting condition.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EQUALS
  in: CONTAINS
property:
  path: argument
  name: argument
  description: Argument of webpage targeting condition.
  datatype: string
  max count: 1

YouTubeVideoInfoShape
type: NodeShape
target class: YouTubeVideoInfo
property:
  path: videoId
  name: video id
  description: YouTube video id as it appears on the YouTube watch page.
  datatype: string
  max count: 1

AudienceInfoShape
type: NodeShape
target class: AudienceInfo
property:
  path: audience
  name: audience
  description: The Audience resource name.
  datatype: string
  max count: 1

GenderInfoShape
type: NodeShape
target class: GenderInfo
property:
  path: type
  name: type
  description: Type of the gender.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MALE
  in: FEMALE
  in: UNDETERMINED

IncomeRangeInfoShape
type: NodeShape
target class: IncomeRangeInfo
property:
  path: type
  name: type
  description: Type of the income range.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INCOME_RANGE_0_50
  in: INCOME_RANGE_50_60
  in: INCOME_RANGE_60_70
  in: INCOME_RANGE_70_80
  in: INCOME_RANGE_80_90
  in: INCOME_RANGE_90_UP
  in: INCOME_RANGE_UNDETERMINED

CombinedAudienceInfoShape
type: NodeShape
target class: CombinedAudienceInfo
property:
  path: combinedAudience
  name: combined audience
  description: The CombinedAudience resource name.
  datatype: string
  max count: 1

LifeEventInfoShape
type: NodeShape
target class: LifeEventInfo
property:
  path: lifeEventId
  name: life event id
  description: Taxonomy id of the life event.
  datatype: long
  max count: 1

PlacementInfoShape
type: NodeShape
target class: PlacementInfo
property:
  path: url
  name: url
  description: URL of the placement. For example, "http://www.domain.com".
  datatype: string
  max count: 1

ParentalStatusInfoShape
type: NodeShape
target class: ParentalStatusInfo
property:
  path: type
  name: type
  description: Type of the parental status.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PARENT
  in: NOT_A_PARENT
  in: UNDETERMINED

RetailFilterBundleShape
type: NodeShape
target class: RetailFilterBundle
property:
  path: sharedSet
  name: shared set
  description: The resource name of the shared set that contains the retail filter. This field is required.
  datatype: string
  max count: 1

UserInterestInfoShape
type: NodeShape
target class: UserInterestInfo
property:
  path: userInterestCategory
  name: user interest category
  description: The UserInterest resource name.
  datatype: string
  max count: 1

AdGroupCriterionPositionEstimatesShape
type: NodeShape
target class: AdGroupCriterionPositionEstimates
property:
  path: topOfPageCpcMicros
  name: top of page cpc micros
  description: Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: estimatedAddCostAtFirstPositionCpc
  name: estimated add cost at first position cpc
  description: Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: firstPageCpcMicros
  name: first page cpc micros
  description: Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: firstPositionCpcMicros
  name: first position cpc micros
  description: Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: estimatedAddClicksAtFirstPositionCpc
  name: estimated add clicks at first position cpc
  description: Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
  write lifecycle: Read only
  datatype: long
  max count: 1

LocationInfoShape
type: NodeShape
target class: LocationInfo
property:
  path: geoTargetConstant
  name: geo target constant
  description: The geo target constant resource name.
  datatype: string
  max count: 1

CustomAffinityInfoShape
type: NodeShape
target class: CustomAffinityInfo
property:
  path: customAffinity
  name: custom affinity
  description: The CustomInterest resource name.
  datatype: string
  max count: 1

VerticalAdsItemGroupRuleListInfoShape
type: NodeShape
target class: VerticalAdsItemGroupRuleListInfo
property:
  path: sharedSet
  name: shared set
  description: The shared set resource name of the vertical ads item group rule list.
  datatype: string
  max count: 1

VideoLineupInfoShape
type: NodeShape
target class: VideoLineupInfo
property:
  path: videoLineupId
  name: video lineup id
  description: ID for a Video lineup. Contact your Google business development representative for details.
  datatype: long
  max count: 1

AdGroupCriterionCustomizerShape
type: NodeShape
target class: AdGroupCriterionCustomizer
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group criterion customizer. Ad group criterion customizer resource names have the form: `customers/{customer_id}/adGroupCriterionCustomizers/{ad_group_id}~{criterion_id}~{customizer_attribute_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: customizerAttribute
  name: customizer attribute
  description: Required. Immutable. The customizer attribute which is linked to the ad group criterion.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: value
  name: value
  description: Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
  node: CustomizerValueShape
  class: CustomizerValue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the ad group criterion customizer.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: adGroupCriterion
  name: ad group criterion
  description: Immutable. The ad group criterion to which the customizer attribute is linked. It must be a keyword criterion.
  write lifecycle: Create only
  datatype: string
  max count: 1

CustomizerValueShape
type: NodeShape
target class: CustomizerValue
property:
  path: type
  name: type
  description: Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TEXT
  in: NUMBER
  in: PRICE
  in: PERCENT
property:
  path: stringValue
  name: string value
  description: Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.
  datatype: string
  max count: 1

AdGroupCriterionLabelShape
type: NodeShape
target class: AdGroupCriterionLabel
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: label
  name: label
  description: Immutable. The label assigned to the ad group criterion.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: adGroupCriterion
  name: ad group criterion
  description: Immutable. The ad group criterion to which the label is attached.
  write lifecycle: Create only
  datatype: string
  max count: 1

AdGroupCriterionSimulationShape
type: NodeShape
target class: AdGroupCriterionSimulation
property:
  path: startDate
  name: start date
  description: Output only. First day on which the simulation is based, in YYYY-MM-DD format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: percentCpcBidPointList
  name: percent cpc bid point list
  description: Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
  write lifecycle: Read only
  node: PercentCpcBidSimulationPointListShape
  class: PercentCpcBidSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cpcBidPointList
  name: cpc bid point list
  description: Output only. Simulation points if the simulation type is CPC_BID.
  write lifecycle: Read only
  node: CpcBidSimulationPointListShape
  class: CpcBidSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: modificationMethod
  name: modification method
  description: Output only. How the simulation modifies the field.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: UNIFORM
  in: DEFAULT
  in: SCALING
property:
  path: type
  name: type
  description: Output only. The field that the simulation modifies.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CPC_BID
  in: CPV_BID
  in: TARGET_CPA
  in: BID_MODIFIER
  in: TARGET_ROAS
  in: PERCENT_CPC_BID
  in: TARGET_IMPRESSION_SHARE
  in: BUDGET
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the ad group criterion simulation. Ad group criterion simulation resource names have the form: `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: criterionId
  name: criterion id
  description: Output only. Criterion ID of the simulation.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: endDate
  name: end date
  description: Output only. Last day on which the simulation is based, in YYYY-MM-DD format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroupId
  name: ad group id
  description: Output only. AdGroup ID of the simulation.
  write lifecycle: Read only
  datatype: long
  max count: 1

PercentCpcBidSimulationPointListShape
type: NodeShape
target class: PercentCpcBidSimulationPointList
property:
  path: points
  name: points
  description: Projected metrics for a series of percent CPC bid amounts.
  node: PercentCpcBidSimulationPointShape
  class: PercentCpcBidSimulationPoint
  node kind: BlankNodeOrIRI

PercentCpcBidSimulationPointShape
type: NodeShape
target class: PercentCpcBidSimulationPoint
property:
  path: biddableConversions
  name: biddable conversions
  description: Projected number of biddable conversions.
  datatype: double
  max count: 1
property:
  path: clicks
  name: clicks
  description: Projected number of clicks.
  datatype: long
  max count: 1
property:
  path: topSlotImpressions
  name: top slot impressions
  description: Projected number of top slot impressions.
  datatype: long
  max count: 1
property:
  path: impressions
  name: impressions
  description: Projected number of impressions.
  datatype: long
  max count: 1
property:
  path: biddableConversionsValue
  name: biddable conversions value
  description: Projected total value of biddable conversions in local currency.
  datatype: double
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Projected cost in micros.
  datatype: long
  max count: 1
property:
  path: percentCpcBidMicros
  name: percent cpc bid micros
  description: 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].
  datatype: long
  max count: 1

CpcBidSimulationPointListShape
type: NodeShape
target class: CpcBidSimulationPointList
property:
  path: points
  name: points
  description: Projected metrics for a series of CPC bid amounts.
  node: CpcBidSimulationPointShape
  class: CpcBidSimulationPoint
  node kind: BlankNodeOrIRI

CpcBidSimulationPointShape
type: NodeShape
target class: CpcBidSimulationPoint
property:
  path: biddableConversions
  name: biddable conversions
  description: Projected number of biddable conversions.
  datatype: double
  max count: 1
property:
  path: topSlotImpressions
  name: top slot impressions
  description: Projected number of top slot impressions. Only search advertising channel type supports this field.
  datatype: long
  max count: 1
property:
  path: cpcBidMicros
  name: cpc bid micros
  description: The simulated CPC bid upon which projected metrics are based.
  datatype: long
  max count: 1
property:
  path: requiredBudgetAmountMicros
  name: required budget amount micros
  description: Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
  datatype: long
  max count: 1
property:
  path: clicks
  name: clicks
  description: Projected number of clicks.
  datatype: long
  max count: 1
property:
  path: impressions
  name: impressions
  description: Projected number of impressions.
  datatype: long
  max count: 1
property:
  path: biddableConversionsValue
  name: biddable conversions value
  description: Projected total value of biddable conversions.
  datatype: double
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Projected cost in micros.
  datatype: long
  max count: 1
property:
  path: cpcBidScalingModifier
  name: cpc bid scaling modifier
  description: The simulated scaling modifier upon which projected metrics are based. All CPC bids relevant to the simulated entity are scaled by this modifier.
  datatype: double
  max count: 1

AdGroupCustomizerShape
type: NodeShape
target class: AdGroupCustomizer
property:
  path: value
  name: value
  description: Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
  node: CustomizerValueShape
  class: CustomizerValue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customizerAttribute
  name: customizer attribute
  description: Required. Immutable. The customizer attribute which is linked to the ad group.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: adGroup
  name: ad group
  description: Immutable. The ad group to which the customizer attribute is linked.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group customizer. Ad group customizer resource names have the form: `customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the ad group customizer.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED

AdGroupLabelShape
type: NodeShape
target class: AdGroupLabel
property:
  path: label
  name: label
  description: Immutable. The label assigned to the ad group.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: adGroup
  name: ad group
  description: Immutable. The ad group to which the label is attached.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1

AdGroupSimulationShape
type: NodeShape
target class: AdGroupSimulation
property:
  path: adGroupId
  name: ad group id
  description: Output only. Ad group id of the simulation.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: endDate
  name: end date
  description: Output only. Last day on which the simulation is based, in YYYY-MM-DD format
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetCpaPointList
  name: target cpa point list
  description: Output only. Simulation points if the simulation type is TARGET_CPA.
  write lifecycle: Read only
  node: TargetCpaSimulationPointListShape
  class: TargetCpaSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cpvBidPointList
  name: cpv bid point list
  description: Output only. Simulation points if the simulation type is CPV_BID.
  write lifecycle: Read only
  node: CpvBidSimulationPointListShape
  class: CpvBidSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the ad group simulation. Ad group simulation resource names have the form: `customers/{customer_id}/adGroupSimulations/{ad_group_id}~{type}~{modification_method}~{start_date}~{end_date}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Output only. The field that the simulation modifies.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CPC_BID
  in: CPV_BID
  in: TARGET_CPA
  in: BID_MODIFIER
  in: TARGET_ROAS
  in: PERCENT_CPC_BID
  in: TARGET_IMPRESSION_SHARE
  in: BUDGET
property:
  path: modificationMethod
  name: modification method
  description: Output only. How the simulation modifies the field.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: UNIFORM
  in: DEFAULT
  in: SCALING
property:
  path: targetRoasPointList
  name: target roas point list
  description: Output only. Simulation points if the simulation type is TARGET_ROAS.
  write lifecycle: Read only
  node: TargetRoasSimulationPointListShape
  class: TargetRoasSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cpcBidPointList
  name: cpc bid point list
  description: Output only. Simulation points if the simulation type is CPC_BID.
  write lifecycle: Read only
  node: CpcBidSimulationPointListShape
  class: CpcBidSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: startDate
  name: start date
  description: Output only. First day on which the simulation is based, in YYYY-MM-DD format.
  write lifecycle: Read only
  datatype: string
  max count: 1

TargetCpaSimulationPointListShape
type: NodeShape
target class: TargetCpaSimulationPointList
property:
  path: points
  name: points
  description: Projected metrics for a series of target CPA amounts.
  node: TargetCpaSimulationPointShape
  class: TargetCpaSimulationPoint
  node kind: BlankNodeOrIRI

TargetCpaSimulationPointShape
type: NodeShape
target class: TargetCpaSimulationPoint
property:
  path: appInstalls
  name: app installs
  description: Projected number of app installs.
  datatype: double
  max count: 1
property:
  path: requiredBudgetAmountMicros
  name: required budget amount micros
  description: Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
  datatype: long
  max count: 1
property:
  path: interactions
  name: interactions
  description: Projected number of interactions. Only discovery advertising channel type supports this field.
  datatype: long
  max count: 1
property:
  path: inAppActions
  name: in app actions
  description: Projected number of in-app actions.
  datatype: double
  max count: 1
property:
  path: targetCpaMicros
  name: target cpa micros
  description: The simulated target CPA upon which projected metrics are based.
  datatype: long
  max count: 1
property:
  path: biddableConversions
  name: biddable conversions
  description: Projected number of biddable conversions.
  datatype: double
  max count: 1
property:
  path: topSlotImpressions
  name: top slot impressions
  description: Projected number of top slot impressions. Only search advertising channel type supports this field.
  datatype: long
  max count: 1
property:
  path: biddableConversionsValue
  name: biddable conversions value
  description: Projected total value of biddable conversions.
  datatype: double
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Projected cost in micros.
  datatype: long
  max count: 1
property:
  path: targetCpaScalingModifier
  name: target cpa scaling modifier
  description: The simulated scaling modifier upon which projected metrics are based. All CPA targets relevant to the simulated entity are scaled by this modifier.
  datatype: double
  max count: 1
property:
  path: clicks
  name: clicks
  description: Projected number of clicks.
  datatype: long
  max count: 1
property:
  path: impressions
  name: impressions
  description: Projected number of impressions.
  datatype: long
  max count: 1

CpvBidSimulationPointListShape
type: NodeShape
target class: CpvBidSimulationPointList
property:
  path: points
  name: points
  description: Projected metrics for a series of CPV bid amounts.
  node: CpvBidSimulationPointShape
  class: CpvBidSimulationPoint
  node kind: BlankNodeOrIRI

CpvBidSimulationPointShape
type: NodeShape
target class: CpvBidSimulationPoint
property:
  path: cpvBidMicros
  name: cpv bid micros
  description: The simulated CPV bid upon which projected metrics are based.
  datatype: long
  max count: 1
property:
  path: views
  name: views
  description: Projected number of views.
  datatype: long
  max count: 1
property:
  path: impressions
  name: impressions
  description: Projected number of impressions.
  datatype: long
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Projected cost in micros.
  datatype: long
  max count: 1

TargetRoasSimulationPointListShape
type: NodeShape
target class: TargetRoasSimulationPointList
property:
  path: points
  name: points
  description: Projected metrics for a series of target ROAS amounts.
  node: TargetRoasSimulationPointShape
  class: TargetRoasSimulationPoint
  node kind: BlankNodeOrIRI

TargetRoasSimulationPointShape
type: NodeShape
target class: TargetRoasSimulationPoint
property:
  path: impressions
  name: impressions
  description: Projected number of impressions.
  datatype: long
  max count: 1
property:
  path: biddableConversions
  name: biddable conversions
  description: Projected number of biddable conversions.
  datatype: double
  max count: 1
property:
  path: clicks
  name: clicks
  description: Projected number of clicks.
  datatype: long
  max count: 1
property:
  path: topSlotImpressions
  name: top slot impressions
  description: Projected number of top slot impressions. Only Search advertising channel type supports this field.
  datatype: long
  max count: 1
property:
  path: requiredBudgetAmountMicros
  name: required budget amount micros
  description: Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
  datatype: long
  max count: 1
property:
  path: biddableConversionsValue
  name: biddable conversions value
  description: Projected total value of biddable conversions.
  datatype: double
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Projected cost in micros.
  datatype: long
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: The simulated target ROAS upon which projected metrics are based.
  datatype: double
  max count: 1

AdParameterShape
type: NodeShape
target class: AdParameter
property:
  path: adGroupCriterion
  name: ad group criterion
  description: Immutable. The ad group criterion that this ad parameter belongs to.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: insertionText
  name: insertion text
  description: Numeric value to insert into the ad text. The following restrictions apply: - Can use comma or period as a separator, with an optional period or comma (respectively) for fractional values. For example, 1,000,000.00 and 2.000.000,10 are valid. - Can be prepended or appended with a currency symbol. For example, $99.99 is valid. - Can be prepended or appended with a currency code. For example, 99.99USD and EUR200 are valid. - Can use '%'. For example, 1.0% and 1,0% are valid. - Can use plus or minus. For example, -10.99 and 25+ are valid. - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are valid.
  datatype: string
  max count: 1
property:
  path: parameterIndex
  name: parameter index
  description: Immutable. The unique index of this ad parameter. Must be either 1 or 2.
  write lifecycle: Create only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the ad parameter. Ad parameter resource names have the form: `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
  write lifecycle: Create only
  datatype: string
  max count: 1

AdScheduleInfoShape
type: NodeShape
target class: AdScheduleInfo
property:
  path: startHour
  name: start hour
  description: Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
  datatype: int
  max count: 1
property:
  path: endHour
  name: end hour
  description: Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
  datatype: int
  max count: 1
property:
  path: startMinute
  name: start minute
  description: Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ZERO
  in: FIFTEEN
  in: THIRTY
  in: FORTY_FIVE
property:
  path: dayOfWeek
  name: day of week
  description: Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MONDAY
  in: TUESDAY
  in: WEDNESDAY
  in: THURSDAY
  in: FRIDAY
  in: SATURDAY
  in: SUNDAY
property:
  path: endMinute
  name: end minute
  description: Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ZERO
  in: FIFTEEN
  in: THIRTY
  in: FORTY_FIVE

AdScheduleViewShape
type: NodeShape
target class: AdScheduleView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: `customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

AdStrengthActionItemShape
type: NodeShape
target class: AdStrengthActionItem
property:
  path: actionItemType
  name: action item type
  description: Output only. The action item type.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADD_ASSET
property:
  path: addAssetDetails
  name: add asset details
  description: Output only. The action item details for action item type ADD_ASSET.
  write lifecycle: Read only
  node: AdStrengthActionItemAddAssetDetailsShape
  class: AdStrengthActionItemAddAssetDetails
  node kind: BlankNodeOrIRI
  max count: 1

AdStrengthActionItemAddAssetDetailsShape
type: NodeShape
target class: AdStrengthActionItemAddAssetDetails
property:
  path: assetFieldType
  name: asset field type
  description: Output only. The asset field type of the asset(s) to add.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: assetCount
  name: asset count
  description: Output only. The number of assets to add.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: videoAspectRatioRequirement
  name: video aspect ratio requirement
  description: Output only. For video field types, the required aspect ratio of the video. When unset and asset_field_type is YOUTUBE_VIDEO, the system recommends the advertiser upload any YouTube video, regardless of aspect ratio.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HORIZONTAL
  in: SQUARE
  in: VERTICAL

AdvertisingPartnerIdentifierShape
type: NodeShape
target class: AdvertisingPartnerIdentifier
property:
  path: customer
  name: customer
  description: Output only. The resource name of the advertising partner Google Ads account. This field is required and should not be empty when creating a new Advertising Partner link. It is unable to be modified after the creation of the link.
  write lifecycle: Read only
  datatype: string
  max count: 1

AdvertisingPartnerLinkInvitationIdentifierShape
type: NodeShape
target class: AdvertisingPartnerLinkInvitationIdentifier
property:
  path: customer
  name: customer
  description: Immutable. The resource name of the advertising partner Google Ads account. This field is read only.
  write lifecycle: Create only
  datatype: string
  max count: 1

AdvertisingPartnerLinkInvitationPropertiesShape
type: NodeShape
target class: AdvertisingPartnerLinkInvitationProperties
property:
  path: allowedDomain
  name: allowed domain
  description: Immutable. The allowed domain for the Advertising Partner link invitation. The advertising partner will only be able to advertise on this domain. The field is immutable after the creation of the link invitation.
  write lifecycle: Create only
  datatype: string
  max count: 1

AdvertisingPartnerPropertiesShape
type: NodeShape
target class: AdvertisingPartnerProperties
property:
  path: allowedDomain
  name: allowed domain
  description: Output only. The allowed domain for the Advertising Partner link. The advertising partner will only be able to advertise on this domain. The field is immutable.
  write lifecycle: Read only
  datatype: string
  max count: 1

AgeDimensionShape
type: NodeShape
target class: AgeDimension
property:
  path: includeUndetermined
  name: include undetermined
  description: Include users whose age is not determined.
  datatype: boolean
  max count: 1
property:
  path: ageRanges
  name: age ranges
  description: Contiguous age range to be included in the dimension.
  node: AgeSegmentShape
  class: AgeSegment
  node kind: BlankNodeOrIRI

AgeSegmentShape
type: NodeShape
target class: AgeSegment
property:
  path: minAge
  name: min age
  description: Minimum age to include. A minimum age must be specified and must be at least 18. Allowed values are 18, 25, 35, 45, 55, and 65.
  datatype: int
  max count: 1
property:
  path: maxAge
  name: max age
  description: Maximum age to include. A maximum age need not be specified. If specified, max_age must be greater than min_age, and allowed values are 24, 34, 44, 54, and 64.
  datatype: int
  max count: 1

AgeRangeViewShape
type: NodeShape
target class: AgeRangeView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

AiMaxSearchTermAdCombinationViewShape
type: NodeShape
target class: AiMaxSearchTermAdCombinationView
property:
  path: adGroup
  name: ad group
  description: Output only. Ad group where the search term served.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: landingPage
  name: landing page
  description: Output only. The destination URL, which was dynamically generated. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the AI Max Search Term Ad Combination view AI Max Search Term Ad Combination view resource names have the form: `customers/{customer_id}/aiMaxSearchTermAdCombinationViews/{ad_group_id}~{URL-base64_search_term}~{URL-base64_landing_page}~{URL-base64_headline}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: searchTerm
  name: search term
  description: Output only. The search term that triggered the ad. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: headline
  name: headline
  description: Output only. The concatenated string containing headline assets for the ad. Up to three headline assets are concatenated, separated by " | ". This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1

AndroidPrivacySharedKeyGoogleAdGroupShape
type: NodeShape
target class: AndroidPrivacySharedKeyGoogleAdGroup
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleAdGroups/{campaign_id}~{ad_group_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: androidPrivacyNetworkType
  name: android privacy network type
  description: Output only. The network type enum used in the share key encoding.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH
  in: DISPLAY
  in: YOUTUBE
property:
  path: adGroupId
  name: ad group id
  description: Output only. The ad group ID used in the share key encoding.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: Output only. The campaign ID used in the share key encoding.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: sharedAdGroupKey
  name: shared ad group key
  description: Output only. 128 bit hex string of the encoded shared ad group key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: androidPrivacyInteractionDate
  name: android privacy interaction date
  description: Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: androidPrivacyInteractionType
  name: android privacy interaction type
  description: Output only. The interaction type enum used in the share key encoding.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CLICK
  in: ENGAGED_VIEW
  in: VIEW

AndroidPrivacySharedKeyGoogleCampaignShape
type: NodeShape
target class: AndroidPrivacySharedKeyGoogleCampaign
property:
  path: campaignId
  name: campaign id
  description: Output only. The campaign ID used in the share key encoding.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleCampaigns/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: sharedCampaignKey
  name: shared campaign key
  description: Output only. 128 bit hex string of the encoded shared campaign key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: androidPrivacyInteractionType
  name: android privacy interaction type
  description: Output only. The interaction type enum used in the share key encoding.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CLICK
  in: ENGAGED_VIEW
  in: VIEW
property:
  path: androidPrivacyInteractionDate
  name: android privacy interaction date
  description: Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
  write lifecycle: Read only
  datatype: string
  max count: 1

AndroidPrivacySharedKeyGoogleNetworkTypeShape
type: NodeShape
target class: AndroidPrivacySharedKeyGoogleNetworkType
property:
  path: androidPrivacyInteractionDate
  name: android privacy interaction date
  description: Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: sharedNetworkTypeKey
  name: shared network type key
  description: Output only. 128 bit hex string of the encoded shared network type key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: androidPrivacyInteractionType
  name: android privacy interaction type
  description: Output only. The interaction type enum used in the share key encoding.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CLICK
  in: ENGAGED_VIEW
  in: VIEW
property:
  path: campaignId
  name: campaign id
  description: Output only. The campaign ID used in the share key encoding.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleNetworkTypes/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: androidPrivacyNetworkType
  name: android privacy network type
  description: Output only. The network type enum used in the share key encoding.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH
  in: DISPLAY
  in: YOUTUBE

AppDeepLinkAssetShape
type: NodeShape
target class: AppDeepLinkAsset
property:
  path: appDeepLinkUri
  name: app deep link uri
  description: The uri for the app deep link, The uri can be either a custom scheme uri (e.g. mystore://shoes) or universal uri (e.g. http://www.mystore.com/shoes).
  datatype: string
  max count: 1

AppliedIncentiveShape
type: NodeShape
target class: AppliedIncentive
property:
  path: currencyCode
  name: currency code
  description: Output only. The currency code for all monetary amounts (for example, "USD").
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: rewardExpirationDateTime
  name: reward expiration date time
  description: Output only. The time when the granted reward expires in "YYYY-MM-DD HH:MM:SS" format in UTC. This field is not set if the reward has not been granted.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: fulfillmentExpirationDateTime
  name: fulfillment expiration date time
  description: Output only. The time by which the incentive's fulfillment requirements must be met, in "YYYY-MM-DD HH:MM:SS" format in UTC.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: couponCode
  name: coupon code
  description: Output only. The coupon code of the incentive.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: requiredMinSpendMicros
  name: required min spend micros
  description: Output only. The minimum amount that must be spent to fulfill the coupon requirements, in micros.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: grantedAmountMicros
  name: granted amount micros
  description: Output only. The amount of the reward granted in micros. This field is not set if the reward has not been granted.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: incentiveState
  name: incentive state
  description: Output only. The current state of the incentive.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REDEEMED
  in: FULFILLED
  in: REWARD_GRANTED
  in: EXPIRED
  in: REWARD_EXPIRED
  in: INVALIDATED
  in: REWARD_EXHAUSTED
property:
  path: redemptionDateTime
  name: redemption date time
  description: Output only. The redemption time of the incentive in "YYYY-MM-DD HH:MM:SS" format in UTC.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: rewardAmountMicros
  name: reward amount micros
  description: Output only. The maximum potential reward amount in micros for the incentive.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: rewardGrantDateTime
  name: reward grant date time
  description: Output only. The time when the reward was granted in "YYYY-MM-DD HH:MM:SS" format in UTC. This field is not set if the reward has not been granted.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the incentive. Incentive resource names have the form: `customers/{customer_id}/appliedIncentives/{coupon_code}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: rewardBalanceRemainingMicros
  name: reward balance remaining micros
  description: Output only. The remaining balance of the granted reward in micros. This field is not set if the reward has not been granted.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: currentSpendTowardsFulfillmentMicros
  name: current spend towards fulfillment micros
  description: Output only. The current amount spent towards the fulfillment requirements, in micros.
  write lifecycle: Read only
  datatype: long
  max count: 1

AppTopCombinationViewShape
type: NodeShape
target class: AppTopCombinationView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the app top combination view. App Top Combination view resource names have the form: `customers/{customer_id}/appTopCombinationViews/{ad_group_id}~{ad_id}~{asset_combination_category}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroupTopCombinations
  name: ad group top combinations
  description: Output only. The top combinations of assets that served together.
  write lifecycle: Read only
  node: AdGroupCreativeAssetCombinationDataShape
  class: AdGroupCreativeAssetCombinationData
  node kind: BlankNodeOrIRI

AssetShape
type: NodeShape
target class: Asset
property:
  path: id
  name: id
  description: Output only. The ID of the asset.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: urlCustomParameters
  name: url custom parameters
  description: A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls.
  node: CustomParameterShape
  class: CustomParameter
  node kind: BlankNodeOrIRI
property:
  path: sitelinkAsset
  name: sitelink asset
  description: A sitelink asset.
  node: SitelinkAssetShape
  class: SitelinkAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dynamicJobsAsset
  name: dynamic jobs asset
  description: A dynamic jobs asset.
  node: DynamicJobsAssetShape
  class: DynamicJobsAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: leadFormAsset
  name: lead form asset
  description: A lead form asset.
  node: LeadFormAssetShape
  class: LeadFormAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dynamicTravelAsset
  name: dynamic travel asset
  description: A dynamic travel asset.
  node: DynamicTravelAssetShape
  class: DynamicTravelAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: businessMessageAsset
  name: business message asset
  description: A business message asset.
  node: BusinessMessageAssetShape
  class: BusinessMessageAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: source
  name: source
  description: Output only. Source of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: promotionAsset
  name: promotion asset
  description: A promotion asset.
  node: PromotionAssetShape
  class: PromotionAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: callToActionAsset
  name: call to action asset
  description: Immutable. A call to action asset.
  write lifecycle: Create only
  node: CallToActionAssetShape
  class: CallToActionAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the asset. Asset resource names have the form: `customers/{customer_id}/assets/{asset_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: locationAsset
  name: location asset
  description: Output only. A location asset.
  write lifecycle: Read only
  node: LocationAssetShape
  class: LocationAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeVideoListAsset
  name: youtube video list asset
  description: Immutable. A YouTube video list asset.
  write lifecycle: Create only
  node: YouTubeVideoListAssetShape
  class: YouTubeVideoListAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeVideoAsset
  name: youtube video asset
  description: Immutable. A YouTube video asset.
  write lifecycle: Create only
  node: YoutubeVideoAssetShape
  class: YoutubeVideoAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dynamicRealEstateAsset
  name: dynamic real estate asset
  description: A dynamic real estate asset.
  node: DynamicRealEstateAssetShape
  class: DynamicRealEstateAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mediaBundleAsset
  name: media bundle asset
  description: Immutable. A media bundle asset.
  write lifecycle: Create only
  node: MediaBundleAssetShape
  class: MediaBundleAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dynamicLocalAsset
  name: dynamic local asset
  description: A dynamic local asset.
  node: DynamicLocalAssetShape
  class: DynamicLocalAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: pageFeedAsset
  name: page feed asset
  description: A page feed asset.
  node: PageFeedAssetShape
  class: PageFeedAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: textAsset
  name: text asset
  description: Immutable. A text asset.
  write lifecycle: Create only
  node: TextAssetShape
  class: TextAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: syntheticContentInfo
  name: synthetic content info
  description: Synthetic content info for the asset.
  node: SyntheticContentInfoShape
  class: SyntheticContentInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: callAsset
  name: call asset
  description: A call asset.
  node: CallAssetShape
  class: CallAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. Type of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: YOUTUBE_VIDEO
  in: MEDIA_BUNDLE
  in: IMAGE
  in: TEXT
  in: LEAD_FORM
  in: BOOK_ON_GOOGLE
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: PAGE_FEED
  in: DYNAMIC_EDUCATION
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: CALL_TO_ACTION
  in: DYNAMIC_REAL_ESTATE
  in: DYNAMIC_CUSTOM
  in: DYNAMIC_HOTELS_AND_RENTALS
  in: DYNAMIC_FLIGHTS
  in: DYNAMIC_TRAVEL
  in: DYNAMIC_LOCAL
  in: DYNAMIC_JOBS
  in: LOCATION
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: APP_DEEP_LINK
  in: YOUTUBE_VIDEO_LIST

SitelinkAssetShape
type: NodeShape
target class: SitelinkAsset
property:
  path: linkText
  name: link text
  description: Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
  datatype: string
  max count: 1
property:
  path: startDate
  name: start date
  description: Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: endDate
  name: end date
  description: Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: description1
  name: description1
  description: First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
  datatype: string
  max count: 1
property:
  path: adScheduleTargets
  name: ad schedule targets
  description: List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
  node: AdScheduleInfoShape
  class: AdScheduleInfo
  node kind: BlankNodeOrIRI
property:
  path: description2
  name: description2
  description: Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
  datatype: string
  max count: 1

DynamicJobsAssetShape
type: NodeShape
target class: DynamicJobsAsset
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1
property:
  path: locationId
  name: location id
  description: Location ID which can be any sequence of letters and digits. The ID sequence (job ID + location ID) must be unique.
  datatype: string
  max count: 1
property:
  path: salary
  name: salary
  description: Salary, for example, $100,000.
  datatype: string
  max count: 1
property:
  path: similarJobIds
  name: similar job ids
  description: Similar job IDs, for example, 1275.
  datatype: string
property:
  path: imageUrl
  name: image url
  description: Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: jobId
  name: job id
  description: Required. Job ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
  datatype: string
  max count: 1
property:
  path: address
  name: address
  description: Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
  datatype: string
  max count: 1
property:
  path: jobCategory
  name: job category
  description: Job category, for example, Technical.
  datatype: string
  max count: 1
property:
  path: jobSubtitle
  name: job subtitle
  description: Job subtitle, for example, Level II.
  datatype: string
  max count: 1
property:
  path: jobTitle
  name: job title
  description: Required. Job title, for example, Software engineer. Required.
  datatype: string
  max count: 1
property:
  path: contextualKeywords
  name: contextual keywords
  description: Contextual keywords, for example, Software engineering job.
  datatype: string
property:
  path: description
  name: description
  description: Description, for example, Apply your technical skills.
  datatype: string
  max count: 1
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1

LeadFormAssetShape
type: NodeShape
target class: LeadFormAsset
property:
  path: businessName
  name: business name
  description: Required. The name of the business being advertised.
  datatype: string
  max count: 1
property:
  path: privacyPolicyUrl
  name: privacy policy url
  description: Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business.
  datatype: string
  max count: 1
property:
  path: customDisclosure
  name: custom disclosure
  description: Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only.
  datatype: string
  max count: 1
property:
  path: postSubmitHeadline
  name: post submit headline
  description: Headline of text shown after form submission that describes how the advertiser will follow up with the user.
  datatype: string
  max count: 1
property:
  path: fields
  name: fields
  description: Ordered list of input fields. This field can be updated by reordering questions, but not by adding or removing questions.
  node: LeadFormFieldShape
  class: LeadFormField
  node kind: BlankNodeOrIRI
property:
  path: customQuestionFields
  name: custom question fields
  description: Ordered list of custom question fields. This field is subject to a limit of 5 qualifying questions per form.
  node: LeadFormCustomQuestionFieldShape
  class: LeadFormCustomQuestionField
  node kind: BlankNodeOrIRI
property:
  path: postSubmitDescription
  name: post submit description
  description: Detailed description shown after form submission that describes how the advertiser will follow up with the user.
  datatype: string
  max count: 1
property:
  path: deliveryMethods
  name: delivery methods
  description: Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured.
  node: LeadFormDeliveryMethodShape
  class: LeadFormDeliveryMethod
  node kind: BlankNodeOrIRI
property:
  path: desiredIntent
  name: desired intent
  description: Chosen intent for the lead form, for example, more volume or more qualified.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LOW_INTENT
  in: HIGH_INTENT
property:
  path: postSubmitCallToActionType
  name: post submit call to action type
  description: Pre-defined display text that encourages user action after the form is submitted.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: VISIT_SITE
  in: DOWNLOAD
  in: LEARN_MORE
  in: SHOP_NOW
property:
  path: backgroundImageAsset
  name: background image asset
  description: Asset resource name of the background image. The image dimensions must be exactly 1200x628.
  datatype: string
  max count: 1
property:
  path: callToActionType
  name: call to action type
  description: Required. Pre-defined display text that encourages user to expand the form.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LEARN_MORE
  in: GET_QUOTE
  in: APPLY_NOW
  in: SIGN_UP
  in: CONTACT_US
  in: SUBSCRIBE
  in: DOWNLOAD
  in: BOOK_NOW
  in: GET_OFFER
  in: REGISTER
  in: GET_INFO
  in: REQUEST_DEMO
  in: JOIN_NOW
  in: GET_STARTED
property:
  path: headline
  name: headline
  description: Required. Headline of the expanded form to describe what the form is asking for or facilitating.
  datatype: string
  max count: 1
property:
  path: callToActionDescription
  name: call to action description
  description: Required. Text giving a clear value proposition of what users expect once they expand the form.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Required. Detailed description of the expanded form to describe what the form is asking for or facilitating.
  datatype: string
  max count: 1

LeadFormFieldShape
type: NodeShape
target class: LeadFormField
property:
  path: inputType
  name: input type
  description: Describes the input type, which may be a predefined type such as "full name" or a pre-vetted question like "What kind of vehicle do you have?".
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: FULL_NAME
  in: EMAIL
  in: PHONE_NUMBER
  in: POSTAL_CODE
  in: STREET_ADDRESS
  in: CITY
  in: REGION
  in: COUNTRY
  in: WORK_EMAIL
  in: COMPANY_NAME
  in: WORK_PHONE
  in: JOB_TITLE
  in: GOVERNMENT_ISSUED_ID_CPF_BR
  in: GOVERNMENT_ISSUED_ID_DNI_AR
  in: GOVERNMENT_ISSUED_ID_DNI_PE
  in: GOVERNMENT_ISSUED_ID_RUT_CL
  in: GOVERNMENT_ISSUED_ID_CC_CO
  in: GOVERNMENT_ISSUED_ID_CI_EC
  in: GOVERNMENT_ISSUED_ID_RFC_MX
  in: FIRST_NAME
  in: LAST_NAME
  in: VEHICLE_MODEL
  in: VEHICLE_TYPE
  in: PREFERRED_DEALERSHIP
  in: VEHICLE_PURCHASE_TIMELINE
  in: VEHICLE_OWNERSHIP
  in: VEHICLE_PAYMENT_TYPE
  in: VEHICLE_CONDITION
  in: COMPANY_SIZE
  in: ANNUAL_SALES
  in: YEARS_IN_BUSINESS
  in: JOB_DEPARTMENT
  in: JOB_ROLE
  in: OVER_18_AGE
  in: OVER_19_AGE
  in: OVER_20_AGE
  in: OVER_21_AGE
  in: OVER_22_AGE
  in: OVER_23_AGE
  in: OVER_24_AGE
  in: OVER_25_AGE
  in: OVER_26_AGE
  in: OVER_27_AGE
  in: OVER_28_AGE
  in: OVER_29_AGE
  in: OVER_30_AGE
  in: OVER_31_AGE
  in: OVER_32_AGE
  in: OVER_33_AGE
  in: OVER_34_AGE
  in: OVER_35_AGE
  in: OVER_36_AGE
  in: OVER_37_AGE
  in: OVER_38_AGE
  in: OVER_39_AGE
  in: OVER_40_AGE
  in: OVER_41_AGE
  in: OVER_42_AGE
  in: OVER_43_AGE
  in: OVER_44_AGE
  in: OVER_45_AGE
  in: OVER_46_AGE
  in: OVER_47_AGE
  in: OVER_48_AGE
  in: OVER_49_AGE
  in: OVER_50_AGE
  in: OVER_51_AGE
  in: OVER_52_AGE
  in: OVER_53_AGE
  in: OVER_54_AGE
  in: OVER_55_AGE
  in: OVER_56_AGE
  in: OVER_57_AGE
property:
  path: singleChoiceAnswers
  name: single choice answers
  description: Answer configuration for a single choice question. Can be set only for pre-vetted question fields. Minimum of 2 answers required and maximum of 12 allowed.
  node: LeadFormSingleChoiceAnswersShape
  class: LeadFormSingleChoiceAnswers
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hasLocationAnswer
  name: has location answer
  description: Answer configuration for location question. If true, campaign/account level location data (state, city, business name etc) will be rendered on the Lead Form. Starting V13.1, has_location_answer can only be set for "What is your preferred dealership?" question, for advertisers with Location Assets setup at campaign/account level.
  datatype: boolean
  max count: 1

LeadFormSingleChoiceAnswersShape
type: NodeShape
target class: LeadFormSingleChoiceAnswers
property:
  path: answers
  name: answers
  description: List of choices for a single question field. The order of entries defines UI order. Minimum of 2 answers required and maximum of 12 allowed.
  datatype: string

LeadFormCustomQuestionFieldShape
type: NodeShape
target class: LeadFormCustomQuestionField
property:
  path: singleChoiceAnswers
  name: single choice answers
  description: Answer configuration for a single choice question. Minimum of 2 answers and maximum of 12 allowed.
  node: LeadFormSingleChoiceAnswersShape
  class: LeadFormSingleChoiceAnswers
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customQuestionText
  name: custom question text
  description: The exact custom question field text (for example, "What kind of vehicle do you have?").
  datatype: string
  max count: 1
property:
  path: hasLocationAnswer
  name: has location answer
  description: Answer configuration for location question. If true, campaign/account level location data (state, city, business name etc) will be rendered on the Lead Form. Starting V13.1, has_location_answer can only be set for "What is your preferred dealership?" question, for advertisers with Location Assets setup at campaign/account level.
  datatype: boolean
  max count: 1

LeadFormDeliveryMethodShape
type: NodeShape
target class: LeadFormDeliveryMethod
property:
  path: webhook
  name: webhook
  description: Webhook method of delivery.
  node: WebhookDeliveryShape
  class: WebhookDelivery
  node kind: BlankNodeOrIRI
  max count: 1

WebhookDeliveryShape
type: NodeShape
target class: WebhookDelivery
property:
  path: googleSecret
  name: google secret
  description: Anti-spoofing secret set by the advertiser as part of the webhook payload.
  datatype: string
  max count: 1
property:
  path: advertiserWebhookUrl
  name: advertiser webhook url
  description: Webhook url specified by advertiser to send the lead.
  datatype: string
  max count: 1
property:
  path: payloadSchemaVersion
  name: payload schema version
  description: The schema version that this delivery instance will use.
  datatype: long
  max count: 1

DynamicTravelAssetShape
type: NodeShape
target class: DynamicTravelAsset
property:
  path: originName
  name: origin name
  description: Origin name, for example, London.
  datatype: string
  max count: 1
property:
  path: formattedPrice
  name: formatted price
  description: Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
  datatype: string
  max count: 1
property:
  path: title
  name: title
  description: Required. Title, for example, Book your train ticket. Required.
  datatype: string
  max count: 1
property:
  path: originId
  name: origin id
  description: Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
  datatype: string
  max count: 1
property:
  path: similarDestinationIds
  name: similar destination ids
  description: Similar destination IDs, for example, NYC.
  datatype: string
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Sale price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
  datatype: string
  max count: 1
property:
  path: formattedSalePrice
  name: formatted sale price
  description: Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
  datatype: string
  max count: 1
property:
  path: destinationId
  name: destination id
  description: Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
  datatype: string
  max count: 1
property:
  path: contextualKeywords
  name: contextual keywords
  description: Contextual keywords, for example, Paris trains.
  datatype: string
property:
  path: category
  name: category
  description: Category, for example, Express.
  datatype: string
  max count: 1
property:
  path: destinationName
  name: destination name
  description: Destination name, for example, Paris.
  datatype: string
  max count: 1
property:
  path: imageUrl
  name: image url
  description: Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: destinationAddress
  name: destination address
  description: Destination address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
  datatype: string
  max count: 1
property:
  path: price
  name: price
  description: Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
  datatype: string
  max count: 1
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1

BusinessMessageAssetShape
type: NodeShape
target class: BusinessMessageAsset
property:
  path: whatsappInfo
  name: whatsapp info
  description: Whatsapp.
  node: WhatsappBusinessMessageInfoShape
  class: WhatsappBusinessMessageInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: zaloInfo
  name: zalo info
  description: Zalo.
  node: ZaloBusinessMessageInfoShape
  class: ZaloBusinessMessageInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: starterMessage
  name: starter message
  description: Required. A welcome message to prompt the user to initiate a conversation.
  datatype: string
  max count: 1
property:
  path: messageProvider
  name: message provider
  description: Required. Message provider of the business message asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WHATSAPP
  in: FACEBOOK_MESSENGER
  in: ZALO
property:
  path: callToAction
  name: call to action
  description: A call to action for the business message asset.
  node: BusinessMessageCallToActionInfoShape
  class: BusinessMessageCallToActionInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: facebookMessengerInfo
  name: facebook messenger info
  description: Facebook Messenger.
  node: FacebookMessengerBusinessMessageInfoShape
  class: FacebookMessengerBusinessMessageInfo
  node kind: BlankNodeOrIRI
  max count: 1

WhatsappBusinessMessageInfoShape
type: NodeShape
target class: WhatsappBusinessMessageInfo
property:
  path: countryCode
  name: country code
  description: Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
  datatype: string
  max count: 1
property:
  path: phoneNumber
  name: phone number
  description: Required. Whatsapp phone number of the business. Examples: '1234567890', '(123)456-7890'.
  datatype: string
  max count: 1

ZaloBusinessMessageInfoShape
type: NodeShape
target class: ZaloBusinessMessageInfo
property:
  path: oaId
  name: oa id
  description: Zalo Official Account ID of the advertiser.
  datatype: long
  max count: 1
property:
  path: customName
  name: custom name
  description: Custom name generated by the advertiser for their Zalo Account. These names will usually be registered brands or trademarks.
  datatype: string
  max count: 1

BusinessMessageCallToActionInfoShape
type: NodeShape
target class: BusinessMessageCallToActionInfo
property:
  path: callToActionSelection
  name: call to action selection
  description: Required. Pre-defined call to action text.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPLY_NOW
  in: BOOK_NOW
  in: CONTACT_US
  in: GET_INFO
  in: GET_OFFER
  in: GET_QUOTE
  in: GET_STARTED
  in: LEARN_MORE
property:
  path: callToActionDescription
  name: call to action description
  description: Required. Text providing a clear value proposition of what users expect once they take the action. Examples: 'Message us for a quote', 'Ask our expert team'.
  datatype: string
  max count: 1

FacebookMessengerBusinessMessageInfoShape
type: NodeShape
target class: FacebookMessengerBusinessMessageInfo
property:
  path: pageName
  name: page name
  description: Required. Facebook page name used for starting a chat on Facebook Messenger.
  datatype: string
  max count: 1

PromotionAssetShape
type: NodeShape
target class: PromotionAsset
property:
  path: promotionBarcodeInfo
  name: promotion barcode info
  description: Barcode info used to generate promotion barcode for user to be eligible for the promotion.
  node: PromotionBarcodeInfoShape
  class: PromotionBarcodeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDate
  name: end date
  description: Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: occasion
  name: occasion
  description: The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEW_YEARS
  in: CHINESE_NEW_YEAR
  in: VALENTINES_DAY
  in: EASTER
  in: MOTHERS_DAY
  in: FATHERS_DAY
  in: LABOR_DAY
  in: BACK_TO_SCHOOL
  in: HALLOWEEN
  in: BLACK_FRIDAY
  in: CYBER_MONDAY
  in: CHRISTMAS
  in: BOXING_DAY
  in: INDEPENDENCE_DAY
  in: NATIONAL_DAY
  in: END_OF_SEASON
  in: WINTER_SALE
  in: SUMMER_SALE
  in: FALL_SALE
  in: SPRING_SALE
  in: RAMADAN
  in: EID_AL_FITR
  in: EID_AL_ADHA
  in: SINGLES_DAY
  in: WOMENS_DAY
  in: HOLI
  in: PARENTS_DAY
  in: ST_NICHOLAS_DAY
  in: CARNIVAL
  in: EPIPHANY
  in: ROSH_HASHANAH
  in: PASSOVER
  in: HANUKKAH
  in: DIWALI
  in: NAVRATRI
  in: SONGKRAN
  in: YEAR_END_GIFT
property:
  path: promotionCode
  name: promotion code
  description: A code the user should use in order to be eligible for the promotion.
  datatype: string
  max count: 1
property:
  path: startDate
  name: start date
  description: Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: adScheduleTargets
  name: ad schedule targets
  description: List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
  node: AdScheduleInfoShape
  class: AdScheduleInfo
  node kind: BlankNodeOrIRI
property:
  path: redemptionEndDate
  name: redemption end date
  description: Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: moneyAmountOff
  name: money amount off
  description: Money amount off for discount in the promotion. Either this or percent_off is required.
  node: CommonMoneyShape
  class: CommonMoney
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: discountModifier
  name: discount modifier
  description: A modifier for qualification of the discount.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: UP_TO
property:
  path: promotionQrCodeInfo
  name: promotion qr code info
  description: QR code info used to generate promotion QR code for user to be eligible for the promotion.
  node: PromotionQrCodeInfoShape
  class: PromotionQrCodeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: ordersOverAmount
  name: orders over amount
  description: The amount the total order needs to be for the user to be eligible for the promotion.
  node: CommonMoneyShape
  class: CommonMoney
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: promotionTarget
  name: promotion target
  description: Required. A freeform description of what the promotion is targeting.
  datatype: string
  max count: 1
property:
  path: languageCode
  name: language code
  description: The language of the promotion. Represented as BCP 47 language tag.
  datatype: string
  max count: 1
property:
  path: percentOff
  name: percent off
  description: Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required.
  datatype: long
  max count: 1
property:
  path: termsAndConditionsUri
  name: terms and conditions uri
  description: URI to the terms and conditions of the promotion.
  datatype: string
  max count: 1
property:
  path: redemptionStartDate
  name: redemption start date
  description: Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: termsAndConditionsText
  name: terms and conditions text
  description: Terms and conditions of the promotion.
  datatype: string
  max count: 1

PromotionBarcodeInfoShape
type: NodeShape
target class: PromotionBarcodeInfo
property:
  path: type
  name: type
  description: Barcode type used to generate barcode with the correct format.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AZTEC
  in: CODABAR
  in: CODE39
  in: CODE128
  in: DATA_MATRIX
  in: EAN8
  in: EAN13
  in: ITF
  in: PDF417
  in: UPC_A
property:
  path: barcodeContent
  name: barcode content
  description: Promotion message to be encoded in the barcode.
  datatype: string
  max count: 1

CommonMoneyShape
type: NodeShape
target class: CommonMoney
property:
  path: amountMicros
  name: amount micros
  description: Amount in micros. One million is equivalent to one unit.
  datatype: long
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: Three-character ISO 4217 currency code.
  datatype: string
  max count: 1

PromotionQrCodeInfoShape
type: NodeShape
target class: PromotionQrCodeInfo
property:
  path: qrCodeContent
  name: qr code content
  description: Promotion message to be encoded in the QR code.
  datatype: string
  max count: 1

CallToActionAssetShape
type: NodeShape
target class: CallToActionAsset
property:
  path: callToAction
  name: call to action
  description: Call to action.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LEARN_MORE
  in: GET_QUOTE
  in: APPLY_NOW
  in: SIGN_UP
  in: CONTACT_US
  in: SUBSCRIBE
  in: DOWNLOAD
  in: BOOK_NOW
  in: SHOP_NOW
  in: BUY_NOW
  in: DONATE_NOW
  in: ORDER_NOW
  in: PLAY_NOW
  in: SEE_MORE
  in: START_NOW
  in: VISIT_SITE
  in: WATCH_NOW

LocationAssetShape
type: NodeShape
target class: LocationAsset
property:
  path: locationOwnershipType
  name: location ownership type
  description: The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BUSINESS_OWNER
  in: AFFILIATE
property:
  path: placeId
  name: place id
  description: Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
  datatype: string
  max count: 1
property:
  path: businessProfileLocations
  name: business profile locations
  description: The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
  node: BusinessProfileLocationShape
  class: BusinessProfileLocation
  node kind: BlankNodeOrIRI

BusinessProfileLocationShape
type: NodeShape
target class: BusinessProfileLocation
property:
  path: storeCode
  name: store code
  description: Business Profile store code of this location. This is synced from the Business Profile account.
  datatype: string
  max count: 1
property:
  path: labels
  name: labels
  description: Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.
  datatype: string
property:
  path: listingId
  name: listing id
  description: Listing ID of this Business Profile location. This is synced from the linked Business Profile account.
  datatype: long
  max count: 1

YouTubeVideoListAssetShape
type: NodeShape
target class: YouTubeVideoListAsset
property:
  path: youtubeVideos
  name: youtube videos
  description: List of videos. Each is a reference to a YouTube video asset. Minimum of 2 videos required and maximum of 5 allowed.
  node: AdVideoAssetShape
  class: AdVideoAsset
  node kind: BlankNodeOrIRI

YoutubeVideoAssetShape
type: NodeShape
target class: YoutubeVideoAsset
property:
  path: youtubeVideoTitle
  name: youtube video title
  description: YouTube video title.
  datatype: string
  max count: 1
property:
  path: youtubeVideoId
  name: youtube video id
  description: YouTube video id. This is the 11 character string value used in the YouTube video URL.
  datatype: string
  max count: 1

DynamicRealEstateAssetShape
type: NodeShape
target class: DynamicRealEstateAsset
property:
  path: listingName
  name: listing name
  description: Required. Listing name, for example, Boulevard Bungalow. Required.
  datatype: string
  max count: 1
property:
  path: similarListingIds
  name: similar listing ids
  description: Similar listing IDs.
  datatype: string
property:
  path: imageUrl
  name: image url
  description: Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: listingType
  name: listing type
  description: Listing type, for example, For sale.
  datatype: string
  max count: 1
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: address
  name: address
  description: Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
  datatype: string
  max count: 1
property:
  path: cityName
  name: city name
  description: City name, for example, Mountain View, California.
  datatype: string
  max count: 1
property:
  path: propertyType
  name: property type
  description: Property type, for example, House.
  datatype: string
  max count: 1
property:
  path: price
  name: price
  description: Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 200,000.00 USD.
  datatype: string
  max count: 1
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1
property:
  path: formattedPrice
  name: formatted price
  description: Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $200,000.00.
  datatype: string
  max count: 1
property:
  path: contextualKeywords
  name: contextual keywords
  description: Contextual keywords, for example, For sale; Houses for sale.
  datatype: string
property:
  path: listingId
  name: listing id
  description: Required. Listing ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Description, for example, 3 beds, 2 baths, 1568 sq. ft.
  datatype: string
  max count: 1

MediaBundleAssetShape
type: NodeShape
target class: MediaBundleAsset
property:
  path: data
  name: data
  description: Media bundle (ZIP file) asset data. The format of the uploaded ZIP file depends on the ad field where it will be used. For more information on the format, see the documentation of the ad field where you plan on using the MediaBundleAsset. This field is mutate only.
  datatype: base64Binary
  max count: 1

DynamicLocalAssetShape
type: NodeShape
target class: DynamicLocalAsset
property:
  path: salePrice
  name: sale price
  description: Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
  datatype: string
  max count: 1
property:
  path: formattedSalePrice
  name: formatted sale price
  description: Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
  datatype: string
  max count: 1
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1
property:
  path: dealName
  name: deal name
  description: Required. Deal name, for example, 50% off at Mountain View Grocers. Required.
  datatype: string
  max count: 1
property:
  path: formattedPrice
  name: formatted price
  description: Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
  datatype: string
  max count: 1
property:
  path: subtitle
  name: subtitle
  description: Subtitle, for example, Groceries.
  datatype: string
  max count: 1
property:
  path: contextualKeywords
  name: contextual keywords
  description: Contextual keywords, for example, Save groceries coupons.
  datatype: string
property:
  path: description
  name: description
  description: Description, for example, Save on your weekly bill.
  datatype: string
  max count: 1
property:
  path: dealId
  name: deal id
  description: Required. Deal ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
  datatype: string
  max count: 1
property:
  path: imageUrl
  name: image url
  description: Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: address
  name: address
  description: Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
  datatype: string
  max count: 1
property:
  path: category
  name: category
  description: Category, for example, Food.
  datatype: string
  max count: 1
property:
  path: similarDealIds
  name: similar deal ids
  description: Similar deal IDs, for example, 1275.
  datatype: string
property:
  path: price
  name: price
  description: Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
  datatype: string
  max count: 1
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1

PageFeedAssetShape
type: NodeShape
target class: PageFeedAsset
property:
  path: labels
  name: labels
  description: Labels used to group the page urls.
  datatype: string
property:
  path: pageUrl
  name: page url
  description: Required. The webpage that advertisers want to target.
  datatype: string
  max count: 1

TextAssetShape
type: NodeShape
target class: TextAsset
property:
  path: text
  name: text
  description: Text content of the text asset.
  datatype: string
  max count: 1

CallAssetShape
type: NodeShape
target class: CallAsset
property:
  path: callConversionReportingState
  name: call conversion reporting state
  description: Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISABLED
  in: USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION
  in: USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION
property:
  path: countryCode
  name: country code
  description: Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
  datatype: string
  max count: 1
property:
  path: phoneNumber
  name: phone number
  description: Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
  datatype: string
  max count: 1
property:
  path: callConversionAction
  name: call conversion action
  description: The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
  datatype: string
  max count: 1
property:
  path: adScheduleTargets
  name: ad schedule targets
  description: List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
  node: AdScheduleInfoShape
  class: AdScheduleInfo
  node kind: BlankNodeOrIRI

DynamicHotelsAndRentalsAssetShape
type: NodeShape
target class: DynamicHotelsAndRentalsAsset
property:
  path: price
  name: price
  description: Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
  datatype: string
  max count: 1
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1
property:
  path: starRating
  name: star rating
  description: Star rating. Must be a number between 1 to 5, inclusive.
  datatype: long
  max count: 1
property:
  path: imageUrl
  name: image url
  description: Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: destinationName
  name: destination name
  description: Destination name, for example, Downtown Mountain View.
  datatype: string
  max count: 1
property:
  path: category
  name: category
  description: Category, for example, Hotel suite.
  datatype: string
  max count: 1
property:
  path: address
  name: address
  description: Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
  datatype: string
  max count: 1
property:
  path: propertyName
  name: property name
  description: Required. Property name, for example, Mountain View Hotel. Required.
  datatype: string
  max count: 1
property:
  path: propertyId
  name: property id
  description: Required. Property ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
  datatype: string
  max count: 1
property:
  path: contextualKeywords
  name: contextual keywords
  description: Contextual keywords, for example, Mountain View "Hotels", South Bay hotels.
  datatype: string
property:
  path: description
  name: description
  description: Description, for example, Close to SJC Airport.
  datatype: string
  max count: 1
property:
  path: similarPropertyIds
  name: similar property ids
  description: Similar property IDs.
  datatype: string
property:
  path: salePrice
  name: sale price
  description: ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
  datatype: string
  max count: 1
property:
  path: formattedSalePrice
  name: formatted sale price
  description: Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
  datatype: string
  max count: 1
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1
property:
  path: formattedPrice
  name: formatted price
  description: Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
  datatype: string
  max count: 1

DynamicFlightsAssetShape
type: NodeShape
target class: DynamicFlightsAsset
property:
  path: originName
  name: origin name
  description: Origin name, for example, London.
  datatype: string
  max count: 1
property:
  path: formattedPrice
  name: formatted price
  description: Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
  datatype: string
  max count: 1
property:
  path: flightSalePrice
  name: flight sale price
  description: Flight sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'flight_price' field.
  datatype: string
  max count: 1
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1
property:
  path: similarDestinationIds
  name: similar destination ids
  description: Similar destination IDs, for example, PAR,LON.
  datatype: string
property:
  path: formattedSalePrice
  name: formatted sale price
  description: Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
  datatype: string
  max count: 1
property:
  path: originId
  name: origin id
  description: Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
  datatype: string
  max count: 1
property:
  path: flightDescription
  name: flight description
  description: Required. Flight description, for example, Book your ticket. Required.
  datatype: string
  max count: 1
property:
  path: destinationId
  name: destination id
  description: Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
  datatype: string
  max count: 1
property:
  path: flightPrice
  name: flight price
  description: Flight price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
  datatype: string
  max count: 1
property:
  path: imageUrl
  name: image url
  description: Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: destinationName
  name: destination name
  description: Destination name, for example, Paris.
  datatype: string
  max count: 1
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1
property:
  path: customMapping
  name: custom mapping
  description: A custom field which can be multiple key to values mapping separated by delimiters (",", "|" and ":"), in the forms of ": , , ... , | : , ... , | ... | : , ... ," for example, wifi: most | aircraft: 320, 77W | flights: 42 | legroom: 32".
  datatype: string
  max count: 1

HotelPropertyAssetShape
type: NodeShape
target class: HotelPropertyAsset
property:
  path: hotelAddress
  name: hotel address
  description: Address of the hotel. Read-only.
  datatype: string
  max count: 1
property:
  path: hotelName
  name: hotel name
  description: Name of the hotel. Read-only.
  datatype: string
  max count: 1
property:
  path: placeId
  name: place id
  description: Place IDs uniquely identify a place in the Google Places database and on Google Maps. See https://developers.google.com/places/web-service/place-id to learn more.
  datatype: string
  max count: 1

DynamicCustomAssetShape
type: NodeShape
target class: DynamicCustomAsset
property:
  path: price
  name: price
  description: Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 20,000.00 USD.
  datatype: string
  max count: 1
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1
property:
  path: itemSubtitle
  name: item subtitle
  description: Item subtitle, for example, At your Mountain View dealership.
  datatype: string
  max count: 1
property:
  path: similarIds
  name: similar ids
  description: Similar IDs.
  datatype: string
property:
  path: imageUrl
  name: image url
  description: Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: itemTitle
  name: item title
  description: Required. Item title, for example, Mid-size sedan. Required.
  datatype: string
  max count: 1
property:
  path: itemCategory
  name: item category
  description: Item category, for example, Sedans.
  datatype: string
  max count: 1
property:
  path: contextualKeywords
  name: contextual keywords
  description: Contextual keywords, for example, Sedans, 4 door sedans.
  datatype: string
property:
  path: itemDescription
  name: item description
  description: Item description, for example, Best selling mid-size car.
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Required. ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag, for example, sedan. Required.
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 15,000.00 USD. Must be less than the 'price' field.
  datatype: string
  max count: 1
property:
  path: formattedSalePrice
  name: formatted sale price
  description: Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $15,000.00.
  datatype: string
  max count: 1
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1
property:
  path: itemAddress
  name: item address
  description: Item address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
  datatype: string
  max count: 1
property:
  path: id2
  name: id2
  description: ID2 which can be any sequence of letters and digits, for example, red. ID sequence (ID + ID2) must be unique.
  datatype: string
  max count: 1
property:
  path: formattedPrice
  name: formatted price
  description: Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $20,000.00.
  datatype: string
  max count: 1

HotelCalloutAssetShape
type: NodeShape
target class: HotelCalloutAsset
property:
  path: text
  name: text
  description: Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive.
  datatype: string
  max count: 1
property:
  path: languageCode
  name: language code
  description: Required. The language of the hotel callout. Represented as BCP 47 language tag.
  datatype: string
  max count: 1

AssetFieldTypePolicySummaryShape
type: NodeShape
target class: AssetFieldTypePolicySummary
property:
  path: policySummaryInfo
  name: policy summary info
  description: Output only. Policy summary.
  write lifecycle: Read only
  node: AssetPolicySummaryShape
  class: AssetPolicySummary
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: assetSource
  name: asset source
  description: Output only. Source of this asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: assetFieldType
  name: asset field type
  description: Output only. FieldType of this asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE

AssetPolicySummaryShape
type: NodeShape
target class: AssetPolicySummary
property:
  path: policyTopicEntries
  name: policy topic entries
  description: Output only. The list of policy findings for this asset.
  write lifecycle: Read only
  node: PolicyTopicEntryShape
  class: PolicyTopicEntry
  node kind: BlankNodeOrIRI
property:
  path: reviewStatus
  name: review status
  description: Output only. Where in the review process this asset is.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REVIEW_IN_PROGRESS
  in: REVIEWED
  in: UNDER_APPEAL
  in: ELIGIBLE_MAY_SERVE
property:
  path: approvalStatus
  name: approval status
  description: Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISAPPROVED
  in: APPROVED_LIMITED
  in: APPROVED
  in: AREA_OF_INTEREST_ONLY

PriceAssetShape
type: NodeShape
target class: PriceAsset
property:
  path: languageCode
  name: language code
  description: Required. The language of the price asset. Represented as BCP 47 language tag.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Required. The type of the price asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BRANDS
  in: EVENTS
  in: LOCATIONS
  in: NEIGHBORHOODS
  in: PRODUCT_CATEGORIES
  in: PRODUCT_TIERS
  in: SERVICES
  in: SERVICE_CATEGORIES
  in: SERVICE_TIERS
property:
  path: priceQualifier
  name: price qualifier
  description: The price qualifier of the price asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: FROM
  in: UP_TO
  in: AVERAGE
property:
  path: priceOfferings
  name: price offerings
  description: The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive.
  node: PriceOfferingShape
  class: PriceOffering
  node kind: BlankNodeOrIRI

PriceOfferingShape
type: NodeShape
target class: PriceOffering
property:
  path: header
  name: header
  description: Required. The header of the price offering. The length of this string should be between 1 and 25, inclusive.
  datatype: string
  max count: 1
property:
  path: finalMobileUrl
  name: final mobile url
  description: The final mobile URL after all cross domain redirects.
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Required. The description of the price offering. The length of this string should be between 1 and 25, inclusive.
  datatype: string
  max count: 1
property:
  path: price
  name: price
  description: Required. The price value of the price offering.
  node: CommonMoneyShape
  class: CommonMoney
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: unit
  name: unit
  description: The price unit of the price offering.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PER_HOUR
  in: PER_DAY
  in: PER_WEEK
  in: PER_MONTH
  in: PER_YEAR
  in: PER_NIGHT
property:
  path: finalUrl
  name: final url
  description: Required. The final URL after all cross domain redirects.
  datatype: string
  max count: 1

ImageAssetShape
type: NodeShape
target class: ImageAsset
property:
  path: fileSize
  name: file size
  description: File size of the image asset in bytes.
  datatype: long
  max count: 1
property:
  path: data
  name: data
  description: The raw bytes data of an image. This field is mutate only.
  datatype: base64Binary
  max count: 1
property:
  path: fullSize
  name: full size
  description: Metadata for this image at its original size.
  node: ImageDimensionShape
  class: ImageDimension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mimeType
  name: mime type
  description: MIME type of the image asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: IMAGE_JPEG
  in: IMAGE_GIF
  in: IMAGE_PNG
  in: FLASH
  in: TEXT_HTML
  in: PDF
  in: MSWORD
  in: MSEXCEL
  in: RTF
  in: AUDIO_WAV
  in: AUDIO_MP3
  in: HTML5_AD_ZIP

ImageDimensionShape
type: NodeShape
target class: ImageDimension
property:
  path: heightPixels
  name: height pixels
  description: Height of the image.
  datatype: long
  max count: 1
property:
  path: widthPixels
  name: width pixels
  description: Width of the image.
  datatype: long
  max count: 1
property:
  path: url
  name: url
  description: A URL that returns the image with this height and width.
  datatype: string
  max count: 1

DynamicEducationAssetShape
type: NodeShape
target class: DynamicEducationAsset
property:
  path: androidAppLink
  name: android app link
  description: Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
  datatype: string
  max count: 1
property:
  path: imageUrl
  name: image url
  description: Image url, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: address
  name: address
  description: School address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
  datatype: string
  max count: 1
property:
  path: iosAppLink
  name: ios app link
  description: iOS deep link, for example, exampleApp://content/page.
  datatype: string
  max count: 1
property:
  path: schoolName
  name: school name
  description: School name, for example, Mountain View School of Nursing.
  datatype: string
  max count: 1
property:
  path: locationId
  name: location id
  description: Location ID which can be any sequence of letters and digits and must be unique.
  datatype: string
  max count: 1
property:
  path: programId
  name: program id
  description: Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
  datatype: string
  max count: 1
property:
  path: similarProgramIds
  name: similar program ids
  description: Similar program IDs.
  datatype: string
property:
  path: iosAppStoreId
  name: ios app store id
  description: iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
  datatype: long
  max count: 1
property:
  path: programName
  name: program name
  description: Required. Program name, for example, Nursing. Required.
  datatype: string
  max count: 1
property:
  path: thumbnailImageUrl
  name: thumbnail image url
  description: Thumbnail image url, for example, http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset.
  datatype: string
  max count: 1
property:
  path: subject
  name: subject
  description: Subject of study, for example, Health.
  datatype: string
  max count: 1
property:
  path: contextualKeywords
  name: contextual keywords
  description: Contextual keywords, for example, Nursing certification, Health, Mountain View.
  datatype: string
property:
  path: programDescription
  name: program description
  description: Program description, for example, Nursing Certification.
  datatype: string
  max count: 1

StructuredSnippetAssetShape
type: NodeShape
target class: StructuredSnippetAsset
property:
  path: header
  name: header
  description: Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers
  datatype: string
  max count: 1
property:
  path: values
  name: values
  description: Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive.
  datatype: string

MobileAppAssetShape
type: NodeShape
target class: MobileAppAsset
property:
  path: linkText
  name: link text
  description: Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive.
  datatype: string
  max count: 1
property:
  path: startDate
  name: start date
  description: Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: endDate
  name: end date
  description: Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: appId
  name: app id
  description: Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.
  datatype: string
  max count: 1
property:
  path: appStore
  name: app store
  description: Required. The application store that distributes this specific app.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPLE_APP_STORE
  in: GOOGLE_APP_STORE

DemandGenCarouselCardAssetShape
type: NodeShape
target class: DemandGenCarouselCardAsset
property:
  path: squareMarketingImageAsset
  name: square marketing image asset
  description: Asset resource name of the associated square marketing image. This and/or a marketing image asset is required.
  datatype: string
  max count: 1
property:
  path: portraitMarketingImageAsset
  name: portrait marketing image asset
  description: Asset resource name of the associated 4:5 portrait marketing image.
  datatype: string
  max count: 1
property:
  path: callToActionText
  name: call to action text
  description: Call to action text.
  datatype: string
  max count: 1
property:
  path: marketingImageAsset
  name: marketing image asset
  description: Asset resource name of the associated 1.91:1 marketing image. This and/or square marketing image asset is required.
  datatype: string
  max count: 1
property:
  path: headline
  name: headline
  description: Required. Headline of the carousel card.
  datatype: string
  max count: 1

CalloutAssetShape
type: NodeShape
target class: CalloutAsset
property:
  path: startDate
  name: start date
  description: Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: endDate
  name: end date
  description: Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
  datatype: string
  max count: 1
property:
  path: adScheduleTargets
  name: ad schedule targets
  description: List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
  node: AdScheduleInfoShape
  class: AdScheduleInfo
  node kind: BlankNodeOrIRI
property:
  path: calloutText
  name: callout text
  description: Required. The callout text. The length of this string should be between 1 and 25, inclusive.
  datatype: string
  max count: 1

AssetCoverageShape
type: NodeShape
target class: AssetCoverage
property:
  path: adStrengthActionItems
  name: ad strength action items
  description: Output only. A list of action items to improve the ad strength of an asset group.
  write lifecycle: Read only
  node: AdStrengthActionItemShape
  class: AdStrengthActionItem
  node kind: BlankNodeOrIRI

AssetFieldTypeViewShape
type: NodeShape
target class: AssetFieldTypeView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the asset field type view. Asset field type view resource names have the form: `customers/{customer_id}/assetFieldTypeViews/{field_type}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: Output only. The asset field type of the asset field type view.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE

AssetGroupShape
type: NodeShape
target class: AssetGroup
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: finalUrls
  name: final urls
  description: A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
  datatype: string
property:
  path: adStrength
  name: ad strength
  description: Output only. Overall ad strength of this asset group.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: NO_ADS
  in: POOR
  in: AVERAGE
  in: GOOD
  in: EXCELLENT
property:
  path: finalMobileUrls
  name: final mobile urls
  description: A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
  datatype: string
property:
  path: googleLocalServicesInfo
  name: google local services info
  description: Local services info of the asset group.
  node: GoogleLocalServicesInfoShape
  class: GoogleLocalServicesInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: path2
  name: path2
  description: Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
  datatype: string
  max count: 1
property:
  path: primaryStatus
  name: primary status
  description: Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: NOT_ELIGIBLE
  in: LIMITED
  in: PENDING
property:
  path: assetCoverage
  name: asset coverage
  description: Output only. The asset coverage of this asset group.
  write lifecycle: Read only
  node: AssetCoverageShape
  class: AssetCoverage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the asset group.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: The status of the asset group.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: PAUSED
  in: REMOVED
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
  datatype: string
  max count: 1
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: ASSET_GROUP_PAUSED
  in: ASSET_GROUP_REMOVED
  in: CAMPAIGN_REMOVED
  in: CAMPAIGN_PAUSED
  in: CAMPAIGN_PENDING
  in: CAMPAIGN_ENDED
  in: ASSET_GROUP_LIMITED
  in: ASSET_GROUP_DISAPPROVED
  in: ASSET_GROUP_UNDER_REVIEW
property:
  path: path1
  name: path1
  description: First part of text that may appear appended to the url displayed in the ad.
  datatype: string
  max count: 1

GoogleLocalServicesInfoShape
type: NodeShape
target class: GoogleLocalServicesInfo
property:
  path: categoryId
  name: category id
  description: Immutable. The local services category associated with this asset group. That is, XCAT format - xcat:service_area_business_plumber. See https://developers.google.com/google-ads/api/data/codes-formats#local-services-category-ids This field cannot be modified after the AssetGroup has been created.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: callouts
  name: callouts
  description: Callouts selected by the advertiser to show.
  node: LocalServicesCalloutShape
  class: LocalServicesCallout
  node kind: BlankNodeOrIRI

LocalServicesCalloutShape
type: NodeShape
target class: LocalServicesCallout
property:
  path: calloutId
  name: callout id
  description: Required. The unique ID of the callout.
  datatype: string
  max count: 1

AssetGroupAssetShape
type: NodeShape
target class: AssetGroupAsset
property:
  path: asset
  name: asset
  description: Immutable. The asset which this asset group asset is linking.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: source
  name: source
  description: Output only. Source of the asset group asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: ASSET_LINK_PAUSED
  in: ASSET_LINK_REMOVED
  in: ASSET_DISAPPROVED
  in: ASSET_UNDER_REVIEW
  in: ASSET_APPROVED_LABELED
property:
  path: primaryStatusDetails
  name: primary status details
  description: Output only. Provides the details of the primary status and its associated reasons.
  write lifecycle: Read only
  node: AssetLinkPrimaryStatusDetailsShape
  class: AssetLinkPrimaryStatusDetails
  node kind: BlankNodeOrIRI
property:
  path: policySummary
  name: policy summary
  description: Output only. The policy information for this asset group asset.
  write lifecycle: Read only
  node: PolicySummaryShape
  class: PolicySummary
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: primaryStatus
  name: primary status
  description: Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: PENDING
  in: LIMITED
  in: NOT_ELIGIBLE
property:
  path: assetGroup
  name: asset group
  description: Immutable. The asset group which this asset group asset is linking.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the asset group asset. Asset group asset resource name have the form: `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: status
  name: status
  description: The status of the link between an asset and asset group.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: PAUSED

PolicySummaryShape
type: NodeShape
target class: PolicySummary
property:
  path: approvalStatus
  name: approval status
  description: The overall approval status, which is calculated based on the status of its individual policy topic entries.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISAPPROVED
  in: APPROVED_LIMITED
  in: APPROVED
  in: AREA_OF_INTEREST_ONLY
property:
  path: policyTopicEntries
  name: policy topic entries
  description: The list of policy findings.
  node: PolicyTopicEntryShape
  class: PolicyTopicEntry
  node kind: BlankNodeOrIRI
property:
  path: reviewStatus
  name: review status
  description: Where in the review process the resource is.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REVIEW_IN_PROGRESS
  in: REVIEWED
  in: UNDER_APPEAL
  in: ELIGIBLE_MAY_SERVE

AssetGroupAssetCombinationDataShape
type: NodeShape
target class: AssetGroupAssetCombinationData
property:
  path: assetCombinationServedAssets
  name: asset combination served assets
  description: Output only. Served assets.
  write lifecycle: Read only
  node: AssetUsageShape
  class: AssetUsage
  node kind: BlankNodeOrIRI

AssetGroupListingGroupFilterShape
type: NodeShape
target class: AssetGroupListingGroupFilter
property:
  path: id
  name: id
  description: Output only. The ID of the ListingGroupFilter.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: path
  name: path
  description: Output only. The path of dimensions defining this listing group filter.
  write lifecycle: Read only
  node: ListingGroupFilterDimensionPathShape
  class: ListingGroupFilterDimensionPath
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: listingSource
  name: listing source
  description: Immutable. The source of listings filtered by this listing group filter.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SHOPPING
  in: WEBPAGE
  in: RETAIL
property:
  path: parentListingGroupFilter
  name: parent listing group filter
  description: Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: caseValue
  name: case value
  description: Dimension value with which this listing group is refining its parent. Undefined for the root group.
  node: ListingGroupFilterDimensionShape
  class: ListingGroupFilterDimension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Immutable. Type of a listing group filter node.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SUBDIVISION
  in: UNIT_INCLUDED
  in: UNIT_EXCLUDED
property:
  path: assetGroup
  name: asset group
  description: Immutable. The asset group which this asset group listing group filter is part of.
  write lifecycle: Create only
  datatype: string
  max count: 1

ListingGroupFilterDimensionPathShape
type: NodeShape
target class: ListingGroupFilterDimensionPath
property:
  path: dimensions
  name: dimensions
  description: Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
  write lifecycle: Read only
  node: ListingGroupFilterDimensionShape
  class: ListingGroupFilterDimension
  node kind: BlankNodeOrIRI

ListingGroupFilterDimensionShape
type: NodeShape
target class: ListingGroupFilterDimension
property:
  path: productChannel
  name: product channel
  description: Locality of a product offer.
  node: ListingGroupFilterDimensionProductChannelShape
  class: ListingGroupFilterDimensionProductChannel
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productType
  name: product type
  description: Type of a product offer.
  node: ListingGroupFilterDimensionProductTypeShape
  class: ListingGroupFilterDimensionProductType
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productBrand
  name: product brand
  description: Brand of a product offer.
  node: ListingGroupFilterDimensionProductBrandShape
  class: ListingGroupFilterDimensionProductBrand
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productCategory
  name: product category
  description: Category of a product offer.
  node: ListingGroupFilterDimensionProductCategoryShape
  class: ListingGroupFilterDimensionProductCategory
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productCustomAttribute
  name: product custom attribute
  description: Custom attribute of a product offer.
  node: ListingGroupFilterDimensionProductCustomAttributeShape
  class: ListingGroupFilterDimensionProductCustomAttribute
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: webpage
  name: webpage
  description: Filters for URLs in a page feed and URLs from the advertiser web domain.
  node: ListingGroupFilterDimensionWebpageShape
  class: ListingGroupFilterDimensionWebpage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productItemId
  name: product item id
  description: Item id of a product offer.
  node: ListingGroupFilterDimensionProductItemIdShape
  class: ListingGroupFilterDimensionProductItemId
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productCondition
  name: product condition
  description: Condition of a product offer.
  node: ListingGroupFilterDimensionProductConditionShape
  class: ListingGroupFilterDimensionProductCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: retailFilterBundle
  name: retail filter bundle
  description: Dimension for Retail Product Tags.
  node: ListingGroupFilterDimensionRetailFilterBundleShape
  class: ListingGroupFilterDimensionRetailFilterBundle
  node kind: BlankNodeOrIRI
  max count: 1

ListingGroupFilterDimensionProductChannelShape
type: NodeShape
target class: ListingGroupFilterDimensionProductChannel
property:
  path: channel
  name: channel
  description: Value of the locality.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ONLINE
  in: LOCAL

ListingGroupFilterDimensionProductTypeShape
type: NodeShape
target class: ListingGroupFilterDimensionProductType
property:
  path: value
  name: value
  description: Value of the type.
  datatype: string
  max count: 1
property:
  path: level
  name: level
  description: Level of the type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LEVEL1
  in: LEVEL2
  in: LEVEL3
  in: LEVEL4
  in: LEVEL5

ListingGroupFilterDimensionProductBrandShape
type: NodeShape
target class: ListingGroupFilterDimensionProductBrand
property:
  path: value
  name: value
  description: String value of the product brand.
  datatype: string
  max count: 1

ListingGroupFilterDimensionProductCategoryShape
type: NodeShape
target class: ListingGroupFilterDimensionProductCategory
property:
  path: categoryId
  name: category id
  description: 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
  datatype: long
  max count: 1
property:
  path: level
  name: level
  description: Indicates the level of the category in the taxonomy.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LEVEL1
  in: LEVEL2
  in: LEVEL3
  in: LEVEL4
  in: LEVEL5

ListingGroupFilterDimensionProductCustomAttributeShape
type: NodeShape
target class: ListingGroupFilterDimensionProductCustomAttribute
property:
  path: value
  name: value
  description: String value of the product custom attribute.
  datatype: string
  max count: 1
property:
  path: index
  name: index
  description: Indicates the index of the custom attribute.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INDEX0
  in: INDEX1
  in: INDEX2
  in: INDEX3
  in: INDEX4

ListingGroupFilterDimensionWebpageShape
type: NodeShape
target class: ListingGroupFilterDimensionWebpage
property:
  path: conditions
  name: conditions
  description: The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
  node: ListingGroupFilterDimensionWebpageConditionShape
  class: ListingGroupFilterDimensionWebpageCondition
  node kind: BlankNodeOrIRI

ListingGroupFilterDimensionWebpageConditionShape
type: NodeShape
target class: ListingGroupFilterDimensionWebpageCondition
property:
  path: urlContains
  name: url contains
  description: Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
  datatype: string
  max count: 1
property:
  path: customLabel
  name: custom label
  description: Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
  datatype: string
  max count: 1

ListingGroupFilterDimensionProductItemIdShape
type: NodeShape
target class: ListingGroupFilterDimensionProductItemId
property:
  path: value
  name: value
  description: Value of the id.
  datatype: string
  max count: 1

ListingGroupFilterDimensionProductConditionShape
type: NodeShape
target class: ListingGroupFilterDimensionProductCondition
property:
  path: condition
  name: condition
  description: Value of the condition.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEW
  in: REFURBISHED
  in: USED

ListingGroupFilterDimensionRetailFilterBundleShape
type: NodeShape
target class: ListingGroupFilterDimensionRetailFilterBundle
property:
  path: sharedSet
  name: shared set
  description: The RetailFilterBundle shared set resource name.
  datatype: string
  max count: 1

AssetGroupProductGroupViewShape
type: NodeShape
target class: AssetGroupProductGroupView
property:
  path: assetGroupListingGroupFilter
  name: asset group listing group filter
  description: Output only. The resource name of the asset group listing group filter.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: assetGroup
  name: asset group
  description: Output only. The asset group associated with the listing group filter.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form: `customers/{customer_id}/assetGroupProductGroupViews/{asset_group_id}~{listing_group_filter_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

AssetGroupSignalShape
type: NodeShape
target class: AssetGroupSignal
property:
  path: localServicesId
  name: local services id
  description: Immutable. The local services signal to be used by the performance max campaign.
  write lifecycle: Create only
  node: LocalServiceIdInfoShape
  class: LocalServiceIdInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: assetGroup
  name: asset group
  description: Immutable. The asset group which this asset group signal belongs to.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: audience
  name: audience
  description: Immutable. The audience signal to be used by the performance max campaign.
  write lifecycle: Create only
  node: AudienceInfoShape
  class: AudienceInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: verticalAdsItemGroupRuleList
  name: vertical ads item group rule list
  description: Immutable. The list of vertical ads item group rules used to select items from the attached vertical feed. This field links to a SharedSet of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST. The rules within the linked SharedSet define which items from the TRAVEL_FEED AssetSet are eligible to be served. Items that do not match the rules will be excluded. This behavior is different from other signal types, which provide guidance to the optimization engine rather than determining item eligibility.
  write lifecycle: Create only
  node: VerticalAdsItemGroupRuleListInfoShape
  class: VerticalAdsItemGroupRuleListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: searchTheme
  name: search theme
  description: Immutable. The search_theme signal to be used by the performance max campaign. Mutate errors of search_theme criterion includes AssetGroupSignalError.UNSPECIFIED AssetGroupSignalError.UNKNOWN AssetGroupSignalError.TOO_MANY_WORDS AssetGroupSignalError.SEARCH_THEME_POLICY_VIOLATION FieldError.REQUIRED StringFormatError.ILLEGAL_CHARS StringLengthError.TOO_LONG ResourceCountLimitExceededError.RESOURCE_LIMIT
  write lifecycle: Create only
  node: SearchThemeInfoShape
  class: SearchThemeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: approvalStatus
  name: approval status
  description: Output only. Approval status is the output value for search theme signal after Google ads policy review. When using Audience signal, this field is not used and will be absent.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPROVED
  in: LIMITED
  in: DISAPPROVED
  in: UNDER_REVIEW
property:
  path: disapprovalReasons
  name: disapproval reasons
  description: Output only. Computed for SearchTheme signals. When using Audience signal, this field is not used and will be absent.
  write lifecycle: Read only
  datatype: string

LocalServiceIdInfoShape
type: NodeShape
target class: LocalServiceIdInfo
property:
  path: serviceId
  name: service id
  description: The criterion resource name.
  datatype: string
  max count: 1

SearchThemeInfoShape
type: NodeShape
target class: SearchThemeInfo
property:
  path: text
  name: text
  description: Each Search Theme has a value of a simple string, like keywords. There are limits on overall length, allowed characters, and number of words.
  datatype: string
  max count: 1

AssetGroupTopCombinationViewShape
type: NodeShape
target class: AssetGroupTopCombinationView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: assetGroupTopCombinations
  name: asset group top combinations
  description: Output only. The top combinations of assets that served together.
  write lifecycle: Read only
  node: AssetGroupAssetCombinationDataShape
  class: AssetGroupAssetCombinationData
  node kind: BlankNodeOrIRI

AssetInteractionTargetShape
type: NodeShape
target class: AssetInteractionTarget
property:
  path: asset
  name: asset
  description: The asset resource name.
  datatype: string
  max count: 1
property:
  path: interactionOnThisAsset
  name: interaction on this asset
  description: 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.
  datatype: boolean
  max count: 1

AssetSetShape
type: NodeShape
target class: AssetSet
property:
  path: type
  name: type
  description: Required. Immutable. The type of the asset set. Required.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PAGE_FEED
  in: DYNAMIC_EDUCATION
  in: MERCHANT_CENTER_FEED
  in: DYNAMIC_REAL_ESTATE
  in: DYNAMIC_CUSTOM
  in: DYNAMIC_HOTELS_AND_RENTALS
  in: DYNAMIC_FLIGHTS
  in: DYNAMIC_TRAVEL
  in: DYNAMIC_LOCAL
  in: DYNAMIC_JOBS
  in: LOCATION_SYNC
  in: BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP
  in: CHAIN_DYNAMIC_LOCATION_GROUP
  in: STATIC_LOCATION_GROUP
  in: HOTEL_PROPERTY
  in: TRAVEL_FEED
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: travelFeedData
  name: travel feed data
  description: Output only. Travel Feed data. Read-only
  write lifecycle: Read only
  node: AssetSetTravelFeedDataShape
  class: AssetSetTravelFeedData
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationSet
  name: location set
  description: Location asset set data. This will be used for sync level location set. This can only be set if AssetSet's type is LOCATION_SYNC.
  node: LocationSetShape
  class: LocationSet
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: merchantCenterFeed
  name: merchant center feed
  description: Merchant ID and Feed Label from Google Merchant Center.
  node: AssetSetMerchantCenterFeedShape
  class: AssetSetMerchantCenterFeed
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the asset set.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the asset set. Read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: chainLocationGroup
  name: chain location group
  description: Represents information about a Chain dynamic location group. Only applicable if the sync level AssetSet's type is LOCATION_SYNC and sync source is chain.
  node: ChainLocationGroupShape
  class: ChainLocationGroup
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationGroupParentAssetSetId
  name: location group parent asset set id
  description: Immutable. Parent asset set ID for the asset set where the elements of this asset set come from. For example: the sync level location AssetSet id where the elements in LocationGroup AssetSet come from. This field is required and only applicable for Location Group typed AssetSet.
  write lifecycle: Create only
  datatype: long
  max count: 1
property:
  path: hotelPropertyData
  name: hotel property data
  description: Output only. For Performance Max for travel goals campaigns with a Hotel Center account link. Read-only.
  write lifecycle: Read only
  node: AssetSetHotelPropertyDataShape
  class: AssetSetHotelPropertyData
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: businessProfileLocationGroup
  name: business profile location group
  description: Business Profile location group asset set data.
  node: BusinessProfileLocationGroupShape
  class: BusinessProfileLocationGroup
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: name
  name: name
  description: Required. Name of the asset set. Required. It must have a minimum length of 1 and maximum length of 128.
  datatype: string
  max count: 1

AssetSetTravelFeedDataShape
type: NodeShape
target class: AssetSetTravelFeedData
property:
  path: partnerCenterId
  name: partner center id
  description: Output only. The Partner Center ID used for a travel vertical feed, except for Hotel, Vacation Rental, and Things to Do feeds.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: travelFeedVerticalType
  name: travel feed vertical type
  description: Output only. Indicates the vertical type of the travel feed.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HOTELS
  in: VACATION_RENTALS
  in: RENTAL_CARS
  in: EVENTS
  in: THINGS_TO_DO
  in: FLIGHTS
property:
  path: hotelCenterAccountId
  name: hotel center account id
  description: Output only. The Hotel Center account ID used for a Hotel or Vacation Rental feed.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: merchantCenterId
  name: merchant center id
  description: Output only. The Merchant Center account ID used for a Things to Do feed.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: subsetId
  name: subset id
  description: Output only. Id representing a subset of the travel feed.
  write lifecycle: Read only
  datatype: long
  max count: 1

LocationSetShape
type: NodeShape
target class: LocationSet
property:
  path: chainLocationSet
  name: chain location set
  description: Data used to configure a location on chain set populated with the specified chains.
  node: ChainSetShape
  class: ChainSet
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mapsLocationSet
  name: maps location set
  description: Only set if locations are synced based on selected maps locations
  node: MapsLocationSetShape
  class: MapsLocationSet
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationOwnershipType
  name: location ownership type
  description: Required. Immutable. Location Ownership Type (owned location or affiliate location).
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BUSINESS_OWNER
  in: AFFILIATE
property:
  path: businessProfileLocationSet
  name: business profile location set
  description: Data used to configure a location set populated from Google Business Profile locations.
  node: BusinessProfileLocationSetShape
  class: BusinessProfileLocationSet
  node kind: BlankNodeOrIRI
  max count: 1

ChainSetShape
type: NodeShape
target class: ChainSet
property:
  path: relationshipType
  name: relationship type
  description: Required. Immutable. Relationship type the specified chains have with this advertiser.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AUTO_DEALERS
  in: GENERAL_RETAILERS
property:
  path: chains
  name: chains
  description: Required. A list of chain level filters, all filters are OR'ed together.
  node: ChainFilterShape
  class: ChainFilter
  node kind: BlankNodeOrIRI

ChainFilterShape
type: NodeShape
target class: ChainFilter
property:
  path: chainId
  name: chain id
  description: Required. Used to filter chain locations by chain id. Only chain locations that belong to the specified chain will be in the asset set.
  datatype: long
  max count: 1
property:
  path: locationAttributes
  name: location attributes
  description: Used to filter chain locations by location attributes. Only chain locations that belong to all of the specified attribute(s) will be in the asset set. If this field is empty, it means no filtering on this field.
  datatype: string

MapsLocationSetShape
type: NodeShape
target class: MapsLocationSet
property:
  path: mapsLocations
  name: maps locations
  description: Required. A list of maps location info that user manually synced in.
  node: MapsLocationInfoShape
  class: MapsLocationInfo
  node kind: BlankNodeOrIRI

MapsLocationInfoShape
type: NodeShape
target class: MapsLocationInfo
property:
  path: placeId
  name: place id
  description: Place ID of the Maps location.
  datatype: string
  max count: 1

BusinessProfileLocationSetShape
type: NodeShape
target class: BusinessProfileLocationSet
property:
  path: labelFilters
  name: label filters
  description: Used to filter Google Business Profile listings by labels. If entries exist in labelFilters, only listings that have any of the labels set are candidates to be synchronized into Assets. If no entries exist in labelFilters, then all listings are candidates for syncing. Label filters are OR'ed together.
  datatype: string
property:
  path: httpAuthorizationToken
  name: http authorization token
  description: Required. Immutable. The HTTP authorization token used to obtain authorization.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: emailAddress
  name: email address
  description: Required. Immutable. Email address of a Google Business Profile account or email address of a manager of the Google Business Profile account.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: listingIdFilters
  name: listing id filters
  description: Used to filter Google Business Profile listings by listing id. If entries exist in listingIdFilters, only listings specified by the filters are candidates to be synchronized into Assets. If no entries exist in listingIdFilters, then all listings are candidates for syncing. Listing ID filters are OR'ed together.
  datatype: long
property:
  path: businessNameFilter
  name: business name filter
  description: Used to filter Google Business Profile listings by business name. If businessNameFilter is set, only listings with a matching business name are candidates to be sync'd into Assets.
  datatype: string
  max count: 1
property:
  path: businessAccountId
  name: business account id
  description: Immutable. The account ID of the managed business whose locations are to be used. If this field is not set, then all businesses accessible by the user (specified by the emailAddress) are used.
  write lifecycle: Create only
  datatype: string
  max count: 1

AssetSetMerchantCenterFeedShape
type: NodeShape
target class: AssetSetMerchantCenterFeed
property:
  path: merchantId
  name: merchant id
  description: Required. Merchant ID from Google Merchant Center
  datatype: long
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Optional. Feed Label from Google Merchant Center.
  datatype: string
  max count: 1

ChainLocationGroupShape
type: NodeShape
target class: ChainLocationGroup
property:
  path: dynamicChainLocationGroupFilters
  name: dynamic chain location group filters
  description: Used to filter chain locations by chain ids. Only Locations that belong to the specified chain(s) will be in the asset set.
  node: ChainFilterShape
  class: ChainFilter
  node kind: BlankNodeOrIRI

AssetSetHotelPropertyDataShape
type: NodeShape
target class: AssetSetHotelPropertyData
property:
  path: hotelCenterId
  name: hotel center id
  description: Output only. The hotel center ID of the partner.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: partnerName
  name: partner name
  description: Output only. Name of the hotel partner.
  write lifecycle: Read only
  datatype: string
  max count: 1

BusinessProfileLocationGroupShape
type: NodeShape
target class: BusinessProfileLocationGroup
property:
  path: dynamicBusinessProfileLocationGroupFilter
  name: dynamic business profile location group filter
  description: Filter for dynamic Business Profile location sets.
  node: DynamicBusinessProfileLocationGroupFilterShape
  class: DynamicBusinessProfileLocationGroupFilter
  node kind: BlankNodeOrIRI
  max count: 1

DynamicBusinessProfileLocationGroupFilterShape
type: NodeShape
target class: DynamicBusinessProfileLocationGroupFilter
property:
  path: labelFilters
  name: label filters
  description: Used to filter Business Profile locations by label. Only locations that have any of the listed labels will be in the asset set. Label filters are OR'ed together.
  datatype: string
property:
  path: businessNameFilter
  name: business name filter
  description: Used to filter Business Profile locations by business name.
  node: BusinessProfileBusinessNameFilterShape
  class: BusinessProfileBusinessNameFilter
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: listingIdFilters
  name: listing id filters
  description: Used to filter Business Profile locations by listing ids.
  datatype: long

BusinessProfileBusinessNameFilterShape
type: NodeShape
target class: BusinessProfileBusinessNameFilter
property:
  path: businessName
  name: business name
  description: Business name string to use for filtering.
  datatype: string
  max count: 1
property:
  path: filterType
  name: filter type
  description: The type of string matching to use when filtering with business_name.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXACT

AssetSetAssetShape
type: NodeShape
target class: AssetSetAsset
property:
  path: asset
  name: asset
  description: Immutable. The asset which this asset set asset is linking to.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: assetSet
  name: asset set
  description: Immutable. The asset set which this asset set asset is linking to.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the asset set asset. Read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED

AssetSetTypeViewShape
type: NodeShape
target class: AssetSetTypeView
property:
  path: assetSetType
  name: asset set type
  description: Output only. The asset set type of the asset set type view.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PAGE_FEED
  in: DYNAMIC_EDUCATION
  in: MERCHANT_CENTER_FEED
  in: DYNAMIC_REAL_ESTATE
  in: DYNAMIC_CUSTOM
  in: DYNAMIC_HOTELS_AND_RENTALS
  in: DYNAMIC_FLIGHTS
  in: DYNAMIC_TRAVEL
  in: DYNAMIC_LOCAL
  in: DYNAMIC_JOBS
  in: LOCATION_SYNC
  in: BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP
  in: CHAIN_DYNAMIC_LOCATION_GROUP
  in: STATIC_LOCATION_GROUP
  in: HOTEL_PROPERTY
  in: TRAVEL_FEED
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the asset set type view. Asset set type view resource names have the form: `customers/{customer_id}/assetSetTypeViews/{asset_set_type}`
  write lifecycle: Read only
  datatype: string
  max count: 1

AudienceShape
type: NodeShape
target class: Audience
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the audience. Audience names have the form: `customers/{customer_id}/audiences/{audience_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Description of this audience.
  datatype: string
  max count: 1
property:
  path: assetGroup
  name: asset group
  description: Immutable. The asset group that this audience is scoped under. Must be set if and only if scope is ASSET_GROUP. Immutable after creation. If an audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field will automatically be cleared.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. ID of the audience.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Status of this audience. Indicates whether the audience is enabled or removed.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: dimensions
  name: dimensions
  description: Positive dimensions specifying the audience composition.
  node: AudienceDimensionShape
  class: AudienceDimension
  node kind: BlankNodeOrIRI
property:
  path: exclusionDimension
  name: exclusion dimension
  description: Negative dimension specifying the audience composition.
  node: AudienceExclusionDimensionShape
  class: AudienceExclusionDimension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: name
  name: name
  description: Name of the audience. It should be unique across all audiences within the account. It must have a minimum length of 1 and maximum length of 255. Required when scope is not set or is set to CUSTOMER. Cannot be set or updated when scope is ASSET_GROUP.
  datatype: string
  max count: 1
property:
  path: scope
  name: scope
  description: Defines the scope this audience can be used in. By default, the scope is CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for exclusive use by a single asset_group. Scope may change from ASSET_GROUP to CUSTOMER but not from CUSTOMER to ASSET_GROUP.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER
  in: ASSET_GROUP

AudienceDimensionShape
type: NodeShape
target class: AudienceDimension
property:
  path: householdIncome
  name: household income
  description: Dimension specifying users by their household income.
  node: HouseholdIncomeDimensionShape
  class: HouseholdIncomeDimension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: age
  name: age
  description: Dimension specifying users by their age.
  node: AgeDimensionShape
  class: AgeDimension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audienceSegments
  name: audience segments
  description: Dimension specifying users by their membership in other audience segments.
  node: AudienceSegmentDimensionShape
  class: AudienceSegmentDimension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: gender
  name: gender
  description: Dimension specifying users by their gender.
  node: GenderDimensionShape
  class: GenderDimension
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: parentalStatus
  name: parental status
  description: Dimension specifying users by their parental status.
  node: ParentalStatusDimensionShape
  class: ParentalStatusDimension
  node kind: BlankNodeOrIRI
  max count: 1

HouseholdIncomeDimensionShape
type: NodeShape
target class: HouseholdIncomeDimension
property:
  path: incomeRanges
  name: income ranges
  description: Included household income demographic segments.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: INCOME_RANGE_0_50
  in: INCOME_RANGE_50_60
  in: INCOME_RANGE_60_70
  in: INCOME_RANGE_70_80
  in: INCOME_RANGE_80_90
  in: INCOME_RANGE_90_UP
  in: INCOME_RANGE_UNDETERMINED
property:
  path: includeUndetermined
  name: include undetermined
  description: Include users whose household income is not determined.
  datatype: boolean
  max count: 1

AudienceSegmentDimensionShape
type: NodeShape
target class: AudienceSegmentDimension
property:
  path: segments
  name: segments
  description: Included audience segments. Users are included if they belong to at least one segment.
  node: AudienceSegmentShape
  class: AudienceSegment
  node kind: BlankNodeOrIRI

AudienceSegmentShape
type: NodeShape
target class: AudienceSegment
property:
  path: detailedDemographic
  name: detailed demographic
  description: Detailed demographic segment.
  node: DetailedDemographicSegmentShape
  class: DetailedDemographicSegment
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: userList
  name: user list
  description: User list segment.
  node: UserListSegmentShape
  class: UserListSegment
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: userInterest
  name: user interest
  description: Affinity or In-market segment.
  node: UserInterestSegmentShape
  class: UserInterestSegment
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: lifeEvent
  name: life event
  description: Live-event audience segment.
  node: LifeEventSegmentShape
  class: LifeEventSegment
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customAudience
  name: custom audience
  description: Custom audience segment.
  node: CustomAudienceSegmentShape
  class: CustomAudienceSegment
  node kind: BlankNodeOrIRI
  max count: 1

DetailedDemographicSegmentShape
type: NodeShape
target class: DetailedDemographicSegment
property:
  path: detailedDemographic
  name: detailed demographic
  description: The detailed demographic resource.
  datatype: string
  max count: 1

UserListSegmentShape
type: NodeShape
target class: UserListSegment
property:
  path: userList
  name: user list
  description: The user list resource.
  datatype: string
  max count: 1

UserInterestSegmentShape
type: NodeShape
target class: UserInterestSegment
property:
  path: userInterestCategory
  name: user interest category
  description: The user interest resource.
  datatype: string
  max count: 1

LifeEventSegmentShape
type: NodeShape
target class: LifeEventSegment
property:
  path: lifeEvent
  name: life event
  description: The life event resource.
  datatype: string
  max count: 1

CustomAudienceSegmentShape
type: NodeShape
target class: CustomAudienceSegment
property:
  path: customAudience
  name: custom audience
  description: The custom audience resource.
  datatype: string
  max count: 1

GenderDimensionShape
type: NodeShape
target class: GenderDimension
property:
  path: genders
  name: genders
  description: Included gender demographic segments.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: MALE
  in: FEMALE
  in: UNDETERMINED
property:
  path: includeUndetermined
  name: include undetermined
  description: Include users whose gender is not determined.
  datatype: boolean
  max count: 1

ParentalStatusDimensionShape
type: NodeShape
target class: ParentalStatusDimension
property:
  path: parentalStatuses
  name: parental statuses
  description: Included parental status demographic segments.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: PARENT
  in: NOT_A_PARENT
  in: UNDETERMINED
property:
  path: includeUndetermined
  name: include undetermined
  description: Include users whose parental status is undetermined.
  datatype: boolean
  max count: 1

AudienceExclusionDimensionShape
type: NodeShape
target class: AudienceExclusionDimension
property:
  path: exclusions
  name: exclusions
  description: Audience segment to be excluded.
  node: ExclusionSegmentShape
  class: ExclusionSegment
  node kind: BlankNodeOrIRI

ExclusionSegmentShape
type: NodeShape
target class: ExclusionSegment
property:
  path: userList
  name: user list
  description: User list segment to be excluded.
  node: UserListSegmentShape
  class: UserListSegment
  node kind: BlankNodeOrIRI
  max count: 1

BackgroundCheckVerificationArtifactShape
type: NodeShape
target class: BackgroundCheckVerificationArtifact
property:
  path: caseUrl
  name: case url
  description: Output only. URL to access background case.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: finalAdjudicationDateTime
  name: final adjudication date time
  description: 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"
  write lifecycle: Read only
  datatype: string
  max count: 1

BasicUserListInfoShape
type: NodeShape
target class: BasicUserListInfo
property:
  path: actions
  name: actions
  description: Actions associated with this user list.
  node: UserListActionInfoShape
  class: UserListActionInfo
  node kind: BlankNodeOrIRI

UserListActionInfoShape
type: NodeShape
target class: UserListActionInfo
property:
  path: conversionAction
  name: conversion action
  description: A conversion action that's not generated from remarketing.
  datatype: string
  max count: 1
property:
  path: remarketingAction
  name: remarketing action
  description: A remarketing action.
  datatype: string
  max count: 1

BatchJobShape
type: NodeShape
target class: BatchJob
property:
  path: id
  name: id
  description: Output only. ID of this batch job.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Status of this batch job.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: RUNNING
  in: DONE
property:
  path: longRunningOperation
  name: long running operation
  description: Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Output only. Contains additional information about this batch job.
  write lifecycle: Read only
  node: BatchJobBatchJobMetadataShape
  class: BatchJobBatchJobMetadata
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the batch job. Batch job resource names have the form: `customers/{customer_id}/batchJobs/{batch_job_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: nextAddSequenceToken
  name: next add sequence token
  description: Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.
  write lifecycle: Read only
  datatype: string
  max count: 1

BatchJobBatchJobMetadataShape
type: NodeShape
target class: BatchJobBatchJobMetadata
property:
  path: estimatedCompletionRatio
  name: estimated completion ratio
  description: Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed. This is empty if the job hasn't started running yet.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: executedOperationCount
  name: executed operation count
  description: Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: completionDateTime
  name: completion date time
  description: Output only. The time when this batch job was completed. Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: operationCount
  name: operation count
  description: Output only. The number of mutate operations in the batch job.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: creationDateTime
  name: creation date time
  description: Output only. The time when this batch job was created. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: executionLimitSeconds
  name: execution limit seconds
  description: Immutable. The approximate upper bound for how long a batch job can be executed, in seconds. If the job runs more than the given upper bound, the job will be canceled.
  write lifecycle: Create only
  datatype: int
  max count: 1
property:
  path: startDateTime
  name: start date time
  description: Output only. The time when this batch job started running. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
  write lifecycle: Read only
  datatype: string
  max count: 1

BiddingDataExclusionShape
type: NodeShape
target class: BiddingDataExclusion
property:
  path: dataExclusionId
  name: data exclusion id
  description: Output only. The ID of the data exclusion.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the data exclusion.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: devices
  name: devices
  description: If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: MOBILE
  in: TABLET
  in: DESKTOP
  in: CONNECTED_TV
  in: OTHER
property:
  path: campaigns
  name: campaigns
  description: The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
  datatype: string
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: endDateTime
  name: end date time
  description: Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the data exclusion. The description can be at most 2048 characters.
  datatype: string
  max count: 1
property:
  path: startDateTime
  name: start date time
  description: Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm:ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future.
  datatype: string
  max count: 1
property:
  path: scope
  name: scope
  description: The scope of the data exclusion.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER
  in: CAMPAIGN
  in: CHANNEL
property:
  path: name
  name: name
  description: The name of the data exclusion. The name can be at most 255 characters.
  datatype: string
  max count: 1
property:
  path: advertisingChannelTypes
  name: advertising channel types
  description: The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH
  in: DISPLAY
  in: SHOPPING
  in: HOTEL
  in: VIDEO
  in: MULTI_CHANNEL
  in: LOCAL
  in: SMART
  in: PERFORMANCE_MAX
  in: LOCAL_SERVICES
  in: TRAVEL
  in: DEMAND_GEN

BiddingSeasonalityAdjustmentShape
type: NodeShape
target class: BiddingSeasonalityAdjustment
property:
  path: startDateTime
  name: start date time
  description: Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. A seasonality adjustment is forward looking and should be used for events that start and end in the future.
  datatype: string
  max count: 1
property:
  path: scope
  name: scope
  description: The scope of the seasonality adjustment.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER
  in: CAMPAIGN
  in: CHANNEL
property:
  path: name
  name: name
  description: The name of the seasonality adjustment. The name can be at most 255 characters.
  datatype: string
  max count: 1
property:
  path: conversionRateModifier
  name: conversion rate modifier
  description: Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.
  datatype: double
  max count: 1
property:
  path: advertisingChannelTypes
  name: advertising channel types
  description: The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH
  in: DISPLAY
  in: SHOPPING
  in: HOTEL
  in: VIDEO
  in: MULTI_CHANNEL
  in: LOCAL
  in: SMART
  in: PERFORMANCE_MAX
  in: LOCAL_SERVICES
  in: TRAVEL
  in: DEMAND_GEN
property:
  path: seasonalityAdjustmentId
  name: seasonality adjustment id
  description: Output only. The ID of the seasonality adjustment.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the seasonality adjustment.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: campaigns
  name: campaigns
  description: The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
  datatype: string
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form: `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: endDateTime
  name: end date time
  description: Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: The description of the seasonality adjustment. The description can be at most 2048 characters.
  datatype: string
  max count: 1
property:
  path: devices
  name: devices
  description: If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: MOBILE
  in: TABLET
  in: DESKTOP
  in: CONNECTED_TV
  in: OTHER

BiddingStrategyShape
type: NodeShape
target class: BiddingStrategy
property:
  path: id
  name: id
  description: Output only. The ID of the bidding strategy.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the bidding strategy. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: type
  name: type
  description: Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: COMMISSION
  in: ENHANCED_CPC
  in: FIXED_CPM
  in: FIXED_SHARE_OF_VOICE
  in: INVALID
  in: MANUAL_CPA
  in: MANUAL_CPC
  in: MANUAL_CPM
  in: MANUAL_CPV
  in: MAXIMIZE_CONVERSIONS
  in: MAXIMIZE_CONVERSION_VALUE
  in: PAGE_ONE_PROMOTED
  in: PERCENT_CPC
  in: TARGET_CPA
  in: TARGET_CPC
  in: TARGET_CPM
  in: TARGET_CPV
  in: TARGET_IMPRESSION_SHARE
  in: TARGET_OUTRANK_SHARE
  in: TARGET_ROAS
  in: TARGET_SPEND
property:
  path: targetSpend
  name: target spend
  description: A bid strategy that sets your bids to help get as many clicks as possible within your budget.
  node: TargetSpendShape
  class: TargetSpend
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
  node: TargetRoasShape
  class: TargetRoas
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: maximizeConversionValue
  name: maximize conversion value
  description: An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
  node: MaximizeConversionValueShape
  class: MaximizeConversionValue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: name
  name: name
  description: The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
  datatype: string
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: nonRemovedCampaignCount
  name: non removed campaign count
  description: Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: campaignCount
  name: campaign count
  description: Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: targetCpa
  name: target cpa
  description: A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
  node: TargetCpaShape
  class: TargetCpa
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetImpressionShare
  name: target impression share
  description: A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
  node: TargetImpressionShareShape
  class: TargetImpressionShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: enhancedCpc
  name: enhanced cpc
  description: A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.
  node: EnhancedCpcShape
  class: EnhancedCpc
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: effectiveCurrencyCode
  name: effective currency code
  description: Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: alignedCampaignBudgetId
  name: aligned campaign budget id
  description: ID of the campaign budget that this portfolio bidding strategy is aligned with. When a portfolio and a campaign budget are aligned, that means that they are attached to the same set of campaigns. After a bidding strategy is aligned with a campaign budget, campaigns that are added to the bidding strategy must also use the aligned campaign budget.
  datatype: long
  max count: 1
property:
  path: maximizeConversions
  name: maximize conversions
  description: An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
  node: MaximizeConversionsShape
  class: MaximizeConversions
  node kind: BlankNodeOrIRI
  max count: 1

TargetSpendShape
type: NodeShape
target class: TargetSpend
property:
  path: targetSpendMicros
  name: target spend micros
  description: Deprecated: 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.
  datatype: long
  max count: 1
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
  datatype: long
  max count: 1

TargetRoasShape
type: NodeShape
target class: TargetRoas
property:
  path: cpcBidFloorMicros
  name: cpc bid floor micros
  description: Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
  datatype: long
  max count: 1
property:
  path: targetRoasTolerancePercentMillis
  name: target roas tolerance percent millis
  description: The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS. This field is only mutable for portfolio bidding strategies.
  datatype: long
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
  datatype: double
  max count: 1
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
  datatype: long
  max count: 1

MaximizeConversionValueShape
type: NodeShape
target class: MaximizeConversionValue
property:
  path: cpcBidFloorMicros
  name: cpc bid floor micros
  description: Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
  datatype: long
  max count: 1
property:
  path: targetRoasTolerancePercentMillis
  name: target roas tolerance percent millis
  description: The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS.
  datatype: long
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: 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.
  datatype: double
  max count: 1
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
  datatype: long
  max count: 1

TargetCpaShape
type: NodeShape
target class: TargetCpa
property:
  path: targetCpaMicros
  name: target cpa micros
  description: Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
  datatype: long
  max count: 1
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
  datatype: long
  max count: 1
property:
  path: cpcBidFloorMicros
  name: cpc bid floor micros
  description: Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
  datatype: long
  max count: 1

TargetImpressionShareShape
type: NodeShape
target class: TargetImpressionShare
property:
  path: location
  name: location
  description: The targeted location on the search results page.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ANYWHERE_ON_PAGE
  in: TOP_OF_PAGE
  in: ABSOLUTE_TOP_OF_PAGE
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
  datatype: long
  max count: 1
property:
  path: locationFractionMicros
  name: location fraction micros
  description: The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
  datatype: long
  max count: 1

MaximizeConversionsShape
type: NodeShape
target class: MaximizeConversions
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
  datatype: long
  max count: 1
property:
  path: targetCpaMicros
  name: target cpa micros
  description: The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
  datatype: long
  max count: 1
property:
  path: cpcBidFloorMicros
  name: cpc bid floor micros
  description: Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
  datatype: long
  max count: 1

BiddingStrategySimulationShape
type: NodeShape
target class: BiddingStrategySimulation
property:
  path: modificationMethod
  name: modification method
  description: Output only. How the simulation modifies the field.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: UNIFORM
  in: DEFAULT
  in: SCALING
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the bidding strategy simulation. Bidding strategy simulation resource names have the form: `customers/{customer_id}/biddingStrategySimulations/{bidding_strategy_id}~{type}~{modification_method}~{start_date}~{end_date}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Output only. The field that the simulation modifies.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CPC_BID
  in: CPV_BID
  in: TARGET_CPA
  in: BID_MODIFIER
  in: TARGET_ROAS
  in: PERCENT_CPC_BID
  in: TARGET_IMPRESSION_SHARE
  in: BUDGET
property:
  path: startDate
  name: start date
  description: Output only. First day on which the simulation is based, in YYYY-MM-DD format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: endDate
  name: end date
  description: Output only. Last day on which the simulation is based, in YYYY-MM-DD format
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetCpaPointList
  name: target cpa point list
  description: Output only. Simulation points if the simulation type is TARGET_CPA.
  write lifecycle: Read only
  node: TargetCpaSimulationPointListShape
  class: TargetCpaSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: biddingStrategyId
  name: bidding strategy id
  description: Output only. Bidding strategy shared set id of the simulation.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: targetRoasPointList
  name: target roas point list
  description: Output only. Simulation points if the simulation type is TARGET_ROAS.
  write lifecycle: Read only
  node: TargetRoasSimulationPointListShape
  class: TargetRoasSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1

BillingSetupShape
type: NodeShape
target class: BillingSetup
property:
  path: startDateTime
  name: start date time
  description: Immutable. The start date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format. Only a future time is allowed.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the billing setup.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the billing setup.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: APPROVED_HELD
  in: APPROVED
  in: CANCELLED
property:
  path: paymentsAccount
  name: payments account
  description: Immutable. The resource name of the payments account associated with this billing setup. Payments resource names have the form: `customers/{customer_id}/paymentsAccounts/{payments_account_id}` When setting up billing, this is used to signup with an existing payments account (and then payments_account_info should not be set). When getting a billing setup, this and payments_account_info will be populated.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: startTimeType
  name: start time type
  description: Immutable. The start time as a type. Only NOW is allowed.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the billing setup. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: endDateTime
  name: end date time
  description: Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: endTimeType
  name: end time type
  description: Output only. The end time as a type. The only possible value is FOREVER.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOW
  in: FOREVER
property:
  path: paymentsAccountInfo
  name: payments account info
  description: Immutable. The payments account information associated with this billing setup. When setting up billing, this is used to signup with a new payments account (and then payments_account should not be set). When getting a billing setup, this and payments_account will be populated.
  write lifecycle: Create only
  node: BillingSetupPaymentsAccountInfoShape
  class: BillingSetupPaymentsAccountInfo
  node kind: BlankNodeOrIRI
  max count: 1

BillingSetupPaymentsAccountInfoShape
type: NodeShape
target class: BillingSetupPaymentsAccountInfo
property:
  path: secondaryPaymentsProfileId
  name: secondary payments profile id
  description: Output only. A secondary payments profile id present in uncommon situations, for example, when a sequential liability agreement has been arranged.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: paymentsProfileId
  name: payments profile id
  description: Immutable. A 12 digit id used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, for example, "1234-5678-9012".
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: paymentsAccountId
  name: payments account id
  description: Output only. A 16 digit id used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, "1234-5678-9012-3456".
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: paymentsProfileName
  name: payments profile name
  description: Output only. The name of the payments profile associated with the billing setup.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: paymentsAccountName
  name: payments account name
  description: Immutable. The name of the payments account associated with the billing setup. This enables the user to specify a meaningful name for a payments account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices.
  write lifecycle: Create only
  datatype: string
  max count: 1

BrandInfoShape
type: NodeShape
target class: BrandInfo
property:
  path: displayName
  name: display name
  description: Output only. A text representation of a brand.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: primaryUrl
  name: primary url
  description: Output only. The primary url of a brand.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: rejectionReason
  name: rejection reason
  description: Output only. The rejection reason when a brand status is REJECTED.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXISTING_BRAND
  in: EXISTING_BRAND_VARIANT
  in: INCORRECT_INFORMATION
  in: NOT_A_BRAND
property:
  path: entityId
  name: entity id
  description: The Commercial KG MID for the brand.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of a brand.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: DEPRECATED
  in: UNVERIFIED
  in: APPROVED
  in: CANCELLED
  in: REJECTED

BudgetCampaignAssociationStatusShape
type: NodeShape
target class: BudgetCampaignAssociationStatus
property:
  path: status
  name: status
  description: Budget campaign association status.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: campaign
  name: campaign
  description: The campaign resource name.
  datatype: string
  max count: 1

BudgetSimulationPointShape
type: NodeShape
target class: BudgetSimulationPoint
property:
  path: budgetAmountMicros
  name: budget amount micros
  description: The simulated budget upon which projected metrics are based.
  datatype: long
  max count: 1
property:
  path: biddableConversionsValue
  name: biddable conversions value
  description: Projected total value of biddable conversions.
  datatype: double
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Projected cost in micros.
  datatype: long
  max count: 1
property:
  path: impressions
  name: impressions
  description: Projected number of impressions.
  datatype: long
  max count: 1
property:
  path: clicks
  name: clicks
  description: Projected number of clicks.
  datatype: long
  max count: 1
property:
  path: requiredCpcBidCeilingMicros
  name: required cpc bid ceiling micros
  description: 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.
  datatype: long
  max count: 1
property:
  path: interactions
  name: interactions
  description: Projected number of interactions. Only discovery advertising channel type supports this field.
  datatype: long
  max count: 1
property:
  path: biddableConversions
  name: biddable conversions
  description: Projected number of biddable conversions.
  datatype: double
  max count: 1
property:
  path: topSlotImpressions
  name: top slot impressions
  description: Projected number of top slot impressions. Only search advertising channel type supports this field.
  datatype: long
  max count: 1

BudgetSimulationPointListShape
type: NodeShape
target class: BudgetSimulationPointList
property:
  path: points
  name: points
  description: Projected metrics for a series of budget amounts.
  node: BudgetSimulationPointShape
  class: BudgetSimulationPoint
  node kind: BlankNodeOrIRI

BusinessRegistrationCheckVerificationArtifactShape
type: NodeShape
target class: BusinessRegistrationCheckVerificationArtifact
property:
  path: registrationNumber
  name: registration number
  description: Output only. Message storing government issued number for the business.
  write lifecycle: Read only
  node: BusinessRegistrationNumberShape
  class: BusinessRegistrationNumber
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: rejectionReason
  name: rejection reason
  description: Output only. Registration document rejection reason.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BUSINESS_NAME_MISMATCH
  in: BUSINESS_DETAILS_MISMATCH
  in: ID_NOT_FOUND
  in: POOR_DOCUMENT_IMAGE_QUALITY
  in: DOCUMENT_EXPIRED
  in: DOCUMENT_INVALID
  in: DOCUMENT_TYPE_MISMATCH
  in: DOCUMENT_UNVERIFIABLE
  in: OTHER
property:
  path: registrationType
  name: registration type
  description: Output only. The type of business registration check (number, document).
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NUMBER
  in: DOCUMENT
property:
  path: checkId
  name: check id
  description: Output only. The id of the check, such as vat_tax_id, representing "VAT Tax ID" requirement.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: registrationDocument
  name: registration document
  description: Output only. Message storing document info for the business.
  write lifecycle: Read only
  node: BusinessRegistrationDocumentShape
  class: BusinessRegistrationDocument
  node kind: BlankNodeOrIRI
  max count: 1

BusinessRegistrationNumberShape
type: NodeShape
target class: BusinessRegistrationNumber
property:
  path: number
  name: number
  description: Output only. Government-issued number for the business.
  write lifecycle: Read only
  datatype: string
  max count: 1

BusinessRegistrationDocumentShape
type: NodeShape
target class: BusinessRegistrationDocument
property:
  path: documentReadonly
  name: document readonly
  description: Output only. The readonly field containing the information for an uploaded business registration document.
  write lifecycle: Read only
  node: LocalServicesDocumentReadOnlyShape
  class: LocalServicesDocumentReadOnly
  node kind: BlankNodeOrIRI
  max count: 1

LocalServicesDocumentReadOnlyShape
type: NodeShape
target class: LocalServicesDocumentReadOnly
property:
  path: documentUrl
  name: document url
  description: URL to access an already uploaded Local Services document.
  datatype: string
  max count: 1

CallReportingSettingShape
type: NodeShape
target class: CallReportingSetting
property:
  path: callReportingEnabled
  name: call reporting enabled
  description: Enable reporting of phone call events by redirecting them through Google System.
  datatype: boolean
  max count: 1
property:
  path: callConversionReportingEnabled
  name: call conversion reporting enabled
  description: Whether to enable call conversion reporting.
  datatype: boolean
  max count: 1
property:
  path: callConversionAction
  name: call conversion action
  description: Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
  datatype: string
  max count: 1

CallViewShape
type: NodeShape
target class: CallView
property:
  path: callTrackingDisplayLocation
  name: call tracking display location
  description: Output only. The call tracking display location.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AD
  in: LANDING_PAGE
property:
  path: callerCountryCode
  name: caller country code
  description: Output only. Country code of the caller.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: callDurationSeconds
  name: call duration seconds
  description: Output only. The advertiser-provided call duration in seconds.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: startCallDateTime
  name: start call date time
  description: Output only. The advertiser-provided call start date time.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: callStatus
  name: call status
  description: Output only. The status of the call.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MISSED
  in: RECEIVED
property:
  path: endCallDateTime
  name: end call date time
  description: Output only. The advertiser-provided call end date time.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the call.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MANUALLY_DIALED
  in: HIGH_END_MOBILE_SEARCH
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the call view. Call view resource names have the form: `customers/{customer_id}/callViews/{call_detail_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: callerAreaCode
  name: caller area code
  description: Output only. Area code of the caller. Null if the call duration is shorter than 15 seconds.
  write lifecycle: Read only
  datatype: string
  max count: 1

CampaignShape
type: NodeShape
target class: Campaign
property:
  path: maximizeConversionValue
  name: maximize conversion value
  description: Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
  node: MaximizeConversionValueShape
  class: MaximizeConversionValue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: endDateTime
  name: end date time
  description: The last day and time of the campaign in serving customer's timezone in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily granularity, time granularity is only supported for some campaign types. On create, defaults to running indefinitely. To set an existing campaign to run indefinitely, clear this field.
  datatype: string
  max count: 1
property:
  path: targetCpm
  name: target cpm
  description: A bidding strategy that automatically optimizes cost per thousand impressions.
  node: TargetCpmShape
  class: TargetCpm
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: fixedCpm
  name: fixed cpm
  description: A manual bidding strategy with a fixed CPM.
  node: FixedCpmShape
  class: FixedCpm
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: viewThroughConversionOptimizationEnabled
  name: view through conversion optimization enabled
  description: Whether VTC (View-through Conversion) optimization is enabled for this campaign. Only allowed for certain Demand Gen and App Campaigns.
  datatype: boolean
  max count: 1
property:
  path: targetCpc
  name: target cpc
  description: An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set.
  node: TargetCpcShape
  class: TargetCpc
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the campaign.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: pmaxCampaignSettings
  name: pmax campaign settings
  description: Settings for Performance Max campaign.
  node: CampaignPmaxCampaignSettingsShape
  class: CampaignPmaxCampaignSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: hotelPropertyAssetSet
  name: hotel property asset set
  description: Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: audienceSetting
  name: audience setting
  description: Immutable. Setting for audience related features.
  write lifecycle: Create only
  node: CampaignAudienceSettingShape
  class: CampaignAudienceSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: demandGenCampaignSettings
  name: demand gen campaign settings
  description: Settings for Demand Gen campaign.
  node: CampaignDemandGenCampaignSettingsShape
  class: CampaignDemandGenCampaignSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: startDateTime
  name: start date time
  description: The date and time when campaign started in serving. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 00:00:00 for daily granularity, time granularity is only supported for some campaign types.
  datatype: string
  max count: 1
property:
  path: biddingStrategySystemStatus
  name: bidding strategy system status
  description: Output only. The system status of the campaign's bidding strategy.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: LEARNING_NEW
  in: LEARNING_SETTING_CHANGE
  in: LEARNING_BUDGET_CHANGE
  in: LEARNING_COMPOSITION_CHANGE
  in: LEARNING_CONVERSION_TYPE_CHANGE
  in: LEARNING_CONVERSION_SETTING_CHANGE
  in: LIMITED_BY_CPC_BID_CEILING
  in: LIMITED_BY_CPC_BID_FLOOR
  in: LIMITED_BY_DATA
  in: LIMITED_BY_BUDGET
  in: LIMITED_BY_LOW_PRIORITY_SPEND
  in: LIMITED_BY_LOW_QUALITY
  in: LIMITED_BY_INVENTORY
  in: MISCONFIGURED_ZERO_ELIGIBILITY
  in: MISCONFIGURED_CONVERSION_TYPES
  in: MISCONFIGURED_CONVERSION_SETTINGS
  in: MISCONFIGURED_SHARED_BUDGET
  in: MISCONFIGURED_STRATEGY_TYPE
  in: PAUSED
  in: UNAVAILABLE
  in: MULTIPLE_LEARNING
  in: MULTIPLE_LIMITED
  in: MULTIPLE_MISCONFIGURED
  in: MULTIPLE
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: targetImpressionShare
  name: target impression share
  description: Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
  node: TargetImpressionShareShape
  class: TargetImpressionShare
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetCpa
  name: target cpa
  description: Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
  node: TargetCpaShape
  class: TargetCpa
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetCpv
  name: target cpv
  description: An automated bidding strategy that sets bids to optimize performance given the target CPV you set.
  node: TargetCpvShape
  class: TargetCpv
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: baseCampaign
  name: base campaign
  description: Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to `resource_name`. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetingSetting
  name: targeting setting
  description: Setting for targeting related features.
  node: TargetingSettingShape
  class: TargetingSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: optimizationScore
  name: optimization score
  description: Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
  node: TargetRoasShape
  class: TargetRoas
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: advertisingChannelSubType
  name: advertising channel sub type
  description: Immutable. Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH_MOBILE_APP
  in: DISPLAY_MOBILE_APP
  in: SEARCH_EXPRESS
  in: DISPLAY_EXPRESS
  in: SHOPPING_SMART_ADS
  in: DISPLAY_GMAIL_AD
  in: DISPLAY_SMART_CAMPAIGN
  in: VIDEO_ACTION
  in: VIDEO_NON_SKIPPABLE
  in: APP_CAMPAIGN
  in: APP_CAMPAIGN_FOR_ENGAGEMENT
  in: LOCAL_CAMPAIGN
  in: SHOPPING_COMPARISON_LISTING_ADS
  in: SMART_CAMPAIGN
  in: VIDEO_SEQUENCE
  in: APP_CAMPAIGN_FOR_PRE_REGISTRATION
  in: VIDEO_REACH_TARGET_FREQUENCY
  in: TRAVEL_ACTIVITIES
  in: YOUTUBE_AUDIO

TargetCpmShape
type: NodeShape
target class: TargetCpm
property:
  path: targetFrequencyGoal
  name: target frequency goal
  description: Target Frequency bidding goal details.
  node: TargetCpmTargetFrequencyGoalShape
  class: TargetCpmTargetFrequencyGoal
  node kind: BlankNodeOrIRI
  max count: 1

TargetCpmTargetFrequencyGoalShape
type: NodeShape
target class: TargetCpmTargetFrequencyGoal
property:
  path: targetCount
  name: target count
  description: Target Frequency count representing how many times you want to reach a single user.
  datatype: long
  max count: 1
property:
  path: timeUnit
  name: time unit
  description: Time window expressing the period over which you want to reach the specified target_count.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEEKLY
  in: MONTHLY

FixedCpmShape
type: NodeShape
target class: FixedCpm
property:
  path: goal
  name: goal
  description: Fixed CPM bidding goal. Determines the exact bidding optimization parameters.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REACH
  in: TARGET_FREQUENCY
property:
  path: targetFrequencyInfo
  name: target frequency info
  description: Target frequency bidding goal details.
  node: FixedCpmTargetFrequencyGoalInfoShape
  class: FixedCpmTargetFrequencyGoalInfo
  node kind: BlankNodeOrIRI
  max count: 1

FixedCpmTargetFrequencyGoalInfoShape
type: NodeShape
target class: FixedCpmTargetFrequencyGoalInfo
property:
  path: targetCount
  name: target count
  description: Target frequency count represents the number of times an advertiser wants to show the ad to target a single user.
  datatype: long
  max count: 1
property:
  path: timeUnit
  name: time unit
  description: Time window expressing the period over which you want to reach the specified target_count.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MONTHLY

TargetCpcShape
type: NodeShape
target class: TargetCpc
property:
  path: targetCpcMicros
  name: target cpc micros
  description: Average CPC target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
  datatype: long
  max count: 1

CampaignPmaxCampaignSettingsShape
type: NodeShape
target class: CampaignPmaxCampaignSettings
property:
  path: brandTargetingOverrides
  name: brand targeting overrides
  description: Overrides of brand targeting for various ad types.
  node: CampaignPmaxCampaignSettingsBrandTargetingOverridesShape
  class: CampaignPmaxCampaignSettingsBrandTargetingOverrides
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: localServicesEnabled
  name: local services enabled
  description: Output only. Indicates whether the Performance Max campaign is a Local Services campaign.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: localServicesPmaxCampaignSettings
  name: local services pmax campaign settings
  description: The Local Services Campaign related settings. Only updates are available for existing Local Services Pmax campaigns.
  node: CampaignLocalServicesPmaxCampaignSettingsShape
  class: CampaignLocalServicesPmaxCampaignSettings
  node kind: BlankNodeOrIRI
  max count: 1

CampaignPmaxCampaignSettingsBrandTargetingOverridesShape
type: NodeShape
target class: CampaignPmaxCampaignSettingsBrandTargetingOverrides
property:
  path: ignoreExclusionsForShoppingAds
  name: ignore exclusions for shopping ads
  description: If true, brand exclusions are ignored for Shopping ads.
  datatype: boolean
  max count: 1

CampaignLocalServicesPmaxCampaignSettingsShape
type: NodeShape
target class: CampaignLocalServicesPmaxCampaignSettings
property:
  path: navigationalQueryLeadsEnabled
  name: navigational query leads enabled
  description: Whether to use navigational query filter.
  datatype: boolean
  max count: 1
property:
  path: foundingYear
  name: founding year
  description: Founding year of the business.
  datatype: long
  max count: 1
property:
  path: countryCode
  name: country code
  description: Immutable. Country code of the Local Services Ad. Set once during Ad Creation and used to determine verification requirements and validate location criterion selection; upper-case, two-letter codes as defined by ISO-3166.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: phoneNumbers
  name: phone numbers
  description: List of phone numbers associated with the provider.
  node: LocalServicesPhoneNumberShape
  class: LocalServicesPhoneNumber
  node kind: BlankNodeOrIRI

LocalServicesPhoneNumberShape
type: NodeShape
target class: LocalServicesPhoneNumber
property:
  path: phoneNumber
  name: phone number
  description: The phone number.
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: Upper-case, two-letter codes as defined by ISO-3166.
  datatype: string
  max count: 1
property:
  path: phoneNumberType
  name: phone number type
  description: The type of the phone number.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DESTINATION_PHONE_NUMBER_FOR_ADS
  in: DESTINATION_PHONE_NUMBER_FOR_SMS_ONLY
  in: DESTINATION_PHONE_NUMBER_FOR_WHATSAPP_ONLY

CampaignAudienceSettingShape
type: NodeShape
target class: CampaignAudienceSetting
property:
  path: useAudienceGrouped
  name: use audience grouped
  description: Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
  write lifecycle: Create only
  datatype: boolean
  max count: 1

CampaignDemandGenCampaignSettingsShape
type: NodeShape
target class: CampaignDemandGenCampaignSettings
property:
  path: upgradedTargeting
  name: upgraded targeting
  description: Immutable. Specifies whether this campaign uses upgraded targeting options. When this field is set to `true`, you can use location and language targeting at the ad group level as opposed to the standard campaign-level targeting. This field defaults to `true`, and can only be set when creating a campaign.
  write lifecycle: Create only
  datatype: boolean
  max count: 1

CampaignHotelSettingInfoShape
type: NodeShape
target class: CampaignHotelSettingInfo
property:
  path: hotelCenterId
  name: hotel center id
  description: The linked Hotel Center account.
  datatype: long
  max count: 1
property:
  path: disableHotelSetting
  name: disable hotel setting
  description: Disable the optional hotel setting. This field is currently supported only for Demand Gen campaigns.
  datatype: boolean
  max count: 1

CampaignSelectiveOptimizationShape
type: NodeShape
target class: CampaignSelectiveOptimization
property:
  path: conversionActions
  name: conversion actions
  description: The selected set of resource names for conversion actions for optimizing this campaign.
  datatype: string

CampaignOptimizationGoalSettingShape
type: NodeShape
target class: CampaignOptimizationGoalSetting
property:
  path: optimizationGoalTypes
  name: optimization goal types
  description: The list of optimization goal types.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: CALL_CLICKS
  in: DRIVING_DIRECTIONS
  in: APP_PRE_REGISTRATION

CampaignLocalServicesCampaignSettingsShape
type: NodeShape
target class: CampaignLocalServicesCampaignSettings
property:
  path: categoryBids
  name: category bids
  description: Categorical level bids associated with MANUAL_CPA bidding strategy.
  node: CampaignCategoryBidShape
  class: CampaignCategoryBid
  node kind: BlankNodeOrIRI

CampaignCategoryBidShape
type: NodeShape
target class: CampaignCategoryBid
property:
  path: categoryId
  name: category id
  description: Category for which the bid will be associated with. For example, xcat:service_area_business_plumber.
  datatype: string
  max count: 1
property:
  path: targetCpaBidMicros
  name: target cpa bid micros
  description: Target CPA bid for the category. Value is in micros and in the advertiser's currency.
  datatype: long
  max count: 1
property:
  path: manualCpaBidMicros
  name: manual cpa bid micros
  description: Manual CPA bid for the category. Bid must be greater than the reserve price associated for that category. Value is in micros and in the advertiser's currency.
  datatype: long
  max count: 1

CampaignAssetAutomationSettingShape
type: NodeShape
target class: CampaignAssetAutomationSetting
property:
  path: assetAutomationType
  name: asset automation type
  description: The asset automation type advertiser would like to opt-in/out.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TEXT_ASSET_AUTOMATION
  in: GENERATE_VERTICAL_YOUTUBE_VIDEOS
  in: GENERATE_SHORTER_YOUTUBE_VIDEOS
  in: GENERATE_LANDING_PAGE_PREVIEW
  in: GENERATE_LANDING_PAGE_TEXT
  in: GENERATE_ENHANCED_YOUTUBE_VIDEOS
  in: GENERATE_IMAGE_ENHANCEMENT
  in: GENERATE_IMAGE_EXTRACTION
  in: GENERATE_DESIGN_VERSIONS_FOR_IMAGES
  in: FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION
  in: GENERATE_VIDEOS_FROM_OTHER_ASSETS
property:
  path: assetAutomationStatus
  name: asset automation status
  description: The opt-in/out status of asset automation type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: OPTED_IN
  in: OPTED_OUT

ManualCpcShape
type: NodeShape
target class: ManualCpc
property:
  path: enhancedCpcEnabled
  name: enhanced cpc enabled
  description: Whether bids are to be enhanced based on conversion optimizer data.
  datatype: boolean
  max count: 1

PercentCpcShape
type: NodeShape
target class: PercentCpc
property:
  path: enhancedCpcEnabled
  name: enhanced cpc enabled
  description: Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
  datatype: boolean
  max count: 1
property:
  path: cpcBidCeilingMicros
  name: cpc bid ceiling micros
  description: Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
  datatype: long
  max count: 1

CampaignTravelCampaignSettingsShape
type: NodeShape
target class: CampaignTravelCampaignSettings
property:
  path: travelAccountId
  name: travel account id
  description: Immutable. The Travel account ID associated with the Travel campaign.
  write lifecycle: Create only
  datatype: long
  max count: 1

CampaignThirdPartyIntegrationPartnersShape
type: NodeShape
target class: CampaignThirdPartyIntegrationPartners
property:
  path: viewabilityIntegrationPartners
  name: viewability integration partners
  description: Third party integration partners for YouTube viewability verification for this Campaign.
  node: CampaignThirdPartyViewabilityIntegrationPartnerShape
  class: CampaignThirdPartyViewabilityIntegrationPartner
  node kind: BlankNodeOrIRI
property:
  path: brandLiftIntegrationPartners
  name: brand lift integration partners
  description: Third party integration partners for Brand Lift verification for this Campaign.
  node: CampaignThirdPartyBrandLiftIntegrationPartnerShape
  class: CampaignThirdPartyBrandLiftIntegrationPartner
  node kind: BlankNodeOrIRI
property:
  path: reachIntegrationPartners
  name: reach integration partners
  description: Third party integration partners for reach verification for this Campaign.
  node: CampaignThirdPartyReachIntegrationPartnerShape
  class: CampaignThirdPartyReachIntegrationPartner
  node kind: BlankNodeOrIRI
property:
  path: brandSafetyIntegrationPartners
  name: brand safety integration partners
  description: Third party integration partners for brand safety verification for this Campaign.
  node: CampaignThirdPartyBrandSafetyIntegrationPartnerShape
  class: CampaignThirdPartyBrandSafetyIntegrationPartner
  node kind: BlankNodeOrIRI

CampaignThirdPartyViewabilityIntegrationPartnerShape
type: NodeShape
target class: CampaignThirdPartyViewabilityIntegrationPartner
property:
  path: viewabilityIntegrationPartnerData
  name: viewability integration partner data
  description: Third party partner data for YouTube viewability verification. This is optional metadata for partners to join or attach data to Ads campaigns.
  node: ThirdPartyIntegrationPartnerDataShape
  class: ThirdPartyIntegrationPartnerData
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shareCost
  name: share cost
  description: If true, then cost data will be shared with this vendor.
  datatype: boolean
  max count: 1
property:
  path: viewabilityIntegrationPartner
  name: viewability integration partner
  description: Allowed third party integration partners for YouTube viewability verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DOUBLE_VERIFY
  in: INTEGRAL_AD_SCIENCE
  in: ZEFR

ThirdPartyIntegrationPartnerDataShape
type: NodeShape
target class: ThirdPartyIntegrationPartnerData
property:
  path: thirdPartyPlacementId
  name: third party placement id
  description: The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
  datatype: string
  max count: 1
property:
  path: clientId
  name: client id
  description: The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
  datatype: string
  max count: 1

CampaignThirdPartyBrandLiftIntegrationPartnerShape
type: NodeShape
target class: CampaignThirdPartyBrandLiftIntegrationPartner
property:
  path: brandLiftIntegrationPartnerData
  name: brand lift integration partner data
  description: Third party partner data for YouTube Brand Lift verification. This is optional metadata for partners to join or attach data to Ads campaigns.
  node: ThirdPartyIntegrationPartnerDataShape
  class: ThirdPartyIntegrationPartnerData
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: brandLiftIntegrationPartner
  name: brand lift integration partner
  description: Allowed third party integration partners for Brand Lift verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: KANTAR_MILLWARD_BROWN
  in: DYNATA
  in: INTAGE
  in: MACROMILL
property:
  path: shareCost
  name: share cost
  description: If true, then cost data will be shared with this vendor.
  datatype: boolean
  max count: 1

CampaignThirdPartyReachIntegrationPartnerShape
type: NodeShape
target class: CampaignThirdPartyReachIntegrationPartner
property:
  path: shareCost
  name: share cost
  description: If true, then cost data will be shared with this vendor.
  datatype: boolean
  max count: 1
property:
  path: reachIntegrationPartner
  name: reach integration partner
  description: Allowed third party integration partners for reach verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NIELSEN
  in: COMSCORE
  in: KANTAR_MILLWARD_BROWN
  in: VIDEO_RESEARCH
  in: GEMIUS
  in: MEDIA_SCOPE
  in: AUDIENCE_PROJECT
  in: VIDEO_AMP
  in: ISPOT_TV
property:
  path: reachIntegrationPartnerData
  name: reach integration partner data
  description: Third party partner data for YouTube Reach verification. This is optional metadata for partners to join or attach data to Ads campaigns.
  node: ThirdPartyIntegrationPartnerDataShape
  class: ThirdPartyIntegrationPartnerData
  node kind: BlankNodeOrIRI
  max count: 1

CampaignThirdPartyBrandSafetyIntegrationPartnerShape
type: NodeShape
target class: CampaignThirdPartyBrandSafetyIntegrationPartner
property:
  path: brandSafetyIntegrationPartner
  name: brand safety integration partner
  description: Allowed third party integration partners for brand safety verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DOUBLE_VERIFY
  in: INTEGRAL_AD_SCIENCE
  in: ZEFR
property:
  path: brandSafetyIntegrationPartnerData
  name: brand safety integration partner data
  description: Third party partner data for YouTube brand safety verification. This is optional metadata for partners to join or attach data to Ads campaigns.
  node: ThirdPartyIntegrationPartnerDataShape
  class: ThirdPartyIntegrationPartnerData
  node kind: BlankNodeOrIRI
  max count: 1

CampaignAiMaxSettingShape
type: NodeShape
target class: CampaignAiMaxSetting
property:
  path: enableAiMax
  name: enable ai max
  description: Controls whether or not AI Max features are served for this campaign. Individual AI Max features are enabled or disabled by their respective settings. But if enable_ai_max is set to false or cleared, then no AI Max features will serve for this campaign, regardless of the other settings. Supported in Search and Shopping campaigns. For Search campaigns, Search Term Matching is enabled by default when AI Max is enabled, and can be disabled at the ad group level. For Shopping campaigns, Text customization is always enabled when AI Max is enabled.
  datatype: boolean
  max count: 1
property:
  path: bundlingRequired
  name: bundling required
  description: Output only. Search campaigns only. Indicates whether a campaign has adopted AI Max before, and is required to have AI Max enabled to adopt campaign-level text asset automation and brand list targeting in all API versions.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOT_REQUIRED
  in: REQUIRED

CampaignNetworkSettingsShape
type: NodeShape
target class: CampaignNetworkSettings
property:
  path: targetGoogleSearch
  name: target google search
  description: Whether ads will be served with google.com search results.
  datatype: boolean
  max count: 1
property:
  path: targetSearchNetwork
  name: target search network
  description: Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`).
  datatype: boolean
  max count: 1
property:
  path: targetGoogleTvNetwork
  name: target google tv network
  description: Whether ads will be served on the Google TV network.
  datatype: boolean
  max count: 1
property:
  path: targetYoutube
  name: target youtube
  description: Whether ads will be served on YouTube.
  datatype: boolean
  max count: 1
property:
  path: targetContentNetwork
  name: target content network
  description: Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
  datatype: boolean
  max count: 1
property:
  path: targetPartnerSearchNetwork
  name: target partner search network
  description: Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead.
  datatype: boolean
  max count: 1

CampaignTrackingSettingShape
type: NodeShape
target class: CampaignTrackingSetting
property:
  path: trackingUrl
  name: tracking url
  description: Output only. The url used for dynamic tracking.
  write lifecycle: Read only
  datatype: string
  max count: 1

CampaignVanityPharmaShape
type: NodeShape
target class: CampaignVanityPharma
property:
  path: vanityPharmaDisplayUrlMode
  name: vanity pharma display url mode
  description: The display mode for vanity pharma URLs.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MANUFACTURER_WEBSITE_URL
  in: WEBSITE_DESCRIPTION
property:
  path: vanityPharmaText
  name: vanity pharma text
  description: The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PRESCRIPTION_TREATMENT_WEBSITE_EN
  in: PRESCRIPTION_TREATMENT_WEBSITE_ES
  in: PRESCRIPTION_DEVICE_WEBSITE_EN
  in: PRESCRIPTION_DEVICE_WEBSITE_ES
  in: MEDICAL_DEVICE_WEBSITE_EN
  in: MEDICAL_DEVICE_WEBSITE_ES
  in: PREVENTATIVE_TREATMENT_WEBSITE_EN
  in: PREVENTATIVE_TREATMENT_WEBSITE_ES
  in: PRESCRIPTION_CONTRACEPTION_WEBSITE_EN
  in: PRESCRIPTION_CONTRACEPTION_WEBSITE_ES
  in: PRESCRIPTION_VACCINE_WEBSITE_EN
  in: PRESCRIPTION_VACCINE_WEBSITE_ES

CampaignBrandGuidelinesShape
type: NodeShape
target class: CampaignBrandGuidelines
property:
  path: accentColor
  name: accent color
  description: The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.
  datatype: string
  max count: 1
property:
  path: predefinedFontFamily
  name: predefined font family
  description: The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.
  datatype: string
  max count: 1
property:
  path: mainColor
  name: main color
  description: The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.
  datatype: string
  max count: 1

FrequencyCapEntryShape
type: NodeShape
target class: FrequencyCapEntry
property:
  path: key
  name: key
  description: The key of a particular frequency cap. There can be no more than one frequency cap with the same key.
  node: FrequencyCapKeyShape
  class: FrequencyCapKey
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cap
  name: cap
  description: Maximum number of events allowed during the time range by this cap.
  datatype: int
  max count: 1

FrequencyCapKeyShape
type: NodeShape
target class: FrequencyCapKey
property:
  path: level
  name: level
  description: The level on which the cap is to be applied (for example, ad group ad, ad group). The cap is applied to all the entities of this level.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AD_GROUP_AD
  in: AD_GROUP
  in: CAMPAIGN
property:
  path: eventType
  name: event type
  description: The type of event that the cap applies to (for example, impression).
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: IMPRESSION
  in: VIDEO_VIEW
property:
  path: timeUnit
  name: time unit
  description: Unit of time the cap is defined at (for example, day, week).
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DAY
  in: WEEK
  in: MONTH
property:
  path: timeLength
  name: time length
  description: Number of time units the cap lasts.
  datatype: int
  max count: 1

CampaignVideoCampaignSettingsShape
type: NodeShape
target class: CampaignVideoCampaignSettings
property:
  path: videoAdFormatControl
  name: video ad format control
  description: Format-restricting control enabling usage of video responsive ads in format defined Video campaigns (for example, non-skippable).
  node: CampaignVideoCampaignSettingsVideoAdFormatControlShape
  class: CampaignVideoCampaignSettingsVideoAdFormatControl
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: videoAdSequence
  name: video ad sequence
  description: Container for video ads sequencing definition.
  node: CampaignVideoCampaignSettingsVideoAdSequenceShape
  class: CampaignVideoCampaignSettingsVideoAdSequence
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: bookingDetails
  name: booking details
  description: Output only. Booking information for campaigns with the FIXED_CPM or FIXED_SHARE_OF_VOICE bidding strategies.
  write lifecycle: Read only
  node: CampaignVideoCampaignSettingsBookingDetailsShape
  class: CampaignVideoCampaignSettingsBookingDetails
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: reservationAdCategorySelfDisclosure
  name: reservation ad category self disclosure
  description: Ad category self-disclosure for campaigns with the FIXED_CPM or FIXED_SHARE_OF_VOICE bidding strategies.
  node: CampaignVideoCampaignSettingsReservationAdCategorySelfDisclosureShape
  class: CampaignVideoCampaignSettingsReservationAdCategorySelfDisclosure
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: videoAdInventoryControl
  name: video ad inventory control
  description: Inventory control for video responsive ads in reach campaigns.
  node: CampaignVideoCampaignSettingsVideoAdInventoryControlShape
  class: CampaignVideoCampaignSettingsVideoAdInventoryControl
  node kind: BlankNodeOrIRI
  max count: 1

CampaignVideoCampaignSettingsVideoAdFormatControlShape
type: NodeShape
target class: CampaignVideoCampaignSettingsVideoAdFormatControl
property:
  path: formatRestriction
  name: format restriction
  description: All contained responsive ads are expected to respect this restriction.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NON_SKIPPABLE_IN_STREAM
property:
  path: nonSkippableInStreamRestrictions
  name: non skippable in stream restrictions
  description: Restrictions for non-skippable format.
  node: CampaignVideoCampaignSettingsNonSkippableInStreamRestrictionsShape
  class: CampaignVideoCampaignSettingsNonSkippableInStreamRestrictions
  node kind: BlankNodeOrIRI
  max count: 1

CampaignVideoCampaignSettingsNonSkippableInStreamRestrictionsShape
type: NodeShape
target class: CampaignVideoCampaignSettingsNonSkippableInStreamRestrictions
property:
  path: minDuration
  name: min duration
  description: The minimum allowed duration for non-skippable ads.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MIN_DURATION_FIVE_SECONDS
  in: MIN_DURATION_SEVEN_SECONDS
  in: MIN_DURATION_SIXTEEN_SECONDS
  in: MIN_DURATION_THIRTY_ONE_SECONDS
property:
  path: maxDuration
  name: max duration
  description: The maximum allowed duration for non-skippable ads.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MAX_DURATION_FIFTEEN_SECONDS
  in: MAX_DURATION_THIRTY_SECONDS
  in: MAX_DURATION_SIXTY_SECONDS

CampaignVideoCampaignSettingsVideoAdSequenceShape
type: NodeShape
target class: CampaignVideoCampaignSettingsVideoAdSequence
property:
  path: minimumDuration
  name: minimum duration
  description: Users are eligible to repeat sequence after this period. Defaults to WEEK if not specified.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEEK
  in: MONTH
property:
  path: steps
  name: steps
  description: The list of sequence steps and data associated with them.
  node: CampaignVideoCampaignSettingsVideoAdSequenceStepShape
  class: CampaignVideoCampaignSettingsVideoAdSequenceStep
  node kind: BlankNodeOrIRI

CampaignVideoCampaignSettingsVideoAdSequenceStepShape
type: NodeShape
target class: CampaignVideoCampaignSettingsVideoAdSequenceStep
property:
  path: previousStepInteractionType
  name: previous step interaction type
  description: Type of interaction *on the previous step* required in order for the user to advance to this step. As with the previous step ID, it's required for every step except for the first one.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PAID_VIEW
  in: SKIP
  in: IMPRESSION
  in: ENGAGED_IMPRESSION
property:
  path: adGroupType
  name: ad group type
  description: The ad group type for this step (denoting the video format).
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH_STANDARD
  in: DISPLAY_STANDARD
  in: SHOPPING_PRODUCT_ADS
  in: HOTEL_ADS
  in: SHOPPING_SMART_ADS
  in: VIDEO_BUMPER
  in: VIDEO_TRUE_VIEW_IN_STREAM
  in: VIDEO_TRUE_VIEW_IN_DISPLAY
  in: VIDEO_NON_SKIPPABLE_IN_STREAM
  in: SEARCH_DYNAMIC_ADS
  in: SHOPPING_COMPARISON_LISTING_ADS
  in: PROMOTED_HOTEL_ADS
  in: VIDEO_RESPONSIVE
  in: VIDEO_EFFICIENT_REACH
  in: SMART_CAMPAIGN_ADS
  in: TRAVEL_ADS
  in: YOUTUBE_AUDIO
property:
  path: previousStepId
  name: previous step id
  description: The ID of the previous step. This field is required for all steps except the first one. It must point to a step that appears in the step definition list before this step.
  datatype: long
  max count: 1
property:
  path: videoAdSequenceStepId
  name: video ad sequence step id
  description: The ID of this sequence step.
  datatype: long
  max count: 1
property:
  path: assetId
  name: asset id
  description: The ID of the Asset for this step. The asset must be type YOUTUBE_VIDEO.
  datatype: long
  max count: 1

CampaignVideoCampaignSettingsBookingDetailsShape
type: NodeShape
target class: CampaignVideoCampaignSettingsBookingDetails
property:
  path: status
  name: status
  description: Output only. The status of the booking.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BOOKED
  in: HELD
  in: CAMPAIGN_ENDED
  in: HOLD_EXPIRED
  in: BOOKING_CANCELLED
property:
  path: holdExpirationDateTime
  name: hold expiration date time
  description: Output only. Time until which booked inventory will be held or has been held for this campaign. Available for status HELD and HOLD_EXPIRED. Format is "yyyy-MM-dd HH:mm:ss" in the customer's time zone.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: cancellationDateTime
  name: cancellation date time
  description: Output only. Time when the booked inventory of this campaign will be cancelled or has been cancelled. Available for primary status NOT_ELIGIBLE if the campaign will be cancelled and for primary status reason BOOKING_CANCELLED. Format is "yyyy-MM-dd HH:mm:ss" in the customer's time zone.
  write lifecycle: Read only
  datatype: string
  max count: 1

CampaignVideoCampaignSettingsReservationAdCategorySelfDisclosureShape
type: NodeShape
target class: CampaignVideoCampaignSettingsReservationAdCategorySelfDisclosure
property:
  path: alcohol
  name: alcohol
  description: The campaign is expected to contain alcohol-related ads.
  datatype: boolean
  max count: 1
property:
  path: politics
  name: politics
  description: The campaign is expected to contain politics-related ads.
  datatype: boolean
  max count: 1
property:
  path: gambling
  name: gambling
  description: The campaign is expected to contain gambling-related ads.
  datatype: boolean
  max count: 1

CampaignVideoCampaignSettingsVideoAdInventoryControlShape
type: NodeShape
target class: CampaignVideoCampaignSettingsVideoAdInventoryControl
property:
  path: allowNonSkippableInStream
  name: allow non skippable in stream
  description: Determine if video responsive ads can be used for non-skippable in-stream ads. This is only available for campaigns that allow mixing of non-skippable with other formats (Video reach campaign with Target Frequency bidding strategy goal).
  datatype: boolean
  max count: 1
property:
  path: allowInStream
  name: allow in stream
  description: Determine if video responsive ads can be used for in-stream video ads.
  datatype: boolean
  max count: 1
property:
  path: allowInFeed
  name: allow in feed
  description: Determine if video responsive ads can be used for in-feed video ads.
  datatype: boolean
  max count: 1
property:
  path: allowShorts
  name: allow shorts
  description: Determine if video responsive ads can be used as shorts format.
  datatype: boolean
  max count: 1

CampaignShoppingSettingShape
type: NodeShape
target class: CampaignShoppingSetting
property:
  path: campaignPriority
  name: campaign priority
  description: Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.
  datatype: int
  max count: 1
property:
  path: disableProductFeed
  name: disable product feed
  description: Disable the optional product feed. This field is currently supported only for Demand Gen campaigns. See https://support.google.com/google-ads/answer/13721750 to learn more about this feature.
  datatype: boolean
  max count: 1
property:
  path: advertisingPartnerIds
  name: advertising partner ids
  description: The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link. Once set, the field is immutable. This feature is currently supported only for Performance Max, Shopping, Search and Demand Gen campaign types.
  datatype: long
property:
  path: enableLocal
  name: enable local
  description: Whether to include local products.
  datatype: boolean
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Feed label of products to include in the campaign. Valid feed labels may contain a maximum of 20 characters including uppercase letters, numbers, hyphens, and underscores. If you previously used the deprecated `sales_country` in the two-letter country code (`XX`) format, the `feed_label` field should be used instead. For more information see the [feed label](//support.google.com/merchants/answer/12453549) support article.
  datatype: string
  max count: 1
property:
  path: ignoreBrandExclusionInShoppingAds
  name: ignore brand exclusion in shopping ads
  description: If true, brand exclusions are ignored for Shopping ads. Only supported for Shopping campaigns.
  datatype: boolean
  max count: 1
property:
  path: merchantId
  name: merchant id
  description: ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
  datatype: long
  max count: 1
property:
  path: useVehicleInventory
  name: use vehicle inventory
  description: Immutable. Whether to target Vehicle Listing inventory. This field is supported only in Smart Shopping Campaigns. For setting Vehicle Listing inventory in Performance Max campaigns, use `listing_type` instead.
  write lifecycle: Create only
  datatype: boolean
  max count: 1

CampaignTextGuidelinesShape
type: NodeShape
target class: CampaignTextGuidelines
property:
  path: termExclusions
  name: term exclusions
  description: Exact words or phrases that will be excluded from generated text assets. At most 25 exclusions may be provided. Valid exclusions may contain a maximum of 30 characters.
  datatype: string
property:
  path: messagingRestrictions
  name: messaging restrictions
  description: Freeform instructions that will be used to guide text asset generation using LLM inference. At most 40 restrictions may be provided.
  node: CampaignMessagingRestrictionShape
  class: CampaignMessagingRestriction
  node kind: BlankNodeOrIRI

CampaignMessagingRestrictionShape
type: NodeShape
target class: CampaignMessagingRestriction
property:
  path: restrictionText
  name: restriction text
  description: Freeform instructions to guide text asset generation using LLM inference. Valid instructions may contain a maximum of 300 characters.
  datatype: string
  max count: 1
property:
  path: restrictionType
  name: restriction type
  description: Determines how the guideline is applied. Only `RESTRICTION_BASED_EXCLUSION` is currently supported.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: RESTRICTION_BASED_EXCLUSION

CampaignDynamicSearchAdsSettingShape
type: NodeShape
target class: CampaignDynamicSearchAdsSetting
property:
  path: domainName
  name: domain name
  description: Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
  datatype: string
  max count: 1
property:
  path: languageCode
  name: language code
  description: Required. The language code specifying the language of the domain, for example, "en".
  datatype: string
  max count: 1
property:
  path: useSuppliedUrlsOnly
  name: use supplied urls only
  description: Whether the campaign uses advertiser supplied URLs exclusively.
  datatype: boolean
  max count: 1

CampaignAppCampaignSettingShape
type: NodeShape
target class: CampaignAppCampaignSetting
property:
  path: biddingStrategyGoalType
  name: bidding strategy goal type
  description: Represents the goal which the bidding strategy of this app campaign should optimize towards.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: OPTIMIZE_INSTALLS_TARGET_INSTALL_COST
  in: OPTIMIZE_IN_APP_CONVERSIONS_TARGET_INSTALL_COST
  in: OPTIMIZE_IN_APP_CONVERSIONS_TARGET_CONVERSION_COST
  in: OPTIMIZE_RETURN_ON_ADVERTISING_SPEND
  in: OPTIMIZE_PRE_REGISTRATION_CONVERSION_VOLUME
  in: OPTIMIZE_INSTALLS_WITHOUT_TARGET_INSTALL_COST
  in: OPTIMIZE_IN_APP_CONVERSIONS_WITHOUT_TARGET_CPA
  in: OPTIMIZE_TOTAL_VALUE_WITHOUT_TARGET_ROAS
property:
  path: appId
  name: app id
  description: Immutable. A string that uniquely identifies a mobile application.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: appStore
  name: app store
  description: Immutable. The application store that distributes this specific app.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPLE_APP_STORE
  in: GOOGLE_APP_STORE

CommissionShape
type: NodeShape
target class: Commission
property:
  path: commissionRateMicros
  name: commission rate micros
  description: Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%).
  datatype: long
  max count: 1

CampaignGeoTargetTypeSettingShape
type: NodeShape
target class: CampaignGeoTargetTypeSetting
property:
  path: positiveGeoTargetType
  name: positive geo target type
  description: The setting used for positive geotargeting in this particular campaign.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PRESENCE_OR_INTEREST
  in: SEARCH_INTEREST
  in: PRESENCE
property:
  path: negativeGeoTargetType
  name: negative geo target type
  description: The setting used for negative geotargeting in this particular campaign.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PRESENCE_OR_INTEREST
  in: PRESENCE

CampaignLocalCampaignSettingShape
type: NodeShape
target class: CampaignLocalCampaignSetting
property:
  path: locationSourceType
  name: location source type
  description: The location source type for this local campaign.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GOOGLE_MY_BUSINESS
  in: AFFILIATE

CampaignPerformanceMaxUpgradeShape
type: NodeShape
target class: CampaignPerformanceMaxUpgrade
property:
  path: performanceMaxCampaign
  name: performance max campaign
  description: Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: UPGRADE_IN_PROGRESS
  in: UPGRADE_COMPLETE
  in: UPGRADE_FAILED
  in: UPGRADE_ELIGIBLE
property:
  path: preUpgradeCampaign
  name: pre upgrade campaign
  description: Output only. The resource name of the legacy campaign upgraded to Performance Max.
  write lifecycle: Read only
  datatype: string
  max count: 1

RealTimeBiddingSettingShape
type: NodeShape
target class: RealTimeBiddingSetting
property:
  path: optIn
  name: opt in
  description: Whether the campaign is opted in to real-time bidding.
  datatype: boolean
  max count: 1

CampaignAggregateAssetViewShape
type: NodeShape
target class: CampaignAggregateAssetView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the campaign aggregate asset view. Campaign aggregate asset view resource names have the form: `customers/{customer_id}/campaignAggregateAssetViews/{Campaign.campaign_id}~{Asset.asset_id}~{AssetLinkSource.asset_link_source}~{AssetFieldType.field_type}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: assetSource
  name: asset source
  description: Output only. Source of the asset link.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: fieldType
  name: field type
  description: Output only. FieldType of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: asset
  name: asset
  description: Output only. The ID of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. Campaign in which the asset served.
  write lifecycle: Read only
  datatype: string
  max count: 1

CampaignAssetShape
type: NodeShape
target class: CampaignAsset
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form: `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: Immutable. Role that the asset takes under the linked campaign. Required.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign to which the asset is linked.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Status of the campaign asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: PAUSED
property:
  path: asset
  name: asset
  description: Immutable. The asset which is linked to the campaign.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: source
  name: source
  description: Output only. Source of the campaign asset link.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: primaryStatus
  name: primary status
  description: Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: PENDING
  in: LIMITED
  in: NOT_ELIGIBLE
property:
  path: primaryStatusDetails
  name: primary status details
  description: Output only. Provides the details of the primary status and its associated reasons.
  write lifecycle: Read only
  node: AssetLinkPrimaryStatusDetailsShape
  class: AssetLinkPrimaryStatusDetails
  node kind: BlankNodeOrIRI
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: ASSET_LINK_PAUSED
  in: ASSET_LINK_REMOVED
  in: ASSET_DISAPPROVED
  in: ASSET_UNDER_REVIEW
  in: ASSET_APPROVED_LABELED

CampaignAssetSetShape
type: NodeShape
target class: CampaignAssetSet
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign to which this asset set is linked.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign asset set. Asset set asset resource names have the form: `customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: assetSet
  name: asset set
  description: Immutable. The asset set which is linked to the campaign.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the campaign asset set asset. Read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED

CampaignAudienceViewShape
type: NodeShape
target class: CampaignAudienceView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: `customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

CampaignBidModifierShape
type: NodeShape
target class: CampaignBidModifier
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: `customers/{customer_id}/campaignBidModifiers/{campaign_id}~{criterion_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: criterionId
  name: criterion id
  description: Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: bidModifier
  name: bid modifier
  description: The modifier for the bid when the criterion matches.
  datatype: double
  max count: 1
property:
  path: interactionType
  name: interaction type
  description: Immutable. Criterion for interaction type. Only supported for search campaigns.
  write lifecycle: Create only
  node: InteractionTypeInfoShape
  class: InteractionTypeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The campaign to which this criterion belongs.
  write lifecycle: Read only
  datatype: string
  max count: 1

InteractionTypeInfoShape
type: NodeShape
target class: InteractionTypeInfo
property:
  path: type
  name: type
  description: The interaction type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CALLS

CampaignBudgetShape
type: NodeShape
target class: CampaignBudget
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{campaign_budget_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: explicitlyShared
  name: explicitly shared
  description: Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared.
  datatype: boolean
  max count: 1
property:
  path: recommendedBudgetEstimatedChangeWeeklyClicks
  name: recommended budget estimated change weekly clicks
  description: Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: deliveryMethod
  name: delivery method
  description: The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: STANDARD
  in: ACCELERATED
property:
  path: totalAmountMicros
  name: total amount micros
  description: The total amount to be spent by the campaign over its entire duration. This field is used *only* when the CampaignBudget `period` is set to `CUSTOM_PERIOD`. It represents the budget cap for the campaign's lifetime, rather than a daily limit. The amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. This field is mutually exclusive with 'amount_micros'. Only one of 'total_amount_micros' or 'amount_micros' should be set.
  datatype: long
  max count: 1
property:
  path: alignedBiddingStrategyId
  name: aligned bidding strategy id
  description: ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campaigns that are added to the campaign budget must also use the aligned bidding strategy.
  datatype: long
  max count: 1
property:
  path: hasRecommendedBudget
  name: has recommended budget
  description: Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: recommendedBudgetEstimatedChangeWeeklyCostMicros
  name: recommended budget estimated change weekly cost micros
  description: Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: amountMicros
  name: amount micros
  description: The average daily amount to be spent by the campaign. This field is used when the CampaignBudget `period` is set to `DAILY`, which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. The effective monthly spend is capped at 30.4 times this daily amount. This field is mutually exclusive with 'total_amount_micros'. Only one of 'amount_micros' or 'total_amount_micros' should be set.
  datatype: long
  max count: 1
property:
  path: referenceCount
  name: reference count
  description: Output only. The number of campaigns actively using the budget. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: period
  name: period
  description: Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DAILY
  in: CUSTOM_PERIOD
property:
  path: recommendedBudgetEstimatedChangeWeeklyViews
  name: recommended budget estimated change weekly views
  description: Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: Immutable. The type of the campaign budget.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: STANDARD
  in: FIXED_CPA
  in: SMART_CAMPAIGN
  in: LOCAL_SERVICES
property:
  path: id
  name: id
  description: Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of this campaign budget. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: recommendedBudgetEstimatedChangeWeeklyInteractions
  name: recommended budget estimated change weekly interactions
  description: Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
  datatype: string
  max count: 1
property:
  path: recommendedBudgetAmountMicros
  name: recommended budget amount micros
  description: Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1

CampaignConversionGoalShape
type: NodeShape
target class: CampaignConversionGoal
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign with which this campaign conversion goal is associated.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: biddable
  name: biddable
  description: The biddability of the campaign conversion goal. If left unspecified during campaign creation or update operations, this value will inherit the account-level default biddability for the corresponding conversion category and origin. Note: The account-level default may be set to `true` for newly created conversion goals. To explicitly prevent a campaign from bidding on this goal, you must explicitly set `biddable` to `false` and include "biddable" in your mutate operation's `update_mask`.
  datatype: boolean
  max count: 1
property:
  path: category
  name: category
  description: The conversion category of this campaign conversion goal.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DEFAULT
  in: PAGE_VIEW
  in: PURCHASE
  in: SIGNUP
  in: DOWNLOAD
  in: ADD_TO_CART
  in: BEGIN_CHECKOUT
  in: SUBSCRIBE_PAID
  in: PHONE_CALL_LEAD
  in: IMPORTED_LEAD
  in: SUBMIT_LEAD_FORM
  in: BOOK_APPOINTMENT
  in: REQUEST_QUOTE
  in: GET_DIRECTIONS
  in: OUTBOUND_CLICK
  in: CONTACT
  in: ENGAGEMENT
  in: STORE_VISIT
  in: STORE_SALE
  in: QUALIFIED_LEAD
  in: CONVERTED_LEAD
  in: YOUTUBE_FOLLOW_ON_VIEWS
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign conversion goal. Campaign conversion goal resource names have the form: `customers/{customer_id}/campaignConversionGoals/{campaign_id}~{category}~{origin}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: origin
  name: origin
  description: The conversion origin of this campaign conversion goal.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBSITE
  in: GOOGLE_HOSTED
  in: APP
  in: CALL_FROM_ADS
  in: STORE
  in: YOUTUBE_HOSTED
  in: LOCAL_SERVICES_ADS

CampaignCriterionShape
type: NodeShape
target class: CampaignCriterion
property:
  path: mobileAppCategory
  name: mobile app category
  description: Immutable. Mobile app category.
  write lifecycle: Create only
  node: MobileAppCategoryInfoShape
  class: MobileAppCategoryInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeChannel
  name: youtube channel
  description: Immutable. YouTube Channel.
  write lifecycle: Create only
  node: YouTubeChannelInfoShape
  class: YouTubeChannelInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: topic
  name: topic
  description: Immutable. Topic.
  write lifecycle: Create only
  node: TopicInfoShape
  class: TopicInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: operatingSystemVersion
  name: operating system version
  description: Immutable. Operating system version.
  write lifecycle: Create only
  node: OperatingSystemVersionInfoShape
  class: OperatingSystemVersionInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: criterionId
  name: criterion id
  description: Output only. The ID of the criterion. This field is ignored during mutate.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: displayName
  name: display name
  description: Output only. The display name of the criterion. This field is ignored for mutates.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: webpage
  name: webpage
  description: Immutable. Webpage.
  write lifecycle: Create only
  node: WebpageInfoShape
  class: WebpageInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: brandList
  name: brand list
  description: Immutable. Brand list campaign criterion.
  write lifecycle: Create only
  node: BrandListInfoShape
  class: BrandListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: language
  name: language
  description: Immutable. Language.
  write lifecycle: Create only
  node: LanguageInfoShape
  class: LanguageInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign to which the criterion belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: incomeRange
  name: income range
  description: Immutable. Income range.
  write lifecycle: Create only
  node: IncomeRangeInfoShape
  class: IncomeRangeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: locationGroup
  name: location group
  description: Immutable. Location Group
  write lifecycle: Create only
  node: LocationGroupInfoShape
  class: LocationGroupInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: ageRange
  name: age range
  description: Immutable. Age range.
  write lifecycle: Create only
  node: AgeRangeInfoShape
  class: AgeRangeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: gender
  name: gender
  description: Immutable. Gender.
  write lifecycle: Create only
  node: GenderInfoShape
  class: GenderInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: bidModifier
  name: bid modifier
  description: The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.
  datatype: float
  max count: 1
property:
  path: contentLabel
  name: content label
  description: Immutable. ContentLabel.
  write lifecycle: Create only
  node: ContentLabelInfoShape
  class: ContentLabelInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: listingScope
  name: listing scope
  description: Immutable. Listing scope.
  write lifecycle: Create only
  node: ListingScopeInfoShape
  class: ListingScopeInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: combinedAudience
  name: combined audience
  description: Immutable. Combined Audience.
  write lifecycle: Create only
  node: CombinedAudienceInfoShape
  class: CombinedAudienceInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: keyword
  name: keyword
  description: Immutable. Keyword.
  write lifecycle: Create only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: extendedDemographic
  name: extended demographic
  description: Immutable. Extended demographic criterion.
  write lifecycle: Create only
  node: ExtendedDemographicInfoShape
  class: ExtendedDemographicInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeVideo
  name: youtube video
  description: Immutable. YouTube Video.
  write lifecycle: Create only
  node: YouTubeVideoInfoShape
  class: YouTubeVideoInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: negative
  name: negative
  description: Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
  write lifecycle: Create only
  datatype: boolean
  max count: 1
property:
  path: keywordTheme
  name: keyword theme
  description: Immutable. Smart Campaign Keyword Theme.
  write lifecycle: Create only
  node: KeywordThemeInfoShape
  class: KeywordThemeInfo
  node kind: BlankNodeOrIRI
  max count: 1

OperatingSystemVersionInfoShape
type: NodeShape
target class: OperatingSystemVersionInfo
property:
  path: operatingSystemVersionConstant
  name: operating system version constant
  description: The operating system version constant resource name.
  datatype: string
  max count: 1

LocationGroupInfoShape
type: NodeShape
target class: LocationGroupInfo
property:
  path: geoTargetConstants
  name: geo target constants
  description: Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed. Cannot be set with AssetSet fields.
  datatype: string
property:
  path: locationGroupAssetSets
  name: location group asset sets
  description: AssetSets whose Assets are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with feed, geo target constants or feed item sets. When using asset sets, either this field or enable_customer_level_location_asset_set should be specified. Both cannot be used at the same time. This can only be set in CREATE operations.
  datatype: string
property:
  path: feedItemSets
  name: feed item sets
  description: FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geo_target_constants. This is optional and can only be set in CREATE operations. Cannot be set with AssetSet fields.
  datatype: string
property:
  path: radius
  name: radius
  description: Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
  datatype: long
  max count: 1
property:
  path: enableCustomerLevelLocationAssetSet
  name: enable customer level location asset set
  description: Denotes that the latest customer level asset set is used for targeting. Used with radius and radius_units. Cannot be used with feed, geo target constants or feed item sets. When using asset sets, either this field or location_group_asset_sets should be specified. Both cannot be used at the same time. This can only be set in CREATE operations.
  datatype: boolean
  max count: 1
property:
  path: radiusUnits
  name: radius units
  description: Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets and asset sets. This is required and must be set in CREATE operations.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: METERS
  in: MILES
  in: MILLI_MILES

ContentLabelInfoShape
type: NodeShape
target class: ContentLabelInfo
property:
  path: type
  name: type
  description: Content label type, required for CREATE operations.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEXUALLY_SUGGESTIVE
  in: BELOW_THE_FOLD
  in: PARKED_DOMAIN
  in: JUVENILE
  in: PROFANITY
  in: TRAGEDY
  in: VIDEO
  in: VIDEO_RATING_DV_G
  in: VIDEO_RATING_DV_PG
  in: VIDEO_RATING_DV_T
  in: VIDEO_RATING_DV_MA
  in: VIDEO_NOT_YET_RATED
  in: EMBEDDED_VIDEO
  in: LIVE_STREAMING_VIDEO
  in: SOCIAL_ISSUES
  in: BRAND_SUITABILITY_CONTENT_FOR_FAMILIES
  in: BRAND_SUITABILITY_GAMES_FIGHTING
  in: BRAND_SUITABILITY_GAMES_MATURE
  in: BRAND_SUITABILITY_HEALTH_SENSITIVE
  in: BRAND_SUITABILITY_HEALTH_SOURCE_UNDETERMINED
  in: BRAND_SUITABILITY_NEWS_RECENT
  in: BRAND_SUITABILITY_NEWS_SENSITIVE
  in: BRAND_SUITABILITY_NEWS_SOURCE_NOT_FEATURED
  in: BRAND_SUITABILITY_POLITICS
  in: BRAND_SUITABILITY_RELIGION

ListingScopeInfoShape
type: NodeShape
target class: ListingScopeInfo
property:
  path: dimensions
  name: dimensions
  description: Scope of the campaign criterion.
  node: ListingDimensionInfoShape
  class: ListingDimensionInfo
  node kind: BlankNodeOrIRI

KeywordThemeInfoShape
type: NodeShape
target class: KeywordThemeInfo
property:
  path: freeFormKeywordTheme
  name: free form keyword theme
  description: Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
  datatype: string
  max count: 1
property:
  path: keywordThemeConstant
  name: keyword theme constant
  description: The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
  datatype: string
  max count: 1

CarrierInfoShape
type: NodeShape
target class: CarrierInfo
property:
  path: carrierConstant
  name: carrier constant
  description: The Carrier constant resource name.
  datatype: string
  max count: 1

WebpageListInfoShape
type: NodeShape
target class: WebpageListInfo
property:
  path: sharedSet
  name: shared set
  description: Shared set resource name of the webpage list.
  datatype: string
  max count: 1

IpBlockInfoShape
type: NodeShape
target class: IpBlockInfo
property:
  path: ipAddress
  name: ip address
  description: The IP address or the CIDR block to be excluded.
  datatype: string
  max count: 1

ProximityInfoShape
type: NodeShape
target class: ProximityInfo
property:
  path: radius
  name: radius
  description: The radius of the proximity.
  datatype: double
  max count: 1
property:
  path: address
  name: address
  description: Full address.
  node: AddressInfoShape
  class: AddressInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: geoPoint
  name: geo point
  description: Latitude and longitude.
  node: GeoPointInfoShape
  class: GeoPointInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: radiusUnits
  name: radius units
  description: The unit of measurement of the radius. Default is KILOMETERS.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MILES
  in: KILOMETERS

GeoPointInfoShape
type: NodeShape
target class: GeoPointInfo
property:
  path: longitudeInMicroDegrees
  name: longitude in micro degrees
  description: Micro degrees for the longitude.
  datatype: int
  max count: 1
property:
  path: latitudeInMicroDegrees
  name: latitude in micro degrees
  description: Micro degrees for the latitude.
  datatype: int
  max count: 1

MobileDeviceInfoShape
type: NodeShape
target class: MobileDeviceInfo
property:
  path: mobileDeviceConstant
  name: mobile device constant
  description: The mobile device constant resource name.
  datatype: string
  max count: 1

CampaignCustomizerShape
type: NodeShape
target class: CampaignCustomizer
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign to which the customizer attribute is linked.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the campaign customizer.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign customizer. Campaign customizer resource names have the form: `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: value
  name: value
  description: Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
  node: CustomizerValueShape
  class: CustomizerValue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customizerAttribute
  name: customizer attribute
  description: Required. Immutable. The customizer attribute which is linked to the campaign.
  write lifecycle: Create only
  datatype: string
  max count: 1

CampaignDraftShape
type: NodeShape
target class: CampaignDraft
property:
  path: baseCampaign
  name: base campaign
  description: Immutable. The base campaign to which the draft belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign draft. Campaign draft resource names have the form: `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: hasExperimentRunning
  name: has experiment running
  description: Output only. Whether there is an experiment based on this draft currently serving.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: name
  name: name
  description: The name of the campaign draft. This field is required and should not be empty when creating new campaign drafts. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the campaign draft. This field is read-only. When a new campaign draft is added, the status defaults to PROPOSED.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PROPOSED
  in: REMOVED
  in: PROMOTING
  in: PROMOTED
  in: PROMOTE_FAILED
property:
  path: draftId
  name: draft id
  description: Output only. The ID of the draft. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: draftCampaign
  name: draft campaign
  description: Output only. Resource name of the Campaign that results from overlaying the draft changes onto the base campaign. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: longRunningOperation
  name: long running operation
  description: Output only. The resource name of the long-running operation that can be used to poll for completion of draft promotion. This is only set if the draft promotion is in progress or finished.
  write lifecycle: Read only
  datatype: string
  max count: 1

CampaignGoalConfigShape
type: NodeShape
target class: CampaignGoalConfig
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign goal config. campaign goal config resource names have the form: `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: goal
  name: goal
  description: Immutable. The resource name of the goal this link is attached to.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Immutable. The resource name of the campaign for this link.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: goalType
  name: goal type
  description: Output only. The goal type this link is attached to.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER_RETENTION
property:
  path: campaignRetentionSettings
  name: campaign retention settings
  description: Retention goal campaign settings.
  node: CampaignGoalSettingsCampaignRetentionGoalSettingsShape
  class: CampaignGoalSettingsCampaignRetentionGoalSettings
  node kind: BlankNodeOrIRI
  max count: 1

CampaignGoalSettingsCampaignRetentionGoalSettingsShape
type: NodeShape
target class: CampaignGoalSettingsCampaignRetentionGoalSettings
property:
  path: valueSettingsOverride
  name: value settings override
  description: Retention goal campaign specific value settings.
  node: CustomerLifecycleOptimizationValueSettingsShape
  class: CustomerLifecycleOptimizationValueSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetOption
  name: target option
  description: Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TARGET_ALL
  in: TARGET_SPECIFIC

CustomerLifecycleOptimizationValueSettingsShape
type: NodeShape
target class: CustomerLifecycleOptimizationValueSettings
property:
  path: additionalValue
  name: additional value
  description: Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value.
  datatype: double
  max count: 1
property:
  path: additionalHighLifetimeValue
  name: additional high lifetime value
  description: High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set.
  datatype: double
  max count: 1

CampaignGroupShape
type: NodeShape
target class: CampaignGroup
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign group. Campaign group resource names have the form: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the campaign group.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED

CampaignLabelShape
type: NodeShape
target class: CampaignLabel
property:
  path: resourceName
  name: resource name
  description: Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign to which the label is attached.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: label
  name: label
  description: Immutable. The label assigned to the campaign.
  write lifecycle: Create only
  datatype: string
  max count: 1

CampaignLifecycleGoalShape
type: NodeShape
target class: CampaignLifecycleGoal
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer lifecycle goal of a campaign. `customers/{customer_id}/campaignLifecycleGoals/{campaign_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The campaign where the goal is attached.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: customerAcquisitionGoalSettings
  name: customer acquisition goal settings
  description: Output only. The customer acquisition goal settings for the campaign. The customer acquisition goal is described in this article: https://support.google.com/google-ads/answer/12080169
  write lifecycle: Read only
  node: CustomerAcquisitionGoalSettingsShape
  class: CustomerAcquisitionGoalSettings
  node kind: BlankNodeOrIRI
  max count: 1

CustomerAcquisitionGoalSettingsShape
type: NodeShape
target class: CustomerAcquisitionGoalSettings
property:
  path: optimizationMode
  name: optimization mode
  description: Output only. Customer acquisition optimization mode of this campaign.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TARGET_ALL_EQUALLY
  in: BID_HIGHER_FOR_NEW_CUSTOMER
  in: TARGET_NEW_CUSTOMER
property:
  path: valueSettings
  name: value settings
  description: Output only. Campaign specific values for the customer acquisition goal.
  write lifecycle: Read only
  node: LifecycleGoalValueSettingsShape
  class: LifecycleGoalValueSettings
  node kind: BlankNodeOrIRI
  max count: 1

LifecycleGoalValueSettingsShape
type: NodeShape
target class: LifecycleGoalValueSettings
property:
  path: value
  name: value
  description: Value of the lifecycle goal. For example, for customer acquisition goal, value is the incremental conversion value for new customers who are not of high value.
  datatype: double
  max count: 1
property:
  path: highLifetimeValue
  name: high lifetime value
  description: High lifetime value of the lifecycle goal. For example, for customer acquisition goal, high lifetime value is the incremental conversion value for new customers who are of high value. High lifetime value should be greater than value, if set.
  datatype: double
  max count: 1

CampaignSearchTermInsightShape
type: NodeShape
target class: CampaignSearchTermInsight
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the campaign level search term insight. Campaign level search term insight resource names have the form: `customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{category_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: categoryLabel
  name: category label
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the insight.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: Output only. The ID of the campaign.
  write lifecycle: Read only
  datatype: long
  max count: 1

CampaignSearchTermViewShape
type: NodeShape
target class: CampaignSearchTermView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the campaign search term view. Campaign search term view resource names have the form: `customers/{customer_id}/campaignSearchTermViews/{campaign_id}~{URL-base64_search_term}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: searchTerm
  name: search term
  description: Output only. The search term.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The campaign the search term served in.
  write lifecycle: Read only
  datatype: string
  max count: 1

CampaignSharedSetShape
type: NodeShape
target class: CampaignSharedSet
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the campaign shared set. Campaign shared set resource names have the form: `customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of this campaign shared set. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign to which the campaign shared set belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: sharedSet
  name: shared set
  description: Immutable. The shared set associated with the campaign. This may be a negative keyword shared set of another customer. This customer should be a manager of the other customer, otherwise the campaign shared set will exist but have no serving effect. Only negative keyword shared sets can be associated with Shopping campaigns. Only negative placement shared sets can be associated with Display mobile app campaigns.
  write lifecycle: Create only
  datatype: string
  max count: 1

CampaignSimulationShape
type: NodeShape
target class: CampaignSimulation
property:
  path: endDate
  name: end date
  description: Output only. Last day on which the simulation is based, in YYYY-MM-DD format
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetCpaPointList
  name: target cpa point list
  description: Output only. Simulation points if the simulation type is TARGET_CPA.
  write lifecycle: Read only
  node: TargetCpaSimulationPointListShape
  class: TargetCpaSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: cpcBidPointList
  name: cpc bid point list
  description: Output only. Simulation points if the simulation type is CPC_BID.
  write lifecycle: Read only
  node: CpcBidSimulationPointListShape
  class: CpcBidSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetRoasPointList
  name: target roas point list
  description: Output only. Simulation points if the simulation type is TARGET_ROAS.
  write lifecycle: Read only
  node: TargetRoasSimulationPointListShape
  class: TargetRoasSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetImpressionSharePointList
  name: target impression share point list
  description: Output only. Simulation points if the simulation type is TARGET_IMPRESSION_SHARE.
  write lifecycle: Read only
  node: TargetImpressionShareSimulationPointListShape
  class: TargetImpressionShareSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: startDate
  name: start date
  description: Output only. First day on which the simulation is based, in YYYY-MM-DD format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaignId
  name: campaign id
  description: Output only. Campaign id of the simulation.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: Output only. The field that the simulation modifies.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CPC_BID
  in: CPV_BID
  in: TARGET_CPA
  in: BID_MODIFIER
  in: TARGET_ROAS
  in: PERCENT_CPC_BID
  in: TARGET_IMPRESSION_SHARE
  in: BUDGET
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the campaign simulation. Campaign simulation resource names have the form: `customers/{customer_id}/campaignSimulations/{campaign_id}~{type}~{modification_method}~{start_date}~{end_date}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: budgetPointList
  name: budget point list
  description: Output only. Simulation points if the simulation type is BUDGET.
  write lifecycle: Read only
  node: BudgetSimulationPointListShape
  class: BudgetSimulationPointList
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: modificationMethod
  name: modification method
  description: Output only. How the simulation modifies the field.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: UNIFORM
  in: DEFAULT
  in: SCALING

TargetImpressionShareSimulationPointListShape
type: NodeShape
target class: TargetImpressionShareSimulationPointList
property:
  path: points
  name: points
  description: Projected metrics for a specific target impression share value.
  node: TargetImpressionShareSimulationPointShape
  class: TargetImpressionShareSimulationPoint
  node kind: BlankNodeOrIRI

TargetImpressionShareSimulationPointShape
type: NodeShape
target class: TargetImpressionShareSimulationPoint
property:
  path: biddableConversionsValue
  name: biddable conversions value
  description: Projected total value of biddable conversions.
  datatype: double
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Projected cost in micros.
  datatype: long
  max count: 1
property:
  path: impressions
  name: impressions
  description: Projected number of impressions.
  datatype: long
  max count: 1
property:
  path: clicks
  name: clicks
  description: Projected number of clicks.
  datatype: long
  max count: 1
property:
  path: absoluteTopImpressions
  name: absolute top impressions
  description: Projected number of absolute top impressions. Only search advertising channel type supports this field.
  datatype: long
  max count: 1
property:
  path: targetImpressionShareMicros
  name: target impression share micros
  description: The simulated target impression share value (in micros) upon which projected metrics are based. For example, 10% impression share, which is equal to 0.1, is stored as 100_000. This value is validated and will not exceed 1M (100%).
  datatype: long
  max count: 1
property:
  path: requiredCpcBidCeilingMicros
  name: required cpc bid ceiling micros
  description: Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency.
  datatype: long
  max count: 1
property:
  path: requiredBudgetAmountMicros
  name: required budget amount micros
  description: Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
  datatype: long
  max count: 1
property:
  path: biddableConversions
  name: biddable conversions
  description: Projected number of biddable conversions.
  datatype: double
  max count: 1
property:
  path: topSlotImpressions
  name: top slot impressions
  description: Projected number of top slot impressions. Only search advertising channel type supports this field.
  datatype: long
  max count: 1

CarrierConstantShape
type: NodeShape
target class: CarrierConstant
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the carrier criterion. Carrier criterion resource names have the form: `carrierConstants/{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the carrier criterion.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. The full name of the carrier in English.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: Output only. The country code of the country where the carrier is located, for example, "AR", "FR", etc.
  write lifecycle: Read only
  datatype: string
  max count: 1

CartDataSalesViewShape
type: NodeShape
target class: CartDataSalesView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Cart data sales view. Cart data sales view resource names have the form: `customers/{customer_id}/cartDataSalesView`
  write lifecycle: Read only
  datatype: string
  max count: 1

ChangeEventShape
type: NodeShape
target class: ChangeEvent
property:
  path: newResource
  name: new resource
  description: Output only. The new resource after the change. Only changed fields will be populated.
  write lifecycle: Read only
  class: ChangeEventChangedResource
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The Campaign affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: changeDateTime
  name: change date time
  description: Output only. Time at which the change was committed on this resource.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceChangeOperation
  name: resource change operation
  description: Output only. The operation on the changed resource.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CREATE
  in: UPDATE
  in: REMOVE
property:
  path: changeResourceName
  name: change resource name
  description: Output only. The Simply resource this change occurred on.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: asset
  name: asset
  description: Output only. The Asset affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: oldResource
  name: old resource
  description: Output only. The old resource before the change. Only changed fields will be populated.
  write lifecycle: Read only
  class: ChangeEventChangedResource
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: userEmail
  name: user email
  description: Output only. The email of the user who made this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the change event. Change event resource names have the form: `customers/{customer_id}/changeEvents/{timestamp_micros}~{command_index}~{mutate_index}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: clientType
  name: client type
  description: Output only. Where the change was made through.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GOOGLE_ADS_WEB_CLIENT
  in: GOOGLE_ADS_AUTOMATED_RULE
  in: GOOGLE_ADS_SCRIPTS
  in: GOOGLE_ADS_BULK_UPLOAD
  in: GOOGLE_ADS_API
  in: GOOGLE_ADS_EDITOR
  in: GOOGLE_ADS_MOBILE_APP
  in: GOOGLE_ADS_RECOMMENDATIONS
  in: SEARCH_ADS_360_SYNC
  in: SEARCH_ADS_360_POST
  in: INTERNAL_TOOL
  in: OTHER
  in: GOOGLE_ADS_RECOMMENDATIONS_SUBSCRIPTION
property:
  path: adGroup
  name: ad group
  description: Output only. The AdGroup affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: changeResourceType
  name: change resource type
  description: Output only. The type of the changed resource. This dictates what resource will be set in old_resource and new_resource.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AD
  in: AD_GROUP
  in: AD_GROUP_CRITERION
  in: CAMPAIGN
  in: CAMPAIGN_BUDGET
  in: AD_GROUP_BID_MODIFIER
  in: CAMPAIGN_CRITERION
  in: FEED
  in: FEED_ITEM
  in: CAMPAIGN_FEED
  in: AD_GROUP_FEED
  in: AD_GROUP_AD
  in: ASSET
  in: CUSTOMER_ASSET
  in: CAMPAIGN_ASSET
  in: AD_GROUP_ASSET
  in: ASSET_SET
  in: ASSET_SET_ASSET
  in: CAMPAIGN_ASSET_SET
property:
  path: changedFields
  name: changed fields
  description: Output only. A list of fields that are changed in the returned resource.
  write lifecycle: Read only
  datatype: string
  max count: 1

ChangeEventChangedResourceShape
type: NodeShape
target class: ChangeEventChangedResource
property:
  path: campaignBudget
  name: campaign budget
  description: Output only. Set if change_resource_type == CAMPAIGN_BUDGET.
  write lifecycle: Read only
  node: CampaignBudgetShape
  class: CampaignBudget
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupCriterion
  name: ad group criterion
  description: Output only. Set if change_resource_type == AD_GROUP_CRITERION.
  write lifecycle: Read only
  node: AdGroupCriterionShape
  class: AdGroupCriterion
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaignAsset
  name: campaign asset
  description: Output only. Set if change_resource_type == CAMPAIGN_ASSET.
  write lifecycle: Read only
  node: CampaignAssetShape
  class: CampaignAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. Set if change_resource_type == CAMPAIGN.
  write lifecycle: Read only
  node: CampaignShape
  class: Campaign
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: asset
  name: asset
  description: Output only. Set if change_resource_type == ASSET.
  write lifecycle: Read only
  class: Asset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: assetSetAsset
  name: asset set asset
  description: Output only. Set if change_resource_type == ASSET_SET_ASSET.
  write lifecycle: Read only
  node: AssetSetAssetShape
  class: AssetSetAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupBidModifier
  name: ad group bid modifier
  description: Output only. Set if change_resource_type == AD_GROUP_BID_MODIFIER.
  write lifecycle: Read only
  node: AdGroupBidModifierShape
  class: AdGroupBidModifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaignAssetSet
  name: campaign asset set
  description: Output only. Set if change_resource_type == CAMPAIGN_ASSET_SET.
  write lifecycle: Read only
  node: CampaignAssetSetShape
  class: CampaignAssetSet
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroup
  name: ad group
  description: Output only. Set if change_resource_type == AD_GROUP.
  write lifecycle: Read only
  node: AdGroupShape
  class: AdGroup
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaignCriterion
  name: campaign criterion
  description: Output only. Set if change_resource_type == CAMPAIGN_CRITERION.
  write lifecycle: Read only
  node: CampaignCriterionShape
  class: CampaignCriterion
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerAsset
  name: customer asset
  description: Output only. Set if change_resource_type == CUSTOMER_ASSET.
  write lifecycle: Read only
  node: CustomerAssetShape
  class: CustomerAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: ad
  name: ad
  description: Output only. Set if change_resource_type == AD.
  write lifecycle: Read only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupAsset
  name: ad group asset
  description: Output only. Set if change_resource_type == AD_GROUP_ASSET.
  write lifecycle: Read only
  node: AdGroupAssetShape
  class: AdGroupAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupAd
  name: ad group ad
  description: Output only. Set if change_resource_type == AD_GROUP_AD.
  write lifecycle: Read only
  class: AdGroupAd
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: assetSet
  name: asset set
  description: Output only. Set if change_resource_type == ASSET_SET.
  write lifecycle: Read only
  node: AssetSetShape
  class: AssetSet
  node kind: BlankNodeOrIRI
  max count: 1

CustomerAssetShape
type: NodeShape
target class: CustomerAsset
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer asset. CustomerAsset resource names have the form: `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: Required. Immutable. Role that the asset takes for the customer link.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: asset
  name: asset
  description: Required. Immutable. The asset which is linked to the customer.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: source
  name: source
  description: Output only. Source of the customer asset link.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: status
  name: status
  description: Status of the customer asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: PAUSED
property:
  path: primaryStatusDetails
  name: primary status details
  description: Output only. Provides the details of the primary status and its associated reasons.
  write lifecycle: Read only
  node: AssetLinkPrimaryStatusDetailsShape
  class: AssetLinkPrimaryStatusDetails
  node kind: BlankNodeOrIRI
property:
  path: primaryStatusReasons
  name: primary status reasons
  description: Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: ASSET_LINK_PAUSED
  in: ASSET_LINK_REMOVED
  in: ASSET_DISAPPROVED
  in: ASSET_UNDER_REVIEW
  in: ASSET_APPROVED_LABELED
property:
  path: primaryStatus
  name: primary status
  description: Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: PAUSED
  in: REMOVED
  in: PENDING
  in: LIMITED
  in: NOT_ELIGIBLE

ChangeStatusShape
type: NodeShape
target class: ChangeStatus
property:
  path: adGroup
  name: ad group
  description: Output only. The AdGroup affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaignCriterion
  name: campaign criterion
  description: Output only. The CampaignCriterion affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: customerAsset
  name: customer asset
  description: Output only. The CustomerAsset affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the change status. Change status resource names have the form: `customers/{customer_id}/changeStatus/{change_status_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaignAssetSet
  name: campaign asset set
  description: Output only. The CampaignAssetSet affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroupBidModifier
  name: ad group bid modifier
  description: Output only. The AdGroupBidModifier affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: assetGroup
  name: asset group
  description: Output only. The AssetGroup affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceStatus
  name: resource status
  description: Output only. Represents the status of the changed resource.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADDED
  in: CHANGED
  in: REMOVED
property:
  path: lastChangeDateTime
  name: last change date time
  description: Output only. Time at which the most recent change has occurred on this resource.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceType
  name: resource type
  description: Output only. Represents the type of the changed resource. This dictates what fields will be set. For example, for AD_GROUP, campaign and ad_group fields will be set.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AD_GROUP
  in: AD_GROUP_AD
  in: AD_GROUP_CRITERION
  in: CAMPAIGN
  in: CAMPAIGN_CRITERION
  in: CAMPAIGN_BUDGET
  in: FEED
  in: FEED_ITEM
  in: AD_GROUP_FEED
  in: CAMPAIGN_FEED
  in: AD_GROUP_BID_MODIFIER
  in: SHARED_SET
  in: CAMPAIGN_SHARED_SET
  in: ASSET
  in: CUSTOMER_ASSET
  in: CAMPAIGN_ASSET
  in: AD_GROUP_ASSET
  in: COMBINED_AUDIENCE
  in: ASSET_GROUP
  in: ASSET_SET
  in: CAMPAIGN_ASSET_SET
property:
  path: adGroupAd
  name: ad group ad
  description: Output only. The AdGroupAd affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: assetSet
  name: asset set
  description: Output only. The AssetSet affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroupAsset
  name: ad group asset
  description: Output only. The AdGroupAsset affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: combinedAudience
  name: combined audience
  description: Output only. The CombinedAudience affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaignBudget
  name: campaign budget
  description: Output only. The CampaignBudget affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The Campaign affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaignSharedSet
  name: campaign shared set
  description: Output only. The CampaignSharedSet affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroupCriterion
  name: ad group criterion
  description: Output only. The AdGroupCriterion affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaignAsset
  name: campaign asset
  description: Output only. The CampaignAsset affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: asset
  name: asset
  description: Output only. The Asset affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: sharedSet
  name: shared set
  description: Output only. The SharedSet affected by this change.
  write lifecycle: Read only
  datatype: string
  max count: 1

ChannelAggregateAssetViewShape
type: NodeShape
target class: ChannelAggregateAssetView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the channel aggregate asset view. Channel aggregate asset view resource names have the form: `customers/{customer_id}/channelAggregateAssetViews/{ChannelAssetV2.advertising_channel_type}~{ChannelAssetV2.asset_id}~{ChannelAssetV2.asset_source}~{ChannelAssetV2.field_type}"`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: assetSource
  name: asset source
  description: Output only. Source of the asset link.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: AUTOMATICALLY_CREATED
property:
  path: fieldType
  name: field type
  description: Output only. FieldType of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: asset
  name: asset
  description: Output only. The ID of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: advertisingChannelType
  name: advertising channel type
  description: Output only. Channel in which the asset served.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH
  in: DISPLAY
  in: SHOPPING
  in: HOTEL
  in: VIDEO
  in: MULTI_CHANNEL
  in: LOCAL
  in: SMART
  in: PERFORMANCE_MAX
  in: LOCAL_SERVICES
  in: TRAVEL
  in: DEMAND_GEN

ClickLocationShape
type: NodeShape
target class: ClickLocation
property:
  path: metro
  name: metro
  description: The metro location criterion associated with the impression.
  datatype: string
  max count: 1
property:
  path: region
  name: region
  description: The region location criterion associated with the impression.
  datatype: string
  max count: 1
property:
  path: mostSpecific
  name: most specific
  description: The most specific location criterion associated with the impression.
  datatype: string
  max count: 1
property:
  path: city
  name: city
  description: The city location criterion associated with the impression.
  datatype: string
  max count: 1
property:
  path: country
  name: country
  description: The country location criterion associated with the impression.
  datatype: string
  max count: 1

ClickViewShape
type: NodeShape
target class: ClickView
property:
  path: locationOfPresence
  name: location of presence
  description: Output only. The location criteria matching the location of presence associated with the impression.
  write lifecycle: Read only
  node: ClickLocationShape
  class: ClickLocation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: areaOfInterest
  name: area of interest
  description: Output only. The location criteria matching the area of interest associated with the impression.
  write lifecycle: Read only
  node: ClickLocationShape
  class: ClickLocation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupAd
  name: ad group ad
  description: Output only. The associated ad.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: userList
  name: user list
  description: Output only. The associated user list, if one exists.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the click view. Click view resource names have the form: `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaignLocationTarget
  name: campaign location target
  description: Output only. The associated campaign location target, if one exists.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: gclid
  name: gclid
  description: Output only. The Google Click ID.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: keyword
  name: keyword
  description: Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: keywordInfo
  name: keyword info
  description: Output only. Basic information about the associated keyword, if it exists.
  write lifecycle: Read only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: pageNumber
  name: page number
  description: Output only. Page number in search results where the ad was shown.
  write lifecycle: Read only
  datatype: long
  max count: 1

CombinedAudienceShape
type: NodeShape
target class: CombinedAudience
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the combined audience. Combined audience names have the form: `customers/{customer_id}/combinedAudience/{combined_audience_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Output only. Description of this combined audience.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. ID of the combined audience.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Status of this combined audience. Indicates whether the combined audience is enabled or removed.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: name
  name: name
  description: Output only. Name of the combined audience. It should be unique across all combined audiences.
  write lifecycle: Read only
  datatype: string
  max count: 1

CommonMetricsShape
type: NodeShape
target class: CommonMetrics
property:
  path: auctionInsightSearchAbsoluteTopImpressionPercentage
  name: auction insight search absolute top impression percentage
  description: 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.
  datatype: double
  max count: 1
property:
  path: allConversionsFromLocationAssetOrder
  name: all conversions from location asset order
  description: Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
  datatype: double
  max count: 1
property:
  path: valuePerAllConversions
  name: value per all conversions
  description: The value of all conversions divided by the number of all conversions.
  datatype: double
  max count: 1
property:
  path: conversionValuePValue
  name: conversion value pvalue
  description: The p-value for the null hypothesis that the experiment has no effect on conversion value. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversion value, is 3%.
  datatype: double
  max count: 1
property:
  path: conversionsAbsoluteChangeMarginOfError
  name: conversions absolute change margin of error
  description: The margin of error when estimating the experiment's effect on conversions absolute change. Together with `conversions_absolute_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment - control). This field specifies the radius of the confidence interval, which is centered at `conversions_absolute_change_point_estimate`.
  datatype: double
  max count: 1
property:
  path: grossProfitMicros
  name: gross profit micros
  description: 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.
  datatype: long
  max count: 1
property:
  path: conversionsUniqueQueryClusters
  name: conversions unique query clusters
  description: Unique query intent cluster count for conversions.
  datatype: long
  max count: 1
property:
  path: allUnitsSold
  name: all units sold
  description: All units sold is the total number of products sold from orders attributed to your ads. Includes the amount from the units_sold metric, plus units sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
  datatype: double
  max count: 1
property:
  path: searchBudgetLostTopImpressionShare
  name: search budget lost top impression share
  description: The estimated percent of times that 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.
  datatype: double
  max count: 1
property:
  path: activeViewAudibleQuartileP50Rate
  name: active view audible quartile p50rate
  description: The number of impressions that were audible at the second quartile of the ad playback, divided by the total number of impressions measurable for audibility.
  datatype: double
  max count: 1
property:
  path: costMicrosChangePointEstimate
  name: cost micros change point estimate
  description: The point estimate when estimating the experiment's effect on cost change. Together with `cost_micros_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(cost_micros_change_point_estimate - cost_micros_margin_of_error, cost_micros_change_point_estimate + cost_micros_margin_of_error)`.
  datatype: double
  max count: 1
property:
  path: benchmarkAverageMaxCpc
  name: benchmark average max cpc
  description: An indication of how other advertisers are bidding on similar products.
  datatype: double
  max count: 1
property:
  path: uniqueUsersThreePlus
  name: unique users three plus
  description: This metric counts the unique individuals who were shown your video ad three or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
  datatype: long
  max count: 1
property:
  path: phoneThroughRate
  name: phone through rate
  description: Number of phone calls received (`phone_calls`) divided by the number of times your phone number is shown (`phone_impressions`).
  datatype: double
  max count: 1
property:
  path: videoQuartileP75Rate
  name: video quartile p75rate
  description: Percentage of impressions where the viewer watched 75% of your video.
  datatype: double
  max count: 1
property:
  path: platformComparableConversions
  name: platform comparable conversions
  description: The number of platform comparable conversions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
  datatype: double
  max count: 1
property:
  path: impressionsFromStoreReach
  name: impressions from store reach
  description: The number of times a business's location-based ad was shown. This metric applies to feed items only.
  datatype: long
  max count: 1
property:
  path: averageCpc
  name: average cpc
  description: The total cost of all clicks divided by the total number of clicks received.
  datatype: double
  max count: 1
property:
  path: interactionRate
  name: interaction rate
  description: 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.
  datatype: double
  max count: 1
property:
  path: uniqueUsersFourPlus
  name: unique users four plus
  description: This metric counts the unique individuals who were shown your video ad four or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
  datatype: long
  max count: 1
property:
  path: generalInvalidClickRate
  name: general invalid click rate
  description: The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).
  datatype: double
  max count: 1
property:
  path: allConversionsByConversionDate
  name: all conversions by conversion date
  description: The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. 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 [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009).
  datatype: double
  max count: 1
property:
  path: conversionsAbsoluteChangePValue
  name: conversions absolute change pvalue
  description: The p-value for the null hypothesis that the experiment has no effect on conversions absolute change. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversions absolute change, is 3%.
  datatype: double
  max count: 1
property:
  path: allCrossSellUnitsSold
  name: all cross sell units sold
  description: All cross-sell units sold is the total number of products sold as a result of advertising a different product. Includes the amount shown in the cross_sell_units_sold metric, plus cross-sell units sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
  datatype: double
  max count: 1
property:
  path: conversionsAbsoluteChangePointEstimate
  name: conversions absolute change point estimate
  description: The point estimate when estimating the experiment's effect on conversions absolute change. Together with `conversions_absolute_change_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment - control). This field specifies the point estimate, which is the center of the confidence interval: `(conversions_absolute_change_point_estimate - conversions_absolute_change_margin_of_error, conversions_absolute_change_point_estimate + conversions_absolute_change_margin_of_error)`.
  datatype: double
  max count: 1
property:
  path: conversionsByConversionDate
  name: conversions by conversion date
  description: The number of conversions. This only includes conversion actions which include_in_conversions_metric 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 [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009).
  datatype: double
  max count: 1
property:
  path: engagementRate
  name: engagement rate
  description: 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.
  datatype: double
  max count: 1
property:
  path: crossDeviceConversionsValueMicros
  name: cross device conversions value micros
  description: The sum of the value of cross-device conversions, in micros.
  datatype: long
  max count: 1
property:
  path: viewThroughConversionsFromLocationAssetOrder
  name: view through conversions from location asset order
  description: Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
  datatype: double
  max count: 1
property:
  path: searchBudgetLostImpressionShare
  name: search budget lost impression share
  description: 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.
  datatype: double
  max count: 1
property:
  path: organicClicks
  name: organic clicks
  description: The number of times someone clicked your site's listing in the unpaid results for a particular query. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
  datatype: long
  max count: 1
property:
  path: valuePerConversionsByConversionDate
  name: value per conversions by conversion date
  description: The value of conversions divided by the number of conversions. This only includes conversion actions for which the `include_in_conversions_metric` 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 [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009).
  datatype: double
  max count: 1
property:
  path: costMicrosPValue
  name: cost micros pvalue
  description: The p-value for the null hypothesis that the experiment has no effect on cost. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on cost, is 3%.
  datatype: double
  max count: 1

SearchVolumeRangeShape
type: NodeShape
target class: SearchVolumeRange
property:
  path: max
  name: max
  description: Upper bound of search volume.
  datatype: long
  max count: 1
property:
  path: min
  name: min
  description: Lower bound of search volume.
  datatype: long
  max count: 1

ConsentShape
type: NodeShape
target class: Consent
property:
  path: adUserData
  name: ad user data
  description: This represents consent for ad user data.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GRANTED
  in: DENIED
property:
  path: adPersonalization
  name: ad personalization
  description: This represents consent for ad personalization. This can only be set for OfflineUserDataJobService and UserDataService.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GRANTED
  in: DENIED

ContactDetailsShape
type: NodeShape
target class: ContactDetails
property:
  path: phoneNumber
  name: phone number
  description: Output only. Phone number of the consumer for the lead. This can be a real phone number or a tracking number. The phone number is returned in E164 format. See https://support.google.com/google-ads/answer/16355235?hl=en to learn more. Example: +16504519489.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: email
  name: email
  description: Output only. Consumer email address.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: consumerName
  name: consumer name
  description: Output only. Consumer name if consumer provided name from Message or Booking form on google.com
  write lifecycle: Read only
  datatype: string
  max count: 1

ContentCriterionViewShape
type: NodeShape
target class: ContentCriterionView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the content criterion view. Content criterion view resource names have the form: `customers/{customer_id}/contentCriterionViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

ConversionActionShape
type: NodeShape
target class: ConversionAction
property:
  path: countingType
  name: counting type
  description: How to count conversion events for the conversion action.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ONE_PER_CLICK
  in: MANY_PER_CLICK
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the conversion action. Conversion action resource names have the form: `customers/{customer_id}/conversionActions/{conversion_action_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: valueSettings
  name: value settings
  description: Settings related to the value for conversion events associated with this conversion action.
  node: ConversionActionValueSettingsShape
  class: ConversionActionValueSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: appId
  name: app id
  description: App ID for an app conversion action.
  datatype: string
  max count: 1
property:
  path: firebaseSettings
  name: firebase settings
  description: Output only. Firebase settings for Firebase conversion types.
  write lifecycle: Read only
  node: ConversionActionFirebaseSettingsShape
  class: ConversionActionFirebaseSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: clickThroughLookbackWindowDays
  name: click through lookback window days
  description: The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.
  datatype: long
  max count: 1
property:
  path: googleAnalytics4Settings
  name: google analytics4settings
  description: Output only. Google Analytics 4 settings for Google Analytics 4 conversion types.
  write lifecycle: Read only
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mobileAppVendor
  name: mobile app vendor
  description: Output only. Mobile app vendor for an app conversion action.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPLE_APP_STORE
  in: GOOGLE_APP_STORE
property:
  path: primaryForGoal
  name: primary for goal
  description: If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.
  datatype: boolean
  max count: 1
property:
  path: category
  name: category
  description: The category of conversions reported for this conversion action.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DEFAULT
  in: PAGE_VIEW
  in: PURCHASE
  in: SIGNUP
  in: DOWNLOAD
  in: ADD_TO_CART
  in: BEGIN_CHECKOUT
  in: SUBSCRIBE_PAID
  in: PHONE_CALL_LEAD
  in: IMPORTED_LEAD
  in: SUBMIT_LEAD_FORM
  in: BOOK_APPOINTMENT
  in: REQUEST_QUOTE
  in: GET_DIRECTIONS
  in: OUTBOUND_CLICK
  in: CONTACT
  in: ENGAGEMENT
  in: STORE_VISIT
  in: STORE_SALE
  in: QUALIFIED_LEAD
  in: CONVERTED_LEAD
  in: YOUTUBE_FOLLOW_ON_VIEWS
property:
  path: type
  name: type
  description: Immutable. The type of this conversion action.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AD_CALL
  in: CLICK_TO_CALL
  in: GOOGLE_PLAY_DOWNLOAD
  in: GOOGLE_PLAY_IN_APP_PURCHASE
  in: UPLOAD_CALLS
  in: UPLOAD_CLICKS
  in: WEBPAGE
  in: WEBSITE_CALL
  in: STORE_SALES_DIRECT_UPLOAD
  in: STORE_SALES
  in: FIREBASE_ANDROID_FIRST_OPEN
  in: FIREBASE_ANDROID_IN_APP_PURCHASE
  in: FIREBASE_ANDROID_CUSTOM
  in: FIREBASE_IOS_FIRST_OPEN
  in: FIREBASE_IOS_IN_APP_PURCHASE
  in: FIREBASE_IOS_CUSTOM
  in: THIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPEN
  in: THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE
  in: THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM
  in: THIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPEN
  in: THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE
  in: THIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM
  in: ANDROID_APP_PRE_REGISTRATION
  in: ANDROID_INSTALLS_ALL_OTHER_APPS
  in: FLOODLIGHT_ACTION
  in: FLOODLIGHT_TRANSACTION
  in: GOOGLE_HOSTED
  in: LEAD_FORM_SUBMIT
  in: SALESFORCE
  in: SEARCH_ADS_360
  in: SMART_CAMPAIGN_AD_CLICKS_TO_CALL
  in: SMART_CAMPAIGN_MAP_CLICKS_TO_CALL
  in: SMART_CAMPAIGN_MAP_DIRECTIONS
  in: SMART_CAMPAIGN_TRACKED_CALLS
  in: STORE_VISITS
  in: WEBPAGE_CODELESS
  in: UNIVERSAL_ANALYTICS_GOAL
  in: UNIVERSAL_ANALYTICS_TRANSACTION
  in: GOOGLE_ANALYTICS_4_CUSTOM
  in: GOOGLE_ANALYTICS_4_PURCHASE
  in: GOOGLE_ANALYTICS_4_GENERATE_LEAD
  in: GOOGLE_ANALYTICS_4_QUALIFY_LEAD
  in: GOOGLE_ANALYTICS_4_CLOSE_CONVERT_LEAD
  in: FIREBASE_ANDROID_GENERATE_LEAD
  in: FIREBASE_ANDROID_QUALIFY_LEAD
  in: FIREBASE_ANDROID_CLOSE_CONVERT_LEAD
  in: FIREBASE_IOS_GENERATE_LEAD
  in: FIREBASE_IOS_QUALIFY_LEAD
  in: FIREBASE_IOS_CLOSE_CONVERT_LEAD
  in: LOCAL_SERVICES_ADS
property:
  path: includeInConversionsMetric
  name: include in conversions metric
  description: Whether this conversion action should be included in the "conversions" metric.
  datatype: boolean
  max count: 1
property:
  path: attributionModelSettings
  name: attribution model settings
  description: Settings related to this conversion action's attribution model.
  node: ConversionActionAttributionModelSettingsShape
  class: ConversionActionAttributionModelSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the conversion action.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: The status of this conversion action for conversion event accrual.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: HIDDEN
property:
  path: ownerCustomer
  name: owner customer
  description: Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
  write lifecycle: Read only
  datatype: string
  max count: 1

ConversionActionValueSettingsShape
type: NodeShape
target class: ConversionActionValueSettings
property:
  path: alwaysUseDefaultValue
  name: always use default value
  description: Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.
  datatype: boolean
  max count: 1
property:
  path: defaultValue
  name: default value
  description: The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.
  datatype: double
  max count: 1
property:
  path: defaultCurrencyCode
  name: default currency code
  description: The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.
  datatype: string
  max count: 1

ConversionActionFirebaseSettingsShape
type: NodeShape
target class: ConversionActionFirebaseSettings
property:
  path: eventName
  name: event name
  description: Output only. The event name of a Firebase conversion.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: projectId
  name: project id
  description: Output only. The Firebase project ID of the conversion.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: propertyId
  name: property id
  description: Output only. The GA property ID of the conversion.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: propertyName
  name: property name
  description: Output only. The GA property name of the conversion.
  write lifecycle: Read only
  datatype: string
  max count: 1

https://relay.inferal.com/ontology/googleads/ConversionActionGoogleAnalytics4SettingsShape
type: NodeShape
property:
  path: propertyId
  name: property id
  description: Output only. The ID of the GA 4 property.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: eventName
  name: event name
  description: Output only. The name of the GA 4 event.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: propertyName
  name: property name
  description: Output only. The name of the GA 4 property.
  write lifecycle: Read only
  datatype: string
  max count: 1

ConversionActionAttributionModelSettingsShape
type: NodeShape
target class: ConversionActionAttributionModelSettings
property:
  path: attributionModel
  name: attribution model
  description: The attribution model type of this conversion action.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXTERNAL
  in: GOOGLE_ADS_LAST_CLICK
  in: GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK
  in: GOOGLE_SEARCH_ATTRIBUTION_LINEAR
  in: GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY
  in: GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED
  in: GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN
property:
  path: dataDrivenModelStatus
  name: data driven model status
  description: Output only. The status of the data-driven attribution model for the conversion action.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AVAILABLE
  in: STALE
  in: EXPIRED
  in: NEVER_GENERATED

TagSnippetShape
type: NodeShape
target class: TagSnippet
property:
  path: globalSiteTag
  name: global site tag
  description: The site tag that adds visitors to your basic remarketing lists and sets new cookies on your domain.
  datatype: string
  max count: 1
property:
  path: eventSnippet
  name: event snippet
  description: The event snippet that works with the site tag to track actions that should be counted as conversions.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: The type of the generated tag snippets for tracking conversions.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBPAGE
  in: WEBPAGE_ONCLICK
  in: CLICK_TO_CALL
  in: WEBSITE_CALL
property:
  path: pageFormat
  name: page format
  description: The format of the web page where the tracking tag and snippet will be installed, for example, HTML.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HTML
  in: AMP

ConversionActionThirdPartyAppAnalyticsSettingsShape
type: NodeShape
target class: ConversionActionThirdPartyAppAnalyticsSettings
property:
  path: eventName
  name: event name
  description: Output only. The event name of a third-party app analytics conversion.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: providerName
  name: provider name
  description: Output only. Name of the third-party app analytics provider.
  write lifecycle: Read only
  datatype: string
  max count: 1

ConversionCustomVariableShape
type: NodeShape
target class: ConversionCustomVariable
property:
  path: tag
  name: tag
  description: Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet and sent to Google Ads along with conversion pings. For conversion uploads in Google Ads API, the resource name of the conversion custom variable is used. Tag should be unique. The maximum size of tag is 100 bytes. There should not be any extra spaces before and after. Currently only lowercase letters, numbers and underscores are allowed in the tag.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the conversion custom variable.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the conversion custom variable for conversion event accrual.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ACTIVATION_NEEDED
  in: ENABLED
  in: PAUSED
property:
  path: ownerCustomer
  name: owner customer
  description: Output only. The resource name of the customer that owns the conversion custom variable.
  write lifecycle: Read only
  datatype: string
  max count: 1

ConversionGoalCampaignConfigShape
type: NodeShape
target class: ConversionGoalCampaignConfig
property:
  path: goalConfigLevel
  name: goal config level
  description: The level of goal config the campaign is using.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER
  in: CAMPAIGN
property:
  path: campaign
  name: campaign
  description: Immutable. The campaign with which this conversion goal campaign config is associated.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the conversion goal campaign config. Conversion goal campaign config resource names have the form: `customers/{customer_id}/conversionGoalCampaignConfigs/{campaign_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: customConversionGoal
  name: custom conversion goal
  description: The custom conversion goal the campaign is using for optimization.
  datatype: string
  max count: 1

ConversionTrackingSettingShape
type: NodeShape
target class: ConversionTrackingSetting
property:
  path: conversionTrackingStatus
  name: conversion tracking status
  description: Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOT_CONVERSION_TRACKED
  in: CONVERSION_TRACKING_MANAGED_BY_SELF
  in: CONVERSION_TRACKING_MANAGED_BY_THIS_MANAGER
  in: CONVERSION_TRACKING_MANAGED_BY_ANOTHER_MANAGER
property:
  path: enhancedConversionsForLeadsEnabled
  name: enhanced conversions for leads enabled
  description: Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: googleAdsConversionCustomer
  name: google ads conversion customer
  description: The resource name of the customer where conversions are created and managed. This field is read-only.
  datatype: string
  max count: 1
property:
  path: conversionTrackingId
  name: conversion tracking id
  description: Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: crossAccountConversionTrackingId
  name: cross account conversion tracking id
  description: Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: acceptedCustomerDataTerms
  name: accepted customer data terms
  description: Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
  write lifecycle: Read only
  datatype: boolean
  max count: 1

ConversionValueRuleShape
type: NodeShape
target class: ConversionValueRule
property:
  path: audienceCondition
  name: audience condition
  description: Condition for audience that must be satisfied for the value rule to apply.
  node: ConversionValueRuleValueRuleAudienceConditionShape
  class: ConversionValueRuleValueRuleAudienceCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: itineraryCondition
  name: itinerary condition
  description: Condition for itinerary that must be satisfied for the value rule to apply.
  node: ConversionValueRuleValueRuleItineraryConditionShape
  class: ConversionValueRuleValueRuleItineraryCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: deviceCondition
  name: device condition
  description: Condition for device type that must be satisfied for the value rule to apply.
  node: ConversionValueRuleValueRuleDeviceConditionShape
  class: ConversionValueRuleValueRuleDeviceCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the conversion value rule. Conversion value rule resource names have the form: `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the conversion value rule.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: geoLocationCondition
  name: geo location condition
  description: Condition for Geo location that must be satisfied for the value rule to apply.
  node: ConversionValueRuleValueRuleGeoLocationConditionShape
  class: ConversionValueRuleValueRuleGeoLocationCondition
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: ownerCustomer
  name: owner customer
  description: Output only. The resource name of the conversion value rule's owner customer. When the value rule is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the conversion value rule.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: PAUSED
property:
  path: action
  name: action
  description: Action applied when the rule is triggered.
  node: ConversionValueRuleValueRuleActionShape
  class: ConversionValueRuleValueRuleAction
  node kind: BlankNodeOrIRI
  max count: 1

ConversionValueRuleValueRuleAudienceConditionShape
type: NodeShape
target class: ConversionValueRuleValueRuleAudienceCondition
property:
  path: userInterests
  name: user interests
  description: User Interests.
  datatype: string
property:
  path: userLists
  name: user lists
  description: User Lists.
  datatype: string

ConversionValueRuleValueRuleItineraryConditionShape
type: NodeShape
target class: ConversionValueRuleValueRuleItineraryCondition
property:
  path: advanceBookingWindow
  name: advance booking window
  description: Range for the number of days between the date of the booking and the start of the itinerary.
  node: ConversionValueRuleValueRuleItineraryAdvanceBookingWindowShape
  class: ConversionValueRuleValueRuleItineraryAdvanceBookingWindow
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: travelLength
  name: travel length
  description: Range for the itinerary length in number of nights.
  node: ConversionValueRuleValueRuleItineraryTravelLengthShape
  class: ConversionValueRuleValueRuleItineraryTravelLength
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: travelStartDay
  name: travel start day
  description: The days of the week on which this itinerary's travel can start.
  node: ConversionValueRuleValueRuleItineraryTravelStartDayShape
  class: ConversionValueRuleValueRuleItineraryTravelStartDay
  node kind: BlankNodeOrIRI
  max count: 1

ConversionValueRuleValueRuleItineraryAdvanceBookingWindowShape
type: NodeShape
target class: ConversionValueRuleValueRuleItineraryAdvanceBookingWindow
property:
  path: minDays
  name: min days
  description: Minimum number of days between the date of the booking the start date.
  datatype: int
  max count: 1
property:
  path: maxDays
  name: max days
  description: Maximum number of days between the date of the booking the start date.
  datatype: int
  max count: 1

ConversionValueRuleValueRuleItineraryTravelLengthShape
type: NodeShape
target class: ConversionValueRuleValueRuleItineraryTravelLength
property:
  path: minNights
  name: min nights
  description: Minimum number of nights between the start date and the end date.
  datatype: int
  max count: 1
property:
  path: maxNights
  name: max nights
  description: Maximum number of days between the start date and the end date.
  datatype: int
  max count: 1

ConversionValueRuleValueRuleItineraryTravelStartDayShape
type: NodeShape
target class: ConversionValueRuleValueRuleItineraryTravelStartDay
property:
  path: thursday
  name: thursday
  description: The travel can start on Thursday.
  datatype: boolean
  max count: 1
property:
  path: monday
  name: monday
  description: The travel can start on Monday.
  datatype: boolean
  max count: 1
property:
  path: tuesday
  name: tuesday
  description: The travel can start on Tuesday.
  datatype: boolean
  max count: 1
property:
  path: saturday
  name: saturday
  description: The travel can start on Saturday.
  datatype: boolean
  max count: 1
property:
  path: friday
  name: friday
  description: The travel can start on Friday.
  datatype: boolean
  max count: 1
property:
  path: sunday
  name: sunday
  description: The travel can start on Sunday.
  datatype: boolean
  max count: 1
property:
  path: wednesday
  name: wednesday
  description: The travel can start on Wednesday.
  datatype: boolean
  max count: 1

ConversionValueRuleValueRuleDeviceConditionShape
type: NodeShape
target class: ConversionValueRuleValueRuleDeviceCondition
property:
  path: deviceTypes
  name: device types
  description: Value for device type condition.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: MOBILE
  in: DESKTOP
  in: TABLET

ConversionValueRuleValueRuleGeoLocationConditionShape
type: NodeShape
target class: ConversionValueRuleValueRuleGeoLocationCondition
property:
  path: geoMatchType
  name: geo match type
  description: Included Geo location match type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ANY
  in: LOCATION_OF_PRESENCE
property:
  path: excludedGeoMatchType
  name: excluded geo match type
  description: Excluded Geo location match type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ANY
  in: LOCATION_OF_PRESENCE
property:
  path: excludedGeoTargetConstants
  name: excluded geo target constants
  description: Geo locations that advertisers want to exclude.
  datatype: string
property:
  path: geoTargetConstants
  name: geo target constants
  description: Geo locations that advertisers want to include.
  datatype: string

ConversionValueRuleValueRuleActionShape
type: NodeShape
target class: ConversionValueRuleValueRuleAction
property:
  path: operation
  name: operation
  description: Specifies applied operation.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADD
  in: MULTIPLY
  in: SET
property:
  path: value
  name: value
  description: Specifies applied value.
  datatype: double
  max count: 1

ConversionValueRuleSetShape
type: NodeShape
target class: ConversionValueRuleSet
property:
  path: attachmentType
  name: attachment type
  description: Immutable. Defines the scope where the conversion value rule set is attached.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER
  in: CAMPAIGN
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form: `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the conversion value rule set.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: dimensions
  name: dimensions
  description: Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: GEO_LOCATION
  in: DEVICE
  in: AUDIENCE
  in: NO_CONDITION
  in: ITINERARY
property:
  path: ownerCustomer
  name: owner customer
  description: Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the conversion value rule set. ** Read-only **
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: PAUSED
property:
  path: conversionActionCategories
  name: conversion action categories
  description: Immutable. The conversion action categories of the conversion value rule set.
  write lifecycle: Create only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: DEFAULT
  in: PAGE_VIEW
  in: PURCHASE
  in: SIGNUP
  in: DOWNLOAD
  in: ADD_TO_CART
  in: BEGIN_CHECKOUT
  in: SUBSCRIBE_PAID
  in: PHONE_CALL_LEAD
  in: IMPORTED_LEAD
  in: SUBMIT_LEAD_FORM
  in: BOOK_APPOINTMENT
  in: REQUEST_QUOTE
  in: GET_DIRECTIONS
  in: OUTBOUND_CLICK
  in: CONTACT
  in: ENGAGEMENT
  in: STORE_VISIT
  in: STORE_SALE
  in: QUALIFIED_LEAD
  in: CONVERTED_LEAD
  in: YOUTUBE_FOLLOW_ON_VIEWS
property:
  path: campaign
  name: campaign
  description: The resource name of the campaign when the conversion value rule set is attached to a campaign.
  datatype: string
  max count: 1
property:
  path: conversionValueRules
  name: conversion value rules
  description: Resource names of rules within the rule set.
  datatype: string

CreditDetailsShape
type: NodeShape
target class: CreditDetails
property:
  path: creditState
  name: credit state
  description: Output only. Credit state of the lead.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: CREDITED
property:
  path: creditStateLastUpdateDateTime
  name: credit state last update date time
  description: 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"
  write lifecycle: Read only
  datatype: string
  max count: 1

CriterionCategoryAvailabilityShape
type: NodeShape
target class: CriterionCategoryAvailability
property:
  path: locale
  name: locale
  description: Locales that are available to the category for the channel.
  node: CriterionCategoryLocaleAvailabilityShape
  class: CriterionCategoryLocaleAvailability
  node kind: BlankNodeOrIRI
property:
  path: channel
  name: channel
  description: Channel types and subtypes that are available to the category.
  node: CriterionCategoryChannelAvailabilityShape
  class: CriterionCategoryChannelAvailability
  node kind: BlankNodeOrIRI
  max count: 1

CriterionCategoryLocaleAvailabilityShape
type: NodeShape
target class: CriterionCategoryLocaleAvailability
property:
  path: languageCode
  name: language code
  description: ISO 639-1 code of the language associated with the category.
  datatype: string
  max count: 1
property:
  path: availabilityMode
  name: availability mode
  description: 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).
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ALL_LOCALES
  in: COUNTRY_AND_ALL_LANGUAGES
  in: LANGUAGE_AND_ALL_COUNTRIES
  in: COUNTRY_AND_LANGUAGE
property:
  path: countryCode
  name: country code
  description: The ISO-3166-1 alpha-2 country code associated with the category.
  datatype: string
  max count: 1

CriterionCategoryChannelAvailabilityShape
type: NodeShape
target class: CriterionCategoryChannelAvailability
property:
  path: availabilityMode
  name: availability mode
  description: Format of the channel availability. Can be ALL_CHANNELS (the rest of the fields will not be set), CHANNEL_TYPE (only advertising_channel_type type will be set, the category is available to all sub types under it) or CHANNEL_TYPE_AND_SUBTYPES (advertising_channel_type, advertising_channel_sub_type, and include_default_channel_sub_type will all be set).
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ALL_CHANNELS
  in: CHANNEL_TYPE_AND_ALL_SUBTYPES
  in: CHANNEL_TYPE_AND_SUBSET_SUBTYPES
property:
  path: advertisingChannelType
  name: advertising channel type
  description: Channel type the category is available to.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH
  in: DISPLAY
  in: SHOPPING
  in: HOTEL
  in: VIDEO
  in: MULTI_CHANNEL
  in: LOCAL
  in: SMART
  in: PERFORMANCE_MAX
  in: LOCAL_SERVICES
  in: TRAVEL
  in: DEMAND_GEN
property:
  path: advertisingChannelSubType
  name: advertising channel sub type
  description: Channel subtypes under the channel type the category is available to.
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: SEARCH_MOBILE_APP
  in: DISPLAY_MOBILE_APP
  in: SEARCH_EXPRESS
  in: DISPLAY_EXPRESS
  in: SHOPPING_SMART_ADS
  in: DISPLAY_GMAIL_AD
  in: DISPLAY_SMART_CAMPAIGN
  in: VIDEO_ACTION
  in: VIDEO_NON_SKIPPABLE
  in: APP_CAMPAIGN
  in: APP_CAMPAIGN_FOR_ENGAGEMENT
  in: LOCAL_CAMPAIGN
  in: SHOPPING_COMPARISON_LISTING_ADS
  in: SMART_CAMPAIGN
  in: VIDEO_SEQUENCE
  in: APP_CAMPAIGN_FOR_PRE_REGISTRATION
  in: VIDEO_REACH_TARGET_FREQUENCY
  in: TRAVEL_ACTIVITIES
  in: YOUTUBE_AUDIO
property:
  path: includeDefaultChannelSubType
  name: include default channel sub type
  description: Whether default channel sub type is included. For example, advertising_channel_type being DISPLAY and include_default_channel_sub_type being false means that the default display campaign where channel sub type is not set is not included in this availability configuration.
  datatype: boolean
  max count: 1

CrmBasedUserListInfoShape
type: NodeShape
target class: CrmBasedUserListInfo
property:
  path: appId
  name: app id
  description: A string that uniquely identifies a mobile application from which the data was collected. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.
  datatype: string
  max count: 1
property:
  path: uploadKeyType
  name: upload key type
  description: Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CONTACT_INFO
  in: CRM_ID
  in: MOBILE_ADVERTISING_ID
property:
  path: dataSourceType
  name: data source type
  description: Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: FIRST_PARTY
  in: THIRD_PARTY_CREDIT_BUREAU
  in: THIRD_PARTY_VOTER_FILE
  in: THIRD_PARTY_PARTNER_DATA

CurrencyConstantShape
type: NodeShape
target class: CurrencyConstant
property:
  path: code
  name: code
  description: Output only. ISO 4217 three-letter currency code, for example, "USD"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Output only. Full English name of the currency.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: symbol
  name: symbol
  description: Output only. Standard symbol for describing this currency, for example, '$' for US Dollars.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: billableUnitMicros
  name: billable unit micros
  description: Output only. The billable unit for this currency. Billed amounts should be multiples of this value.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the currency constant. Currency constant resource names have the form: `currencyConstants/{code}`
  write lifecycle: Read only
  datatype: string
  max count: 1

CustomAudienceShape
type: NodeShape
target class: CustomAudience
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the custom audience. Custom audience resource names have the form: `customers/{customer_id}/customAudiences/{custom_audience_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Description of this custom audience.
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Type of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences)
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AUTO
  in: INTEREST
  in: PURCHASE_INTENT
  in: SEARCH
property:
  path: id
  name: id
  description: Output only. ID of the custom audience.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: name
  name: name
  description: Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.
  datatype: string
  max count: 1
property:
  path: members
  name: members
  description: List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
  node: CustomAudienceMemberShape
  class: CustomAudienceMember
  node kind: BlankNodeOrIRI

CustomAudienceMemberShape
type: NodeShape
target class: CustomAudienceMember
property:
  path: url
  name: url
  description: An HTTP URL, protocol-included — at most 2048 characters, which includes contents users have interests in.
  datatype: string
  max count: 1
property:
  path: memberType
  name: member type
  description: The type of custom audience member, KEYWORD, URL, PLACE_CATEGORY or APP.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: KEYWORD
  in: URL
  in: PLACE_CATEGORY
  in: APP
property:
  path: keyword
  name: keyword
  description: A keyword or keyword phrase — at most 10 words and 80 characters. Languages with double-width characters such as Chinese, Japanese, or Korean, are allowed 40 characters, which describes the user's interests or actions.
  datatype: string
  max count: 1
property:
  path: app
  name: app
  description: A package name of Android apps which users installed such as com.google.example.
  datatype: string
  max count: 1
property:
  path: placeCategory
  name: place category
  description: A place type described by a place category users visit.
  datatype: long
  max count: 1

CustomConversionGoalShape
type: NodeShape
target class: CustomConversionGoal
property:
  path: conversionActions
  name: conversion actions
  description: Conversion actions that the custom conversion goal makes biddable.
  datatype: string
property:
  path: id
  name: id
  description: Immutable. The ID for this custom conversion goal.
  write lifecycle: Create only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name for this custom conversion goal.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: The status of the custom conversion goal.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1

CustomerShape
type: NodeShape
target class: Customer
property:
  path: hasPartnersBadge
  name: has partners badge
  description: Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: videoBrandSafetySuitability
  name: video brand safety suitability
  description: Brand Safety setting at the account level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXPANDED_INVENTORY
  in: STANDARD_INVENTORY
  in: LIMITED_INVENTORY
property:
  path: id
  name: id
  description: Output only. The ID of the customer.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: manager
  name: manager
  description: Output only. Whether the customer is a manager.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: payPerConversionEligibilityFailureReasons
  name: pay per conversion eligibility failure reasons
  description: Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
  write lifecycle: Read only
  datatype: string
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOT_ENOUGH_CONVERSIONS
  in: CONVERSION_LAG_TOO_HIGH
  in: HAS_CAMPAIGN_WITH_SHARED_BUDGET
  in: HAS_UPLOAD_CLICKS_CONVERSION
  in: AVERAGE_DAILY_SPEND_TOO_HIGH
  in: ANALYSIS_NOT_COMPLETE
  in: OTHER
property:
  path: locationAssetAutoMigrationDone
  name: location asset auto migration done
  description: Output only. True if feed based location has been migrated to asset based location.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: customerAgreementSetting
  name: customer agreement setting
  description: Output only. Customer Agreement Setting for a customer.
  write lifecycle: Read only
  node: CustomerAgreementSettingShape
  class: CustomerAgreementSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: conversionTrackingSetting
  name: conversion tracking setting
  description: Conversion tracking setting for a customer.
  node: ConversionTrackingSettingShape
  class: ConversionTrackingSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: optimizationScore
  name: optimization score
  description: Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: autoTaggingEnabled
  name: auto tagging enabled
  description: Whether auto-tagging is enabled for the customer. Only mutable in an `update` operation.
  datatype: boolean
  max count: 1
property:
  path: imageAssetAutoMigrationDone
  name: image asset auto migration done
  description: Output only. True if feed based image has been migrated to asset based image.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: timeZone
  name: time zone
  description: Immutable. The local timezone ID of the customer.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: localServicesSettings
  name: local services settings
  description: Output only. Settings for Local Services customer.
  write lifecycle: Read only
  node: LocalServicesSettingsShape
  class: LocalServicesSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the customer.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: CANCELED
  in: SUSPENDED
  in: CLOSED
property:
  path: containsEuPoliticalAdvertising
  name: contains eu political advertising
  description: Output only. Returns the advertiser self-declaration status of whether this customer contains political advertising content targeted towards the European Union. You can use the Google Ads UI to update this account-level declaration, or use the API to update the self-declaration status of individual campaigns.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CONTAINS_EU_POLITICAL_ADVERTISING
  in: DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING
property:
  path: testAccount
  name: test account
  description: Output only. Whether the customer is a test account.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: descriptiveName
  name: descriptive name
  description: Optional, non-unique descriptive name of the customer.
  datatype: string
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: callReportingSetting
  name: call reporting setting
  description: Call reporting setting for a customer. Only mutable in an `update` operation.
  node: CallReportingSettingShape
  class: CallReportingSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: optimizationScoreWeight
  name: optimization score weight
  description: Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of `Customer.optimization_score * Customer.optimization_score_weight`. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: videoCustomer
  name: video customer
  description: Video specific information about a Customer.
  node: VideoCustomerShape
  class: VideoCustomer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: imageAssetAutoMigrationDoneDateTime
  name: image asset auto migration done date time
  description: Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH:mm:ss format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: finalUrlSuffix
  name: final url suffix
  description: The URL template for appending params to the final URL. Only mutable in an `update` operation.
  datatype: string
  max count: 1
property:
  path: remarketingSetting
  name: remarketing setting
  description: Output only. Remarketing setting for a customer.
  write lifecycle: Read only
  node: RemarketingSettingShape
  class: RemarketingSetting
  node kind: BlankNodeOrIRI
  max count: 1

CustomerAgreementSettingShape
type: NodeShape
target class: CustomerAgreementSetting
property:
  path: acceptedLeadFormTerms
  name: accepted lead form terms
  description: Output only. Whether the customer has accepted lead form term of service.
  write lifecycle: Read only
  datatype: boolean
  max count: 1

LocalServicesSettingsShape
type: NodeShape
target class: LocalServicesSettings
property:
  path: granularLicenseStatuses
  name: granular license statuses
  description: Output only. A read-only list of geo vertical level license statuses.
  write lifecycle: Read only
  node: GranularLicenseStatusShape
  class: GranularLicenseStatus
  node kind: BlankNodeOrIRI
property:
  path: granularInsuranceStatuses
  name: granular insurance statuses
  description: Output only. A read-only list of geo vertical level insurance statuses.
  write lifecycle: Read only
  node: GranularInsuranceStatusShape
  class: GranularInsuranceStatus
  node kind: BlankNodeOrIRI

GranularLicenseStatusShape
type: NodeShape
target class: GranularLicenseStatus
property:
  path: verificationStatus
  name: verification status
  description: Output only. Granular license status, per geo + vertical.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEEDS_REVIEW
  in: FAILED
  in: PASSED
  in: NOT_APPLICABLE
  in: NO_SUBMISSION
  in: PARTIAL_SUBMISSION
  in: PENDING_ESCALATION
property:
  path: categoryId
  name: category id
  description: Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: geoCriterionId
  name: geo criterion id
  description: Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
  write lifecycle: Read only
  datatype: long
  max count: 1

GranularInsuranceStatusShape
type: NodeShape
target class: GranularInsuranceStatus
property:
  path: verificationStatus
  name: verification status
  description: Output only. Granular insurance status, per geo + vertical.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEEDS_REVIEW
  in: FAILED
  in: PASSED
  in: NOT_APPLICABLE
  in: NO_SUBMISSION
  in: PARTIAL_SUBMISSION
  in: PENDING_ESCALATION
property:
  path: categoryId
  name: category id
  description: Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: geoCriterionId
  name: geo criterion id
  description: Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
  write lifecycle: Read only
  datatype: long
  max count: 1

VideoCustomerShape
type: NodeShape
target class: VideoCustomer
property:
  path: thirdPartyIntegrationPartners
  name: third party integration partners
  description: Third Party integration partners.
  node: CustomerThirdPartyIntegrationPartnersShape
  class: CustomerThirdPartyIntegrationPartners
  node kind: BlankNodeOrIRI
  max count: 1

CustomerThirdPartyIntegrationPartnersShape
type: NodeShape
target class: CustomerThirdPartyIntegrationPartners
property:
  path: brandSafetyIntegrationPartners
  name: brand safety integration partners
  description: Allowed third party integration partners for brand safety verification.
  node: CustomerThirdPartyBrandSafetyIntegrationPartnerShape
  class: CustomerThirdPartyBrandSafetyIntegrationPartner
  node kind: BlankNodeOrIRI
property:
  path: brandLiftIntegrationPartners
  name: brand lift integration partners
  description: Allowed third party integration partners for Brand Lift verification.
  node: CustomerThirdPartyBrandLiftIntegrationPartnerShape
  class: CustomerThirdPartyBrandLiftIntegrationPartner
  node kind: BlankNodeOrIRI
property:
  path: reachIntegrationPartners
  name: reach integration partners
  description: Allowed third party integration partners for reach verification.
  node: CustomerThirdPartyReachIntegrationPartnerShape
  class: CustomerThirdPartyReachIntegrationPartner
  node kind: BlankNodeOrIRI
property:
  path: viewabilityIntegrationPartners
  name: viewability integration partners
  description: Allowed third party integration partners for YouTube viewability verification.
  node: CustomerThirdPartyViewabilityIntegrationPartnerShape
  class: CustomerThirdPartyViewabilityIntegrationPartner
  node kind: BlankNodeOrIRI

CustomerThirdPartyBrandSafetyIntegrationPartnerShape
type: NodeShape
target class: CustomerThirdPartyBrandSafetyIntegrationPartner
property:
  path: brandSafetyIntegrationPartner
  name: brand safety integration partner
  description: Allowed third party integration partners for brand safety verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DOUBLE_VERIFY
  in: INTEGRAL_AD_SCIENCE
  in: ZEFR

CustomerThirdPartyBrandLiftIntegrationPartnerShape
type: NodeShape
target class: CustomerThirdPartyBrandLiftIntegrationPartner
property:
  path: brandLiftIntegrationPartner
  name: brand lift integration partner
  description: Allowed Third Party integration partners for Brand Lift verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: KANTAR_MILLWARD_BROWN
  in: DYNATA
  in: INTAGE
  in: MACROMILL
property:
  path: allowShareCost
  name: allow share cost
  description: If true, cost data can be shared with this vendor.
  datatype: boolean
  max count: 1

CustomerThirdPartyReachIntegrationPartnerShape
type: NodeShape
target class: CustomerThirdPartyReachIntegrationPartner
property:
  path: reachIntegrationPartner
  name: reach integration partner
  description: Allowed Third Party integration partners for reach verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NIELSEN
  in: COMSCORE
  in: KANTAR_MILLWARD_BROWN
  in: VIDEO_RESEARCH
  in: GEMIUS
  in: MEDIA_SCOPE
  in: AUDIENCE_PROJECT
  in: VIDEO_AMP
  in: ISPOT_TV
property:
  path: allowShareCost
  name: allow share cost
  description: If true, cost data can be shared with this vendor.
  datatype: boolean
  max count: 1

CustomerThirdPartyViewabilityIntegrationPartnerShape
type: NodeShape
target class: CustomerThirdPartyViewabilityIntegrationPartner
property:
  path: viewabilityIntegrationPartner
  name: viewability integration partner
  description: Allowed third party integration partners for YouTube viewability verification.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DOUBLE_VERIFY
  in: INTEGRAL_AD_SCIENCE
  in: ZEFR
property:
  path: allowShareCost
  name: allow share cost
  description: If true, cost data can be shared with this vendor.
  datatype: boolean
  max count: 1

RemarketingSettingShape
type: NodeShape
target class: RemarketingSetting
property:
  path: googleGlobalSiteTag
  name: google global site tag
  description: Output only. The Google tag.
  write lifecycle: Read only
  datatype: string
  max count: 1

CustomerAssetSetShape
type: NodeShape
target class: CustomerAssetSet
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer asset set. Asset set asset resource names have the form: `customers/{customer_id}/customerAssetSets/{asset_set_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: assetSet
  name: asset set
  description: Immutable. The asset set which is linked to the customer.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: customer
  name: customer
  description: Immutable. The customer to which this asset set is linked.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the customer asset set asset. Read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED

CustomerClientShape
type: NodeShape
target class: CustomerClient
property:
  path: appliedLabels
  name: applied labels
  description: Output only. The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
  write lifecycle: Read only
  datatype: string
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the customer client. CustomerClient resource names have the form: `customers/{customer_id}/customerClients/{client_customer_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: clientCustomer
  name: client customer
  description: Output only. The resource name of the client-customer which is linked to the given customer. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: hidden
  name: hidden
  description: Output only. Specifies whether this is a [hidden account](https://support.google.com/google-ads/answer/7519830). Read only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: manager
  name: manager
  description: Output only. Identifies if the client is a manager. Read only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the client customer. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the client customer. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: CANCELED
  in: SUSPENDED
  in: CLOSED
property:
  path: timeZone
  name: time zone
  description: Output only. Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: descriptiveName
  name: descriptive name
  description: Output only. Descriptive name for the client. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: level
  name: level
  description: Output only. Distance between given customer and client. For self link, the level value will be 0. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: testAccount
  name: test account
  description: Output only. Identifies if the client is a test account. Read only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1

CustomerClientLinkShape
type: NodeShape
target class: CustomerClientLink
property:
  path: resourceName
  name: resource name
  description: Immutable. Name of the resource. CustomerClientLink resource names have the form: `customers/{customer_id}/customerClientLinks/{client_customer_id}~{manager_link_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: clientCustomer
  name: client customer
  description: Immutable. The client customer linked to this customer.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: hidden
  name: hidden
  description: The visibility of the link. Users can choose whether or not to see hidden links in the Google Ads UI. Default value is false
  datatype: boolean
  max count: 1
property:
  path: status
  name: status
  description: This is the status of the link between client and manager.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ACTIVE
  in: INACTIVE
  in: PENDING
  in: REFUSED
  in: CANCELED
property:
  path: managerLinkId
  name: manager link id
  description: Output only. This is uniquely identifies a customer client link. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1

CustomerConversionGoalShape
type: NodeShape
target class: CustomerConversionGoal
property:
  path: biddable
  name: biddable
  description: The biddability of the customer conversion goal.
  datatype: boolean
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer conversion goal. Customer conversion goal resource names have the form: `customers/{customer_id}/customerConversionGoals/{category}~{origin}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: category
  name: category
  description: The conversion category of this customer conversion goal. Only conversion actions that have this category will be included in this goal.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DEFAULT
  in: PAGE_VIEW
  in: PURCHASE
  in: SIGNUP
  in: DOWNLOAD
  in: ADD_TO_CART
  in: BEGIN_CHECKOUT
  in: SUBSCRIBE_PAID
  in: PHONE_CALL_LEAD
  in: IMPORTED_LEAD
  in: SUBMIT_LEAD_FORM
  in: BOOK_APPOINTMENT
  in: REQUEST_QUOTE
  in: GET_DIRECTIONS
  in: OUTBOUND_CLICK
  in: CONTACT
  in: ENGAGEMENT
  in: STORE_VISIT
  in: STORE_SALE
  in: QUALIFIED_LEAD
  in: CONVERTED_LEAD
  in: YOUTUBE_FOLLOW_ON_VIEWS
property:
  path: origin
  name: origin
  description: The conversion origin of this customer conversion goal. Only conversion actions that have this conversion origin will be included in this goal.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBSITE
  in: GOOGLE_HOSTED
  in: APP
  in: CALL_FROM_ADS
  in: STORE
  in: YOUTUBE_HOSTED
  in: LOCAL_SERVICES_ADS

CustomerCustomizerShape
type: NodeShape
target class: CustomerCustomizer
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer customizer. Customer customizer resource names have the form: `customers/{customer_id}/customerCustomizers/{customizer_attribute_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the customer customizer attribute.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: value
  name: value
  description: Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
  node: CustomizerValueShape
  class: CustomizerValue
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customizerAttribute
  name: customizer attribute
  description: Required. Immutable. The customizer attribute which is linked to the customer.
  write lifecycle: Create only
  datatype: string
  max count: 1

CustomerLabelShape
type: NodeShape
target class: CustomerLabel
property:
  path: resourceName
  name: resource name
  description: Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: customer
  name: customer
  description: Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: label
  name: label
  description: Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`.
  write lifecycle: Read only
  datatype: string
  max count: 1

CustomerLifecycleGoalShape
type: NodeShape
target class: CustomerLifecycleGoal
property:
  path: customerAcquisitionGoalValueSettings
  name: customer acquisition goal value settings
  description: Output only. Customer acquisition goal customer level value settings.
  write lifecycle: Read only
  node: LifecycleGoalValueSettingsShape
  class: LifecycleGoalValueSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer lifecycle goal. Customer lifecycle resource names have the form: `customers/{customer_id}/customerLifecycleGoal`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: ownerCustomer
  name: owner customer
  description: Output only. The resource name of the customer which owns the lifecycle goal.
  write lifecycle: Read only
  datatype: string
  max count: 1

CustomerManagerLinkShape
type: NodeShape
target class: CustomerManagerLink
property:
  path: managerCustomer
  name: manager customer
  description: Output only. The manager customer linked to the customer.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: managerLinkId
  name: manager link id
  description: Output only. ID of the customer-manager link. This field is read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Status of the link between the customer and the manager.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ACTIVE
  in: INACTIVE
  in: PENDING
  in: REFUSED
  in: CANCELED

CustomerMatchUserListMetadataShape
type: NodeShape
target class: CustomerMatchUserListMetadata
property:
  path: consent
  name: consent
  description: The consent setting for all the users in this job.
  node: ConsentShape
  class: Consent
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: userList
  name: user list
  description: The resource name of remarketing list to update data. Required for job of CUSTOMER_MATCH_USER_LIST type.
  datatype: string
  max count: 1

CustomerNegativeCriterionShape
type: NodeShape
target class: CustomerNegativeCriterion
property:
  path: negativeKeywordList
  name: negative keyword list
  description: Immutable. NegativeKeywordList.
  write lifecycle: Create only
  node: NegativeKeywordListInfoShape
  class: NegativeKeywordListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: placement
  name: placement
  description: Immutable. Placement.
  write lifecycle: Create only
  node: PlacementInfoShape
  class: PlacementInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeVideo
  name: youtube video
  description: Immutable. YouTube Video.
  write lifecycle: Create only
  node: YouTubeVideoInfoShape
  class: YouTubeVideoInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customer negative criterion. Customer negative criterion resource names have the form: `customers/{customer_id}/customerNegativeCriteria/{criterion_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: contentLabel
  name: content label
  description: Immutable. ContentLabel.
  write lifecycle: Create only
  node: ContentLabelInfoShape
  class: ContentLabelInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the criterion.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: KEYWORD
  in: PLACEMENT
  in: MOBILE_APP_CATEGORY
  in: MOBILE_APPLICATION
  in: DEVICE
  in: LOCATION
  in: LISTING_GROUP
  in: AD_SCHEDULE
  in: AGE_RANGE
  in: GENDER
  in: INCOME_RANGE
  in: PARENTAL_STATUS
  in: YOUTUBE_VIDEO
  in: YOUTUBE_CHANNEL
  in: USER_LIST
  in: PROXIMITY
  in: TOPIC
  in: LISTING_SCOPE
  in: LANGUAGE
  in: IP_BLOCK
  in: CONTENT_LABEL
  in: CARRIER
  in: USER_INTEREST
  in: WEBPAGE
  in: OPERATING_SYSTEM_VERSION
  in: APP_PAYMENT_MODEL
  in: MOBILE_DEVICE
  in: CUSTOM_AFFINITY
  in: CUSTOM_INTENT
  in: LOCATION_GROUP
  in: CUSTOM_AUDIENCE
  in: COMBINED_AUDIENCE
  in: KEYWORD_THEME
  in: AUDIENCE
  in: NEGATIVE_KEYWORD_LIST
  in: LOCAL_SERVICE_ID
  in: SEARCH_THEME
  in: BRAND
  in: BRAND_LIST
  in: LIFE_EVENT
  in: WEBPAGE_LIST
  in: VIDEO_LINEUP
  in: PLACEMENT_LIST
  in: VERTICAL_ADS_ITEM_GROUP_RULE_LIST
  in: VERTICAL_ADS_ITEM_GROUP_RULE
  in: RETAIL_FILTER_BUNDLE
  in: RETAIL_FILTER
property:
  path: ipBlock
  name: ip block
  description: Immutable. IpBlock. You can exclude up to 500 IP addresses per account.
  write lifecycle: Create only
  node: IpBlockInfoShape
  class: IpBlockInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: placementList
  name: placement list
  description: Immutable. PlacementList.
  write lifecycle: Create only
  node: PlacementListInfoShape
  class: PlacementListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the criterion.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: mobileApplication
  name: mobile application
  description: Immutable. MobileApplication.
  write lifecycle: Create only
  node: MobileApplicationInfoShape
  class: MobileApplicationInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mobileAppCategory
  name: mobile app category
  description: Immutable. MobileAppCategory.
  write lifecycle: Create only
  node: MobileAppCategoryInfoShape
  class: MobileAppCategoryInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeChannel
  name: youtube channel
  description: Immutable. YouTube Channel.
  write lifecycle: Create only
  node: YouTubeChannelInfoShape
  class: YouTubeChannelInfo
  node kind: BlankNodeOrIRI
  max count: 1

NegativeKeywordListInfoShape
type: NodeShape
target class: NegativeKeywordListInfo
property:
  path: sharedSet
  name: shared set
  description: The NegativeKeywordListInfo shared set resource name.
  datatype: string
  max count: 1

PlacementListInfoShape
type: NodeShape
target class: PlacementListInfo
property:
  path: sharedSet
  name: shared set
  description: The PlacementListInfo shared set resource name.
  datatype: string
  max count: 1

CustomerSearchTermInsightShape
type: NodeShape
target class: CustomerSearchTermInsight
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the customer level search term insight. Customer level search term insight resource names have the form: `customers/{customer_id}/customerSearchTermInsights/{category_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: categoryLabel
  name: category label
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the insight.
  write lifecycle: Read only
  datatype: long
  max count: 1

CustomerUserAccessShape
type: NodeShape
target class: CustomerUserAccess
property:
  path: emailAddress
  name: email address
  description: Output only. Email address of the user. Read only field
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: pendingMultiPartyAuthReview
  name: pending multi party auth review
  description: Output only. The resource name of the pending Multi-Party Authorization review. Read only field
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: accessRole
  name: access role
  description: Access role of the user.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADMIN
  in: STANDARD
  in: READ_ONLY
  in: EMAIL_ONLY
property:
  path: accessCreationDateTime
  name: access creation date time
  description: Output only. The customer user access creation time. Read only field The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: userId
  name: user id
  description: Output only. User id of the user with the customer access. Read only field
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccesses/{user_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: inviterUserEmailAddress
  name: inviter user email address
  description: Output only. The email address of the inviter user. Read only field
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: passkeyEnabled
  name: passkey enabled
  description: Output only. Whether the user has passkey enabled. Read only field
  write lifecycle: Read only
  datatype: boolean
  max count: 1

CustomerUserAccessInvitationShape
type: NodeShape
target class: CustomerUserAccessInvitation
property:
  path: invitationId
  name: invitation id
  description: Output only. The ID of the invitation. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: creationDateTime
  name: creation date time
  description: Output only. Time invitation was created. This field is read-only. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: emailAddress
  name: email address
  description: Immutable. Email address the invitation was sent to. This can differ from the email address of the account that accepts the invite.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: accessRole
  name: access role
  description: Immutable. Access role of the user.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADMIN
  in: STANDARD
  in: READ_ONLY
  in: EMAIL_ONLY
property:
  path: invitationStatus
  name: invitation status
  description: Output only. Invitation status of the user.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: DECLINED
  in: EXPIRED

CustomerUserAccessInvitationReviewShape
type: NodeShape
target class: CustomerUserAccessInvitationReview
property:
  path: newCustomerUserAccessInvitation
  name: new customer user access invitation
  description: Output only. The new CustomerUserAccessInvitation details. Only fields that need to be reviewed are populated.
  write lifecycle: Read only
  node: CustomerUserAccessInvitationShape
  class: CustomerUserAccessInvitation
  node kind: BlankNodeOrIRI
  max count: 1

CustomerUserAccessReviewShape
type: NodeShape
target class: CustomerUserAccessReview
property:
  path: oldCustomerUserAccess
  name: old customer user access
  description: Output only. The resource name of the CustomerUserAccess being changed.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: newCustomerUserAccess
  name: new customer user access
  description: Output only. The new CustomerUserAccess details. Only fields that need to be reviewed are populated.
  write lifecycle: Read only
  node: CustomerUserAccessShape
  class: CustomerUserAccess
  node kind: BlankNodeOrIRI
  max count: 1

CustomInterestShape
type: NodeShape
target class: CustomInterest
property:
  path: id
  name: id
  description: Output only. Id of the custom interest.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Status of this custom interest. Indicates whether the custom interest is enabled or removed.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: name
  name: name
  description: Name of the custom interest. It should be unique across the same custom affinity audience. This field is required for create operations.
  datatype: string
  max count: 1
property:
  path: members
  name: members
  description: List of custom interest members that this custom interest is composed of. Members can be added during CustomInterest creation. If members are presented in UPDATE operation, existing members will be overridden.
  node: CustomInterestMemberShape
  class: CustomInterestMember
  node kind: BlankNodeOrIRI
property:
  path: type
  name: type
  description: Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT. By default the type is set to CUSTOM_AFFINITY.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOM_AFFINITY
  in: CUSTOM_INTENT
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the custom interest. Custom interest resource names have the form: `customers/{customer_id}/customInterests/{custom_interest_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Description of this custom interest audience.
  datatype: string
  max count: 1

CustomInterestMemberShape
type: NodeShape
target class: CustomInterestMember
property:
  path: parameter
  name: parameter
  description: Keyword text when member_type is KEYWORD or URL string when member_type is URL.
  datatype: string
  max count: 1
property:
  path: memberType
  name: member type
  description: The type of custom interest member, KEYWORD or URL.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: KEYWORD
  in: URL

CustomizerAttributeShape
type: NodeShape
target class: CustomizerAttribute
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the customizer attribute. Customizer Attribute resource names have the form: `customers/{customer_id}/customizerAttributes/{customizer_attribute_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Immutable. The type of the customizer attribute.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TEXT
  in: NUMBER
  in: PRICE
  in: PERCENT
property:
  path: id
  name: id
  description: Output only. The ID of the customizer attribute.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Required. Immutable. Name of the customizer attribute. Required. It must have a minimum length of 1 and maximum length of 40. Name of an enabled customizer attribute must be unique (case insensitive).
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the customizer attribute.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED

CustomLeadFormSubmissionFieldShape
type: NodeShape
target class: CustomLeadFormSubmissionField
property:
  path: fieldValue
  name: field value
  description: Output only. Field value for custom question response, maximum number of characters is 70.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: questionText
  name: question text
  description: Output only. Question text for custom question, maximum number of characters is 300.
  write lifecycle: Read only
  datatype: string
  max count: 1

DataLinkShape
type: NodeShape
target class: DataLink
property:
  path: productLinkId
  name: product link id
  description: Output only. The ID of the link. This field is read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: dataLinkId
  name: data link id
  description: Output only. The ID of the data link. This field is read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. Resource name of the product data link. DataLink resource names have the form: `customers/{customer_id}/datalinks/{product_link_id}~{data_link_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the data.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: VIDEO
property:
  path: youtubeLinkMetadata
  name: youtube link metadata
  description: Immutable. Metadata for a YouTube link.
  write lifecycle: Create only
  node: YoutubeLinkMetadataShape
  class: YoutubeLinkMetadata
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeVideo
  name: youtube video
  description: Immutable. A data link to YouTube video.
  write lifecycle: Create only
  node: YoutubeVideoIdentifierShape
  class: YoutubeVideoIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the data link.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REQUESTED
  in: PENDING_APPROVAL
  in: ENABLED
  in: DISABLED
  in: REVOKED
  in: REJECTED

YoutubeLinkMetadataShape
type: NodeShape
target class: YoutubeLinkMetadata
property:
  path: brandChannelId
  name: brand channel id
  description: Immutable. The ID of a YouTube brand channel to help creators understand your brand. The channel must be linked to this account. This is a string value with “UC” prefix. For example, "UCK8sQmJBp8GCxrOtXWBpyEA".
  write lifecycle: Create only
  datatype: string
  max count: 1

YoutubeVideoIdentifierShape
type: NodeShape
target class: YoutubeVideoIdentifier
property:
  path: channelId
  name: channel id
  description: Immutable. The ID of the hosting channel of the video. This is a string value with “UC” prefix. For example, "UCK8sQmJBp8GCxrOtXWBpyEA".
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: videoId
  name: video id
  description: Immutable. The ID of the video associated with the video link. This is the 11 character string value used in the YouTube video URL. For example, video ID is jV1vkHv4zq8 from the YouTube video URL "https://www.youtube.com/watch?v=jV1vkHv4zq8&t=2s".
  write lifecycle: Create only
  datatype: string
  max count: 1

DataPartnerIdentifierShape
type: NodeShape
target class: DataPartnerIdentifier
property:
  path: dataPartnerId
  name: data partner id
  description: Immutable. The customer ID of the Data partner account. This field is required and should not be empty when creating a new data partner link. It is unable to be modified after the creation of the link.
  write lifecycle: Create only
  datatype: long
  max count: 1

DateRangeShape
type: NodeShape
target class: DateRange
property:
  path: startDate
  name: start date
  description: The start date, in yyyy-mm-dd format. This date is inclusive.
  datatype: string
  max count: 1
property:
  path: endDate
  name: end date
  description: The end date, in yyyy-mm-dd format. This date is inclusive.
  datatype: string
  max count: 1

DetailContentSuitabilityPlacementViewShape
type: NodeShape
target class: DetailContentSuitabilityPlacementView
property:
  path: placementType
  name: placement type
  description: Output only. Represents the type of the placement, for example, Website, YouTubeVideo and MobileApplication.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBSITE
  in: MOBILE_APP_CATEGORY
  in: MOBILE_APPLICATION
  in: YOUTUBE_VIDEO
  in: YOUTUBE_CHANNEL
  in: GOOGLE_PRODUCTS
property:
  path: displayName
  name: display name
  description: Output only. The display name is URL for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: placement
  name: placement
  description: Output only. The automatic placement string at detail level, for example. website url, mobile application id, or a YouTube video id.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the detail content suitability placement view. Detail content suitability placement view resource names have the form: `customers/{customer_id}/detailContentSuitabilityPlacementViews/{placement_fingerprint}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetUrl
  name: target url
  description: Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
  write lifecycle: Read only
  datatype: string
  max count: 1

DetailedDemographicShape
type: NodeShape
target class: DetailedDemographic
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the detailed demographic. Detailed demographic resource names have the form: `customers/{customer_id}/detailedDemographics/{detailed_demographic_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: availabilities
  name: availabilities
  description: Output only. Availability information of the detailed demographic.
  write lifecycle: Read only
  node: CriterionCategoryAvailabilityShape
  class: CriterionCategoryAvailability
  node kind: BlankNodeOrIRI
property:
  path: parent
  name: parent
  description: Output only. The parent of the detailed_demographic.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: launchedToAll
  name: launched to all
  description: Output only. True if the detailed demographic is launched to all channels and locales.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the detailed demographic.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name of the detailed demographic. For example,"Highest Level of Educational Attainment"
  write lifecycle: Read only
  datatype: string
  max count: 1

DetailPlacementViewShape
type: NodeShape
target class: DetailPlacementView
property:
  path: placementType
  name: placement type
  description: Output only. Type of the placement, for example, Website, YouTube Video, and Mobile Application.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBSITE
  in: MOBILE_APP_CATEGORY
  in: MOBILE_APPLICATION
  in: YOUTUBE_VIDEO
  in: YOUTUBE_CHANNEL
  in: GOOGLE_PRODUCTS
property:
  path: displayName
  name: display name
  description: Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: groupPlacementTargetUrl
  name: group placement target url
  description: Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: placement
  name: placement
  description: Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the detail placement view. Detail placement view resource names have the form: `customers/{customer_id}/detailPlacementViews/{ad_group_id}~{base64_placement}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetUrl
  name: target url
  description: Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
  write lifecycle: Read only
  datatype: string
  max count: 1

DisplayKeywordViewShape
type: NodeShape
target class: DisplayKeywordView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the display keyword view. Display Keyword view resource names have the form: `customers/{customer_id}/displayKeywordViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

DistanceViewShape
type: NodeShape
target class: DistanceView
property:
  path: distanceBucket
  name: distance bucket
  description: Output only. Grouping of user distance from location extensions.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WITHIN_700M
  in: WITHIN_1KM
  in: WITHIN_5KM
  in: WITHIN_10KM
  in: WITHIN_15KM
  in: WITHIN_20KM
  in: WITHIN_25KM
  in: WITHIN_30KM
  in: WITHIN_35KM
  in: WITHIN_40KM
  in: WITHIN_45KM
  in: WITHIN_50KM
  in: WITHIN_55KM
  in: WITHIN_60KM
  in: WITHIN_65KM
  in: BEYOND_65KM
  in: WITHIN_0_7MILES
  in: WITHIN_1MILE
  in: WITHIN_5MILES
  in: WITHIN_10MILES
  in: WITHIN_15MILES
  in: WITHIN_20MILES
  in: WITHIN_25MILES
  in: WITHIN_30MILES
  in: WITHIN_35MILES
  in: WITHIN_40MILES
  in: BEYOND_40MILES
property:
  path: metricSystem
  name: metric system
  description: Output only. True if the DistanceBucket is using the metric system, false otherwise.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the distance view. Distance view resource names have the form: `customers/{customer_id}/distanceViews/1~{distance_bucket}`
  write lifecycle: Read only
  datatype: string
  max count: 1

DomainCategoryShape
type: NodeShape
target class: DomainCategory
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the domain category. Domain category resource names have the form: `customers/{customer_id}/domainCategories/{campaign_id}~{category_base64}~{language_code}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: languageCode
  name: language code
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The campaign this category is recommended for.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: hasChildren
  name: has children
  description: Output only. Indicates whether this category has sub-categories.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: coverageFraction
  name: coverage fraction
  description: Output only. Fraction of pages on your site that this category matches.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: categoryRank
  name: category rank
  description: 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.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: category
  name: category
  description: Output only. Recommended category for the website domain, for example, if you have a website about electronics, the categories could be "cameras", "televisions", etc.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: domain
  name: domain
  description: Output only. The domain for the website. The domain can be specified in the DynamicSearchAdsSetting required for dynamic search ads.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: recommendedCpcBidMicros
  name: recommended cpc bid micros
  description: Output only. The recommended cost per click for the category.
  write lifecycle: Read only
  datatype: long
  max count: 1

DynamicSearchAdsSearchTermViewShape
type: NodeShape
target class: DynamicSearchAdsSearchTermView
property:
  path: landingPage
  name: landing page
  description: Output only. The dynamically selected landing page URL of the impression. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: `customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: searchTerm
  name: search term
  description: Output only. Search term This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: headline
  name: headline
  description: Output only. The dynamically generated headline of the Dynamic Search Ad. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: pageUrl
  name: page url
  description: Output only. The URL of page feed item served for the impression. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: hasMatchingKeyword
  name: has matching keyword
  description: Output only. True if query is added to targeted keywords. This field is read-only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: hasNegativeUrl
  name: has negative url
  description: Output only. True if query matches a negative url. This field is read-only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: hasNegativeKeyword
  name: has negative keyword
  description: Output only. True if query matches a negative keyword. This field is read-only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1

ExpandedLandingPageViewShape
type: NodeShape
target class: ExpandedLandingPageView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the expanded landing page view. Expanded landing page view resource names have the form: `customers/{customer_id}/expandedLandingPageViews/{expanded_final_url_fingerprint}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: expandedFinalUrl
  name: expanded final url
  description: Output only. The final URL that clicks are directed to.
  write lifecycle: Read only
  datatype: string
  max count: 1

ExperimentShape
type: NodeShape
target class: Experiment
property:
  path: longRunningOperation
  name: long running operation
  description: Output only. The resource name of the long-running operation that can be used to poll for completion of experiment schedule or promote. The most recent long running operation is returned.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Required. The name of the experiment. It must have a minimum length of 1 and maximum length of 1024. It must be unique under a customer.
  datatype: string
  max count: 1
property:
  path: endDate
  name: end date
  description: Date when the experiment ends. By default, the experiment ends on the campaign's end date. If this field is set, then the experiment ends at the end of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-04-18
  datatype: string
  max count: 1
property:
  path: promoteStatus
  name: promote status
  description: Output only. The status of the experiment promotion process.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOT_STARTED
  in: IN_PROGRESS
  in: COMPLETED
  in: FAILED
  in: COMPLETED_WITH_WARNING
property:
  path: syncEnabled
  name: sync enabled
  description: Immutable. Set to true if changes to base campaigns should be synced to the trial campaigns. Any changes made directly to trial campaigns will be preserved. This field can only be set when the experiment is being created.
  write lifecycle: Create only
  datatype: boolean
  max count: 1
property:
  path: status
  name: status
  description: The Advertiser-chosen status of this experiment.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: HALTED
  in: PROMOTED
  in: SETUP
  in: INITIATED
  in: GRADUATED
property:
  path: experimentId
  name: experiment id
  description: Output only. The ID of the experiment. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: startDate
  name: start date
  description: Date when the experiment starts. By default, the experiment starts now or on the campaign's start date, whichever is later. If this field is set, then the experiment starts at the beginning of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-03-14
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Required. The product/feature that uses this experiment.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DISPLAY_AND_VIDEO_360
  in: AD_VARIATION
  in: YOUTUBE_CUSTOM
  in: DISPLAY_CUSTOM
  in: SEARCH_CUSTOM
  in: DISPLAY_AUTOMATED_BIDDING_STRATEGY
  in: SEARCH_AUTOMATED_BIDDING_STRATEGY
  in: SHOPPING_AUTOMATED_BIDDING_STRATEGY
  in: SMART_MATCHING
  in: HOTEL_CUSTOM
  in: OPTIMIZE_ASSETS
  in: ADOPT_AI_MAX
  in: ADOPT_BROAD_MATCH_KEYWORDS
  in: PMAX_REPLACEMENT_SHOPPING
  in: COMPARE_CAMPAIGNS
  in: PMAX_TEXT_CUSTOMIZATION_FINAL_URL_EXPANSION
property:
  path: description
  name: description
  description: The description of the experiment. It must have a minimum length of 1 and maximum length of 2048.
  datatype: string
  max count: 1
property:
  path: suffix
  name: suffix
  description: For system managed experiments, the advertiser must provide a suffix during construction, in the setup stage before moving to initiated. The suffix will be appended to the in-design and experiment campaign names so that the name is base campaign name + suffix.
  datatype: string
  max count: 1
property:
  path: goals
  name: goals
  description: The goals of this experiment.
  node: MetricGoalShape
  class: MetricGoal
  node kind: BlankNodeOrIRI
property:
  path: optimizeAssetsExperiment
  name: optimize assets experiment
  description: Immutable. Details of the optimize assets experiment. Applies for experiment types: OPTIMIZE_ASSETS.
  write lifecycle: Create only
  node: OptimizeAssetsExperimentInfoShape
  class: OptimizeAssetsExperimentInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the experiment. Experiment resource names have the form: `customers/{customer_id}/experiments/{experiment_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: videoExperiment
  name: video experiment
  description: Immutable. Details of the video experiment. Applies for experiment types: YOUTUBE_CUSTOM.
  write lifecycle: Create only
  node: VideoExperimentInfoShape
  class: VideoExperimentInfo
  node kind: BlankNodeOrIRI
  max count: 1

MetricGoalShape
type: NodeShape
target class: MetricGoal
property:
  path: metric
  name: metric
  description: The metric of the goal. For example, clicks, impressions, cost, conversions, etc.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CLICKS
  in: IMPRESSIONS
  in: COST
  in: CONVERSIONS_PER_INTERACTION_RATE
  in: COST_PER_CONVERSION
  in: CONVERSIONS_VALUE_PER_COST
  in: AVERAGE_CPC
  in: CTR
  in: INCREMENTAL_CONVERSIONS
  in: COMPLETED_VIDEO_VIEWS
  in: CUSTOM_ALGORITHMS
  in: CONVERSIONS
  in: CONVERSION_VALUE
property:
  path: direction
  name: direction
  description: The metric direction of the goal. For example, increase, decrease, no change.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NO_CHANGE
  in: INCREASE
  in: DECREASE
  in: NO_CHANGE_OR_INCREASE
  in: NO_CHANGE_OR_DECREASE

OptimizeAssetsExperimentInfoShape
type: NodeShape
target class: OptimizeAssetsExperimentInfo
property:
  path: optimizeAssetsExperimentSubtype
  name: optimize assets experiment subtype
  description: The subtype of the Optimize Assets experiment.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADD_ASSETS_TO_ASSETLESS_RETAIL
  in: ADD_VIDEO_ASSETS_TO_VIDEOLESS
  in: COMPARE_ASSETS

VideoExperimentInfoShape
type: NodeShape
target class: VideoExperimentInfo
property:
  path: videoExperimentSubtype
  name: video experiment subtype
  description: The subtype of the Video experiment.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DEMAND_GEN_ASSET
  in: ASSET
  in: ASSET_UPLIFT

ExperimentArmShape
type: NodeShape
target class: ExperimentArm
property:
  path: campaigns
  name: campaigns
  description: List of campaigns in the trial arm. The max length is one.
  datatype: string
property:
  path: inDesignCampaigns
  name: in design campaigns
  description: Output only. The in design campaigns in the treatment experiment arm.
  write lifecycle: Read only
  datatype: string
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the experiment arm. Experiment arm resource names have the form: `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: assetTestingInfo
  name: asset testing info
  description: Details of assets under experiment.
  node: ExperimentArmAssetTestingInfoShape
  class: ExperimentArmAssetTestingInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: control
  name: control
  description: Whether this arm is a control arm. A control arm is the arm against which the other arms are compared.
  datatype: boolean
  max count: 1
property:
  path: trafficSplit
  name: traffic split
  description: Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms.
  datatype: long
  max count: 1
property:
  path: assetGroups
  name: asset groups
  description: List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID.
  node: ExperimentArmAssetGroupInfoShape
  class: ExperimentArmAssetGroupInfo
  node kind: BlankNodeOrIRI
property:
  path: performanceMaxExperimentArmInfo
  name: performance max experiment arm info
  description: Immutable. Information specific to the control or treatment campaign of a Performance Max experiment. This field is specific to experiments of type PMAX_REPLACEMENT_SHOPPING. For example, the treatment experiment arm contains the information of treatment Performance Max campaign settings for PMAX_REPLACEMENT_SHOPPING experiments.
  write lifecycle: Create only
  node: ExperimentArmPerformanceMaxExperimentArmInfoShape
  class: ExperimentArmPerformanceMaxExperimentArmInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: experiment
  name: experiment
  description: Immutable. The experiment to which the ExperimentArm belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment.
  datatype: string
  max count: 1

ExperimentArmAssetTestingInfoShape
type: NodeShape
target class: ExperimentArmAssetTestingInfo
property:
  path: assetVariationInfos
  name: asset variation infos
  description: Details of assets associated for each experimental copy of the ad.
  node: ExperimentArmAssetVariationInfoShape
  class: ExperimentArmAssetVariationInfo
  node kind: BlankNodeOrIRI

ExperimentArmAssetVariationInfoShape
type: NodeShape
target class: ExperimentArmAssetVariationInfo
property:
  path: assetDetails
  name: asset details
  description: Details for each asset that is being modified from the base ad.
  node: ExperimentArmAssetDetailShape
  class: ExperimentArmAssetDetail
  node kind: BlankNodeOrIRI
property:
  path: baseAdGroup
  name: base ad group
  description: Associated base AdGroup resource name.
  datatype: string
  max count: 1
property:
  path: baseAd
  name: base ad
  description: Associated base ad resource name.
  datatype: string
  max count: 1

ExperimentArmAssetDetailShape
type: NodeShape
target class: ExperimentArmAssetDetail
property:
  path: asset
  name: asset
  description: The asset that is being modified for the experiment.
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: Field type for the asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: assetDetailOperation
  name: asset detail operation
  description: Enum to specify whether the asset is removed or added from the base ad.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADD
  in: REMOVE

ExperimentArmAssetGroupInfoShape
type: NodeShape
target class: ExperimentArmAssetGroupInfo
property:
  path: assetGroup
  name: asset group
  description: Asset group resource name.
  datatype: string
  max count: 1
property:
  path: assetGroupAssets
  name: asset group assets
  description: List of asset group assets under the asset group.
  node: ExperimentArmAssetGroupAssetInfoShape
  class: ExperimentArmAssetGroupAssetInfo
  node kind: BlankNodeOrIRI

ExperimentArmAssetGroupAssetInfoShape
type: NodeShape
target class: ExperimentArmAssetGroupAssetInfo
property:
  path: fieldType
  name: field type
  description: Field type of the asset group asset.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE
property:
  path: asset
  name: asset
  description: Asset resource name of the asset group asset.
  datatype: string
  max count: 1

ExperimentArmPerformanceMaxExperimentArmInfoShape
type: NodeShape
target class: ExperimentArmPerformanceMaxExperimentArmInfo
property:
  path: experimentalPerformanceMaxCampaignSettings
  name: experimental performance max campaign settings
  description: Immutable. Performance Max campaign settings to be applied on the Google-created experimental campaign in a Performance Max experiment. The experimental campaign is automatically created by Google upon experiment creation.
  write lifecycle: Create only
  node: ExperimentArmExperimentalPerformanceMaxCampaignSettingsShape
  class: ExperimentArmExperimentalPerformanceMaxCampaignSettings
  node kind: BlankNodeOrIRI
  max count: 1

ExperimentArmExperimentalPerformanceMaxCampaignSettingsShape
type: NodeShape
target class: ExperimentArmExperimentalPerformanceMaxCampaignSettings
property:
  path: budgetAmountMicros
  name: budget amount micros
  description: Immutable. The amount of budget of the Performance Max experiment campaign.
  write lifecycle: Create only
  datatype: long
  max count: 1
property:
  path: targetRoas
  name: target roas
  description: Immutable. Target ROAS of the Performance Max experiment campaign.
  write lifecycle: Create only
  datatype: double
  max count: 1
property:
  path: targetCpaMicros
  name: target cpa micros
  description: Immutable. Target CPA of the Performance Max experiment campaign.
  write lifecycle: Create only
  datatype: long
  max count: 1
property:
  path: biddingStrategyType
  name: bidding strategy type
  description: Immutable. Bidding strategy type of the Performance Max experiment campaign.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: COMMISSION
  in: ENHANCED_CPC
  in: FIXED_CPM
  in: FIXED_SHARE_OF_VOICE
  in: INVALID
  in: MANUAL_CPA
  in: MANUAL_CPC
  in: MANUAL_CPM
  in: MANUAL_CPV
  in: MAXIMIZE_CONVERSIONS
  in: MAXIMIZE_CONVERSION_VALUE
  in: PAGE_ONE_PROMOTED
  in: PERCENT_CPC
  in: TARGET_CPA
  in: TARGET_CPC
  in: TARGET_CPM
  in: TARGET_CPV
  in: TARGET_IMPRESSION_SHARE
  in: TARGET_OUTRANK_SHARE
  in: TARGET_ROAS
  in: TARGET_SPEND

FellowshipShape
type: NodeShape
target class: Fellowship
property:
  path: institutionName
  name: institution name
  description: Output only. Name of the instutition at which the fellowship was completed.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: completionYear
  name: completion year
  description: Output only. Year of completion.
  write lifecycle: Read only
  datatype: int
  max count: 1

FinalUrlExpansionAssetViewShape
type: NodeShape
target class: FinalUrlExpansionAssetView
property:
  path: campaign
  name: campaign
  description: Output only. Campaign in which the asset served.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. Status of the FinalUrlExpansionAsset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
  in: PAUSED
property:
  path: finalUrl
  name: final url
  description: Output only. Final URL of the FinalUrlExpansionAsset.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: assetGroup
  name: asset group
  description: Output only. Asset Group in which FinalUrlExpansionAsset served.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: asset
  name: asset
  description: Output only. The ID of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroup
  name: ad group
  description: Output only. Ad Group in which FinalUrlExpansionAsset served.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the FinalUrlExpansionAsset.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: fieldType
  name: field type
  description: Output only. The field type of the asset.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HEADLINE
  in: DESCRIPTION
  in: MANDATORY_AD_TEXT
  in: MARKETING_IMAGE
  in: MEDIA_BUNDLE
  in: YOUTUBE_VIDEO
  in: BOOK_ON_GOOGLE
  in: LEAD_FORM
  in: PROMOTION
  in: CALLOUT
  in: STRUCTURED_SNIPPET
  in: SITELINK
  in: MOBILE_APP
  in: HOTEL_CALLOUT
  in: CALL
  in: PRICE
  in: LONG_HEADLINE
  in: BUSINESS_NAME
  in: SQUARE_MARKETING_IMAGE
  in: PORTRAIT_MARKETING_IMAGE
  in: LOGO
  in: LANDSCAPE_LOGO
  in: VIDEO
  in: CALL_TO_ACTION_SELECTION
  in: AD_IMAGE
  in: BUSINESS_LOGO
  in: HOTEL_PROPERTY
  in: DEMAND_GEN_CAROUSEL_CARD
  in: BUSINESS_MESSAGE
  in: TALL_PORTRAIT_MARKETING_IMAGE
  in: RELATED_YOUTUBE_VIDEOS
  in: LANDING_PAGE_PREVIEW
  in: LONG_DESCRIPTION
  in: CALL_TO_ACTION
  in: CLASSIC_DISPLAY_IMAGE

FlexibleRuleOperandInfoShape
type: NodeShape
target class: FlexibleRuleOperandInfo
property:
  path: lookbackWindowDays
  name: lookback window days
  description: Lookback window for this rule in days. From now until X days ago.
  datatype: long
  max count: 1
property:
  path: rule
  name: rule
  description: List of rule item groups that defines this rule. Rule item groups are grouped together.
  node: UserListRuleInfoShape
  class: UserListRuleInfo
  node kind: BlankNodeOrIRI
  max count: 1

UserListRuleInfoShape
type: NodeShape
target class: UserListRuleInfo
property:
  path: ruleItemGroups
  name: rule item groups
  description: List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
  node: UserListRuleItemGroupInfoShape
  class: UserListRuleItemGroupInfo
  node kind: BlankNodeOrIRI
property:
  path: ruleType
  name: rule type
  description: Rule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. OR of ANDs is the only supported type for FlexibleRuleUserList.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AND_OF_ORS
  in: OR_OF_ANDS

UserListRuleItemGroupInfoShape
type: NodeShape
target class: UserListRuleItemGroupInfo
property:
  path: ruleItems
  name: rule items
  description: Rule items that will be grouped together based on rule_type.
  node: UserListRuleItemInfoShape
  class: UserListRuleItemInfo
  node kind: BlankNodeOrIRI

UserListRuleItemInfoShape
type: NodeShape
target class: UserListRuleItemInfo
property:
  path: name
  name: name
  description: Rule variable name. It should match the corresponding key name fired by the pixel. A name must begin with US-ascii letters or underscore or UTF8 code that is greater than 127 and consist of US-ascii letters or digits or underscore or UTF8 code that is greater than 127. For websites, there are two built-in variable URL (name = 'url__') and referrer URL (name = 'ref_url__'). This field must be populated when creating a new rule item.
  datatype: string
  max count: 1
property:
  path: numberRuleItem
  name: number rule item
  description: An atomic rule item composed of a number operation.
  node: UserListNumberRuleItemInfoShape
  class: UserListNumberRuleItemInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dateRuleItem
  name: date rule item
  description: An atomic rule item composed of a date operation.
  node: UserListDateRuleItemInfoShape
  class: UserListDateRuleItemInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: stringRuleItem
  name: string rule item
  description: An atomic rule item composed of a string operation.
  node: UserListStringRuleItemInfoShape
  class: UserListStringRuleItemInfo
  node kind: BlankNodeOrIRI
  max count: 1

UserListNumberRuleItemInfoShape
type: NodeShape
target class: UserListNumberRuleItemInfo
property:
  path: operator
  name: operator
  description: Number comparison operator. This field is required and must be populated when creating a new number rule item.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GREATER_THAN
  in: GREATER_THAN_OR_EQUAL
  in: EQUALS
  in: NOT_EQUALS
  in: LESS_THAN
  in: LESS_THAN_OR_EQUAL
property:
  path: value
  name: value
  description: Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.
  datatype: double
  max count: 1

UserListDateRuleItemInfoShape
type: NodeShape
target class: UserListDateRuleItemInfo
property:
  path: value
  name: value
  description: String representing date value to be compared with the rule variable. Supported date format is YYYY-MM-DD. Times are reported in the customer's time zone.
  datatype: string
  max count: 1
property:
  path: offsetInDays
  name: offset in days
  description: The relative date value of the right hand side denoted by number of days offset from now. The value field will override this field when both are present.
  datatype: long
  max count: 1
property:
  path: operator
  name: operator
  description: Date comparison operator. This field is required and must be populated when creating new date rule item.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EQUALS
  in: NOT_EQUALS
  in: BEFORE
  in: AFTER

UserListStringRuleItemInfoShape
type: NodeShape
target class: UserListStringRuleItemInfo
property:
  path: operator
  name: operator
  description: String comparison operator. This field is required and must be populated when creating a new string rule item.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CONTAINS
  in: EQUALS
  in: STARTS_WITH
  in: ENDS_WITH
  in: NOT_EQUALS
  in: NOT_CONTAINS
  in: NOT_STARTS_WITH
  in: NOT_ENDS_WITH
property:
  path: value
  name: value
  description: The right hand side of the string rule item. For URLs or referrer URLs, the value can not contain illegal URL chars such as newlines, quotes, tabs, or parentheses. This field is required and must be populated when creating a new string rule item.
  datatype: string
  max count: 1

FlexibleRuleUserListInfoShape
type: NodeShape
target class: FlexibleRuleUserListInfo
property:
  path: inclusiveRuleOperator
  name: inclusive rule operator
  description: Operator that defines how the inclusive operands are combined.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AND
  in: OR
property:
  path: inclusiveOperands
  name: inclusive operands
  description: Rules representing users that should be included in the user list. These are located on the left side of the AND_NOT operator, and joined together by either AND/OR as specified by the inclusive_rule_operator.
  node: FlexibleRuleOperandInfoShape
  class: FlexibleRuleOperandInfo
  node kind: BlankNodeOrIRI
property:
  path: exclusiveOperands
  name: exclusive operands
  description: Rules representing users that should be excluded from the user list. These are located on the right side of the AND_NOT operator, and joined together by OR.
  node: FlexibleRuleOperandInfoShape
  class: FlexibleRuleOperandInfo
  node kind: BlankNodeOrIRI

GenderViewShape
type: NodeShape
target class: GenderView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

GeographicViewShape
type: NodeShape
target class: GeographicView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the geographic view. Geographic view resource names have the form: `customers/{customer_id}/geographicViews/{country_criterion_id}~{location_type}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: locationType
  name: location type
  description: Output only. Type of the geo targeting of the campaign.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AREA_OF_INTEREST
  in: LOCATION_OF_PRESENCE
property:
  path: countryCriterionId
  name: country criterion id
  description: Output only. Criterion Id for the country.
  write lifecycle: Read only
  datatype: long
  max count: 1

GeoTargetConstantShape
type: NodeShape
target class: GeoTargetConstant
property:
  path: targetType
  name: target type
  description: Output only. Geo target constant target type.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: parentGeoTarget
  name: parent geo target
  description: Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: canonicalName
  name: canonical name
  description: Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the geo target constant.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. Geo target constant English name.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. Geo target constant status.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVAL_PLANNED

GoalShape
type: NodeShape
target class: Goal
property:
  path: ownerCustomer
  name: owner customer
  description: Output only. The resource name of the goal owner customer.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: goalType
  name: goal type
  description: Output only. The type of this goal.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER_RETENTION
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the goal. Goal resource names have the form: `customers/{customer_id}/goals/{goal_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: retentionGoalSettings
  name: retention goal settings
  description: Retention goal settings.
  node: GoalSettingRetentionGoalShape
  class: GoalSettingRetentionGoal
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: goalId
  name: goal id
  description: Output only. The ID of this goal.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: optimizationEligibility
  name: optimization eligibility
  description: Output only. Indicates if this goal is eligible for campaign optimization.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ELIGIBLE
  in: INELIGIBLE

GoalSettingRetentionGoalShape
type: NodeShape
target class: GoalSettingRetentionGoal
property:
  path: valueSettings
  name: value settings
  description: Retention goal value settings.
  node: CustomerLifecycleOptimizationValueSettingsShape
  class: CustomerLifecycleOptimizationValueSettings
  node kind: BlankNodeOrIRI
  max count: 1

GoogleAdsIdentifierShape
type: NodeShape
target class: GoogleAdsIdentifier
property:
  path: customer
  name: customer
  description: Immutable. The resource name of the Google Ads account. This field is required and should not be empty when creating a new Google Ads link. It is unable to be modified after the creation of the link.
  write lifecycle: Create only
  datatype: string
  max count: 1

GoogleAdsRowShape
type: NodeShape
target class: GoogleAdsRow
property:
  path: keywordPlan
  name: keyword plan
  description: The keyword plan referenced in the query.
  node: KeywordPlanShape
  class: KeywordPlan
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audience
  name: audience
  description: The Audience referenced in the query.
  node: AudienceShape
  class: Audience
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: video
  name: video
  description: The video referenced in the query.
  node: VideoShape
  class: Video
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: languageConstant
  name: language constant
  description: The language constant referenced in the query.
  node: LanguageConstantShape
  class: LanguageConstant
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupCriterion
  name: ad group criterion
  description: The criterion referenced in the query.
  node: AdGroupCriterionShape
  class: AdGroupCriterion
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: groupPlacementView
  name: group placement view
  description: The group placement view referenced in the query.
  node: GroupPlacementViewShape
  class: GroupPlacementView
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: smartCampaignSetting
  name: smart campaign setting
  description: The Smart campaign setting referenced in the query.
  node: SmartCampaignSettingShape
  class: SmartCampaignSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: userListCustomerType
  name: user list customer type
  description: The user list customer type in the query.
  node: UserListCustomerTypeShape
  class: UserListCustomerType
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerLifecycleGoal
  name: customer lifecycle goal
  description: The customer lifecycle goal referenced in the query.
  node: CustomerLifecycleGoalShape
  class: CustomerLifecycleGoal
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: biddingStrategySimulation
  name: bidding strategy simulation
  description: The bidding strategy simulation referenced in the query.
  node: BiddingStrategySimulationShape
  class: BiddingStrategySimulation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupAsset
  name: ad group asset
  description: The ad group asset referenced in the query.
  node: AdGroupAssetShape
  class: AdGroupAsset
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: segments
  name: segments
  description: The segments.
  node: SegmentsShape
  class: Segments
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupCustomizer
  name: ad group customizer
  description: The ad group customizer referenced in the query.
  node: AdGroupCustomizerShape
  class: AdGroupCustomizer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: androidPrivacySharedKeyGoogleNetworkType
  name: android privacy shared key google network type
  description: The android privacy shared key google network type referenced in the query.
  node: AndroidPrivacySharedKeyGoogleNetworkTypeShape
  class: AndroidPrivacySharedKeyGoogleNetworkType
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adScheduleView
  name: ad schedule view
  description: The ad schedule view referenced in the query.
  node: AdScheduleViewShape
  class: AdScheduleView
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: goal
  name: goal
  description: The goal in the query.
  node: GoalShape
  class: Goal
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: adGroupAdAssetView
  name: ad group ad asset view
  description: The ad group ad asset view in the query.
  class: AdGroupAdAssetView
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: changeEvent
  name: change event
  description: The ChangeEvent referenced in the query.
  node: ChangeEventShape
  class: ChangeEvent
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: keywordPlanCampaign
  name: keyword plan campaign
  description: The keyword plan campaign referenced in the query.
  node: KeywordPlanCampaignShape
  class: KeywordPlanCampaign
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: groupContentSuitabilityPlacementView
  name: group content suitability placement view
  description: The group content suitability placement view referenced in the query.
  node: GroupContentSuitabilityPlacementViewShape
  class: GroupContentSuitabilityPlacementView
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shoppingProduct
  name: shopping product
  description: The shopping product referenced in the query.
  node: ShoppingProductShape
  class: ShoppingProduct
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: smartCampaignSearchTermView
  name: smart campaign search term view
  description: The Smart campaign search term view referenced in the query.
  node: SmartCampaignSearchTermViewShape
  class: SmartCampaignSearchTermView
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: channelAggregateAssetView
  name: channel aggregate asset view
  description: The channel aggregate asset view referenced in the query.
  node: ChannelAggregateAssetViewShape
  class: ChannelAggregateAssetView
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerConversionGoal
  name: customer conversion goal
  description: The CustomerConversionGoal referenced in the query.
  node: CustomerConversionGoalShape
  class: CustomerConversionGoal
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dataLink
  name: data link
  description: The data link referenced in the query.
  node: DataLinkShape
  class: DataLink
  node kind: BlankNodeOrIRI
  max count: 1

KeywordPlanShape
type: NodeShape
target class: KeywordPlan
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Keyword Planner plan. KeywordPlan resource names have the form: `customers/{customer_id}/keywordPlans/{kp_plan_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the keyword plan.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the keyword plan. This field is required and should not be empty when creating new keyword plans.
  datatype: string
  max count: 1
property:
  path: forecastPeriod
  name: forecast period
  description: The date period used for forecasting the plan.
  node: KeywordPlanForecastPeriodShape
  class: KeywordPlanForecastPeriod
  node kind: BlankNodeOrIRI
  max count: 1

KeywordPlanForecastPeriodShape
type: NodeShape
target class: KeywordPlanForecastPeriod
property:
  path: dateRange
  name: date range
  description: The custom date range used for forecasting. It cannot be greater than a year. The start and end dates must be in the future. Otherwise, an error will be returned when the forecasting action is performed. The start and end dates are inclusive.
  node: DateRangeShape
  class: DateRange
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dateInterval
  name: date interval
  description: A future date range relative to the current date used for forecasting.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEXT_WEEK
  in: NEXT_MONTH
  in: NEXT_QUARTER

VideoShape
type: NodeShape
target class: Video
property:
  path: id
  name: id
  description: Output only. The ID of the video.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: channelId
  name: channel id
  description: Output only. The owner channel id of the video.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: title
  name: title
  description: Output only. The title of the video.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the video. Video resource names have the form: `customers/{customer_id}/videos/{video_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: durationMillis
  name: duration millis
  description: Output only. The duration of the video in milliseconds.
  write lifecycle: Read only
  datatype: long
  max count: 1

LanguageConstantShape
type: NodeShape
target class: LanguageConstant
property:
  path: id
  name: id
  description: Output only. The ID of the language constant.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: code
  name: code
  description: Output only. The language code, for example, "en_US", "en_AU", "es", "fr", etc.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Output only. The full name of the language in English, for example, "English (US)", "Spanish", etc.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetable
  name: targetable
  description: Output only. Whether the language is targetable.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the language constant. Language constant resource names have the form: `languageConstants/{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

GroupPlacementViewShape
type: NodeShape
target class: GroupPlacementView
property:
  path: displayName
  name: display name
  description: Output only. Domain name for websites and YouTube channel name for YouTube channels.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: placement
  name: placement
  description: Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the group placement view. Group placement view resource names have the form: `customers/{customer_id}/groupPlacementViews/{ad_group_id}~{base64_placement}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetUrl
  name: target url
  description: Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: placementType
  name: placement type
  description: Output only. Type of the placement, for example, Website, YouTube Channel, Mobile Application.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBSITE
  in: MOBILE_APP_CATEGORY
  in: MOBILE_APPLICATION
  in: YOUTUBE_VIDEO
  in: YOUTUBE_CHANNEL
  in: GOOGLE_PRODUCTS

SmartCampaignSettingShape
type: NodeShape
target class: SmartCampaignSetting
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Smart campaign setting. Smart campaign setting resource names have the form: `customers/{customer_id}/smartCampaignSettings/{campaign_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: phoneNumber
  name: phone number
  description: Phone number and country code.
  node: SmartCampaignSettingPhoneNumberShape
  class: SmartCampaignSettingPhoneNumber
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: finalUrl
  name: final url
  description: The user-provided landing page URL for this Campaign.
  datatype: string
  max count: 1
property:
  path: adOptimizedBusinessProfileSetting
  name: ad optimized business profile setting
  description: Settings for configuring a business profile optimized for ads as this campaign's landing page. This campaign must be linked to a business profile to use this option. For more information on this feature, consult https://support.google.com/google-ads/answer/9827068.
  node: SmartCampaignSettingAdOptimizedBusinessProfileSettingShape
  class: SmartCampaignSettingAdOptimizedBusinessProfileSetting
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The campaign to which these settings apply.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: advertisingLanguageCode
  name: advertising language code
  description: The language code to advertise in from the set of [supported language codes] (https://developers.google.com/google-ads/api/reference/data/codes-formats#languages).
  datatype: string
  max count: 1
property:
  path: businessProfileLocation
  name: business profile location
  description: The resource name of a Business Profile location. Business Profile location resource names can be fetched through the Business Profile API and adhere to the following format: `locations/{locationId}`. See the [Business Profile API] (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) for additional details.
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  description: The name of the business.
  datatype: string
  max count: 1

SmartCampaignSettingPhoneNumberShape
type: NodeShape
target class: SmartCampaignSettingPhoneNumber
property:
  path: phoneNumber
  name: phone number
  description: Phone number of the smart campaign.
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: Upper-case, two-letter country code as defined by ISO-3166.
  datatype: string
  max count: 1

SmartCampaignSettingAdOptimizedBusinessProfileSettingShape
type: NodeShape
target class: SmartCampaignSettingAdOptimizedBusinessProfileSetting
property:
  path: includeLeadForm
  name: include lead form
  description: Enabling a lead form on your business profile enables prospective customers to contact your business by filling out a simple form, and you'll receive their information through email.
  datatype: boolean
  max count: 1

UserListCustomerTypeShape
type: NodeShape
target class: UserListCustomerType
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the user list customer type User list customer type resource names have the form: `customers/{customer_id}/userListCustomerTypes/{user_list_id}~{customer_type_category}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: userList
  name: user list
  description: Immutable. The resource name for the user list this user list customer type is associated with
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: customerTypeCategory
  name: customer type category
  description: Immutable. The user list customer type category
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ALL_CUSTOMERS
  in: PURCHASERS
  in: HIGH_VALUE_CUSTOMERS
  in: DISENGAGED_CUSTOMERS
  in: QUALIFIED_LEADS
  in: CONVERTED_LEADS
  in: PAID_SUBSCRIBERS
  in: CART_ABANDONERS
  in: LOYALTY_TIER_1_MEMBERS
  in: LOYALTY_TIER_2_MEMBERS
  in: LOYALTY_TIER_3_MEMBERS
  in: LOYALTY_TIER_4_MEMBERS
  in: LOYALTY_TIER_5_MEMBERS
  in: LOYALTY_TIER_6_MEMBERS
  in: LOYALTY_TIER_7_MEMBERS

SegmentsShape
type: NodeShape
target class: Segments
property:
  path: productAggregatorId
  name: product aggregator id
  description: Aggregator ID of the product.
  datatype: long
  max count: 1
property:
  path: searchEngineResultsPageType
  name: search engine results page type
  description: Type of the search engine results page.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADS_ONLY
  in: ORGANIC_ONLY
  in: ADS_AND_ORGANIC
property:
  path: travelDestinationRegion
  name: travel destination region
  description: The region the user is searching for at query time.
  datatype: string
  max count: 1
property:
  path: skAdNetworkVersion
  name: sk ad network version
  description: The version of the SKAdNetwork API used.
  datatype: string
  max count: 1
property:
  path: productTypeL5
  name: product type l5
  description: Type (level 5) of the product.
  datatype: string
  max count: 1
property:
  path: hotelState
  name: hotel state
  description: Hotel state.
  datatype: string
  max count: 1
property:
  path: productSoldTypeL5
  name: product sold type l5
  description: Type (level 5) of the product sold.
  datatype: string
  max count: 1
property:
  path: conversionValueRulePrimaryDimension
  name: conversion value rule primary dimension
  description: 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, ITINERARY show the net adjustment after value rules were applied.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NO_RULE_APPLIED
  in: ORIGINAL
  in: NEW_VS_RETURNING_USER
  in: GEO_LOCATION
  in: DEVICE
  in: AUDIENCE
  in: MULTIPLE
  in: ITINERARY
property:
  path: productSoldCondition
  name: product sold condition
  description: Condition of the product sold.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEW
  in: REFURBISHED
  in: USED
property:
  path: geoTargetPostalCode
  name: geo target postal code
  description: Resource name of the geo target constant that represents a postal code.
  datatype: string
  max count: 1
property:
  path: auctionInsightDomain
  name: auction insight domain
  description: Domain (visible URL) of a participant in the Auction Insights report.
  datatype: string
  max count: 1
property:
  path: conversionOrAdjustmentLagBucket
  name: conversion or adjustment lag bucket
  description: An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CONVERSION_LESS_THAN_ONE_DAY
  in: CONVERSION_ONE_TO_TWO_DAYS
  in: CONVERSION_TWO_TO_THREE_DAYS
  in: CONVERSION_THREE_TO_FOUR_DAYS
  in: CONVERSION_FOUR_TO_FIVE_DAYS
  in: CONVERSION_FIVE_TO_SIX_DAYS
  in: CONVERSION_SIX_TO_SEVEN_DAYS
  in: CONVERSION_SEVEN_TO_EIGHT_DAYS
  in: CONVERSION_EIGHT_TO_NINE_DAYS
  in: CONVERSION_NINE_TO_TEN_DAYS
  in: CONVERSION_TEN_TO_ELEVEN_DAYS
  in: CONVERSION_ELEVEN_TO_TWELVE_DAYS
  in: CONVERSION_TWELVE_TO_THIRTEEN_DAYS
  in: CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS
  in: CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS
  in: CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS
  in: CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS
  in: CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS
  in: CONVERSION_SIXTY_TO_NINETY_DAYS
  in: ADJUSTMENT_LESS_THAN_ONE_DAY
  in: ADJUSTMENT_ONE_TO_TWO_DAYS
  in: ADJUSTMENT_TWO_TO_THREE_DAYS
  in: ADJUSTMENT_THREE_TO_FOUR_DAYS
  in: ADJUSTMENT_FOUR_TO_FIVE_DAYS
  in: ADJUSTMENT_FIVE_TO_SIX_DAYS
  in: ADJUSTMENT_SIX_TO_SEVEN_DAYS
  in: ADJUSTMENT_SEVEN_TO_EIGHT_DAYS
  in: ADJUSTMENT_EIGHT_TO_NINE_DAYS
  in: ADJUSTMENT_NINE_TO_TEN_DAYS
  in: ADJUSTMENT_TEN_TO_ELEVEN_DAYS
  in: ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS
  in: ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS
  in: ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS
  in: ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS
  in: ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS
  in: ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS
  in: ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS
  in: ADJUSTMENT_SIXTY_TO_NINETY_DAYS
  in: ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS
  in: CONVERSION_UNKNOWN
  in: ADJUSTMENT_UNKNOWN
property:
  path: productTypeL2
  name: product type l2
  description: Type (level 2) of the product.
  datatype: string
  max count: 1
property:
  path: newVersusReturningCustomers
  name: new versus returning customers
  description: 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.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEW
  in: RETURNING
  in: NEW_AND_HIGH_LTV
property:
  path: date
  name: date
  description: Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
  datatype: string
  max count: 1
property:
  path: productSoldCustomAttribute4
  name: product sold custom attribute4
  description: Custom attribute 4 of the product sold.
  datatype: string
  max count: 1
property:
  path: adDestinationType
  name: ad destination type
  description: Ad Destination type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOT_APPLICABLE
  in: WEBSITE
  in: APP_DEEP_LINK
  in: APP_STORE
  in: PHONE_CALL
  in: MAP_DIRECTIONS
  in: LOCATION_LISTING
  in: MESSAGE
  in: LEAD_FORM
  in: YOUTUBE
  in: UNMODELED_FOR_CONVERSIONS
property:
  path: productItemId
  name: product item id
  description: Item ID of the product.
  datatype: string
  max count: 1
property:
  path: productTypeL3
  name: product type l3
  description: Type (level 3) of the product.
  datatype: string
  max count: 1
property:
  path: partnerHotelId
  name: partner hotel id
  description: Partner hotel ID.
  datatype: string
  max count: 1

KeywordShape
type: NodeShape
target class: Keyword
property:
  path: adGroupCriterion
  name: ad group criterion
  description: The AdGroupCriterion resource name.
  datatype: string
  max count: 1
property:
  path: info
  name: info
  description: Keyword info.
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
  max count: 1

SkAdNetworkSourceAppShape
type: NodeShape
target class: SkAdNetworkSourceApp
property:
  path: skAdNetworkSourceAppId
  name: sk ad network source app id
  description: App id where the ad that drove the iOS Store Kit Ad Network install was shown.
  datatype: string
  max count: 1

KeywordPlanCampaignShape
type: NodeShape
target class: KeywordPlanCampaign
property:
  path: keywordPlan
  name: keyword plan
  description: The keyword plan this campaign belongs to.
  datatype: string
  max count: 1
property:
  path: keywordPlanNetwork
  name: keyword plan network
  description: Targeting network. This field is required and should not be empty when creating Keyword Plan campaigns.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GOOGLE_SEARCH
  in: GOOGLE_SEARCH_AND_PARTNERS
property:
  path: id
  name: id
  description: Output only. The ID of the Keyword Plan campaign.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the Keyword Plan campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
  datatype: string
  max count: 1
property:
  path: cpcBidMicros
  name: cpc bid micros
  description: A default max cpc bid in micros, and in the account currency, for all ad groups under the campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
  datatype: long
  max count: 1
property:
  path: geoTargets
  name: geo targets
  description: The geo targets. Max number allowed: 20.
  node: KeywordPlanGeoTargetShape
  class: KeywordPlanGeoTarget
  node kind: BlankNodeOrIRI
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Keyword Plan campaign. KeywordPlanCampaign resource names have the form: `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: languageConstants
  name: language constants
  description: The languages targeted for the Keyword Plan campaign. Max allowed: 1.
  datatype: string

KeywordPlanGeoTargetShape
type: NodeShape
target class: KeywordPlanGeoTarget
property:
  path: geoTargetConstant
  name: geo target constant
  description: Required. The resource name of the geo target.
  datatype: string
  max count: 1

GroupContentSuitabilityPlacementViewShape
type: NodeShape
target class: GroupContentSuitabilityPlacementView
property:
  path: placementType
  name: placement type
  description: Output only. Represents the type of the placement, for example, Website, YouTubeVideo and MobileApplication.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBSITE
  in: MOBILE_APP_CATEGORY
  in: MOBILE_APPLICATION
  in: YOUTUBE_VIDEO
  in: YOUTUBE_CHANNEL
  in: GOOGLE_PRODUCTS
property:
  path: placement
  name: placement
  description: Output only. The automatic placement string at group level, for example. website url, mobile application id, or a YouTube video id.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: displayName
  name: display name
  description: Output only. The display name is URL for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetUrl
  name: target url
  description: Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the group content suitability placement view. Group content suitability placement view resource names have the form: `customers/{customer_id}/groupContentSuitabilityPlacementViews/{placement_fingerprint}`
  write lifecycle: Read only
  datatype: string
  max count: 1

ShoppingProductShape
type: NodeShape
target class: ShoppingProduct
property:
  path: productTypeLevel3
  name: product type level3
  description: Output only. The product type level 3 as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: customAttribute3
  name: custom attribute3
  description: Output only. The custom attribute 3 of the product as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: categoryLevel2
  name: category level2
  description: Output only. The category level 2 of the product.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: channelExclusivity
  name: channel exclusivity
  description: Output only. The channel exclusivity of the product as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SINGLE_CHANNEL
  in: MULTI_CHANNEL
property:
  path: customAttribute0
  name: custom attribute0
  description: Output only. The custom attribute 0 of the product as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: customAttribute4
  name: custom attribute4
  description: Output only. The custom attribute 4 of the product as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: brand
  name: brand
  description: Output only. The brand of the product as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Output only. The product feed label as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: categoryLevel4
  name: category level4
  description: Output only. The category level 4 of the product.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: productTypeLevel4
  name: product type level4
  description: Output only. The product type level 4 as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: issues
  name: issues
  description: Output only. The list of issues affecting whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update. This field is not supported for App campaigns.
  write lifecycle: Read only
  node: ShoppingProductProductIssueShape
  class: ShoppingProductProductIssue
  node kind: BlankNodeOrIRI
property:
  path: status
  name: status
  description: Output only. The status that indicates whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update. This field is not supported for App campaigns.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NOT_ELIGIBLE
  in: ELIGIBLE_LIMITED
  in: ELIGIBLE
property:
  path: multiClientAccountId
  name: multi client account id
  description: Output only. The id of the Multi Client Account of the merchant, if present.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: productTypeLevel5
  name: product type level5
  description: Output only. The product type level 5 as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: Output only. The currency code as provided by the merchant, in ISO 4217 format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: merchantCenterId
  name: merchant center id
  description: Output only. The id of the merchant that owns the product.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: languageCode
  name: language code
  description: Output only. The language code as provided by the merchant, in BCP 47 format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: categoryLevel1
  name: category level1
  description: Output only. The category level 1 of the product.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroup
  name: ad group
  description: Output only. An ad group of a campaign that includes the product. This field is selectable only in the ad group scope, which requires an equality filter on `campaign` and `ad_group`.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the shopping product. Shopping product resource names have the form: `customers/{customer_id}/shoppingProducts/{merchant_center_id}~{channel}~{language_code}~{feed_label}~{item_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: productTypeLevel1
  name: product type level1
  description: Output only. The product type level 1 as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: effectiveMaxCpcMicros
  name: effective max cpc micros
  description: Output only. The effective maximum cost-per-click (effective max. CPC) of the product. This field is available only if the query specifies the campaign or ad group scope, and if the campaign uses manual bidding. The value is the highest bid set for the product in product groups across all enabled ad groups. It represents the most you're willing to pay for a click on the product. This field can take up to 24 hours to update.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: channel
  name: channel
  description: Output only. The product channel describing the locality of the product.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ONLINE
  in: LOCAL
property:
  path: productImageUri
  name: product image uri
  description: Output only. The URI of the product image as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: productTypeLevel2
  name: product type level2
  description: Output only. The product type level 2 as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: categoryLevel5
  name: category level5
  description: Output only. The category level 5 of the product.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: itemId
  name: item id
  description: Output only. The item id of the product as provided by the merchant.
  write lifecycle: Read only
  datatype: string
  max count: 1

ShoppingProductProductIssueShape
type: NodeShape
target class: ShoppingProductProductIssue
property:
  path: affectedRegions
  name: affected regions
  description: Output only. List of upper-case two-letter ISO 3166-1 codes of the regions affected by the issue. If empty, all regions are affected.
  write lifecycle: Read only
  datatype: string
property:
  path: errorCode
  name: error code
  description: Output only. The error code that identifies the issue.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: attributeName
  name: attribute name
  description: Output only. The name of the product's attribute, if any, that triggered the issue.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Output only. The short description of the issue in English.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: documentation
  name: documentation
  description: Output only. The URL of the Help Center article for the issue.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: detail
  name: detail
  description: Output only. The detailed description of the issue in English.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adsSeverity
  name: ads severity
  description: Output only. The severity of the issue in Google Ads.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WARNING
  in: ERROR

SmartCampaignSearchTermViewShape
type: NodeShape
target class: SmartCampaignSearchTermView
property:
  path: campaign
  name: campaign
  description: Output only. The Smart campaign the search term served in.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Smart campaign search term view. Smart campaign search term view resource names have the form: `customers/{customer_id}/smartCampaignSearchTermViews/{campaign_id}~{URL-base64_search_term}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: searchTerm
  name: search term
  description: Output only. The search term.
  write lifecycle: Read only
  datatype: string
  max count: 1

OfflineConversionUploadConversionActionSummaryShape
type: NodeShape
target class: OfflineConversionUploadConversionActionSummary
property:
  path: jobSummaries
  name: job summaries
  description: Output only. Summary of history stats by last N jobs.
  write lifecycle: Read only
  node: OfflineConversionSummaryShape
  class: OfflineConversionSummary
  node kind: BlankNodeOrIRI
property:
  path: conversionActionId
  name: conversion action id
  description: Output only. Conversion action id.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: successfulEventCount
  name: successful event count
  description: Output only. Total count of successful uploaded events.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: alerts
  name: alerts
  description: Output only. Details for each error code. Alerts are generated from most recent calendar day with upload stats.
  write lifecycle: Read only
  node: OfflineConversionAlertShape
  class: OfflineConversionAlert
  node kind: BlankNodeOrIRI
property:
  path: lastUploadDateTime
  name: last upload date time
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: client
  name: client
  description: Output only. Client type of the upload event.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GOOGLE_ADS_API
  in: GOOGLE_ADS_WEB_CLIENT
  in: ADS_DATA_CONNECTOR
property:
  path: pendingEventCount
  name: pending event count
  description: Output only. Total count of pending uploaded events.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Overall status for offline conversion upload conversion action summary. Status is generated from most recent calendar day with upload stats.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXCELLENT
  in: GOOD
  in: NEEDS_ATTENTION
  in: NO_RECENT_UPLOAD
property:
  path: dailySummaries
  name: daily summaries
  description: Output only. Summary of history stats by last N days.
  write lifecycle: Read only
  node: OfflineConversionSummaryShape
  class: OfflineConversionSummary
  node kind: BlankNodeOrIRI
property:
  path: conversionActionName
  name: conversion action name
  description: Output only. The name of the conversion action.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: totalEventCount
  name: total event count
  description: Output only. Total count of uploaded events.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the offline conversion upload summary at conversion action level. Offline conversion upload conversion action summary resource names have the form: `customers/{customer_id}/offlineConversionUploadConversionActionSummaries/{conversion_action_id}~{client}`
  write lifecycle: Read only
  datatype: string
  max count: 1

OfflineConversionSummaryShape
type: NodeShape
target class: OfflineConversionSummary
property:
  path: failedCount
  name: failed count
  description: Output only. Total count of failed event.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: successfulCount
  name: successful count
  description: Output only. Total count of successful event.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: pendingCount
  name: pending count
  description: Output only. Total count of pending uploaded event.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: jobId
  name: job id
  description: Output only. Dimension key for last N jobs.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: uploadDate
  name: upload date
  description: Output only. Dimension key for last N days.
  write lifecycle: Read only
  datatype: string
  max count: 1

OfflineConversionAlertShape
type: NodeShape
target class: OfflineConversionAlert
property:
  path: error
  name: error
  description: Output only. Error for offline conversion client alert.
  write lifecycle: Read only
  node: OfflineConversionErrorShape
  class: OfflineConversionError
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: errorPercentage
  name: error percentage
  description: Output only. Percentage of the error, the range of this field should be [0, 1.0].
  write lifecycle: Read only
  datatype: double
  max count: 1

OfflineConversionErrorShape
type: NodeShape
target class: OfflineConversionError
property:
  path: mutateError
  name: mutate error
  description: Output only. Mutate error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: RESOURCE_NOT_FOUND
  in: ID_EXISTS_IN_MULTIPLE_MUTATES
  in: INCONSISTENT_FIELD_VALUES
  in: MUTATE_NOT_ALLOWED
  in: RESOURCE_NOT_IN_GOOGLE_ADS
  in: RESOURCE_ALREADY_EXISTS
  in: RESOURCE_DOES_NOT_SUPPORT_VALIDATE_ONLY
  in: OPERATION_DOES_NOT_SUPPORT_PARTIAL_FAILURE
  in: RESOURCE_READ_ONLY
  in: EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED
property:
  path: stringLengthError
  name: string length error
  description: Output only. String length error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EMPTY
  in: TOO_SHORT
  in: TOO_LONG
property:
  path: collectionSizeError
  name: collection size error
  description: Output only. Collection size error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TOO_FEW
  in: TOO_MANY
property:
  path: stringFormatError
  name: string format error
  description: Output only. String format error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ILLEGAL_CHARS
  in: INVALID_FORMAT
property:
  path: conversionUploadError
  name: conversion upload error
  description: Output only. Conversion upload error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TOO_MANY_CONVERSIONS_IN_REQUEST
  in: UNPARSEABLE_GCLID
  in: CONVERSION_PRECEDES_EVENT
  in: EXPIRED_EVENT
  in: TOO_RECENT_EVENT
  in: EVENT_NOT_FOUND
  in: UNAUTHORIZED_CUSTOMER
  in: TOO_RECENT_CONVERSION_ACTION
  in: CONVERSION_TRACKING_NOT_ENABLED_AT_IMPRESSION_TIME
  in: EXTERNAL_ATTRIBUTION_DATA_SET_FOR_NON_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION
  in: EXTERNAL_ATTRIBUTION_DATA_NOT_SET_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION
  in: ORDER_ID_NOT_PERMITTED_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION
  in: ORDER_ID_ALREADY_IN_USE
  in: DUPLICATE_ORDER_ID
  in: TOO_RECENT_CALL
  in: EXPIRED_CALL
  in: CALL_NOT_FOUND
  in: CONVERSION_PRECEDES_CALL
  in: CONVERSION_TRACKING_NOT_ENABLED_AT_CALL_TIME
  in: UNPARSEABLE_CALLERS_PHONE_NUMBER
  in: CLICK_CONVERSION_ALREADY_EXISTS
  in: CALL_CONVERSION_ALREADY_EXISTS
  in: DUPLICATE_CLICK_CONVERSION_IN_REQUEST
  in: DUPLICATE_CALL_CONVERSION_IN_REQUEST
  in: CUSTOM_VARIABLE_NOT_ENABLED
  in: CUSTOM_VARIABLE_VALUE_CONTAINS_PII
  in: INVALID_CUSTOMER_FOR_CLICK
  in: INVALID_CUSTOMER_FOR_CALL
  in: CONVERSION_NOT_COMPLIANT_WITH_ATT_POLICY
  in: CLICK_NOT_FOUND
  in: INVALID_USER_IDENTIFIER
  in: EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION_NOT_PERMITTED_WITH_USER_IDENTIFIER
  in: UNSUPPORTED_USER_IDENTIFIER
  in: GBRAID_WBRAID_BOTH_SET
  in: UNPARSEABLE_WBRAID
  in: UNPARSEABLE_GBRAID
  in: ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID
  in: CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS
  in: CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS
  in: ORDER_ID_CONTAINS_PII
  in: CUSTOMER_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS
  in: INVALID_JOB_ID
  in: NO_CONVERSION_ACTION_FOUND
  in: INVALID_CONVERSION_ACTION_TYPE
property:
  path: dateError
  name: date error
  description: Output only. Date error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INVALID_FIELD_VALUES_IN_DATE
  in: INVALID_FIELD_VALUES_IN_DATE_TIME
  in: INVALID_STRING_DATE
  in: INVALID_STRING_DATE_TIME_MICROS
  in: INVALID_STRING_DATE_TIME_SECONDS
  in: INVALID_STRING_DATE_TIME_SECONDS_WITH_OFFSET
  in: EARLIER_THAN_MINIMUM_DATE
  in: LATER_THAN_MAXIMUM_DATE
  in: DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE
  in: DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL
  in: DATE_RANGE_ERROR_START_TIME_MUST_BE_THE_START_OF_A_DAY
  in: DATE_RANGE_ERROR_END_TIME_MUST_BE_THE_END_OF_A_DAY
property:
  path: notAllowlistedError
  name: not allowlisted error
  description: Output only. Not allowlisted error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER_NOT_ALLOWLISTED_FOR_THIS_FEATURE
property:
  path: fieldError
  name: field error
  description: Output only. Field error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REQUIRED
  in: IMMUTABLE_FIELD
  in: INVALID_VALUE
  in: VALUE_MUST_BE_UNSET
  in: REQUIRED_NONEMPTY_LIST
  in: FIELD_CANNOT_BE_CLEARED
  in: BLOCKED_VALUE
  in: FIELD_CAN_ONLY_BE_CLEARED
property:
  path: conversionAdjustmentUploadError
  name: conversion adjustment upload error
  description: Output only. Conversion adjustment upload error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: TOO_RECENT_CONVERSION_ACTION
  in: CONVERSION_ALREADY_RETRACTED
  in: CONVERSION_NOT_FOUND
  in: CONVERSION_EXPIRED
  in: ADJUSTMENT_PRECEDES_CONVERSION
  in: MORE_RECENT_RESTATEMENT_FOUND
  in: TOO_RECENT_CONVERSION
  in: CANNOT_RESTATE_CONVERSION_ACTION_THAT_ALWAYS_USES_DEFAULT_CONVERSION_VALUE
  in: TOO_MANY_ADJUSTMENTS_IN_REQUEST
  in: TOO_MANY_ADJUSTMENTS
  in: RESTATEMENT_ALREADY_EXISTS
  in: DUPLICATE_ADJUSTMENT_IN_REQUEST
  in: CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS
  in: CONVERSION_ACTION_NOT_ELIGIBLE_FOR_ENHANCEMENT
  in: INVALID_USER_IDENTIFIER
  in: UNSUPPORTED_USER_IDENTIFIER
  in: GCLID_DATE_TIME_PAIR_AND_ORDER_ID_BOTH_SET
  in: CONVERSION_ALREADY_ENHANCED
  in: DUPLICATE_ENHANCEMENT_IN_REQUEST
  in: CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCEMENT
  in: MISSING_ORDER_ID_FOR_WEBPAGE
  in: ORDER_ID_CONTAINS_PII
  in: INVALID_JOB_ID
  in: NO_CONVERSION_ACTION_FOUND
  in: INVALID_CONVERSION_ACTION_TYPE
property:
  path: distinctError
  name: distinct error
  description: Output only. Distinct error.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DUPLICATE_ELEMENT
  in: DUPLICATE_TYPE

ProductGroupViewShape
type: NodeShape
target class: ProductGroupView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the product group view. Product group view resource names have the form: `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

ThirdPartyAppAnalyticsLinkShape
type: NodeShape
target class: ThirdPartyAppAnalyticsLink
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the third party app analytics link. Third party app analytics link resource names have the form: `customers/{customer_id}/thirdPartyAppAnalyticsLinks/{account_link_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: shareableLinkId
  name: shareable link id
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1

LocationInterestViewShape
type: NodeShape
target class: LocationInterestView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the location interest view. Location interest view resource names have the form: `customers/{customer_id}/locationInterestViews/{campaign_id}~{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

LeadFormSubmissionDataShape
type: NodeShape
target class: LeadFormSubmissionData
property:
  path: asset
  name: asset
  description: Output only. Asset associated with the submitted lead form.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adGroupAd
  name: ad group ad
  description: Output only. AdGroupAd associated with the submitted lead form.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: customLeadFormSubmissionFields
  name: custom lead form submission fields
  description: Output only. Submission data associated with a custom lead form.
  write lifecycle: Read only
  node: CustomLeadFormSubmissionFieldShape
  class: CustomLeadFormSubmissionField
  node kind: BlankNodeOrIRI
property:
  path: adGroup
  name: ad group
  description: Output only. AdGroup associated with the submitted lead form.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: submissionDateTime
  name: submission date time
  description: 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".
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the lead form submission data. Lead form submission data resource names have the form: `customers/{customer_id}/leadFormSubmissionData/{lead_form_submission_data_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: leadFormSubmissionFields
  name: lead form submission fields
  description: Output only. Submission data associated with a lead form.
  write lifecycle: Read only
  node: LeadFormSubmissionFieldShape
  class: LeadFormSubmissionField
  node kind: BlankNodeOrIRI
property:
  path: gclid
  name: gclid
  description: Output only. Google Click Id associated with the submissed lead form.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. Campaign associated with the submitted lead form.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. ID of this lead form submission.
  write lifecycle: Read only
  datatype: string
  max count: 1

LeadFormSubmissionFieldShape
type: NodeShape
target class: LeadFormSubmissionField
property:
  path: fieldType
  name: field type
  description: Output only. Field type for lead form fields.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: FULL_NAME
  in: EMAIL
  in: PHONE_NUMBER
  in: POSTAL_CODE
  in: STREET_ADDRESS
  in: CITY
  in: REGION
  in: COUNTRY
  in: WORK_EMAIL
  in: COMPANY_NAME
  in: WORK_PHONE
  in: JOB_TITLE
  in: GOVERNMENT_ISSUED_ID_CPF_BR
  in: GOVERNMENT_ISSUED_ID_DNI_AR
  in: GOVERNMENT_ISSUED_ID_DNI_PE
  in: GOVERNMENT_ISSUED_ID_RUT_CL
  in: GOVERNMENT_ISSUED_ID_CC_CO
  in: GOVERNMENT_ISSUED_ID_CI_EC
  in: GOVERNMENT_ISSUED_ID_RFC_MX
  in: FIRST_NAME
  in: LAST_NAME
  in: VEHICLE_MODEL
  in: VEHICLE_TYPE
  in: PREFERRED_DEALERSHIP
  in: VEHICLE_PURCHASE_TIMELINE
  in: VEHICLE_OWNERSHIP
  in: VEHICLE_PAYMENT_TYPE
  in: VEHICLE_CONDITION
  in: COMPANY_SIZE
  in: ANNUAL_SALES
  in: YEARS_IN_BUSINESS
  in: JOB_DEPARTMENT
  in: JOB_ROLE
  in: OVER_18_AGE
  in: OVER_19_AGE
  in: OVER_20_AGE
  in: OVER_21_AGE
  in: OVER_22_AGE
  in: OVER_23_AGE
  in: OVER_24_AGE
  in: OVER_25_AGE
  in: OVER_26_AGE
  in: OVER_27_AGE
  in: OVER_28_AGE
  in: OVER_29_AGE
  in: OVER_30_AGE
  in: OVER_31_AGE
  in: OVER_32_AGE
  in: OVER_33_AGE
  in: OVER_34_AGE
  in: OVER_35_AGE
  in: OVER_36_AGE
  in: OVER_37_AGE
  in: OVER_38_AGE
  in: OVER_39_AGE
  in: OVER_40_AGE
  in: OVER_41_AGE
  in: OVER_42_AGE
  in: OVER_43_AGE
  in: OVER_44_AGE
  in: OVER_45_AGE
  in: OVER_46_AGE
  in: OVER_47_AGE
  in: OVER_48_AGE
  in: OVER_49_AGE
  in: OVER_50_AGE
  in: OVER_51_AGE
  in: OVER_52_AGE
  in: OVER_53_AGE
  in: OVER_54_AGE
  in: OVER_55_AGE
  in: OVER_56_AGE
property:
  path: fieldValue
  name: field value
  description: Output only. Field value for lead form fields.
  write lifecycle: Read only
  datatype: string
  max count: 1

LifeEventShape
type: NodeShape
target class: LifeEvent
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the life event. Life event resource names have the form: `customers/{customer_id}/lifeEvents/{life_event_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: availabilities
  name: availabilities
  description: Output only. Availability information of the life event.
  write lifecycle: Read only
  node: CriterionCategoryAvailabilityShape
  class: CriterionCategoryAvailability
  node kind: BlankNodeOrIRI
property:
  path: id
  name: id
  description: Output only. The ID of the life event.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name of the life event, for example,"Recently Moved"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: parent
  name: parent
  description: Output only. The parent of the life_event.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: launchedToAll
  name: launched to all
  description: Output only. True if the life event is launched to all channels and locales.
  write lifecycle: Read only
  datatype: boolean
  max count: 1

KeywordPlanCampaignKeywordShape
type: NodeShape
target class: KeywordPlanCampaignKeyword
property:
  path: keywordPlanCampaign
  name: keyword plan campaign
  description: The Keyword Plan campaign to which this negative keyword belongs.
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The keyword match type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXACT
  in: PHRASE
  in: BROAD
property:
  path: negative
  name: negative
  description: Immutable. If true, the keyword is negative. Must be set to true. Only negative campaign keywords are supported.
  write lifecycle: Create only
  datatype: boolean
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Keyword Plan Campaign keyword. KeywordPlanCampaignKeyword resource names have the form: `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: The keyword text.
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the Keyword Plan negative keyword.
  write lifecycle: Read only
  datatype: long
  max count: 1

UserInterestShape
type: NodeShape
target class: UserInterest
property:
  path: taxonomyType
  name: taxonomy type
  description: Output only. Taxonomy type of the user interest.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: AFFINITY
  in: IN_MARKET
  in: MOBILE_APP_INSTALL_USER
  in: VERTICAL_GEO
  in: NEW_SMART_PHONE_USER
property:
  path: userInterestId
  name: user interest id
  description: Output only. The ID of the user interest.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: userInterestParent
  name: user interest parent
  description: Output only. The parent of the user interest.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: availabilities
  name: availabilities
  description: Output only. Availability information of the user interest.
  write lifecycle: Read only
  node: CriterionCategoryAvailabilityShape
  class: CriterionCategoryAvailability
  node kind: BlankNodeOrIRI
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the user interest. User interest resource names have the form: `customers/{customer_id}/userInterests/{user_interest_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: launchedToAll
  name: launched to all
  description: Output only. True if the user interest is launched to all channels and locales.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name of the user interest.
  write lifecycle: Read only
  datatype: string
  max count: 1

YouTubeVideoUploadShape
type: NodeShape
target class: YouTubeVideoUpload
property:
  path: state
  name: state
  description: Output only. The current state of the YouTube video upload.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: UPLOADED
  in: PROCESSED
  in: FAILED
  in: REJECTED
  in: UNAVAILABLE
property:
  path: videoPrivacy
  name: video privacy
  description: The privacy state of the video. Only mutable for videos uploaded to the advertiser owned (brand) YouTube channel. For videos uploaded to the Google-managed channels only UNLISTED privacy is allowed. Defaults to UNLISTED privacy if not specified.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PUBLIC
  in: UNLISTED
property:
  path: videoTitle
  name: video title
  description: Input only. Immutable. The title of the video. Only mutable on YouTube video upload creation. Immutable after creation.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. Resource name of the YouTube video upload.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: videoDescription
  name: video description
  description: Input only. Immutable. The description of the video. Only mutable on YouTube video upload creation. Immutable after creation.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: videoId
  name: video id
  description: Output only. The YouTube video ID of the uploaded video.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: videoUploadId
  name: video upload id
  description: Output only. The unique ID of the YouTube video upload.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: channelId
  name: channel id
  description: Immutable. The destination YouTube channel ID for the video upload. Only mutable on YouTube video upload creation. If omitted, the video will be uploaded to the Google-managed YouTube channel associated with the Ads account.
  write lifecycle: Create only
  datatype: string
  max count: 1

ProductCategoryConstantShape
type: NodeShape
target class: ProductCategoryConstant
property:
  path: productCategoryConstantParent
  name: product category constant parent
  description: Output only. Resource name of the parent product category.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: level
  name: level
  description: Output only. Level of the product category.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LEVEL1
  in: LEVEL2
  in: LEVEL3
  in: LEVEL4
  in: LEVEL5
property:
  path: categoryId
  name: category id
  description: 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.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: localizations
  name: localizations
  description: Output only. List of all available localizations of the product category.
  write lifecycle: Read only
  node: ProductCategoryConstantProductCategoryLocalizationShape
  class: ProductCategoryConstantProductCategoryLocalization
  node kind: BlankNodeOrIRI
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the product category. Product category resource names have the form: `productCategoryConstants/{level}~{category_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: state
  name: state
  description: Output only. State of the product category.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: OBSOLETE

ProductCategoryConstantProductCategoryLocalizationShape
type: NodeShape
target class: ProductCategoryConstantProductCategoryLocalization
property:
  path: regionCode
  name: region code
  description: Output only. Upper-case two-letter ISO 3166-1 country code of the localized category.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: languageCode
  name: language code
  description: Output only. Two-letter ISO 639-1 language code of the localized category.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: value
  name: value
  description: Output only. The name of the category in the specified locale.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationSubscriptionShape
type: NodeShape
target class: RecommendationSubscription
property:
  path: status
  name: status
  description: Required. Status of the subscription, either enabled or paused.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: PAUSED
property:
  path: modifyDateTime
  name: modify date time
  description: Output only. Contains the time in microseconds, when the Recommendation Subscription was last updated. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the recommendation subscription. `customers/{customer_id}/recommendationSubscriptions/{recommendation_type}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Required. Immutable. The type of recommendation subscribed to.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_BUDGET
  in: KEYWORD
  in: TEXT_AD
  in: TARGET_CPA_OPT_IN
  in: MAXIMIZE_CONVERSIONS_OPT_IN
  in: ENHANCED_CPC_OPT_IN
  in: SEARCH_PARTNERS_OPT_IN
  in: MAXIMIZE_CLICKS_OPT_IN
  in: OPTIMIZE_AD_ROTATION
  in: KEYWORD_MATCH_TYPE
  in: MOVE_UNUSED_BUDGET
  in: FORECASTING_CAMPAIGN_BUDGET
  in: TARGET_ROAS_OPT_IN
  in: RESPONSIVE_SEARCH_AD
  in: MARGINAL_ROI_CAMPAIGN_BUDGET
  in: USE_BROAD_MATCH_KEYWORD
  in: RESPONSIVE_SEARCH_AD_ASSET
  in: UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX
  in: RESPONSIVE_SEARCH_AD_IMPROVE_AD_STRENGTH
  in: DISPLAY_EXPANSION_OPT_IN
  in: UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX
  in: RAISE_TARGET_CPA_BID_TOO_LOW
  in: FORECASTING_SET_TARGET_ROAS
  in: CALLOUT_ASSET
  in: SITELINK_ASSET
  in: CALL_ASSET
  in: SHOPPING_ADD_AGE_GROUP
  in: SHOPPING_ADD_COLOR
  in: SHOPPING_ADD_GENDER
  in: SHOPPING_ADD_GTIN
  in: SHOPPING_ADD_MORE_IDENTIFIERS
  in: SHOPPING_ADD_SIZE
  in: SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN
  in: SHOPPING_FIX_DISAPPROVED_PRODUCTS
  in: SHOPPING_TARGET_ALL_OFFERS
  in: SHOPPING_FIX_SUSPENDED_MERCHANT_CENTER_ACCOUNT
  in: SHOPPING_FIX_MERCHANT_CENTER_ACCOUNT_SUSPENSION_WARNING
  in: SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX
  in: DYNAMIC_IMAGE_EXTENSION_OPT_IN
  in: RAISE_TARGET_CPA
  in: LOWER_TARGET_ROAS
  in: PERFORMANCE_MAX_OPT_IN
  in: IMPROVE_PERFORMANCE_MAX_AD_STRENGTH
  in: MIGRATE_DYNAMIC_SEARCH_ADS_CAMPAIGN_TO_PERFORMANCE_MAX
  in: FORECASTING_SET_TARGET_CPA
  in: SET_TARGET_CPA
  in: SET_TARGET_ROAS
  in: MAXIMIZE_CONVERSION_VALUE_OPT_IN
  in: IMPROVE_GOOGLE_TAG_COVERAGE
  in: PERFORMANCE_MAX_FINAL_URL_OPT_IN
  in: REFRESH_CUSTOMER_MATCH_LIST
  in: CUSTOM_AUDIENCE_OPT_IN
  in: LEAD_FORM_ASSET
  in: IMPROVE_DEMAND_GEN_AD_STRENGTH
property:
  path: createDateTime
  name: create date time
  description: Output only. Time in seconds when the subscription was first created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
  write lifecycle: Read only
  datatype: string
  max count: 1

MediaFileShape
type: NodeShape
target class: MediaFile
property:
  path: id
  name: id
  description: Output only. The ID of the media file.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: mimeType
  name: mime type
  description: Output only. The mime type of the media file.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: IMAGE_JPEG
  in: IMAGE_GIF
  in: IMAGE_PNG
  in: FLASH
  in: TEXT_HTML
  in: PDF
  in: MSWORD
  in: MSEXCEL
  in: RTF
  in: AUDIO_WAV
  in: AUDIO_MP3
  in: HTML5_AD_ZIP
property:
  path: type
  name: type
  description: Immutable. Type of the media file.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: IMAGE
  in: ICON
  in: MEDIA_BUNDLE
  in: AUDIO
  in: VIDEO
  in: DYNAMIC_IMAGE
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the media file. Media file resource names have the form: `customers/{customer_id}/mediaFiles/{media_file_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: image
  name: image
  description: Immutable. Encapsulates an Image.
  write lifecycle: Create only
  node: MediaImageShape
  class: MediaImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mediaBundle
  name: media bundle
  description: Immutable. A ZIP archive media the content of which contains HTML5 assets.
  write lifecycle: Create only
  node: MediaBundleShape
  class: MediaBundle
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: audio
  name: audio
  description: Output only. Encapsulates an Audio.
  write lifecycle: Read only
  node: MediaAudioShape
  class: MediaAudio
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: name
  name: name
  description: Immutable. The name of the media file. The name can be used by clients to help identify previously uploaded media.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: video
  name: video
  description: Immutable. Encapsulates a Video.
  write lifecycle: Create only
  node: MediaVideoShape
  class: MediaVideo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: fileSize
  name: file size
  description: Output only. The size of the media file in bytes.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: sourceUrl
  name: source url
  description: 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.
  write lifecycle: Create only
  datatype: string
  max count: 1

MediaImageShape
type: NodeShape
target class: MediaImage
property:
  path: data
  name: data
  description: Immutable. Raw image data.
  write lifecycle: Create only
  datatype: base64Binary
  max count: 1
property:
  path: fullSizeImageUrl
  name: full size image url
  description: Output only. The url to the full size version of the image.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: previewSizeImageUrl
  name: preview size image url
  description: Output only. The url to the preview size version of the image.
  write lifecycle: Read only
  datatype: string
  max count: 1

MediaBundleShape
type: NodeShape
target class: MediaBundle
property:
  path: data
  name: data
  description: Immutable. Raw zipped data.
  write lifecycle: Create only
  datatype: base64Binary
  max count: 1
property:
  path: url
  name: url
  description: Output only. The url to access the uploaded zipped data. For example, https://tpc.googlesyndication.com/simgad/123 This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1

MediaAudioShape
type: NodeShape
target class: MediaAudio
property:
  path: adDurationMillis
  name: ad duration millis
  description: Output only. The duration of the Audio in milliseconds.
  write lifecycle: Read only
  datatype: long
  max count: 1

MediaVideoShape
type: NodeShape
target class: MediaVideo
property:
  path: advertisingIdCode
  name: advertising id code
  description: Output only. The Advertising Digital Identification code for this video, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adDurationMillis
  name: ad duration millis
  description: Output only. The duration of the Video in milliseconds.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: youtubeVideoId
  name: youtube video id
  description: 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.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: isciCode
  name: isci code
  description: Output only. The Industry Standard Commercial Identifier code for this video, used mainly for television commercials.
  write lifecycle: Read only
  datatype: string
  max count: 1

OperatingSystemVersionConstantShape
type: NodeShape
target class: OperatingSystemVersionConstant
property:
  path: osMinorVersion
  name: os minor version
  description: Output only. The OS Minor Version number.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the operating system version.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. Name of the operating system.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: osMajorVersion
  name: os major version
  description: Output only. The OS Major Version number.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the operating system version constant. Operating system version constant resource names have the form: `operatingSystemVersionConstants/{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: operatorType
  name: operator type
  description: Output only. Determines whether this constant represents a single version or a range of versions.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EQUALS_TO
  in: GREATER_THAN_EQUALS_TO

ManagedPlacementViewShape
type: NodeShape
target class: ManagedPlacementView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Managed Placement view. Managed placement view resource names have the form: `customers/{customer_id}/managedPlacementViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

MultiPartyAuthReviewShape
type: NodeShape
target class: MultiPartyAuthReview
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Multi-Party Authentication review. Resource names have the form: `customers/{customer_id}/multiPartyAuthReviews/{multi_party_auth_review_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: operationType
  name: operation type
  description: Output only. The operation type of the Multi-Party Authorization review.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CREATE
  in: UPDATE
  in: REMOVE
property:
  path: customerUserAccessReview
  name: customer user access review
  description: Output only. The CustomerUserAccess details.
  write lifecycle: Read only
  node: CustomerUserAccessReviewShape
  class: CustomerUserAccessReview
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: approvalDateTime
  name: approval date time
  description: Output only. The approval date and time of the Multi-Party Authorization review.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: reviewStatus
  name: review status
  description: Output only. The status of the Multi-Party Authorization review.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: APPROVED
  in: PENDING
  in: REVOKED
  in: REJECTED
  in: EXPIRED
property:
  path: customerUserAccessInvitationReview
  name: customer user access invitation review
  description: Output only. The CustomerUserAccessInvitation details.
  write lifecycle: Read only
  node: CustomerUserAccessInvitationReviewShape
  class: CustomerUserAccessInvitationReview
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: targetResource
  name: target resource
  description: Output only. The target resource for which Multi-Party Authorization is requested.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CUSTOMER_USER_ACCESS
  in: CUSTOMER_USER_ACCESS_INVITATION
property:
  path: multiPartyAuthReviewId
  name: multi party auth review id
  description: Output only. The ID of the Multi-Party Authorization review.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: requestUserEmail
  name: request user email
  description: Output only. The email of the user who requested the Multi-Party Authorization review
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: creationDateTime
  name: creation date time
  description: Output only. The creation date and time of the Multi-Party Authorization review.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: justification
  name: justification
  description: Output only. The justification for the Multi-Party Authorization review request given by the requester.
  write lifecycle: Read only
  datatype: string
  max count: 1

WebpageViewShape
type: NodeShape
target class: WebpageView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the webpage view. Webpage view resource names have the form: `customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

KeywordPlanAdGroupShape
type: NodeShape
target class: KeywordPlanAdGroup
property:
  path: id
  name: id
  description: Output only. The ID of the keyword plan ad group.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the keyword plan ad group. This field is required and should not be empty when creating keyword plan ad group.
  datatype: string
  max count: 1
property:
  path: cpcBidMicros
  name: cpc bid micros
  description: A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group. If not set, will inherit from parent campaign.
  datatype: long
  max count: 1
property:
  path: keywordPlanCampaign
  name: keyword plan campaign
  description: The keyword plan campaign to which this ad group belongs.
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Keyword Planner ad group. KeywordPlanAdGroup resource names have the form: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1

TopicConstantShape
type: NodeShape
target class: TopicConstant
property:
  path: path
  name: path
  description: 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
  write lifecycle: Read only
  datatype: string
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the topic constant. topic constant resource names have the form: `topicConstants/{topic_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the topic.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: topicConstantParent
  name: topic constant parent
  description: Output only. Resource name of parent of the topic constant.
  write lifecycle: Read only
  datatype: string
  max count: 1

OfflineConversionUploadClientSummaryShape
type: NodeShape
target class: OfflineConversionUploadClientSummary
property:
  path: totalEventCount
  name: total event count
  description: Output only. Total count of uploaded events.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the offline conversion upload summary at customer level. Offline conversion upload client summary resource names have the form: `customers/{customer_id}/offlineConversionUploadClientSummaries/{client}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: client
  name: client
  description: Output only. Client type of the upload event.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: GOOGLE_ADS_API
  in: GOOGLE_ADS_WEB_CLIENT
  in: ADS_DATA_CONNECTOR
property:
  path: pendingEventCount
  name: pending event count
  description: Output only. Total count of pending uploaded events.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Overall status for offline conversion client summary. Status is generated from most recent calendar day with upload stats.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXCELLENT
  in: GOOD
  in: NEEDS_ATTENTION
  in: NO_RECENT_UPLOAD
property:
  path: dailySummaries
  name: daily summaries
  description: Output only. Summary of history stats by last N days.
  write lifecycle: Read only
  node: OfflineConversionSummaryShape
  class: OfflineConversionSummary
  node kind: BlankNodeOrIRI
property:
  path: alerts
  name: alerts
  description: Output only. Details for each error code. Alerts are generated from most recent calendar day with upload stats.
  write lifecycle: Read only
  node: OfflineConversionAlertShape
  class: OfflineConversionAlert
  node kind: BlankNodeOrIRI
property:
  path: successfulEventCount
  name: successful event count
  description: Output only. Total count of successful uploaded events.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: lastUploadDateTime
  name: last upload date time
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: jobSummaries
  name: job summaries
  description: Output only. Summary of history stats by last N jobs.
  write lifecycle: Read only
  node: OfflineConversionSummaryShape
  class: OfflineConversionSummary
  node kind: BlankNodeOrIRI
property:
  path: successRate
  name: success rate
  description: Output only. Successful rate.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: pendingRate
  name: pending rate
  description: Output only. The ratio of total pending events to total events.
  write lifecycle: Read only
  datatype: double
  max count: 1

KeywordThemeConstantShape
type: NodeShape
target class: KeywordThemeConstant
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the keyword theme constant. Keyword theme constant resource names have the form: `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: Output only. The ISO-3166 Alpha-2 country code of the constant, eg. "US". To display and query matching purpose, the keyword theme needs to be localized.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: languageCode
  name: language code
  description: Output only. The ISO-639-1 language code with 2 letters of the constant, eg. "en". To display and query matching purpose, the keyword theme needs to be localized.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: displayName
  name: display name
  description: Output only. The display name of the keyword theme or sub keyword theme.
  write lifecycle: Read only
  datatype: string
  max count: 1

LocalServicesLeadShape
type: NodeShape
target class: LocalServicesLead
property:
  path: id
  name: id
  description: Output only. ID of this Lead.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: categoryId
  name: category id
  description: Output only. Service category of the lead. For example: `xcat:service_area_business_hvac`, `xcat:service_area_business_real_estate_agent`, etc. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: leadType
  name: lead type
  description: Output only. Type of Local Services lead: phone, message, booking, etc.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MESSAGE
  in: PHONE_CALL
  in: BOOKING
property:
  path: leadStatus
  name: lead status
  description: Output only. Current status of lead.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEW
  in: ACTIVE
  in: BOOKED
  in: DECLINED
  in: EXPIRED
  in: DISABLED
  in: CONSUMER_DECLINED
  in: WIPED_OUT
property:
  path: note
  name: note
  description: Output only. Note added by advertiser for the lead.
  write lifecycle: Read only
  node: NoteShape
  class: Note
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: creationDateTime
  name: creation date time
  description: 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"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: locale
  name: locale
  description: Output only. Language used by the Local Services provider linked to lead. See https://developers.google.com/google-ads/api/data/codes-formats#locales
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: leadFeedbackSubmitted
  name: lead feedback submitted
  description: Output only. True if the advertiser submitted feedback for the lead.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: creditDetails
  name: credit details
  description: Output only. Credit details of the lead.
  write lifecycle: Read only
  node: CreditDetailsShape
  class: CreditDetails
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the local services lead data. Local Services Lead resource name have the form `customers/{customer_id}/localServicesLead/{local_services_lead_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: contactDetails
  name: contact details
  description: Output only. Lead's contact details.
  write lifecycle: Read only
  node: ContactDetailsShape
  class: ContactDetails
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: leadCharged
  name: lead charged
  description: Output only. True if the advertiser was charged for the lead.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: serviceId
  name: service id
  description: Output only. Service for the category. For example: `buyer_agent`, `seller_agent` for the category of `xcat:service_area_business_real_estate_agent`.
  write lifecycle: Read only
  datatype: string
  max count: 1

NoteShape
type: NodeShape
target class: Note
property:
  path: editDateTime
  name: edit date time
  description: 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"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Output only. Content of lead note.
  write lifecycle: Read only
  datatype: string
  max count: 1

ProductLinkInvitationShape
type: NodeShape
target class: ProductLinkInvitation
property:
  path: status
  name: status
  description: Output only. The status of the product link invitation. This field is read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ACCEPTED
  in: REQUESTED
  in: PENDING_APPROVAL
  in: REVOKED
  in: REJECTED
  in: EXPIRED
property:
  path: merchantCenter
  name: merchant center
  description: Output only. Merchant Center link invitation.
  write lifecycle: Read only
  node: MerchantCenterLinkInvitationIdentifierShape
  class: MerchantCenterLinkInvitationIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: productLinkInvitationId
  name: product link invitation id
  description: Output only. The ID of the product link invitation. This field is read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: hotelCenter
  name: hotel center
  description: Output only. Hotel link invitation.
  write lifecycle: Read only
  node: HotelCenterLinkInvitationIdentifierShape
  class: HotelCenterLinkInvitationIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: advertisingPartnerProperties
  name: advertising partner properties
  description: Output only. Advertising Partner link invitation properties. These properties are only applicable when the link is for an Advertising Partner.
  write lifecycle: Read only
  node: AdvertisingPartnerLinkInvitationPropertiesShape
  class: AdvertisingPartnerLinkInvitationProperties
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the invited account. This field is read only and can be used for filtering invitations with {
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DATA_PARTNER
  in: GOOGLE_ADS
  in: HOTEL_CENTER
  in: MERCHANT_CENTER
  in: ADVERTISING_PARTNER
property:
  path: advertisingPartner
  name: advertising partner
  description: Output only. Advertising Partner link invitation.
  write lifecycle: Read only
  node: AdvertisingPartnerLinkInvitationIdentifierShape
  class: AdvertisingPartnerLinkInvitationIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of a product link invitation. Product link invitation resource names have the form: `customers/{customer_id}/productLinkInvitations/{product_link_invitation_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1

MerchantCenterLinkInvitationIdentifierShape
type: NodeShape
target class: MerchantCenterLinkInvitationIdentifier
property:
  path: merchantCenterId
  name: merchant center id
  description: Output only. The Merchant Center id of the Merchant account. This field is read only
  write lifecycle: Read only
  datatype: long
  max count: 1

HotelCenterLinkInvitationIdentifierShape
type: NodeShape
target class: HotelCenterLinkInvitationIdentifier
property:
  path: hotelCenterId
  name: hotel center id
  description: Output only. The hotel center id of the hotel account. This field is read only
  write lifecycle: Read only
  datatype: long
  max count: 1

KeywordViewShape
type: NodeShape
target class: KeywordView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the keyword view. Keyword view resource names have the form: `customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

HotelPerformanceViewShape
type: NodeShape
target class: HotelPerformanceView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the hotel performance view. Hotel performance view resource names have the form: `customers/{customer_id}/hotelPerformanceView`
  write lifecycle: Read only
  datatype: string
  max count: 1

LocalServicesEmployeeShape
type: NodeShape
target class: LocalServicesEmployee
property:
  path: lastName
  name: last name
  description: Output only. Last name of the employee.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form: `customers/{customer_id}/localServicesEmployees/{gls_employee_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: fellowships
  name: fellowships
  description: Output only. The institutions where the employee has completed their fellowship.
  write lifecycle: Read only
  node: FellowshipShape
  class: Fellowship
  node kind: BlankNodeOrIRI
property:
  path: residencies
  name: residencies
  description: Output only. The institutions where the employee has completed their residency.
  write lifecycle: Read only
  node: ResidencyShape
  class: Residency
  node kind: BlankNodeOrIRI
property:
  path: languagesSpoken
  name: languages spoken
  description: Output only. Languages that the employee speaks, represented as language tags from https://developers.google.com/admin-sdk/directory/v1/languages
  write lifecycle: Read only
  datatype: string
property:
  path: middleName
  name: middle name
  description: Output only. Middle name of the employee.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: yearStartedPracticing
  name: year started practicing
  description: Output only. The year that this employee started practicing in this field.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the employee.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Employee status, such as DELETED or ENABLED.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: firstName
  name: first name
  description: Output only. First name of the employee.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Output only. Employee type.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BUSINESS_OWNER
  in: EMPLOYEE
property:
  path: universityDegrees
  name: university degrees
  description: Output only. A list of degrees this employee has obtained, and wants to feature.
  write lifecycle: Read only
  node: UniversityDegreeShape
  class: UniversityDegree
  node kind: BlankNodeOrIRI
property:
  path: jobTitle
  name: job title
  description: Output only. Job title for this employee, such as "Senior partner" in legal verticals.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: emailAddress
  name: email address
  description: Output only. Email address of the employee.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: creationDateTime
  name: creation date time
  description: 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"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: nationalProviderIdNumber
  name: national provider id number
  description: Output only. NPI id associated with the employee.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: categoryIds
  name: category ids
  description: 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.
  write lifecycle: Read only
  datatype: string

ResidencyShape
type: NodeShape
target class: Residency
property:
  path: completionYear
  name: completion year
  description: Output only. Year of completion.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: institutionName
  name: institution name
  description: Output only. Name of the institution at which the residency was completed.
  write lifecycle: Read only
  datatype: string
  max count: 1

UniversityDegreeShape
type: NodeShape
target class: UniversityDegree
property:
  path: graduationYear
  name: graduation year
  description: Output only. Year of graduation.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: degree
  name: degree
  description: Output only. Name of the degree obtained.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: institutionName
  name: institution name
  description: Output only. Name of the university at which the degree was obtained.
  write lifecycle: Read only
  datatype: string
  max count: 1

HotelGroupViewShape
type: NodeShape
target class: HotelGroupView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the hotel group view. Hotel Group view resource names have the form: `customers/{customer_id}/hotelGroupViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

VideoEnhancementShape
type: NodeShape
target class: VideoEnhancement
property:
  path: durationMillis
  name: duration millis
  description: Output only. Duration of this video, in milliseconds.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: source
  name: source
  description: Output only. The source of the video (e.g. advertiser or enhanced by Google Ads).
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: ENHANCED_BY_GOOGLE_ADS
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the video enhancement. Video enhancement resource names have the form: `customers/{customer_id}/videoEnhancements/{video_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: title
  name: title
  description: Output only. Title of this video.
  write lifecycle: Read only
  datatype: string
  max count: 1

LandingPageViewShape
type: NodeShape
target class: LandingPageView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the landing page view. Landing page view resource names have the form: `customers/{customer_id}/landingPageViews/{unexpanded_final_url_fingerprint}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: unexpandedFinalUrl
  name: unexpanded final url
  description: Output only. The advertiser-specified final URL.
  write lifecycle: Read only
  datatype: string
  max count: 1

LocalServicesLeadConversationShape
type: NodeShape
target class: LocalServicesLeadConversation
property:
  path: eventDateTime
  name: event date time
  description: 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"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the local services lead conversation data. Local Services Lead Conversation resource name have the form `customers/{customer_id}/localServicesLeadConversation/{local_services_lead_conversation_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: conversationChannel
  name: conversation channel
  description: Output only. Type of GLS lead conversation, EMAIL, MESSAGE, PHONE_CALL, SMS, etc.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EMAIL
  in: MESSAGE
  in: PHONE_CALL
  in: SMS
  in: BOOKING
  in: WHATSAPP
  in: ADS_API
property:
  path: participantType
  name: participant type
  description: Output only. Type of participant in the lead conversation, ADVERTISER or CONSUMER.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADVERTISER
  in: CONSUMER
property:
  path: phoneCallDetails
  name: phone call details
  description: Output only. Details of phone call conversation in case of PHONE_CALL.
  write lifecycle: Read only
  node: PhoneCallDetailsShape
  class: PhoneCallDetails
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: messageDetails
  name: message details
  description: Output only. Details of message conversation in case of EMAIL, MESSAGE or SMS.
  write lifecycle: Read only
  node: MessageDetailsShape
  class: MessageDetails
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. ID of this Lead Conversation.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: lead
  name: lead
  description: Output only. Resource name of Lead associated to the Lead Conversation.
  write lifecycle: Read only
  datatype: string
  max count: 1

PhoneCallDetailsShape
type: NodeShape
target class: PhoneCallDetails
property:
  path: callDurationMillis
  name: call duration millis
  description: Output only. The duration (in milliseconds) of the phone call (end to end).
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: callRecordingUrl
  name: call recording url
  description: Output only. URL to the call recording audio file.
  write lifecycle: Read only
  datatype: string
  max count: 1

MessageDetailsShape
type: NodeShape
target class: MessageDetails
property:
  path: text
  name: text
  description: Output only. Textual content of the message.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: attachmentUrls
  name: attachment urls
  description: 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.
  write lifecycle: Read only
  datatype: string

TravelActivityGroupViewShape
type: NodeShape
target class: TravelActivityGroupView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the travel activity group view. Travel Activity Group view resource names have the form: `customers/{customer_id}/travelActivityGroupViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

UserLocationViewShape
type: NodeShape
target class: UserLocationView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the user location view. UserLocation view resource names have the form: `customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: targetingLocation
  name: targeting location
  description: Output only. Indicates whether location was targeted or not.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: countryCriterionId
  name: country criterion id
  description: Output only. Criterion Id for the country.
  write lifecycle: Read only
  datatype: long
  max count: 1

ParentalStatusViewShape
type: NodeShape
target class: ParentalStatusView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the parental status view. Parental Status view resource names have the form: `customers/{customer_id}/parentalStatusViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

HotelReconciliationShape
type: NodeShape
target class: HotelReconciliation
property:
  path: orderId
  name: order id
  description: Output only. The order ID is the identifier for this booking as provided in the 'transaction_id' parameter of the conversion tracking tag.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: campaign
  name: campaign
  description: Output only. The resource name for the Campaign associated with the conversion.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: RESERVATION_ENABLED
  in: RECONCILIATION_NEEDED
  in: RECONCILED
  in: CANCELED
property:
  path: reconciledValueMicros
  name: reconciled value micros
  description: 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.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the hotel reconciliation. Hotel reconciliation resource names have the form: `customers/{customer_id}/hotelReconciliations/{commission_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: commissionId
  name: commission id
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: checkInDate
  name: check in date
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: hotelId
  name: hotel id
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: checkOutDate
  name: check out date
  description: 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.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: hotelCenterId
  name: hotel center id
  description: Output only. Identifier for the Hotel Center account which provides the rates for the Hotel campaign.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: billed
  name: billed
  description: Output only. Whether a given booking has been billed. Once billed, a booking can't be modified.
  write lifecycle: Read only
  datatype: boolean
  max count: 1

SharedCriterionShape
type: NodeShape
target class: SharedCriterion
property:
  path: brand
  name: brand
  description: Immutable. Brand.
  write lifecycle: Create only
  node: BrandInfoShape
  class: BrandInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: placement
  name: placement
  description: Immutable. Placement.
  write lifecycle: Create only
  node: PlacementInfoShape
  class: PlacementInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: youtubeChannel
  name: youtube channel
  description: Immutable. YouTube Channel.
  write lifecycle: Create only
  node: YouTubeChannelInfoShape
  class: YouTubeChannelInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mobileAppCategory
  name: mobile app category
  description: Immutable. Mobile App Category.
  write lifecycle: Create only
  node: MobileAppCategoryInfoShape
  class: MobileAppCategoryInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: mobileApplication
  name: mobile application
  description: Immutable. Mobile application.
  write lifecycle: Create only
  node: MobileApplicationInfoShape
  class: MobileApplicationInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: webpage
  name: webpage
  description: Immutable. Webpage.
  write lifecycle: Create only
  node: WebpageInfoShape
  class: WebpageInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the shared criterion. Shared set resource names have the form: `customers/{customer_id}/sharedCriteria/{shared_set_id}~{criterion_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: criterionId
  name: criterion id
  description: Output only. The ID of the criterion. This field is ignored for mutates.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: sharedSet
  name: shared set
  description: Immutable. The shared set to which the shared criterion belongs.
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: youtubeVideo
  name: youtube video
  description: Immutable. YouTube Video.
  write lifecycle: Create only
  node: YouTubeVideoInfoShape
  class: YouTubeVideoInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: retailFilter
  name: retail filter
  description: Immutable. Retail Filter.
  write lifecycle: Create only
  node: RetailFilterShape
  class: RetailFilter
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: verticalAdsItemGroupRule
  name: vertical ads item group rule
  description: Immutable. Vertical ads item group rule.
  write lifecycle: Create only
  node: VerticalAdsItemGroupRuleInfoShape
  class: VerticalAdsItemGroupRuleInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: negative
  name: negative
  description: Immutable. If true, the criterion is excluded. If false, the criterion is targeted.
  write lifecycle: Create only
  datatype: boolean
  max count: 1
property:
  path: keyword
  name: keyword
  description: Immutable. Keyword.
  write lifecycle: Create only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the criterion.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: KEYWORD
  in: PLACEMENT
  in: MOBILE_APP_CATEGORY
  in: MOBILE_APPLICATION
  in: DEVICE
  in: LOCATION
  in: LISTING_GROUP
  in: AD_SCHEDULE
  in: AGE_RANGE
  in: GENDER
  in: INCOME_RANGE
  in: PARENTAL_STATUS
  in: YOUTUBE_VIDEO
  in: YOUTUBE_CHANNEL
  in: USER_LIST
  in: PROXIMITY
  in: TOPIC
  in: LISTING_SCOPE
  in: LANGUAGE
  in: IP_BLOCK
  in: CONTENT_LABEL
  in: CARRIER
  in: USER_INTEREST
  in: WEBPAGE
  in: OPERATING_SYSTEM_VERSION
  in: APP_PAYMENT_MODEL
  in: MOBILE_DEVICE
  in: CUSTOM_AFFINITY
  in: CUSTOM_INTENT
  in: LOCATION_GROUP
  in: CUSTOM_AUDIENCE
  in: COMBINED_AUDIENCE
  in: KEYWORD_THEME
  in: AUDIENCE
  in: NEGATIVE_KEYWORD_LIST
  in: LOCAL_SERVICE_ID
  in: SEARCH_THEME
  in: BRAND
  in: BRAND_LIST
  in: LIFE_EVENT
  in: WEBPAGE_LIST
  in: VIDEO_LINEUP
  in: PLACEMENT_LIST
  in: VERTICAL_ADS_ITEM_GROUP_RULE_LIST
  in: VERTICAL_ADS_ITEM_GROUP_RULE
  in: RETAIL_FILTER_BUNDLE
  in: RETAIL_FILTER

RetailFilterShape
type: NodeShape
target class: RetailFilter
property:
  path: expression
  name: expression
  description: An expression node. At this time, this can only be an OR node.
  node: RetailFilterExpressionShape
  class: RetailFilterExpression
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: tag
  name: tag
  description: A tag node.
  node: RetailTagShape
  class: RetailTag
  node kind: BlankNodeOrIRI
  max count: 1

RetailFilterExpressionShape
type: NodeShape
target class: RetailFilterExpression
property:
  path: name
  name: name
  description: The name of the expression. This name is used for grouping Retail Tags into one logical expression with OR operator. The name can contain at most 20 characters. Only lowercase latin letters, underscores, and numbers are allowed. This field is required and must be unique within the shared set.
  datatype: string
  max count: 1

RetailTagShape
type: NodeShape
target class: RetailTag
property:
  path: expressionName
  name: expression name
  description: The name of the expression this tag belongs to. If empty, the tag is a top-level condition.
  datatype: string
  max count: 1
property:
  path: value
  name: value
  description: The value of the tag. It can contain at most 50 characters. All Unicode characters except comma and newline are allowed. This field is required.
  datatype: string
  max count: 1

VerticalAdsItemGroupRuleInfoShape
type: NodeShape
target class: VerticalAdsItemGroupRuleInfo
property:
  path: cityCriterionId
  name: city criterion id
  description: The resource name of the Geo Target Constant for the city.
  datatype: string
  max count: 1
property:
  path: itemCode
  name: item code
  description: The id specifying a particular Vertical Ad listing.
  datatype: string
  max count: 1
property:
  path: regionCriterionId
  name: region criterion id
  description: The resource name of the Geo Target Constant for the region.
  datatype: string
  max count: 1
property:
  path: venue
  name: venue
  description: A name for a specific location, like the venue for a concert event.
  datatype: string
  max count: 1
property:
  path: userRating
  name: user rating
  description: Integer value specifying the user rating for a Vertical Ad listing. Ranges from 1 to 5, where 5 is the best.
  datatype: long
  max count: 1
property:
  path: hotelClass
  name: hotel class
  description: Integer value specifying the class rating for a hotel. Ranges from 1 to 5 stars.
  datatype: long
  max count: 1
property:
  path: eventParticipantDisplayName
  name: event participant display name
  description: The name of an associated participant for a given event. For example, headliner for a concert event.
  datatype: string
  max count: 1
property:
  path: countryCriterionId
  name: country criterion id
  description: The resource name of the Geo Target Constant for the country.
  datatype: string
  max count: 1

KeywordPlanAdGroupKeywordShape
type: NodeShape
target class: KeywordPlanAdGroupKeyword
property:
  path: keywordPlanAdGroup
  name: keyword plan ad group
  description: The Keyword Plan ad group to which this keyword belongs.
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Keyword Plan ad group keyword. KeywordPlanAdGroupKeyword resource names have the form: `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: The keyword text.
  datatype: string
  max count: 1
property:
  path: matchType
  name: match type
  description: The keyword match type.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXACT
  in: PHRASE
  in: BROAD
property:
  path: negative
  name: negative
  description: Immutable. If true, the keyword is negative.
  write lifecycle: Create only
  datatype: boolean
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the Keyword Plan keyword.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: cpcBidMicros
  name: cpc bid micros
  description: A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency is the same as the account currency code. This will override any CPC bid set at the keyword plan ad group level. Not applicable for negative keywords. (negative = true) This field is Optional.
  datatype: long
  max count: 1

RemarketingActionShape
type: NodeShape
target class: RemarketingAction
property:
  path: tagSnippets
  name: tag snippets
  description: Output only. The snippets used for tracking remarketing actions.
  write lifecycle: Read only
  node: TagSnippetShape
  class: TagSnippet
  node kind: BlankNodeOrIRI
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the remarketing action. Remarketing action resource names have the form: `customers/{customer_id}/remarketingActions/{remarketing_action_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. Id of the remarketing action.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the remarketing action. This field is required and should not be empty when creating new remarketing actions.
  datatype: string
  max count: 1

OfflineUserDataJobShape
type: NodeShape
target class: OfflineUserDataJob
property:
  path: id
  name: id
  description: Output only. ID of this offline user data job.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. Status of the job.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: RUNNING
  in: SUCCESS
  in: FAILED
property:
  path: operationMetadata
  name: operation metadata
  description: Output only. Metadata of offline user data job depicting match rate range.
  write lifecycle: Read only
  node: OfflineUserDataJobMetadataShape
  class: OfflineUserDataJobMetadata
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the offline user data job. Offline user data job resource names have the form: `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Immutable. Type of the job.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: STORE_SALES_UPLOAD_FIRST_PARTY
  in: STORE_SALES_UPLOAD_THIRD_PARTY
  in: CUSTOMER_MATCH_USER_LIST
  in: CUSTOMER_MATCH_WITH_ATTRIBUTES
property:
  path: customerMatchUserListMetadata
  name: customer match user list metadata
  description: Immutable. Metadata for data updates to a CRM-based user list.
  write lifecycle: Create only
  node: CustomerMatchUserListMetadataShape
  class: CustomerMatchUserListMetadata
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: storeSalesMetadata
  name: store sales metadata
  description: Immutable. Metadata for store sales data update.
  write lifecycle: Create only
  node: StoreSalesMetadataShape
  class: StoreSalesMetadata
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: failureReason
  name: failure reason
  description: Output only. Reason for the processing failure, if status is FAILED.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: INSUFFICIENT_MATCHED_TRANSACTIONS
  in: INSUFFICIENT_TRANSACTIONS
  in: HIGH_AVERAGE_TRANSACTION_VALUE
  in: LOW_AVERAGE_TRANSACTION_VALUE
  in: NEWLY_OBSERVED_CURRENCY_CODE
property:
  path: externalId
  name: external id
  description: Immutable. User specified job ID.
  write lifecycle: Create only
  datatype: long
  max count: 1

OfflineUserDataJobMetadataShape
type: NodeShape
target class: OfflineUserDataJobMetadata
property:
  path: matchRateRange
  name: match rate range
  description: Output only. Match rate of the Customer Match user list upload. Describes the estimated match rate when the status of the job is "RUNNING" and final match rate when the final match rate is available after the status of the job is "SUCCESS/FAILED".
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MATCH_RANGE_LESS_THAN_20
  in: MATCH_RANGE_20_TO_30
  in: MATCH_RANGE_31_TO_40
  in: MATCH_RANGE_41_TO_50
  in: MATCH_RANGE_51_TO_60
  in: MATCH_RANGE_61_TO_70
  in: MATCH_RANGE_71_TO_80
  in: MATCH_RANGE_81_TO_90
  in: MATCH_RANGE_91_TO_100

StoreSalesMetadataShape
type: NodeShape
target class: StoreSalesMetadata
property:
  path: transactionUploadFraction
  name: transaction upload fraction
  description: This is the ratio of sales being uploaded compared to the overall sales that can be associated with a customer. Required. The fraction needs to be between 0 and 1 (excluding 0). For example, if you upload half the sales that you are able to associate with a customer, this would be 0.5.
  datatype: double
  max count: 1
property:
  path: customKey
  name: custom key
  description: Name of the store sales custom variable key. A predefined key that can be applied to the transaction and then later used for custom segmentation in reporting. Accessible only to customers on the allow-list.
  datatype: string
  max count: 1
property:
  path: loyaltyFraction
  name: loyalty fraction
  description: This is the fraction of all transactions that are identifiable (for example, associated with any form of customer information). Required. The fraction needs to be between 0 and 1 (excluding 0).
  datatype: double
  max count: 1
property:
  path: thirdPartyMetadata
  name: third party metadata
  description: Metadata for a third party Store Sales upload.
  node: StoreSalesThirdPartyMetadataShape
  class: StoreSalesThirdPartyMetadata
  node kind: BlankNodeOrIRI
  max count: 1

StoreSalesThirdPartyMetadataShape
type: NodeShape
target class: StoreSalesThirdPartyMetadata
property:
  path: partnerMatchFraction
  name: partner match fraction
  description: The fraction of valid transactions that are matched to a third party assigned user ID on the partner side. Required. The fraction needs to be between 0 and 1 (excluding 0).
  datatype: double
  max count: 1
property:
  path: partnerUploadFraction
  name: partner upload fraction
  description: The fraction of valid transactions that are uploaded by the partner to Google. Required. The fraction needs to be between 0 and 1 (excluding 0).
  datatype: double
  max count: 1
property:
  path: bridgeMapVersionId
  name: bridge map version id
  description: Version of partner IDs to be used for uploads. Required.
  datatype: string
  max count: 1
property:
  path: partnerId
  name: partner id
  description: ID of the third party partner updating the transaction feed.
  datatype: long
  max count: 1
property:
  path: validTransactionFraction
  name: valid transaction fraction
  description: The fraction of transactions that are valid. Invalid transactions may include invalid formats or values. Required. The fraction needs to be between 0 and 1 (excluding 0).
  datatype: double
  max count: 1
property:
  path: advertiserUploadDateTime
  name: advertiser upload date time
  description: Time the advertiser uploaded the data to the partner. Required. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
  datatype: string
  max count: 1

SearchTermViewShape
type: NodeShape
target class: SearchTermView
property:
  path: adGroup
  name: ad group
  description: Output only. The ad group the search term served in.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the search term view. Search term view resource names have the form: `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: searchTerm
  name: search term
  description: Output only. The search term.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ADDED
  in: EXCLUDED
  in: ADDED_EXCLUDED
  in: NONE

PerformanceMaxPlacementViewShape
type: NodeShape
target class: PerformanceMaxPlacementView
property:
  path: placementType
  name: placement type
  description: Output only. Type of the placement. Possible values for Performance Max placements are WEBSITE, MOBILE_APPLICATION, or YOUTUBE_VIDEO.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: WEBSITE
  in: MOBILE_APP_CATEGORY
  in: MOBILE_APPLICATION
  in: YOUTUBE_VIDEO
  in: YOUTUBE_CHANNEL
  in: GOOGLE_PRODUCTS
property:
  path: targetUrl
  name: target url
  description: Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Performance Max placement view. Performance Max placement view resource names have the form: `customers/{customer_id}/performanceMaxPlacementViews/{base_64_placement}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: placement
  name: placement
  description: Output only. The default placement string, such as the website URL, mobile application ID, or a YouTube video ID.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: displayName
  name: display name
  description: Output only. The name displayed to represent the placement, such as the URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
  write lifecycle: Read only
  datatype: string
  max count: 1

MatchedLocationInterestViewShape
type: NodeShape
target class: MatchedLocationInterestView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the matched location interest view. Matched location interest view resource names have the form: `customers/{customer_id}/matchedLocationInterestViews/{country_criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

TopicViewShape
type: NodeShape
target class: TopicView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the topic view. Topic view resource names have the form: `customers/{customer_id}/topicViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

IncomeRangeViewShape
type: NodeShape
target class: IncomeRangeView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the income range view. Income range view resource names have the form: `customers/{customer_id}/incomeRangeViews/{ad_group_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

TravelActivityPerformanceViewShape
type: NodeShape
target class: TravelActivityPerformanceView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the travel activity performance view. Travel Activity performance view resource names have the form: `customers/{customer_id}/travelActivityPerformanceView`
  write lifecycle: Read only
  datatype: string
  max count: 1

PaidOrganicSearchTermViewShape
type: NodeShape
target class: PaidOrganicSearchTermView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the search term view. Search term view resource names have the form: `customers/{customer_id}/paidOrganicSearchTermViews/{campaign_id}~ {ad_group_id}~{URL-base64 search term}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: searchTerm
  name: search term
  description: Output only. The search term.
  write lifecycle: Read only
  datatype: string
  max count: 1

LabelShape
type: NodeShape
target class: Label
property:
  path: resourceName
  name: resource name
  description: Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. ID of the label. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. Status of the label. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: textLabel
  name: text label
  description: A type of label displaying text on a colored background.
  node: TextLabelShape
  class: TextLabel
  node kind: BlankNodeOrIRI
  max count: 1

TextLabelShape
type: NodeShape
target class: TextLabel
property:
  path: description
  name: description
  description: A short description of the label. The length must be no more than 200 characters.
  datatype: string
  max count: 1
property:
  path: backgroundColor
  name: background color
  description: Background color of the label in HEX format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
  datatype: string
  max count: 1

QualifyingQuestionShape
type: NodeShape
target class: QualifyingQuestion
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the qualifying question. 'qualifyingQuestions/{qualifyingQuestionId}'
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: qualifyingQuestionId
  name: qualifying question id
  description: Output only. The id of the qualifying question.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: locale
  name: locale
  description: Output only. The locale of the qualifying question.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: text
  name: text
  description: Output only. The qualifying question.
  write lifecycle: Read only
  datatype: string
  max count: 1

LocalServicesVerificationArtifactShape
type: NodeShape
target class: LocalServicesVerificationArtifact
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form: `customers/{customer_id}/localServicesVerificationArtifacts/{verification_artifact_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: businessRegistrationCheckVerificationArtifact
  name: business registration check verification artifact
  description: Output only. A business registration check verification artifact.
  write lifecycle: Read only
  node: BusinessRegistrationCheckVerificationArtifactShape
  class: BusinessRegistrationCheckVerificationArtifact
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: artifactType
  name: artifact type
  description: Output only. The type of the verification artifact.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BACKGROUND_CHECK
  in: INSURANCE
  in: LICENSE
  in: BUSINESS_REGISTRATION_CHECK
property:
  path: id
  name: id
  description: Output only. The ID of the verification artifact.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of the verification artifact.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PASSED
  in: FAILED
  in: PENDING
  in: NO_SUBMISSION
  in: CANCELLED
property:
  path: backgroundCheckVerificationArtifact
  name: background check verification artifact
  description: Output only. A background check verification artifact.
  write lifecycle: Read only
  node: BackgroundCheckVerificationArtifactShape
  class: BackgroundCheckVerificationArtifact
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: licenseVerificationArtifact
  name: license verification artifact
  description: Output only. A license verification artifact.
  write lifecycle: Read only
  node: LicenseVerificationArtifactShape
  class: LicenseVerificationArtifact
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: insuranceVerificationArtifact
  name: insurance verification artifact
  description: Output only. An insurance verification artifact.
  write lifecycle: Read only
  node: InsuranceVerificationArtifactShape
  class: InsuranceVerificationArtifact
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: creationDateTime
  name: creation date time
  description: 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"
  write lifecycle: Read only
  datatype: string
  max count: 1

LicenseVerificationArtifactShape
type: NodeShape
target class: LicenseVerificationArtifact
property:
  path: licenseeFirstName
  name: licensee first name
  description: Output only. First name of the licensee.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: licenseeLastName
  name: licensee last name
  description: Output only. Last name of the licensee.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: expirationDateTime
  name: expiration date time
  description: Output only. The timestamp when this license expires. 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"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: rejectionReason
  name: rejection reason
  description: Output only. License rejection reason.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BUSINESS_NAME_MISMATCH
  in: UNAUTHORIZED
  in: EXPIRED
  in: POOR_QUALITY
  in: UNVERIFIABLE
  in: WRONG_DOCUMENT_OR_ID
  in: OTHER
property:
  path: licenseDocumentReadonly
  name: license document readonly
  description: Output only. The readonly field containing the information for an uploaded license document.
  write lifecycle: Read only
  node: LocalServicesDocumentReadOnlyShape
  class: LocalServicesDocumentReadOnly
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: licenseType
  name: license type
  description: Output only. License type / name.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: licenseNumber
  name: license number
  description: Output only. License number.
  write lifecycle: Read only
  datatype: string
  max count: 1

InsuranceVerificationArtifactShape
type: NodeShape
target class: InsuranceVerificationArtifact
property:
  path: amountMicros
  name: amount micros
  description: Output only. Insurance amount. This is measured in "micros" of the currency mentioned in the insurance document.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: insuranceDocumentReadonly
  name: insurance document readonly
  description: Output only. The readonly field containing the information for an uploaded insurance document.
  write lifecycle: Read only
  node: LocalServicesDocumentReadOnlyShape
  class: LocalServicesDocumentReadOnly
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: expirationDateTime
  name: expiration date time
  description: Output only. The timestamp when this insurance expires. 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"
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: rejectionReason
  name: rejection reason
  description: Output only. Insurance document's rejection reason.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: BUSINESS_NAME_MISMATCH
  in: INSURANCE_AMOUNT_INSUFFICIENT
  in: EXPIRED
  in: NO_SIGNATURE
  in: NO_POLICY_NUMBER
  in: NO_COMMERCIAL_GENERAL_LIABILITY
  in: EDITABLE_FORMAT
  in: CATEGORY_MISMATCH
  in: MISSING_EXPIRATION_DATE
  in: POOR_QUALITY
  in: POTENTIALLY_EDITED
  in: WRONG_DOCUMENT_TYPE
  in: NON_FINAL
  in: OTHER

ProductLinkShape
type: NodeShape
target class: ProductLink
property:
  path: merchantCenter
  name: merchant center
  description: Immutable. Google Merchant Center link.
  write lifecycle: Create only
  node: MerchantCenterIdentifierShape
  class: MerchantCenterIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: advertisingPartnerProperties
  name: advertising partner properties
  description: Output only. Advertising Partner link properties. These properties are only applicable when the link is for an Advertising Partner.
  write lifecycle: Read only
  node: AdvertisingPartnerPropertiesShape
  class: AdvertisingPartnerProperties
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of the linked product.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: DATA_PARTNER
  in: GOOGLE_ADS
  in: HOTEL_CENTER
  in: MERCHANT_CENTER
  in: ADVERTISING_PARTNER
property:
  path: advertisingPartner
  name: advertising partner
  description: Output only. Advertising Partner link.
  write lifecycle: Read only
  node: AdvertisingPartnerIdentifierShape
  class: AdvertisingPartnerIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. Resource name of the product link. ProductLink resource names have the form: `customers/{customer_id}/productLinks/{product_link_id} `
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: productLinkId
  name: product link id
  description: Output only. The ID of the link. This field is read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: dataPartner
  name: data partner
  description: Immutable. Data partner link.
  write lifecycle: Create only
  node: DataPartnerIdentifierShape
  class: DataPartnerIdentifier
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: googleAds
  name: google ads
  description: Immutable. Google Ads link.
  write lifecycle: Create only
  node: GoogleAdsIdentifierShape
  class: GoogleAdsIdentifier
  node kind: BlankNodeOrIRI
  max count: 1

MerchantCenterIdentifierShape
type: NodeShape
target class: MerchantCenterIdentifier
property:
  path: merchantCenterId
  name: merchant center id
  description: Immutable. The customer ID of the Google Merchant Center account. This field is required and should not be empty when creating a new Merchant Center link. It is unable to be modified after the creation of the link.
  write lifecycle: Create only
  datatype: long
  max count: 1

SharedSetShape
type: NodeShape
target class: SharedSet
property:
  path: verticalAdsItemVerticalType
  name: vertical ads item vertical type
  description: Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are associated with a particular vertical (e.g. hotels, things to do, flights, etc.). This field is required for shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: HOTELS
  in: VACATION_RENTALS
  in: RENTAL_CARS
  in: EVENTS
  in: THINGS_TO_DO
  in: FLIGHTS
property:
  path: id
  name: id
  description: Output only. The ID of this shared set. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: The name of this shared set. Required. Shared Sets must have names that are unique among active shared sets of the same type. The length of this string should be between 1 and 255 UTF-8 bytes, inclusive.
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Output only. The status of this shared set. Read only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: REMOVED
property:
  path: memberCount
  name: member count
  description: Output only. The number of shared criteria within this shared set. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: type
  name: type
  description: Immutable. The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.
  write lifecycle: Create only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NEGATIVE_KEYWORDS
  in: NEGATIVE_PLACEMENTS
  in: ACCOUNT_LEVEL_NEGATIVE_KEYWORDS
  in: BRANDS
  in: WEBPAGES
  in: VERTICAL_ADS_ITEM_GROUP_RULE_LIST
  in: RETAIL_FILTER
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the shared set. Shared set resource names have the form: `customers/{customer_id}/sharedSets/{shared_set_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: referenceCount
  name: reference count
  description: Output only. The number of campaigns associated with this shared set. Read only.
  write lifecycle: Read only
  datatype: long
  max count: 1

UserListShape
type: NodeShape
target class: UserList
property:
  path: membershipLifeSpan
  name: membership life span
  description: Number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. This field is ignored for `logical_user_list` and `rule_based_user_list` types. Membership to lists of these types depends on the rules defined by the lists.
  datatype: long
  max count: 1
property:
  path: sizeForDisplay
  name: size for display
  description: Output only. Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
  write lifecycle: Create only
  datatype: string
  max count: 1
property:
  path: accountUserListStatus
  name: account user list status
  description: Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ENABLED
  in: DISABLED
property:
  path: accessReason
  name: access reason
  description: Output only. Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: OWNED
  in: SHARED
  in: LICENSED
  in: SUBSCRIBED
  in: AFFILIATED
property:
  path: sizeRangeForDisplay
  name: size range for display
  description: Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LESS_THAN_FIVE_HUNDRED
  in: LESS_THAN_ONE_THOUSAND
  in: ONE_THOUSAND_TO_TEN_THOUSAND
  in: TEN_THOUSAND_TO_FIFTY_THOUSAND
  in: FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND
  in: ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND
  in: THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND
  in: FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION
  in: ONE_MILLION_TO_TWO_MILLION
  in: TWO_MILLION_TO_THREE_MILLION
  in: THREE_MILLION_TO_FIVE_MILLION
  in: FIVE_MILLION_TO_TEN_MILLION
  in: TEN_MILLION_TO_TWENTY_MILLION
  in: TWENTY_MILLION_TO_THIRTY_MILLION
  in: THIRTY_MILLION_TO_FIFTY_MILLION
  in: OVER_FIFTY_MILLION
property:
  path: basicUserList
  name: basic user list
  description: User list targeting as a collection of conversion or remarketing actions.
  node: BasicUserListInfoShape
  class: BasicUserListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: id
  name: id
  description: Output only. Id of the user list.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: membershipStatus
  name: membership status
  description: Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: OPEN
  in: CLOSED
property:
  path: similarUserList
  name: similar user list
  description: Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
  write lifecycle: Read only
  node: SimilarUserListInfoShape
  class: SimilarUserListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  description: Description of this user list.
  datatype: string
  max count: 1
property:
  path: ruleBasedUserList
  name: rule based user list
  description: User list generated by a rule.
  node: RuleBasedUserListInfoShape
  class: RuleBasedUserListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: sizeRangeForSearch
  name: size range for search
  description: Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: LESS_THAN_FIVE_HUNDRED
  in: LESS_THAN_ONE_THOUSAND
  in: ONE_THOUSAND_TO_TEN_THOUSAND
  in: TEN_THOUSAND_TO_FIFTY_THOUSAND
  in: FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND
  in: ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND
  in: THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND
  in: FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION
  in: ONE_MILLION_TO_TWO_MILLION
  in: TWO_MILLION_TO_THREE_MILLION
  in: THREE_MILLION_TO_FIVE_MILLION
  in: FIVE_MILLION_TO_TEN_MILLION
  in: TEN_MILLION_TO_TWENTY_MILLION
  in: TWENTY_MILLION_TO_THIRTY_MILLION
  in: THIRTY_MILLION_TO_FIFTY_MILLION
  in: OVER_FIFTY_MILLION
property:
  path: integrationCode
  name: integration code
  description: An ID from external system. It is used by user list sellers to correlate IDs on their systems.
  datatype: string
  max count: 1
property:
  path: lookalikeUserList
  name: lookalike user list
  description: Immutable. Lookalike User List.
  write lifecycle: Create only
  node: LookalikeUserListInfoShape
  class: LookalikeUserListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: logicalUserList
  name: logical user list
  description: User list that is a custom combination of user lists and user interests.
  node: LogicalUserListInfoShape
  class: LogicalUserListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: crmBasedUserList
  name: crm based user list
  description: User list of CRM users provided by the advertiser.
  node: CrmBasedUserListInfoShape
  class: CrmBasedUserListInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. Type of this list. This field is read-only.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REMARKETING
  in: LOGICAL
  in: EXTERNAL_REMARKETING
  in: RULE_BASED
  in: SIMILAR
  in: CRM_BASED
  in: LOOKALIKE
property:
  path: eligibleForDisplay
  name: eligible for display
  description: Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: readOnly
  name: read only
  description: Output only. An option that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is read-only.
  write lifecycle: Read only
  datatype: boolean
  max count: 1

SimilarUserListInfoShape
type: NodeShape
target class: SimilarUserListInfo
property:
  path: seedUserList
  name: seed user list
  description: Seed UserList from which this list is derived.
  datatype: string
  max count: 1

RuleBasedUserListInfoShape
type: NodeShape
target class: RuleBasedUserListInfo
property:
  path: prepopulationStatus
  name: prepopulation status
  description: The status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: REQUESTED
  in: FINISHED
  in: FAILED
property:
  path: flexibleRuleUserList
  name: flexible rule user list
  description: Flexible rule representation of visitors with one or multiple actions. The flexible user list is defined by two lists of operands – inclusive_operands and exclusive_operands; each operand represents a set of users based on actions they took in a given timeframe. These lists of operands are combined with the AND_NOT operator, so that users represented by the inclusive operands are included in the user list, minus the users represented by the exclusive operands.
  class: FlexibleRuleUserListInfo
  node kind: BlankNodeOrIRI
  max count: 1

LookalikeUserListInfoShape
type: NodeShape
target class: LookalikeUserListInfo
property:
  path: countryCodes
  name: country codes
  description: Countries targeted by the Lookalike. Two-letter country code as defined by ISO-3166
  datatype: string
property:
  path: seedUserListIds
  name: seed user list ids
  description: Seed UserList ID from which this list is derived, provided by user.
  datatype: long
property:
  path: expansionLevel
  name: expansion level
  description: Expansion level, reflecting the size of the lookalike audience
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: NARROW
  in: BALANCED
  in: BROAD

LogicalUserListInfoShape
type: NodeShape
target class: LogicalUserListInfo
property:
  path: rules
  name: rules
  description: Logical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated. Required for creating a logical user list.
  node: UserListLogicalRuleInfoShape
  class: UserListLogicalRuleInfo
  node kind: BlankNodeOrIRI

UserListLogicalRuleInfoShape
type: NodeShape
target class: UserListLogicalRuleInfo
property:
  path: operator
  name: operator
  description: The logical operator of the rule.
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: ALL
  in: ANY
  in: NONE
property:
  path: ruleOperands
  name: rule operands
  description: The list of operands of the rule.
  node: LogicalUserListOperandInfoShape
  class: LogicalUserListOperandInfo
  node kind: BlankNodeOrIRI

LogicalUserListOperandInfoShape
type: NodeShape
target class: LogicalUserListOperandInfo
property:
  path: userList
  name: user list
  description: Resource name of a user list as an operand.
  datatype: string
  max count: 1

MobileAppCategoryConstantShape
type: NodeShape
target class: MobileAppCategoryConstant
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the mobile app category constant. Mobile app category constant resource names have the form: `mobileAppCategoryConstants/{mobile_app_category_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: id
  name: id
  description: Output only. The ID of the mobile app category constant.
  write lifecycle: Read only
  datatype: int
  max count: 1
property:
  path: name
  name: name
  description: Output only. Mobile app category name.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationShape
type: NodeShape
target class: Recommendation
property:
  path: shoppingAddGtinRecommendation
  name: shopping add gtin recommendation
  description: Output only. The shopping add GTIN recommendation.
  write lifecycle: Read only
  node: RecommendationShoppingOfferAttributeRecommendationShape
  class: RecommendationShoppingOfferAttributeRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: marginalRoiCampaignBudgetRecommendation
  name: marginal roi campaign budget recommendation
  description: Output only. The marginal ROI campaign budget recommendation.
  write lifecycle: Read only
  node: RecommendationCampaignBudgetRecommendationShape
  class: RecommendationCampaignBudgetRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: keywordMatchTypeRecommendation
  name: keyword match type recommendation
  description: Output only. The keyword match type recommendation.
  write lifecycle: Read only
  node: RecommendationKeywordMatchTypeRecommendationShape
  class: RecommendationKeywordMatchTypeRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: forecastingCampaignBudgetRecommendation
  name: forecasting campaign budget recommendation
  description: Output only. The forecasting campaign budget recommendation.
  write lifecycle: Read only
  node: RecommendationCampaignBudgetRecommendationShape
  class: RecommendationCampaignBudgetRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of recommendation.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: CAMPAIGN_BUDGET
  in: KEYWORD
  in: TEXT_AD
  in: TARGET_CPA_OPT_IN
  in: MAXIMIZE_CONVERSIONS_OPT_IN
  in: ENHANCED_CPC_OPT_IN
  in: SEARCH_PARTNERS_OPT_IN
  in: MAXIMIZE_CLICKS_OPT_IN
  in: OPTIMIZE_AD_ROTATION
  in: KEYWORD_MATCH_TYPE
  in: MOVE_UNUSED_BUDGET
  in: FORECASTING_CAMPAIGN_BUDGET
  in: TARGET_ROAS_OPT_IN
  in: RESPONSIVE_SEARCH_AD
  in: MARGINAL_ROI_CAMPAIGN_BUDGET
  in: USE_BROAD_MATCH_KEYWORD
  in: RESPONSIVE_SEARCH_AD_ASSET
  in: UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX
  in: RESPONSIVE_SEARCH_AD_IMPROVE_AD_STRENGTH
  in: DISPLAY_EXPANSION_OPT_IN
  in: UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX
  in: RAISE_TARGET_CPA_BID_TOO_LOW
  in: FORECASTING_SET_TARGET_ROAS
  in: CALLOUT_ASSET
  in: SITELINK_ASSET
  in: CALL_ASSET
  in: SHOPPING_ADD_AGE_GROUP
  in: SHOPPING_ADD_COLOR
  in: SHOPPING_ADD_GENDER
  in: SHOPPING_ADD_GTIN
  in: SHOPPING_ADD_MORE_IDENTIFIERS
  in: SHOPPING_ADD_SIZE
  in: SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN
  in: SHOPPING_FIX_DISAPPROVED_PRODUCTS
  in: SHOPPING_TARGET_ALL_OFFERS
  in: SHOPPING_FIX_SUSPENDED_MERCHANT_CENTER_ACCOUNT
  in: SHOPPING_FIX_MERCHANT_CENTER_ACCOUNT_SUSPENSION_WARNING
  in: SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX
  in: DYNAMIC_IMAGE_EXTENSION_OPT_IN
  in: RAISE_TARGET_CPA
  in: LOWER_TARGET_ROAS
  in: PERFORMANCE_MAX_OPT_IN
  in: IMPROVE_PERFORMANCE_MAX_AD_STRENGTH
  in: MIGRATE_DYNAMIC_SEARCH_ADS_CAMPAIGN_TO_PERFORMANCE_MAX
  in: FORECASTING_SET_TARGET_CPA
  in: SET_TARGET_CPA
  in: SET_TARGET_ROAS
  in: MAXIMIZE_CONVERSION_VALUE_OPT_IN
  in: IMPROVE_GOOGLE_TAG_COVERAGE
  in: PERFORMANCE_MAX_FINAL_URL_OPT_IN
  in: REFRESH_CUSTOMER_MATCH_LIST
  in: CUSTOM_AUDIENCE_OPT_IN
  in: LEAD_FORM_ASSET
  in: IMPROVE_DEMAND_GEN_AD_STRENGTH
property:
  path: shoppingAddSizeRecommendation
  name: shopping add size recommendation
  description: Output only. The shopping add size recommendation.
  write lifecycle: Read only
  node: RecommendationShoppingOfferAttributeRecommendationShape
  class: RecommendationShoppingOfferAttributeRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: forecastingSetTargetRoasRecommendation
  name: forecasting set target roas recommendation
  description: Output only. The forecasting set target ROAS recommendation.
  write lifecycle: Read only
  node: RecommendationForecastingSetTargetRoasRecommendationShape
  class: RecommendationForecastingSetTargetRoasRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: upgradeLocalCampaignToPerformanceMaxRecommendation
  name: upgrade local campaign to performance max recommendation
  description: Output only. The upgrade a Local campaign to a Performance Max campaign recommendation.
  write lifecycle: Read only
  node: RecommendationUpgradeLocalCampaignToPerformanceMaxRecommendationShape
  class: RecommendationUpgradeLocalCampaignToPerformanceMaxRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: keywordRecommendation
  name: keyword recommendation
  description: Output only. The keyword recommendation.
  write lifecycle: Read only
  node: RecommendationKeywordRecommendationShape
  class: RecommendationKeywordRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dynamicImageExtensionOptInRecommendation
  name: dynamic image extension opt in recommendation
  description: Output only. Recommendation to enable dynamic image extensions on the account, allowing Google to find the best images from ad landing pages and complement text ads.
  write lifecycle: Read only
  node: RecommendationDynamicImageExtensionOptInRecommendationShape
  class: RecommendationDynamicImageExtensionOptInRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: migrateDynamicSearchAdsCampaignToPerformanceMaxRecommendation
  name: migrate dynamic search ads campaign to performance max recommendation
  description: Output only. The Dynamic Search Ads to Performance Max migration recommendation.
  write lifecycle: Read only
  node: RecommendationMigrateDynamicSearchAdsCampaignToPerformanceMaxRecommendationShape
  class: RecommendationMigrateDynamicSearchAdsCampaignToPerformanceMaxRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: performanceMaxFinalUrlOptInRecommendation
  name: performance max final url opt in recommendation
  description: Output only. Recommendation to turn on Final URL expansion for your Performance Max campaigns.
  write lifecycle: Read only
  node: RecommendationPerformanceMaxFinalUrlOptInRecommendationShape
  class: RecommendationPerformanceMaxFinalUrlOptInRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: campaigns
  name: campaigns
  description: Output only. The campaigns targeted by this recommendation. This field will be set for the following recommendation types: CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET and MOVE_UNUSED_BUDGET
  write lifecycle: Read only
  datatype: string
property:
  path: setTargetRoasRecommendation
  name: set target roas recommendation
  description: Output only. The set target ROAS recommendation.
  write lifecycle: Read only
  node: RecommendationForecastingSetTargetRoasRecommendationShape
  class: RecommendationForecastingSetTargetRoasRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: responsiveSearchAdImproveAdStrengthRecommendation
  name: responsive search ad improve ad strength recommendation
  description: Output only. The responsive search ad improve ad strength recommendation.
  write lifecycle: Read only
  class: RecommendationResponsiveSearchAdImproveAdStrengthRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: lowerTargetRoasRecommendation
  name: lower target roas recommendation
  description: Output only. Recommendation to lower Target ROAS.
  write lifecycle: Read only
  node: RecommendationLowerTargetRoasRecommendationShape
  class: RecommendationLowerTargetRoasRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shoppingFixMerchantCenterAccountSuspensionWarningRecommendation
  name: shopping fix merchant center account suspension warning recommendation
  description: Output only. The shopping fix Merchant Center account suspension warning recommendation.
  write lifecycle: Read only
  node: RecommendationShoppingMerchantCenterAccountSuspensionRecommendationShape
  class: RecommendationShoppingMerchantCenterAccountSuspensionRecommendation
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationShoppingOfferAttributeRecommendationShape
type: NodeShape
target class: RecommendationShoppingOfferAttributeRecommendation
property:
  path: offersCount
  name: offers count
  description: Output only. The number of online, servable offers.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: merchant
  name: merchant
  description: Output only. The details of the Merchant Center account.
  write lifecycle: Read only
  node: RecommendationMerchantInfoShape
  class: RecommendationMerchantInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Output only. The campaign feed label.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: demotedOffersCount
  name: demoted offers count
  description: Output only. The number of online, servable offers that are demoted for missing attributes. Visit the Merchant Center for more details.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationMerchantInfoShape
type: NodeShape
target class: RecommendationMerchantInfo
property:
  path: id
  name: id
  description: Output only. The Merchant Center account ID.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name of the Merchant Center account.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: multiClient
  name: multi client
  description: Output only. Whether the Merchant Center account is a Multi-Client account (MCA).
  write lifecycle: Read only
  datatype: boolean
  max count: 1

RecommendationCampaignBudgetRecommendationShape
type: NodeShape
target class: RecommendationCampaignBudgetRecommendation
property:
  path: recommendedBudgetAmountMicros
  name: recommended budget amount micros
  description: Output only. The recommended budget amount in micros.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: budgetOptions
  name: budget options
  description: Output only. The budget amounts and associated impact estimates for some values of possible budget amounts.
  write lifecycle: Read only
  node: RecommendationCampaignBudgetRecommendationCampaignBudgetRecommendationOptionShape
  class: RecommendationCampaignBudgetRecommendationCampaignBudgetRecommendationOption
  node kind: BlankNodeOrIRI
property:
  path: currentBudgetAmountMicros
  name: current budget amount micros
  description: Output only. The current budget amount in micros.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationCampaignBudgetRecommendationCampaignBudgetRecommendationOptionShape
type: NodeShape
target class: RecommendationCampaignBudgetRecommendationCampaignBudgetRecommendationOption
property:
  path: budgetAmountMicros
  name: budget amount micros
  description: Output only. The budget amount for this option.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: impact
  name: impact
  description: Output only. The impact estimate if budget is changed to amount specified in this option.
  write lifecycle: Read only
  node: RecommendationRecommendationImpactShape
  class: RecommendationRecommendationImpact
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationRecommendationImpactShape
type: NodeShape
target class: RecommendationRecommendationImpact
property:
  path: baseMetrics
  name: base metrics
  description: Output only. Base metrics at the time the recommendation was generated.
  write lifecycle: Read only
  node: RecommendationRecommendationMetricsShape
  class: RecommendationRecommendationMetrics
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: potentialMetrics
  name: potential metrics
  description: Output only. Estimated metrics if the recommendation is applied.
  write lifecycle: Read only
  node: RecommendationRecommendationMetricsShape
  class: RecommendationRecommendationMetrics
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationRecommendationMetricsShape
type: NodeShape
target class: RecommendationRecommendationMetrics
property:
  path: impressions
  name: impressions
  description: Output only. Number of ad impressions.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: conversions
  name: conversions
  description: Output only. Number of conversions.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: clicks
  name: clicks
  description: Output only. Number of ad clicks.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: conversionsValue
  name: conversions value
  description: Output only. Sum of the conversion value of the conversions.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: costMicros
  name: cost micros
  description: Output only. Cost (in micros) for advertising, in the local currency for the account.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: videoViews
  name: video views
  description: Output only. Number of video views for a video ad campaign.
  write lifecycle: Read only
  datatype: double
  max count: 1

RecommendationKeywordMatchTypeRecommendationShape
type: NodeShape
target class: RecommendationKeywordMatchTypeRecommendation
property:
  path: keyword
  name: keyword
  description: Output only. The existing keyword where the match type should be more broad.
  write lifecycle: Read only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: recommendedMatchType
  name: recommended match type
  description: Output only. The recommended new match type.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: EXACT
  in: PHRASE
  in: BROAD

RecommendationForecastingSetTargetRoasRecommendationShape
type: NodeShape
target class: RecommendationForecastingSetTargetRoasRecommendation
property:
  path: campaignBudget
  name: campaign budget
  description: Output only. The campaign budget.
  write lifecycle: Read only
  node: RecommendationCampaignBudgetShape
  class: RecommendationCampaignBudget
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: recommendedTargetRoas
  name: recommended target roas
  description: Output only. The recommended target ROAS (revenue per unit of spend). The value is between 0.01 and 1000.0, inclusive.
  write lifecycle: Read only
  datatype: double
  max count: 1

RecommendationCampaignBudgetShape
type: NodeShape
target class: RecommendationCampaignBudget
property:
  path: newStartDate
  name: new start date
  description: Output only. The date when the new budget would start being used. This field will be set for the following recommendation types: FORECASTING_SET_TARGET_ROAS , FORECASTING_SET_TARGET_CPA YYYY-MM-DD format, for example, 2018-04-17.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: currentAmountMicros
  name: current amount micros
  description: Output only. Current budget amount.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: recommendedNewAmountMicros
  name: recommended new amount micros
  description: Output only. Recommended budget amount.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationKeywordRecommendationShape
type: NodeShape
target class: RecommendationKeywordRecommendation
property:
  path: searchTerms
  name: search terms
  description: Output only. A list of search terms this keyword matches. The same search term may be repeated for multiple keywords.
  write lifecycle: Read only
  node: RecommendationKeywordRecommendationSearchTermShape
  class: RecommendationKeywordRecommendationSearchTerm
  node kind: BlankNodeOrIRI
property:
  path: keyword
  name: keyword
  description: Output only. The recommended keyword.
  write lifecycle: Read only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: recommendedCpcBidMicros
  name: recommended cpc bid micros
  description: Output only. The recommended CPC (cost-per-click) bid.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationKeywordRecommendationSearchTermShape
type: NodeShape
target class: RecommendationKeywordRecommendationSearchTerm
property:
  path: text
  name: text
  description: Output only. The text of the search term.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: estimatedWeeklySearchCount
  name: estimated weekly search count
  description: Output only. Estimated number of historical weekly searches for this search term.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationMigrateDynamicSearchAdsCampaignToPerformanceMaxRecommendationShape
type: NodeShape
target class: RecommendationMigrateDynamicSearchAdsCampaignToPerformanceMaxRecommendation
property:
  path: applyLink
  name: apply link
  description: Output only. A link to the Google Ads UI where the customer can manually apply the recommendation.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationResponsiveSearchAdImproveAdStrengthRecommendationShape
type: NodeShape
target class: RecommendationResponsiveSearchAdImproveAdStrengthRecommendation
property:
  path: currentAd
  name: current ad
  description: Output only. The current ad to be updated.
  write lifecycle: Read only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: recommendedAd
  name: recommended ad
  description: Output only. The updated ad.
  write lifecycle: Read only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationLowerTargetRoasRecommendationShape
type: NodeShape
target class: RecommendationLowerTargetRoasRecommendation
property:
  path: targetAdjustment
  name: target adjustment
  description: Output only. The relevant information describing the recommended target adjustment.
  write lifecycle: Read only
  node: RecommendationTargetAdjustmentInfoShape
  class: RecommendationTargetAdjustmentInfo
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationTargetAdjustmentInfoShape
type: NodeShape
target class: RecommendationTargetAdjustmentInfo
property:
  path: currentAverageTargetMicros
  name: current average target micros
  description: Output only. The current average target of the campaign or portfolio targeted by this recommendation.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: recommendedTargetMultiplier
  name: recommended target multiplier
  description: Output only. The factor by which we recommend the target to be adjusted by.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: sharedSet
  name: shared set
  description: Output only. The shared set resource name of the portfolio bidding strategy where the target is defined. Only populated if the recommendation is portfolio level.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationShoppingMerchantCenterAccountSuspensionRecommendationShape
type: NodeShape
target class: RecommendationShoppingMerchantCenterAccountSuspensionRecommendation
property:
  path: merchant
  name: merchant
  description: Output only. The details of the Merchant Center account.
  write lifecycle: Read only
  node: RecommendationMerchantInfoShape
  class: RecommendationMerchantInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Output only. The feed label of the campaign for which the suspension happened.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationTextAdRecommendationShape
type: NodeShape
target class: RecommendationTextAdRecommendation
property:
  path: creationDate
  name: creation date
  description: Output only. Creation date of the recommended ad. YYYY-MM-DD format, for example, 2018-04-17.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: autoApplyDate
  name: auto apply date
  description: Output only. Date, if present, is the earliest when the recommendation will be auto applied. YYYY-MM-DD format, for example, 2018-04-17.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: ad
  name: ad
  description: Output only. Recommended ad.
  write lifecycle: Read only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationTargetCpaOptInRecommendationShape
type: NodeShape
target class: RecommendationTargetCpaOptInRecommendation
property:
  path: options
  name: options
  description: Output only. The available goals and corresponding options for Target CPA strategy.
  write lifecycle: Read only
  node: RecommendationTargetCpaOptInRecommendationTargetCpaOptInRecommendationOptionShape
  class: RecommendationTargetCpaOptInRecommendationTargetCpaOptInRecommendationOption
  node kind: BlankNodeOrIRI
property:
  path: recommendedTargetCpaMicros
  name: recommended target cpa micros
  description: Output only. The recommended average CPA target. See required budget amount and impact of using this recommendation in options list.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationTargetCpaOptInRecommendationTargetCpaOptInRecommendationOptionShape
type: NodeShape
target class: RecommendationTargetCpaOptInRecommendationTargetCpaOptInRecommendationOption
property:
  path: impact
  name: impact
  description: Output only. The impact estimate if this option is selected.
  write lifecycle: Read only
  node: RecommendationRecommendationImpactShape
  class: RecommendationRecommendationImpact
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: goal
  name: goal
  description: Output only. The goal achieved by this option.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: SAME_COST
  in: SAME_CONVERSIONS
  in: SAME_CPA
  in: CLOSEST_CPA
property:
  path: targetCpaMicros
  name: target cpa micros
  description: Output only. Average CPA target.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: requiredCampaignBudgetAmountMicros
  name: required campaign budget amount micros
  description: Output only. The minimum campaign budget, in local currency for the account, required to achieve the target CPA. Amount is specified in micros, where one million is equivalent to one currency unit.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationImprovePerformanceMaxAdStrengthRecommendationShape
type: NodeShape
target class: RecommendationImprovePerformanceMaxAdStrengthRecommendation
property:
  path: assetGroup
  name: asset group
  description: Output only. The asset group resource name.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: adStrength
  name: ad strength
  description: Output only. The current ad strength score of the asset group.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: NO_ADS
  in: POOR
  in: AVERAGE
  in: GOOD
  in: EXCELLENT

RecommendationForecastingSetTargetCpaRecommendationShape
type: NodeShape
target class: RecommendationForecastingSetTargetCpaRecommendation
property:
  path: recommendedTargetCpaMicros
  name: recommended target cpa micros
  description: Output only. The recommended target CPA.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: campaignBudget
  name: campaign budget
  description: Output only. The campaign budget.
  write lifecycle: Read only
  node: RecommendationCampaignBudgetShape
  class: RecommendationCampaignBudget
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationMaximizeClicksOptInRecommendationShape
type: NodeShape
target class: RecommendationMaximizeClicksOptInRecommendation
property:
  path: recommendedBudgetAmountMicros
  name: recommended budget amount micros
  description: Output only. The recommended new budget amount. Only set if the current budget is too high.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationShoppingTargetAllOffersRecommendationShape
type: NodeShape
target class: RecommendationShoppingTargetAllOffersRecommendation
property:
  path: merchant
  name: merchant
  description: Output only. The details of the Merchant Center account.
  write lifecycle: Read only
  node: RecommendationMerchantInfoShape
  class: RecommendationMerchantInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: untargetedOffersCount
  name: untargeted offers count
  description: Output only. The number of untargeted offers.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Output only. The offer feed label.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationImproveDemandGenAdStrengthRecommendationShape
type: NodeShape
target class: RecommendationImproveDemandGenAdStrengthRecommendation
property:
  path: adStrength
  name: ad strength
  description: Output only. The current ad strength.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: PENDING
  in: NO_ADS
  in: POOR
  in: AVERAGE
  in: GOOD
  in: EXCELLENT
property:
  path: demandGenAssetActionItems
  name: demand gen asset action items
  description: Output only. A list of recommendations to improve the ad strength.
  write lifecycle: Read only
  datatype: string
property:
  path: ad
  name: ad
  description: Output only. The resource name of the ad that can be improved.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationResponsiveSearchAdAssetRecommendationShape
type: NodeShape
target class: RecommendationResponsiveSearchAdAssetRecommendation
property:
  path: recommendedAssets
  name: recommended assets
  description: Output only. The recommended assets. This is populated only with the new headlines and/or descriptions, and is otherwise empty.
  write lifecycle: Read only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: currentAd
  name: current ad
  description: Output only. The current ad to be updated.
  write lifecycle: Read only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1

RecommendationRaiseTargetCpaBidTooLowRecommendationShape
type: NodeShape
target class: RecommendationRaiseTargetCpaBidTooLowRecommendation
property:
  path: averageTargetCpaMicros
  name: average target cpa micros
  description: Output only. The current average target CPA of the campaign, in micros of customer local currency.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: recommendedTargetMultiplier
  name: recommended target multiplier
  description: Output only. A number greater than 1.0 indicating the factor by which we recommend the target CPA should be increased.
  write lifecycle: Read only
  datatype: double
  max count: 1

RecommendationMoveUnusedBudgetRecommendationShape
type: NodeShape
target class: RecommendationMoveUnusedBudgetRecommendation
property:
  path: budgetRecommendation
  name: budget recommendation
  description: Output only. The recommendation for the constrained budget to increase.
  write lifecycle: Read only
  node: RecommendationCampaignBudgetRecommendationShape
  class: RecommendationCampaignBudgetRecommendation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: excessCampaignBudget
  name: excess campaign budget
  description: Output only. The excess budget's resource_name.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationUseBroadMatchKeywordRecommendationShape
type: NodeShape
target class: RecommendationUseBroadMatchKeywordRecommendation
property:
  path: keyword
  name: keyword
  description: Output only. Sample of keywords to be expanded to Broad Match.
  write lifecycle: Read only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI
property:
  path: campaignUsesSharedBudget
  name: campaign uses shared budget
  description: Output only. Whether the associated campaign uses a shared budget.
  write lifecycle: Read only
  datatype: boolean
  max count: 1
property:
  path: campaignKeywordsCount
  name: campaign keywords count
  description: Output only. Total number of keywords in the campaign.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: suggestedKeywordsCount
  name: suggested keywords count
  description: Output only. Total number of keywords to be expanded to Broad Match in the campaign.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: requiredCampaignBudgetAmountMicros
  name: required campaign budget amount micros
  description: Output only. The budget recommended to avoid becoming budget constrained after applying the recommendation.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationShoppingFixDisapprovedProductsRecommendationShape
type: NodeShape
target class: RecommendationShoppingFixDisapprovedProductsRecommendation
property:
  path: productsCount
  name: products count
  description: Output only. The number of products of the campaign.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: merchant
  name: merchant
  description: Output only. The details of the Merchant Center account.
  write lifecycle: Read only
  node: RecommendationMerchantInfoShape
  class: RecommendationMerchantInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Output only. The feed label for the campaign.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: disapprovedProductsCount
  name: disapproved products count
  description: Output only. The numbers of products of the campaign that are disapproved.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationShoppingAddProductsToCampaignRecommendationShape
type: NodeShape
target class: RecommendationShoppingAddProductsToCampaignRecommendation
property:
  path: reason
  name: reason
  description: Output only. The reason why no products are attached to the campaign.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MERCHANT_CENTER_ACCOUNT_HAS_NO_SUBMITTED_PRODUCTS
  in: MERCHANT_CENTER_ACCOUNT_HAS_NO_SUBMITTED_PRODUCTS_IN_FEED
  in: ADS_ACCOUNT_EXCLUDES_OFFERS_FROM_CAMPAIGN
  in: ALL_PRODUCTS_ARE_EXCLUDED_FROM_CAMPAIGN
property:
  path: merchant
  name: merchant
  description: Output only. The details of the Merchant Center account.
  write lifecycle: Read only
  node: RecommendationMerchantInfoShape
  class: RecommendationMerchantInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Output only. The feed label for the campaign.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationRefreshCustomerMatchListRecommendationShape
type: NodeShape
target class: RecommendationRefreshCustomerMatchListRecommendation
property:
  path: targetingAccountsCount
  name: targeting accounts count
  description: Output only. User lists can be shared with other accounts by the owner. targeting_accounts_count is the number of those accounts that can use it for targeting.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: topSpendingAccount
  name: top spending account
  description: Output only. The top spending account.
  write lifecycle: Read only
  node: RecommendationAccountInfoShape
  class: RecommendationAccountInfo
  node kind: BlankNodeOrIRI
property:
  path: userListId
  name: user list id
  description: Output only. The user list ID.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: daysSinceLastRefresh
  name: days since last refresh
  description: Output only. Days since last refresh.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: ownerAccount
  name: owner account
  description: Output only. The owner account. This is the account that should update the customer list.
  write lifecycle: Read only
  node: RecommendationAccountInfoShape
  class: RecommendationAccountInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: userListName
  name: user list name
  description: Output only. The name of the list.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationAccountInfoShape
type: NodeShape
target class: RecommendationAccountInfo
property:
  path: customerId
  name: customer id
  description: Output only. The customer ID of the account.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: descriptiveName
  name: descriptive name
  description: Output only. The descriptive name of the account.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationUpgradeSmartShoppingCampaignToPerformanceMaxRecommendationShape
type: NodeShape
target class: RecommendationUpgradeSmartShoppingCampaignToPerformanceMaxRecommendation
property:
  path: merchantId
  name: merchant id
  description: Output only. ID of Merchant Center account.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: salesCountryCode
  name: sales country code
  description: Output only. Country whose products from merchant's inventory should be included.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationMaximizeConversionsOptInRecommendationShape
type: NodeShape
target class: RecommendationMaximizeConversionsOptInRecommendation
property:
  path: recommendedBudgetAmountMicros
  name: recommended budget amount micros
  description: Output only. The recommended new budget amount.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationSitelinkAssetRecommendationShape
type: NodeShape
target class: RecommendationSitelinkAssetRecommendation
property:
  path: recommendedCampaignSitelinkAssets
  name: recommended campaign sitelink assets
  description: Output only. New sitelink assets recommended at the campaign level.
  write lifecycle: Read only
  class: Asset
  node kind: BlankNodeOrIRI
property:
  path: recommendedCustomerSitelinkAssets
  name: recommended customer sitelink assets
  description: Output only. New sitelink assets recommended at the customer level.
  write lifecycle: Read only
  class: Asset
  node kind: BlankNodeOrIRI

RecommendationCustomAudienceOptInRecommendationShape
type: NodeShape
target class: RecommendationCustomAudienceOptInRecommendation
property:
  path: keywords
  name: keywords
  description: Output only. The list of keywords to use for custom audience creation.
  write lifecycle: Read only
  node: KeywordInfoShape
  class: KeywordInfo
  node kind: BlankNodeOrIRI

RecommendationCalloutAssetRecommendationShape
type: NodeShape
target class: RecommendationCalloutAssetRecommendation
property:
  path: recommendedCampaignCalloutAssets
  name: recommended campaign callout assets
  description: Output only. New callout extension assets recommended at the campaign level.
  write lifecycle: Read only
  class: Asset
  node kind: BlankNodeOrIRI
property:
  path: recommendedCustomerCalloutAssets
  name: recommended customer callout assets
  description: Output only. New callout extension assets recommended at the customer level.
  write lifecycle: Read only
  class: Asset
  node kind: BlankNodeOrIRI

RecommendationShoppingMigrateRegularShoppingCampaignOffersToPerformanceMaxRecommendationShape
type: NodeShape
target class: RecommendationShoppingMigrateRegularShoppingCampaignOffersToPerformanceMaxRecommendation
property:
  path: merchant
  name: merchant
  description: Output only. The details of the Merchant Center account.
  write lifecycle: Read only
  node: RecommendationMerchantInfoShape
  class: RecommendationMerchantInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: feedLabel
  name: feed label
  description: Output only. The feed label of the offers targeted by the campaigns sharing this suggestion.
  write lifecycle: Read only
  datatype: string
  max count: 1

RecommendationRaiseTargetCpaRecommendationShape
type: NodeShape
target class: RecommendationRaiseTargetCpaRecommendation
property:
  path: targetAdjustment
  name: target adjustment
  description: Output only. The relevant information describing the recommended target adjustment.
  write lifecycle: Read only
  node: RecommendationTargetAdjustmentInfoShape
  class: RecommendationTargetAdjustmentInfo
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: appBiddingGoal
  name: app bidding goal
  description: Output only. Represents the goal towards which the bidding strategy should optimize. Only populated for App Campaigns.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: OPTIMIZE_FOR_INSTALL_CONVERSION_VOLUME
  in: OPTIMIZE_FOR_IN_APP_CONVERSION_VOLUME
  in: OPTIMIZE_FOR_TOTAL_CONVERSION_VALUE
  in: OPTIMIZE_FOR_TARGET_IN_APP_CONVERSION
  in: OPTIMIZE_FOR_RETURN_ON_ADVERTISING_SPEND
  in: OPTIMIZE_FOR_INSTALL_CONVERSION_VOLUME_WITHOUT_TARGET_CPI
  in: OPTIMIZE_FOR_PRE_REGISTRATION_CONVERSION_VOLUME

RecommendationTargetRoasOptInRecommendationShape
type: NodeShape
target class: RecommendationTargetRoasOptInRecommendation
property:
  path: recommendedTargetRoas
  name: recommended target roas
  description: Output only. The recommended target ROAS (revenue per unit of spend). The value is between 0.01 and 1000.0, inclusive.
  write lifecycle: Read only
  datatype: double
  max count: 1
property:
  path: requiredCampaignBudgetAmountMicros
  name: required campaign budget amount micros
  description: Output only. The minimum campaign budget, in local currency for the account, required to achieve the target ROAS. Amount is specified in micros, where one million is equivalent to one currency unit.
  write lifecycle: Read only
  datatype: long
  max count: 1

RecommendationResponsiveSearchAdRecommendationShape
type: NodeShape
target class: RecommendationResponsiveSearchAdRecommendation
property:
  path: ad
  name: ad
  description: Output only. Recommended ad.
  write lifecycle: Read only
  node: AdShape
  class: Ad
  node kind: BlankNodeOrIRI
  max count: 1

PerStoreViewShape
type: NodeShape
target class: PerStoreView
property:
  path: postalCode
  name: postal code
  description: Output only. The postal code of the store's address.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the per store view. Per Store view resource names have the form: `customers/{customer_id}/perStoreViews/{place_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: address1
  name: address1
  description: Output only. First line of the store's address.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: city
  name: city
  description: Output only. The city where the store is located.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: province
  name: province
  description: Output only. The province or state of the store's address.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: businessName
  name: business name
  description: Output only. The name of the business.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: countryCode
  name: country code
  description: Output only. The two-letter country code for the store's location (e.g., "US").
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: phoneNumber
  name: phone number
  description: Output only. The phone number of the store.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: placeId
  name: place id
  description: Output only. The place ID of the per store view.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: address2
  name: address2
  description: Output only. Second line of the store's address.
  write lifecycle: Read only
  datatype: string
  max count: 1

TargetingExpansionViewShape
type: NodeShape
target class: TargetingExpansionView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the targeting expansion view. Targeting expansion view resource names have the form: `customers/{customer_id}/targetingExpansionViews/{campaign_id}~{targeting_expansion_type}`
  write lifecycle: Read only
  datatype: string
  max count: 1

MobileDeviceConstantShape
type: NodeShape
target class: MobileDeviceConstant
property:
  path: operatingSystemName
  name: operating system name
  description: Output only. The operating system of the mobile device.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the mobile device constant. Mobile device constant resource names have the form: `mobileDeviceConstants/{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Output only. The type of mobile device.
  write lifecycle: Read only
  datatype: string
  max count: 1
  in: UNSPECIFIED
  in: UNKNOWN
  in: MOBILE
  in: TABLET
property:
  path: id
  name: id
  description: Output only. The ID of the mobile device constant.
  write lifecycle: Read only
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Output only. The name of the mobile device.
  write lifecycle: Read only
  datatype: string
  max count: 1
property:
  path: manufacturerName
  name: manufacturer name
  description: Output only. The manufacturer of the mobile device.
  write lifecycle: Read only
  datatype: string
  max count: 1

ShoppingPerformanceViewShape
type: NodeShape
target class: ShoppingPerformanceView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView`
  write lifecycle: Read only
  datatype: string
  max count: 1

LocationViewShape
type: NodeShape
target class: LocationView
property:
  path: resourceName
  name: resource name
  description: Output only. The resource name of the location view. Location view resource names have the form: `customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}`
  write lifecycle: Read only
  datatype: string
  max count: 1

path: hotelAd
name: hotel ad
description: Details pertaining to a hotel ad.
node: HotelAdInfoShape
class: HotelAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: demandGenProductAd
name: demand gen product ad
description: Details pertaining to a Demand Gen product ad.
node: DemandGenProductAdInfoShape
class: DemandGenProductAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: syntheticContentInfo
name: synthetic content info
description: Synthetic content info for the ad.
node: SyntheticContentInfoShape
class: SyntheticContentInfo
node kind: BlankNodeOrIRI
max count: 1

path: videoResponsiveAd
name: video responsive ad
description: Details pertaining to a Video responsive ad.
node: VideoResponsiveAdInfoShape
class: VideoResponsiveAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: urlCollections
name: url collections
description: Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
node: UrlCollectionShape
class: UrlCollection
node kind: BlankNodeOrIRI

path: appPreRegistrationAd
name: app pre registration ad
description: Details pertaining to an app pre-registration ad.
node: AppPreRegistrationAdInfoShape
class: AppPreRegistrationAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: trackingUrlTemplate
name: tracking url template
description: The URL template for constructing a tracking URL.
datatype: string
max count: 1

path: legacyResponsiveDisplayAd
name: legacy responsive display ad
description: Details pertaining to a legacy responsive display ad.
node: LegacyResponsiveDisplayAdInfoShape
class: LegacyResponsiveDisplayAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: appAd
name: app ad
description: Details pertaining to an app ad.
node: AppAdInfoShape
class: AppAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: travelAd
name: travel ad
description: Details pertaining to a travel ad.
node: TravelAdInfoShape
class: TravelAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: expandedDynamicSearchAd
name: expanded dynamic search ad
description: Immutable. Details pertaining to an Expanded Dynamic Search Ad. This type of ad has its headline, final URLs, and display URL auto-generated at serving time according to domain name specific information provided by `dynamic_search_ads_setting` linked at the campaign level.
write lifecycle: Create only
node: ExpandedDynamicSearchAdInfoShape
class: ExpandedDynamicSearchAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: finalAppUrls
name: final app urls
description: A list of final app URLs that will be used on mobile if the user has the specific app installed.
node: FinalAppUrlShape
class: FinalAppUrl
node kind: BlankNodeOrIRI

path: finalUrlSuffix
name: final url suffix
description: The suffix to use when constructing a final URL.
datatype: string
max count: 1

path: textAd
name: text ad
description: Immutable. Details pertaining to a text ad.
write lifecycle: Create only
node: TextAdInfoShape
class: TextAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: finalUrls
name: final urls
description: The list of possible final URLs after all cross-domain redirects for the ad.
datatype: string

path: localAd
name: local ad
description: Details pertaining to a local ad.
node: LocalAdInfoShape
class: LocalAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: expandedTextAd
name: expanded text ad
description: Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead.
node: ExpandedTextAdInfoShape
class: ExpandedTextAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: finalMobileUrls
name: final mobile urls
description: The list of possible final mobile URLs after all cross-domain redirects for the ad.
datatype: string

path: shoppingProductAd
name: shopping product ad
description: Details pertaining to a Shopping product ad.
node: ShoppingProductAdInfoShape
class: ShoppingProductAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: responsiveDisplayAd
name: responsive display ad
description: Details pertaining to a responsive display ad.
node: ResponsiveDisplayAdInfoShape
class: ResponsiveDisplayAdInfo
node kind: BlankNodeOrIRI
max count: 1

path: effectiveTargetRoas
name: effective target roas
description: Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.
write lifecycle: Read only
datatype: double
max count: 1

path: excludedParentAssetSetTypes
name: excluded parent asset set types
description: The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
datatype: string
in: UNSPECIFIED
in: UNKNOWN
in: PAGE_FEED
in: DYNAMIC_EDUCATION
in: MERCHANT_CENTER_FEED
in: DYNAMIC_REAL_ESTATE
in: DYNAMIC_CUSTOM
in: DYNAMIC_HOTELS_AND_RENTALS
in: DYNAMIC_FLIGHTS
in: DYNAMIC_TRAVEL
in: DYNAMIC_LOCAL
in: DYNAMIC_JOBS
in: LOCATION_SYNC
in: BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP
in: CHAIN_DYNAMIC_LOCATION_GROUP
in: STATIC_LOCATION_GROUP
in: HOTEL_PROPERTY
in: TRAVEL_FEED

path: status
name: status
description: The status of the ad group.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ENABLED
in: PAUSED
in: REMOVED

path: targetingSetting
name: targeting setting
description: Setting for targeting related features.
node: TargetingSettingShape
class: TargetingSetting
node kind: BlankNodeOrIRI
max count: 1

path: cpvBidMicros
name: cpv bid micros
description: The CPV (cost-per-view) bid.
datatype: long
max count: 1

path: targetCpvMicros
name: target cpv micros
description: Average amount in micros that the advertiser is willing to pay for every ad view.
datatype: long
max count: 1

path: displayCustomBidDimension
name: display custom bid dimension
description: Lets advertisers specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: KEYWORD
in: AUDIENCE
in: TOPIC
in: GENDER
in: AGE_RANGE
in: PLACEMENT
in: PARENTAL_STATUS
in: INCOME_RANGE

path: videoAdGroupSettings
name: video ad group settings
description: Settings for video ad groups.
node: AdGroupVideoAdGroupSettingsShape
class: AdGroupVideoAdGroupSettings
node kind: BlankNodeOrIRI
max count: 1

path: baseAdGroup
name: base ad group
description: Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
write lifecycle: Read only
datatype: string
max count: 1

path: resourceName
name: resource name
description: Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
write lifecycle: Create only
datatype: string
max count: 1

path: percentCpcBidMicros
name: percent cpc bid micros
description: The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
datatype: long
max count: 1

path: cpcBidMicros
name: cpc bid micros
description: The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy.
datatype: long
max count: 1

path: cpmBidMicros
name: cpm bid micros
description: The maximum CPM (cost-per-thousand viewable impressions) bid.
datatype: long
max count: 1

path: audienceSetting
name: audience setting
description: Immutable. Setting for audience related features.
write lifecycle: Create only
node: AdGroupAudienceSettingShape
class: AdGroupAudienceSetting
node kind: BlankNodeOrIRI
max count: 1

path: effectiveTargetCpaMicros
name: effective target cpa micros
description: Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
write lifecycle: Read only
datatype: long
max count: 1

path: effectiveTargetCpcSource
name: effective target cpc source
description: Output only. Source of the effective target CPC. This field is read-only.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: CAMPAIGN_BIDDING_STRATEGY
in: AD_GROUP
in: AD_GROUP_CRITERION

path: demandGenAdGroupSettings
name: demand gen ad group settings
description: Settings for Demand Gen ad groups.
node: AdGroupDemandGenAdGroupSettingsShape
class: AdGroupDemandGenAdGroupSettings
node kind: BlankNodeOrIRI
max count: 1

path: urlCustomParameters
name: url custom parameters
description: The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
node: CustomParameterShape
class: CustomParameter
node kind: BlankNodeOrIRI

path: campaign
name: campaign
description: Immutable. The campaign to which the ad group belongs.
write lifecycle: Create only
datatype: string
max count: 1

path: effectiveTargetCpc
name: effective target cpc
description: Output only. The effective target CPC (cost-per-click). This field is read-only.
write lifecycle: Read only
datatype: long
max count: 1

path: verticalAdsFormatSetting
name: vertical ads format setting
description: Vertical ads setting feature to enable/disable ad group format controls in search campaigns. This setting requires AiMaxAdGroupSetting to be enabled and a travel feed to be attached to the campaign.
node: AdGroupVerticalAdsFormatSettingShape
class: AdGroupVerticalAdsFormatSetting
node kind: BlankNodeOrIRI
max count: 1

path: id
name: id
description: Output only. The ID of the ad group.
write lifecycle: Read only
datatype: long
max count: 1

path: appPaymentModel
name: app payment model
description: Immutable. App Payment Model.
write lifecycle: Create only
node: AppPaymentModelInfoShape
class: AppPaymentModelInfo
node kind: BlankNodeOrIRI
max count: 1

path: customIntent
name: custom intent
description: Immutable. Custom Intent.
write lifecycle: Create only
node: CustomIntentInfoShape
class: CustomIntentInfo
node kind: BlankNodeOrIRI
max count: 1

path: customAudience
name: custom audience
description: Immutable. Custom Audience.
write lifecycle: Create only
node: CustomAudienceInfoShape
class: CustomAudienceInfo
node kind: BlankNodeOrIRI
max count: 1

path: status
name: status
description: The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ENABLED
in: PAUSED
in: REMOVED

path: effectiveCpmBidSource
name: effective cpm bid source
description: Output only. Source of the effective CPM bid.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: CAMPAIGN_BIDDING_STRATEGY
in: AD_GROUP
in: AD_GROUP_CRITERION

path: effectiveCpvBidMicros
name: effective cpv bid micros
description: Output only. The effective CPV (cost-per-view) bid.
write lifecycle: Read only
datatype: long
max count: 1

path: youtubeChannel
name: youtube channel
description: Immutable. YouTube Channel.
write lifecycle: Create only
node: YouTubeChannelInfoShape
class: YouTubeChannelInfo
node kind: BlankNodeOrIRI
max count: 1

path: webpage
name: webpage
description: Immutable. Webpage
write lifecycle: Create only
node: WebpageInfoShape
class: WebpageInfo
node kind: BlankNodeOrIRI
max count: 1

path: criterionId
name: criterion id
description: Output only. The ID of the criterion. This field is ignored for mutates.
write lifecycle: Read only
datatype: long
max count: 1

path: percentCpcBidMicros
name: percent cpc bid micros
description: The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
datatype: long
max count: 1

path: systemServingStatus
name: system serving status
description: Output only. Serving status of the criterion.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ELIGIBLE
in: RARELY_SERVED

path: youtubeVideo
name: youtube video
description: Immutable. YouTube Video.
write lifecycle: Create only
node: YouTubeVideoInfoShape
class: YouTubeVideoInfo
node kind: BlankNodeOrIRI
max count: 1

path: approvalStatus
name: approval status
description: Output only. Approval status of the criterion.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: APPROVED
in: DISAPPROVED
in: PENDING_REVIEW
in: UNDER_REVIEW

path: audience
name: audience
description: Immutable. Audience.
write lifecycle: Create only
node: AudienceInfoShape
class: AudienceInfo
node kind: BlankNodeOrIRI
max count: 1

path: negative
name: negative
description: Immutable. Whether to target (`false`) or exclude (`true`) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.
write lifecycle: Create only
datatype: boolean
max count: 1

path: gender
name: gender
description: Immutable. Gender.
write lifecycle: Create only
node: GenderInfoShape
class: GenderInfo
node kind: BlankNodeOrIRI
max count: 1

path: incomeRange
name: income range
description: Immutable. Income range.
write lifecycle: Create only
node: IncomeRangeInfoShape
class: IncomeRangeInfo
node kind: BlankNodeOrIRI
max count: 1

path: urlCustomParameters
name: url custom parameters
description: The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
node: CustomParameterShape
class: CustomParameter
node kind: BlankNodeOrIRI

path: combinedAudience
name: combined audience
description: Immutable. Combined Audience.
write lifecycle: Create only
node: CombinedAudienceInfoShape
class: CombinedAudienceInfo
node kind: BlankNodeOrIRI
max count: 1

path: bidModifier
name: bid modifier
description: The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
datatype: double
max count: 1

path: finalUrlSuffix
name: final url suffix
description: URL template for appending params to final URL.
datatype: string
max count: 1

path: lifeEvent
name: life event
description: Immutable. Life event campaign criterion.
write lifecycle: Create only
node: LifeEventInfoShape
class: LifeEventInfo
node kind: BlankNodeOrIRI
max count: 1

path: primaryStatus
name: primary status
description: Output only. The primary status for the ad group criterion.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ELIGIBLE
in: PAUSED
in: REMOVED
in: PENDING
in: NOT_ELIGIBLE

path: placement
name: placement
description: Immutable. Placement.
write lifecycle: Create only
node: PlacementInfoShape
class: PlacementInfo
node kind: BlankNodeOrIRI
max count: 1

path: parentalStatus
name: parental status
description: Immutable. Parental status.
write lifecycle: Create only
node: ParentalStatusInfoShape
class: ParentalStatusInfo
node kind: BlankNodeOrIRI
max count: 1

path: retailFilterBundle
name: retail filter bundle
description: Immutable. Retail Filter Bundle.
write lifecycle: Create only
node: RetailFilterBundleShape
class: RetailFilterBundle
node kind: BlankNodeOrIRI
max count: 1

path: userInterest
name: user interest
description: Immutable. User Interest.
write lifecycle: Create only
node: UserInterestInfoShape
class: UserInterestInfo
node kind: BlankNodeOrIRI
max count: 1

path: positionEstimates
name: position estimates
description: Output only. Estimates for criterion bids at various positions.
write lifecycle: Read only
node: AdGroupCriterionPositionEstimatesShape
class: AdGroupCriterionPositionEstimates
node kind: BlankNodeOrIRI
max count: 1

path: location
name: location
description: Immutable. Location.
write lifecycle: Create only
node: LocationInfoShape
class: LocationInfo
node kind: BlankNodeOrIRI
max count: 1

path: effectivePercentCpcBidMicros
name: effective percent cpc bid micros
description: Output only. The effective Percent CPC bid amount.
write lifecycle: Read only
datatype: long
max count: 1

path: finalUrls
name: final urls
description: The list of possible final URLs after all cross-domain redirects for the ad.
datatype: string

path: effectiveCpmBidMicros
name: effective cpm bid micros
description: Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
write lifecycle: Read only
datatype: long
max count: 1

path: customAffinity
name: custom affinity
description: Immutable. Custom Affinity.
write lifecycle: Create only
node: CustomAffinityInfoShape
class: CustomAffinityInfo
node kind: BlankNodeOrIRI
max count: 1

path: verticalAdsItemGroupRuleList
name: vertical ads item group rule list
description: Immutable. Vertical ads item group rule list criterion.
write lifecycle: Create only
node: VerticalAdsItemGroupRuleListInfoShape
class: VerticalAdsItemGroupRuleListInfo
node kind: BlankNodeOrIRI
max count: 1

path: videoLineup
name: video lineup
description: Immutable. Video lineup criterion.
write lifecycle: Create only
node: VideoLineupInfoShape
class: VideoLineupInfo
node kind: BlankNodeOrIRI
max count: 1

path: effectiveCpcBidMicros
name: effective cpc bid micros
description: Output only. The effective CPC (cost-per-click) bid.
write lifecycle: Read only
datatype: long
max count: 1

path: type
name: type
description: Output only. The type of the criterion.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: KEYWORD
in: PLACEMENT
in: MOBILE_APP_CATEGORY
in: MOBILE_APPLICATION
in: DEVICE
in: LOCATION
in: LISTING_GROUP
in: AD_SCHEDULE
in: AGE_RANGE
in: GENDER
in: INCOME_RANGE
in: PARENTAL_STATUS
in: YOUTUBE_VIDEO
in: YOUTUBE_CHANNEL
in: USER_LIST
in: PROXIMITY
in: TOPIC
in: LISTING_SCOPE
in: LANGUAGE
in: IP_BLOCK
in: CONTENT_LABEL
in: CARRIER
in: USER_INTEREST
in: WEBPAGE
in: OPERATING_SYSTEM_VERSION
in: APP_PAYMENT_MODEL
in: MOBILE_DEVICE
in: CUSTOM_AFFINITY
in: CUSTOM_INTENT
in: LOCATION_GROUP
in: CUSTOM_AUDIENCE
in: COMBINED_AUDIENCE
in: KEYWORD_THEME
in: AUDIENCE
in: NEGATIVE_KEYWORD_LIST
in: LOCAL_SERVICE_ID
in: SEARCH_THEME
in: BRAND
in: BRAND_LIST
in: LIFE_EVENT
in: WEBPAGE_LIST
in: VIDEO_LINEUP
in: PLACEMENT_LIST
in: VERTICAL_ADS_ITEM_GROUP_RULE_LIST
in: VERTICAL_ADS_ITEM_GROUP_RULE
in: RETAIL_FILTER_BUNDLE
in: RETAIL_FILTER

path: dynamicHotelsAndRentalsAsset
name: dynamic hotels and rentals asset
description: A dynamic hotels and rentals asset.
node: DynamicHotelsAndRentalsAssetShape
class: DynamicHotelsAndRentalsAsset
node kind: BlankNodeOrIRI
max count: 1

path: dynamicFlightsAsset
name: dynamic flights asset
description: A dynamic flights asset.
node: DynamicFlightsAssetShape
class: DynamicFlightsAsset
node kind: BlankNodeOrIRI
max count: 1

path: hotelPropertyAsset
name: hotel property asset
description: Immutable. A hotel property asset.
write lifecycle: Create only
node: HotelPropertyAssetShape
class: HotelPropertyAsset
node kind: BlankNodeOrIRI
max count: 1

path: dynamicCustomAsset
name: dynamic custom asset
description: A dynamic custom asset.
node: DynamicCustomAssetShape
class: DynamicCustomAsset
node kind: BlankNodeOrIRI
max count: 1

path: hotelCalloutAsset
name: hotel callout asset
description: A hotel callout asset.
node: HotelCalloutAssetShape
class: HotelCalloutAsset
node kind: BlankNodeOrIRI
max count: 1

path: fieldTypePolicySummaries
name: field type policy summaries
description: Output only. Policy information for the asset for each FieldType.
write lifecycle: Read only
class: AssetFieldTypePolicySummary
node kind: BlankNodeOrIRI

path: priceAsset
name: price asset
description: A price asset.
node: PriceAssetShape
class: PriceAsset
node kind: BlankNodeOrIRI
max count: 1

path: imageAsset
name: image asset
description: Output only. An image asset.
write lifecycle: Read only
node: ImageAssetShape
class: ImageAsset
node kind: BlankNodeOrIRI
max count: 1

path: name
name: name
description: Optional name of the asset.
datatype: string
max count: 1

path: policySummary
name: policy summary
description: Output only. Policy information for the asset.
write lifecycle: Read only
node: AssetPolicySummaryShape
class: AssetPolicySummary
node kind: BlankNodeOrIRI
max count: 1

path: orientation
name: orientation
description: Output only. Orientation of the asset. This is only supported for image and video assets.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: LANDSCAPE
in: PORTRAIT
in: SQUARE

path: dynamicEducationAsset
name: dynamic education asset
description: A dynamic education asset.
node: DynamicEducationAssetShape
class: DynamicEducationAsset
node kind: BlankNodeOrIRI
max count: 1

path: structuredSnippetAsset
name: structured snippet asset
description: A structured snippet asset.
node: StructuredSnippetAssetShape
class: StructuredSnippetAsset
node kind: BlankNodeOrIRI
max count: 1

path: finalMobileUrls
name: final mobile urls
description: A list of possible final mobile URLs after all cross domain redirects.
datatype: string

path: mobileAppAsset
name: mobile app asset
description: A mobile app asset.
node: MobileAppAssetShape
class: MobileAppAsset
node kind: BlankNodeOrIRI
max count: 1

path: finalUrls
name: final urls
description: A list of possible final URLs after all cross domain redirects.
datatype: string

path: demandGenCarouselCardAsset
name: demand gen carousel card asset
description: Immutable. A Demand Gen carousel card asset.
write lifecycle: Create only
node: DemandGenCarouselCardAssetShape
class: DemandGenCarouselCardAsset
node kind: BlankNodeOrIRI
max count: 1

path: appDeepLinkAsset
name: app deep link asset
description: Immutable. An app deep link asset.
write lifecycle: Create only
node: AppDeepLinkAssetShape
class: AppDeepLinkAsset
node kind: BlankNodeOrIRI
max count: 1

path: bookOnGoogleAsset
name: book on google asset
description: A book on google asset.
node: BookOnGoogleAssetShape
class: BookOnGoogleAsset
node kind: BlankNodeOrIRI
max count: 1

path: finalUrlSuffix
name: final url suffix
description: URL template for appending params to landing page URLs served with parallel tracking.
datatype: string
max count: 1

path: calloutAsset
name: callout asset
description: A callout asset.
node: CalloutAssetShape
class: CalloutAsset
node kind: BlankNodeOrIRI
max count: 1

path: trackingUrlTemplate
name: tracking url template
description: URL template for constructing a tracking URL.
datatype: string
max count: 1

path: targetSpend
name: target spend
description: Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
node: TargetSpendShape
class: TargetSpend
node kind: BlankNodeOrIRI
max count: 1

path: status
name: status
description: The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ENABLED
in: PAUSED
in: REMOVED

path: hotelSetting
name: hotel setting
description: The hotel setting for the campaign.
node: CampaignHotelSettingInfoShape
class: CampaignHotelSettingInfo
node kind: BlankNodeOrIRI
max count: 1

path: selectiveOptimization
name: selective optimization
description: Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
node: CampaignSelectiveOptimizationShape
class: CampaignSelectiveOptimization
node kind: BlankNodeOrIRI
max count: 1

path: paymentMode
name: payment mode
description: Payment mode for the campaign.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: CLICKS
in: CONVERSION_VALUE
in: CONVERSIONS
in: GUEST_STAY

path: primaryStatusReasons
name: primary status reasons
description: Output only. The primary status reasons of the campaign. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus.
write lifecycle: Read only
datatype: string
in: UNSPECIFIED
in: UNKNOWN
in: CAMPAIGN_REMOVED
in: CAMPAIGN_PAUSED
in: CAMPAIGN_PENDING
in: CAMPAIGN_ENDED
in: CAMPAIGN_DRAFT
in: BIDDING_STRATEGY_MISCONFIGURED
in: BIDDING_STRATEGY_LIMITED
in: BIDDING_STRATEGY_LEARNING
in: BIDDING_STRATEGY_CONSTRAINED
in: BUDGET_CONSTRAINED
in: BUDGET_MISCONFIGURED
in: SEARCH_VOLUME_LIMITED
in: AD_GROUPS_PAUSED
in: NO_AD_GROUPS
in: KEYWORDS_PAUSED
in: NO_KEYWORDS
in: AD_GROUP_ADS_PAUSED
in: NO_AD_GROUP_ADS
in: HAS_ADS_LIMITED_BY_POLICY
in: HAS_ADS_DISAPPROVED
in: MOST_ADS_UNDER_REVIEW
in: MISSING_LEAD_FORM_EXTENSION
in: MISSING_CALL_EXTENSION
in: LEAD_FORM_EXTENSION_UNDER_REVIEW
in: LEAD_FORM_EXTENSION_DISAPPROVED
in: CALL_EXTENSION_UNDER_REVIEW
in: CALL_EXTENSION_DISAPPROVED
in: NO_MOBILE_APPLICATION_AD_GROUP_CRITERIA
in: CAMPAIGN_GROUP_PAUSED
in: CAMPAIGN_GROUP_ALL_GROUP_BUDGETS_ENDED
in: APP_NOT_RELEASED
in: APP_PARTIALLY_RELEASED
in: HAS_ASSET_GROUPS_DISAPPROVED
in: HAS_ASSET_GROUPS_LIMITED_BY_POLICY
in: MOST_ASSET_GROUPS_UNDER_REVIEW
in: NO_ASSET_GROUPS
in: ASSET_GROUPS_PAUSED
in: MISSING_LOCATION_TARGETING
in: CAMPAIGN_NOT_BOOKED
in: BOOKING_HOLD_EXPIRING
in: BOOKING_HOLD_EXPIRED
in: BOOKING_CANCELLED

path: experimentType
name: experiment type
description: Output only. The type of campaign: normal, draft, or experiment.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: BASE
in: DRAFT
in: EXPERIMENT

path: optimizationGoalSetting
name: optimization goal setting
description: Optimization goal setting for this campaign, which includes a set of optimization goal types.
node: CampaignOptimizationGoalSettingShape
class: CampaignOptimizationGoalSetting
node kind: BlankNodeOrIRI
max count: 1

path: accessibleBiddingStrategy
name: accessible bidding strategy
description: Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
write lifecycle: Read only
datatype: string
max count: 1

path: localServicesCampaignSettings
name: local services campaign settings
description: The Local Services Campaign related settings.
node: CampaignLocalServicesCampaignSettingsShape
class: CampaignLocalServicesCampaignSettings
node kind: BlankNodeOrIRI
max count: 1

path: keywordMatchType
name: keyword match type
description: Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: BROAD

path: brandGuidelinesEnabled
name: brand guidelines enabled
description: Immutable. Whether Brand Guidelines are enabled for this Campaign. Only applicable to Performance Max campaigns. If enabled, business name and logo assets must be linked as CampaignAssets instead of AssetGroupAssets. Writable only at campaign creation. Set to true to enable Brand Guidelines when creating a new Performance Max campaign. Immutable after creation. This field cannot be modified using standard update operations after the campaign has been created. For existing campaigns: To enable Brand Guidelines on a campaign after it has been created, use the CampaignService.EnablePMaxBrandGuidelines method, which is a separate operation. It is not possible to disable Brand Guidelines for an existing campaign. Incompatible with Travel Goals: This feature is not supported for Performance Max campaigns with Travel Goals. Attempting to set this field to true for a Travel Goals campaign will result in an error.
write lifecycle: Create only
datatype: boolean
max count: 1

path: labels
name: labels
description: Output only. The resource names of labels attached to this campaign.
write lifecycle: Read only
datatype: string

path: trackingUrlTemplate
name: tracking url template
description: The URL template for constructing a tracking URL.
datatype: string
max count: 1

path: listingType
name: listing type
description: Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.
write lifecycle: Create only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: VEHICLES

path: maximizeConversions
name: maximize conversions
description: Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
node: MaximizeConversionsShape
class: MaximizeConversions
node kind: BlankNodeOrIRI
max count: 1

path: campaignBudget
name: campaign budget
description: The resource name of the campaign budget of the campaign.
datatype: string
max count: 1

path: assetAutomationSettings
name: asset automation settings
description: Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
node: CampaignAssetAutomationSettingShape
class: CampaignAssetAutomationSetting
node kind: BlankNodeOrIRI

path: biddingStrategy
name: bidding strategy
description: The resource name of the portfolio bidding strategy used by the campaign.
datatype: string
max count: 1

path: advertisingChannelType
name: advertising channel type
description: Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
write lifecycle: Create only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: SEARCH
in: DISPLAY
in: SHOPPING
in: HOTEL
in: VIDEO
in: MULTI_CHANNEL
in: LOCAL
in: SMART
in: PERFORMANCE_MAX
in: LOCAL_SERVICES
in: TRAVEL
in: DEMAND_GEN

path: urlCustomParameters
name: url custom parameters
description: The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
node: CustomParameterShape
class: CustomParameter
node kind: BlankNodeOrIRI

path: manualCpc
name: manual cpc
description: Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
node: ManualCpcShape
class: ManualCpc
node kind: BlankNodeOrIRI
max count: 1

path: percentCpc
name: percent cpc
description: Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
node: PercentCpcShape
class: PercentCpc
node kind: BlankNodeOrIRI
max count: 1

path: travelCampaignSettings
name: travel campaign settings
description: Settings for Travel campaign.
node: CampaignTravelCampaignSettingsShape
class: CampaignTravelCampaignSettings
node kind: BlankNodeOrIRI
max count: 1

path: thirdPartyIntegrationPartners
name: third party integration partners
description: Third-Party integration partners.
node: CampaignThirdPartyIntegrationPartnersShape
class: CampaignThirdPartyIntegrationPartners
node kind: BlankNodeOrIRI
max count: 1

path: aiMaxSetting
name: ai max setting
description: Settings for AI Max in Search and Shopping campaigns.
node: CampaignAiMaxSettingShape
class: CampaignAiMaxSetting
node kind: BlankNodeOrIRI
max count: 1

path: networkSettings
name: network settings
description: The network settings for the campaign.
node: CampaignNetworkSettingsShape
class: CampaignNetworkSettings
node kind: BlankNodeOrIRI
max count: 1

path: trackingSetting
name: tracking setting
description: Output only. Campaign-level settings for tracking information.
write lifecycle: Read only
node: CampaignTrackingSettingShape
class: CampaignTrackingSetting
node kind: BlankNodeOrIRI
max count: 1

path: vanityPharma
name: vanity pharma
description: Describes how unbranded pharma ads will be displayed.
node: CampaignVanityPharmaShape
class: CampaignVanityPharma
node kind: BlankNodeOrIRI
max count: 1

path: biddingStrategyType
name: bidding strategy type
description: Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: COMMISSION
in: ENHANCED_CPC
in: FIXED_CPM
in: FIXED_SHARE_OF_VOICE
in: INVALID
in: MANUAL_CPA
in: MANUAL_CPC
in: MANUAL_CPM
in: MANUAL_CPV
in: MAXIMIZE_CONVERSIONS
in: MAXIMIZE_CONVERSION_VALUE
in: PAGE_ONE_PROMOTED
in: PERCENT_CPC
in: TARGET_CPA
in: TARGET_CPC
in: TARGET_CPM
in: TARGET_CPV
in: TARGET_IMPRESSION_SHARE
in: TARGET_OUTRANK_SHARE
in: TARGET_ROAS
in: TARGET_SPEND

path: feedTypes
name: feed types
description: Output only. Types of feeds that are attached directly to this campaign.
write lifecycle: Read only
datatype: string
in: UNSPECIFIED
in: UNKNOWN
in: PAGE_FEED
in: DYNAMIC_EDUCATION
in: MERCHANT_CENTER_FEED
in: DYNAMIC_REAL_ESTATE
in: DYNAMIC_CUSTOM
in: DYNAMIC_HOTELS_AND_RENTALS
in: DYNAMIC_FLIGHTS
in: DYNAMIC_TRAVEL
in: DYNAMIC_LOCAL
in: DYNAMIC_JOBS
in: LOCATION_SYNC
in: BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP
in: CHAIN_DYNAMIC_LOCATION_GROUP
in: STATIC_LOCATION_GROUP
in: HOTEL_PROPERTY
in: TRAVEL_FEED

path: brandGuidelines
name: brand guidelines
description: These settings control how your brand appears in automatically generated assets and formats within this campaign. Note: These settings can only be used for Performance Max campaigns that have Brand Guidelines enabled.
node: CampaignBrandGuidelinesShape
class: CampaignBrandGuidelines
node kind: BlankNodeOrIRI
max count: 1

path: manualCpv
name: manual cpv
description: A bidding strategy that pays a configurable amount per video view.
node: ManualCpvShape
class: ManualCpv
node kind: BlankNodeOrIRI
max count: 1

path: missingEuPoliticalAdvertisingDeclaration
name: missing eu political advertising declaration
description: Output only. Indicates whether this campaign is missing a declaration about whether it contains political advertising targeted towards the EU and is ineligible for any exemptions. If this field is true, use the contains_eu_political_advertising field to add the required declaration. This field is read-only.
write lifecycle: Read only
datatype: boolean
max count: 1

path: containsEuPoliticalAdvertising
name: contains eu political advertising
description: The advertiser should self-declare whether this campaign contains political advertising content targeted towards the European Union.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: CONTAINS_EU_POLITICAL_ADVERTISING
in: DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING

path: excludedParentAssetSetTypes
name: excluded parent asset set types
description: The asset set types that should be excluded from this campaign. Asset set links with these types will not be inherited by this campaign from the upper level. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this campaign, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this campaign. Only LOCATION_SYNC is currently supported.
datatype: string
in: UNSPECIFIED
in: UNKNOWN
in: PAGE_FEED
in: DYNAMIC_EDUCATION
in: MERCHANT_CENTER_FEED
in: DYNAMIC_REAL_ESTATE
in: DYNAMIC_CUSTOM
in: DYNAMIC_HOTELS_AND_RENTALS
in: DYNAMIC_FLIGHTS
in: DYNAMIC_TRAVEL
in: DYNAMIC_LOCAL
in: DYNAMIC_JOBS
in: LOCATION_SYNC
in: BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP
in: CHAIN_DYNAMIC_LOCATION_GROUP
in: STATIC_LOCATION_GROUP
in: HOTEL_PROPERTY
in: TRAVEL_FEED

path: manualCpm
name: manual cpm
description: Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
node: ManualCpmShape
class: ManualCpm
node kind: BlankNodeOrIRI
max count: 1

path: frequencyCaps
name: frequency caps
description: A list that limits how often each user will see this campaign's ads.
node: FrequencyCapEntryShape
class: FrequencyCapEntry
node kind: BlankNodeOrIRI

path: manualCpa
name: manual cpa
description: Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
node: ManualCpaShape
class: ManualCpa
node kind: BlankNodeOrIRI
max count: 1

path: videoCampaignSettings
name: video campaign settings
description: Settings for Video campaign.
node: CampaignVideoCampaignSettingsShape
class: CampaignVideoCampaignSettings
node kind: BlankNodeOrIRI
max count: 1

path: excludedParentAssetFieldTypes
name: excluded parent asset field types
description: The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.
datatype: string
in: UNSPECIFIED
in: UNKNOWN
in: HEADLINE
in: DESCRIPTION
in: MANDATORY_AD_TEXT
in: MARKETING_IMAGE
in: MEDIA_BUNDLE
in: YOUTUBE_VIDEO
in: BOOK_ON_GOOGLE
in: LEAD_FORM
in: PROMOTION
in: CALLOUT
in: STRUCTURED_SNIPPET
in: SITELINK
in: MOBILE_APP
in: HOTEL_CALLOUT
in: CALL
in: PRICE
in: LONG_HEADLINE
in: BUSINESS_NAME
in: SQUARE_MARKETING_IMAGE
in: PORTRAIT_MARKETING_IMAGE
in: LOGO
in: LANDSCAPE_LOGO
in: VIDEO
in: CALL_TO_ACTION_SELECTION
in: AD_IMAGE
in: BUSINESS_LOGO
in: HOTEL_PROPERTY
in: DEMAND_GEN_CAROUSEL_CARD
in: BUSINESS_MESSAGE
in: TALL_PORTRAIT_MARKETING_IMAGE
in: RELATED_YOUTUBE_VIDEOS
in: LANDING_PAGE_PREVIEW
in: LONG_DESCRIPTION
in: CALL_TO_ACTION
in: CLASSIC_DISPLAY_IMAGE

path: shoppingSetting
name: shopping setting
description: The setting for controlling Shopping campaigns.
node: CampaignShoppingSettingShape
class: CampaignShoppingSetting
node kind: BlankNodeOrIRI
max count: 1

path: name
name: name
description: The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
datatype: string
max count: 1

path: textGuidelines
name: text guidelines
description: Settings to control automatically generated text assets. Only available in Performance Max and Search campaigns (Brand Guidelines does not need to be enabled).
node: CampaignTextGuidelinesShape
class: CampaignTextGuidelines
node kind: BlankNodeOrIRI
max count: 1

path: campaignGroup
name: campaign group
description: The resource name of the campaign group that this campaign belongs to.
datatype: string
max count: 1

path: dynamicSearchAdsSetting
name: dynamic search ads setting
description: The setting for controlling Dynamic Search Ads (DSA).
node: CampaignDynamicSearchAdsSettingShape
class: CampaignDynamicSearchAdsSetting
node kind: BlankNodeOrIRI
max count: 1

path: servingStatus
name: serving status
description: Output only. The ad serving status of the campaign.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: SERVING
in: NONE
in: ENDED
in: PENDING
in: SUSPENDED

path: adServingOptimizationStatus
name: ad serving optimization status
description: The ad serving optimization status of the campaign.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: OPTIMIZE
in: CONVERSION_OPTIMIZE
in: ROTATE
in: ROTATE_INDEFINITELY
in: UNAVAILABLE

path: appCampaignSetting
name: app campaign setting
description: The setting related to App Campaign.
node: CampaignAppCampaignSettingShape
class: CampaignAppCampaignSetting
node kind: BlankNodeOrIRI
max count: 1

path: commission
name: commission
description: Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
node: CommissionShape
class: Commission
node kind: BlankNodeOrIRI
max count: 1

path: geoTargetTypeSetting
name: geo target type setting
description: The setting for ads geotargeting.
node: CampaignGeoTargetTypeSettingShape
class: CampaignGeoTargetTypeSetting
node kind: BlankNodeOrIRI
max count: 1

path: localCampaignSetting
name: local campaign setting
description: The setting for local campaign.
node: CampaignLocalCampaignSettingShape
class: CampaignLocalCampaignSetting
node kind: BlankNodeOrIRI
max count: 1

path: performanceMaxUpgrade
name: performance max upgrade
description: Output only. Information about campaigns being upgraded to Performance Max.
write lifecycle: Read only
node: CampaignPerformanceMaxUpgradeShape
class: CampaignPerformanceMaxUpgrade
node kind: BlankNodeOrIRI
max count: 1

path: realTimeBiddingSetting
name: real time bidding setting
description: Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
node: RealTimeBiddingSettingShape
class: RealTimeBiddingSetting
node kind: BlankNodeOrIRI
max count: 1

path: finalUrlSuffix
name: final url suffix
description: Suffix used to append query parameters to landing pages that are served with parallel tracking.
datatype: string
max count: 1

path: primaryStatus
name: primary status
description: Output only. The primary status of the campaign. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ELIGIBLE
in: PAUSED
in: REMOVED
in: ENDED
in: PENDING
in: MISCONFIGURED
in: LIMITED
in: LEARNING
in: NOT_ELIGIBLE

path: carrier
name: carrier
description: Immutable. Carrier.
write lifecycle: Create only
node: CarrierInfoShape
class: CarrierInfo
node kind: BlankNodeOrIRI
max count: 1

path: mobileApplication
name: mobile application
description: Immutable. Mobile application.
write lifecycle: Create only
node: MobileApplicationInfoShape
class: MobileApplicationInfo
node kind: BlankNodeOrIRI
max count: 1

path: webpageList
name: webpage list
description: Immutable. Webpage list. This criterion is not publicly available.
write lifecycle: Create only
node: WebpageListInfoShape
class: WebpageListInfo
node kind: BlankNodeOrIRI
max count: 1

path: device
name: device
description: Immutable. Device.
write lifecycle: Create only
node: DeviceInfoShape
class: DeviceInfo
node kind: BlankNodeOrIRI
max count: 1

path: userInterest
name: user interest
description: Immutable. User Interest.
write lifecycle: Create only
node: UserInterestInfoShape
class: UserInterestInfo
node kind: BlankNodeOrIRI
max count: 1

path: parentalStatus
name: parental status
description: Immutable. Parental status.
write lifecycle: Create only
node: ParentalStatusInfoShape
class: ParentalStatusInfo
node kind: BlankNodeOrIRI
max count: 1

path: localServiceId
name: local service id
description: Immutable. GLS service campaign criterion.
write lifecycle: Create only
node: LocalServiceIdInfoShape
class: LocalServiceIdInfo
node kind: BlankNodeOrIRI
max count: 1

path: ipBlock
name: ip block
description: Immutable. IpBlock. You can exclude up to 500 IP addresses per campaign.
write lifecycle: Create only
node: IpBlockInfoShape
class: IpBlockInfo
node kind: BlankNodeOrIRI
max count: 1

path: proximity
name: proximity
description: Immutable. Proximity.
write lifecycle: Create only
node: ProximityInfoShape
class: ProximityInfo
node kind: BlankNodeOrIRI
max count: 1

path: location
name: location
description: Immutable. Location.
write lifecycle: Create only
node: LocationInfoShape
class: LocationInfo
node kind: BlankNodeOrIRI
max count: 1

path: lifeEvent
name: life event
description: Immutable. Life event campaign criterion.
write lifecycle: Create only
node: LifeEventInfoShape
class: LifeEventInfo
node kind: BlankNodeOrIRI
max count: 1

path: mobileDevice
name: mobile device
description: Immutable. Mobile Device.
write lifecycle: Create only
node: MobileDeviceInfoShape
class: MobileDeviceInfo
node kind: BlankNodeOrIRI
max count: 1

path: placement
name: placement
description: Immutable. Placement.
write lifecycle: Create only
node: PlacementInfoShape
class: PlacementInfo
node kind: BlankNodeOrIRI
max count: 1

path: status
name: status
description: The status of the criterion.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ENABLED
in: PAUSED
in: REMOVED

path: customAudience
name: custom audience
description: Immutable. Custom Audience
write lifecycle: Create only
node: CustomAudienceInfoShape
class: CustomAudienceInfo
node kind: BlankNodeOrIRI
max count: 1

path: type
name: type
description: Output only. The type of the criterion.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: KEYWORD
in: PLACEMENT
in: MOBILE_APP_CATEGORY
in: MOBILE_APPLICATION
in: DEVICE
in: LOCATION
in: LISTING_GROUP
in: AD_SCHEDULE
in: AGE_RANGE
in: GENDER
in: INCOME_RANGE
in: PARENTAL_STATUS
in: YOUTUBE_VIDEO
in: YOUTUBE_CHANNEL
in: USER_LIST
in: PROXIMITY
in: TOPIC
in: LISTING_SCOPE
in: LANGUAGE
in: IP_BLOCK
in: CONTENT_LABEL
in: CARRIER
in: USER_INTEREST
in: WEBPAGE
in: OPERATING_SYSTEM_VERSION
in: APP_PAYMENT_MODEL
in: MOBILE_DEVICE
in: CUSTOM_AFFINITY
in: CUSTOM_INTENT
in: LOCATION_GROUP
in: CUSTOM_AUDIENCE
in: COMBINED_AUDIENCE
in: KEYWORD_THEME
in: AUDIENCE
in: NEGATIVE_KEYWORD_LIST
in: LOCAL_SERVICE_ID
in: SEARCH_THEME
in: BRAND
in: BRAND_LIST
in: LIFE_EVENT
in: WEBPAGE_LIST
in: VIDEO_LINEUP
in: PLACEMENT_LIST
in: VERTICAL_ADS_ITEM_GROUP_RULE_LIST
in: VERTICAL_ADS_ITEM_GROUP_RULE
in: RETAIL_FILTER_BUNDLE
in: RETAIL_FILTER

path: videoLineup
name: video lineup
description: Immutable. Video lineup criterion.
write lifecycle: Create only
node: VideoLineupInfoShape
class: VideoLineupInfo
node kind: BlankNodeOrIRI
max count: 1

path: adSchedule
name: ad schedule
description: Immutable. Ad Schedule.
write lifecycle: Create only
node: AdScheduleInfoShape
class: AdScheduleInfo
node kind: BlankNodeOrIRI
max count: 1

path: customAffinity
name: custom affinity
description: Immutable. Custom Affinity.
write lifecycle: Create only
node: CustomAffinityInfoShape
class: CustomAffinityInfo
node kind: BlankNodeOrIRI
max count: 1

path: userList
name: user list
description: Immutable. User List.
write lifecycle: Create only
node: UserListInfoShape
class: UserListInfo
node kind: BlankNodeOrIRI
max count: 1

path: publisherPurchasedClicks
name: publisher purchased clicks
description: Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity
datatype: long
max count: 1

path: allAverageOrderValueMicros
name: all average order value micros
description: All average order value is the average revenue you made per order attributed to your ads. Includes the amount from the average_order_value metric, plus avg. order value from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: interactionEventTypes
name: interaction event types
description: The types of payable and free interactions.
datatype: string
in: UNSPECIFIED
in: UNKNOWN
in: CLICK
in: ENGAGEMENT
in: VIDEO_VIEW
in: NONE

path: hotelEligibleImpressions
name: hotel eligible impressions
description: The number of impressions that hotel partners could have had given their feed performance.
datatype: long
max count: 1

path: averagePageViews
name: average page views
description: Average number of pages viewed per session.
datatype: double
max count: 1

path: conversionsValuePerCost
name: conversions value per cost
description: The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: activeViewAudibleTwoSecondsImpressionsRate
name: active view audible two seconds impressions rate
description: The number of impressions that were audible for at least 2 seconds (cumulative), divided by the total number of impressions measurable for audibility.
datatype: double
max count: 1

path: conversionLastConversionDate
name: conversion last conversion date
description: The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
datatype: string
max count: 1

path: linkedEntitiesCount
name: linked entities count
description: Number of linked resources in which the asset is used. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`.
datatype: long
max count: 1

path: costPerCurrentModelAttributedConversion
name: cost per current model attributed conversion
description: The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: publisherOrganicClicks
name: publisher organic clicks
description: Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity
datatype: long
max count: 1

path: allConversionsFromInteractionsValuePerInteraction
name: all conversions from interactions value per interaction
description: The value of all conversions from interactions divided by the total number of interactions.
datatype: double
max count: 1

path: coviewedImpressions
name: coviewed impressions
description: All co-viewed impressions represent the total number of people who saw your ad. This includes people who are signed into their Google Account, as well as other people who are watching the same ad on a connected TV. This metric is only available for the Campaign resource with adjusted_age_range and adjusted_gender segments. These segmentations are mandatory to get the all coviewed impressions.
datatype: long
max count: 1

path: biddableAppInstallConversions
name: biddable app install conversions
description: Number of app installs.
datatype: double
max count: 1

path: messageImpressions
name: message impressions
description: Number of Click To Message impressions that were message tracking eligible.
datatype: long
max count: 1

path: clicksPointEstimate
name: clicks point estimate
description: The point estimate when estimating the experiment's effect on clicks. Together with `clicks_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(clicks_point_estimate - clicks_margin_of_error, clicks_point_estimate + clicks_margin_of_error)`.
datatype: double
max count: 1

path: crossSellGrossProfitMicros
name: cross sell gross profit micros
description: 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.
datatype: long
max count: 1

path: allConversionsFromInteractionsRate
name: all conversions from interactions rate
description: All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
datatype: double
max count: 1

path: crossSellUnitsSold
name: cross sell units sold
description: 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.
datatype: double
max count: 1

path: controlClicks
name: control clicks
description: The number of clicks on the control arm of an experiment. The treatment clicks value can be selected by using `clicks`.
datatype: long
max count: 1

path: videoTrueviewViewRateShorts
name: video trueview view rate shorts
description: The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for Shorts ads.
datatype: double
max count: 1

path: platformComparableConversionsValue
name: platform comparable conversions value
description: The value of platform comparable conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: trueviewAverageCpv
name: trueview average cpv
description: 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 TrueView views.
datatype: double
max count: 1

path: svr
name: svr
description: This feature is available to allowlisted accounts only.
datatype: long
max count: 1

path: controlConversionValue
name: control conversion value
description: The conversion value metric on the control arm of the experiment. The treatment conversion value can be selected by using `conversions_value`.
datatype: double
max count: 1

path: primaryImpressions
name: primary impressions
description: Primary impression is counted each time your ad is served. This metric is only available for the Campaign resource with adjusted_age_range and adjusted_gender segments. These segmentations are mandatory to get the primary impressions.
datatype: long
max count: 1

path: messageChats
name: message chats
description: Number of message chats initiated for Click To Message impressions that were message tracking eligible.
datatype: long
max count: 1

path: conversionsFromInteractionsValuePerInteraction
name: conversions from interactions value per interaction
description: The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: activeViewAudibleQuartileP25Rate
name: active view audible quartile p25rate
description: The number of impressions that were audible at the first quartile of the ad playback, divided by the total number of impressions measurable for audibility.
datatype: double
max count: 1

path: revenueMicros
name: revenue micros
description: 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.
datatype: long
max count: 1

path: allGrossProfitMargin
name: all gross profit margin
description: All 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). This value is between 0.0 and 1.0, where 1.0 means 100%. Includes the amount from the gross_profit_margin metric, plus gross profit margin across all conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: double
max count: 1

path: interactions
name: interactions
description: 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.
datatype: long
max count: 1

path: clicksMarginOfError
name: clicks margin of error
description: The margin of error when estimating the experiment's effect on clicks. Together with `clicks_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `clicks_point_estimate`.
datatype: double
max count: 1

path: activeViewAudibilityInvalidMeasurableImpressionsRate
name: active view audibility invalid measurable impressions rate
description: The number of impressions for which Active View could measure audibility, but that were filtered out by traffic quality filters, divided by the total number of impressions measurable for audibility.
datatype: double
max count: 1

path: optimizationScoreUrl
name: optimization score url
description: URL for the optimization score page in the Google Ads web interface. This metric can be selected from `customer` or `campaign`, and can be segmented by `segments.recommendation_type`. For example, `SELECT metrics.optimization_score_url, segments.recommendation_type FROM customer` will return a URL for each unique (customer, recommendation_type) combination.
datatype: string
max count: 1

path: auctionInsightSearchOutrankingShare
name: auction insight search outranking share
description: 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.
datatype: double
max count: 1

path: valuePerConversion
name: value per conversion
description: The value of conversions divided by the number of conversions. This only includes conversion actions for which the `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: auctionInsightSearchTopImpressionPercentage
name: auction insight search top impression percentage
description: 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.
datatype: double
max count: 1

path: conversions
name: conversions
description: The number of conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: searchAbsoluteTopImpressionShare
name: search absolute top impression share
description: The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/google-ads/answer/7501826) for details. Any value below 0.1 is reported as 0.0999.
datatype: double
max count: 1

path: searchBudgetLostAbsoluteTopImpressionShare
name: search budget lost absolute top impression share
description: 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.
datatype: double
max count: 1

path: crossSellCostOfGoodsSoldMicros
name: cross sell cost of goods sold micros
description: 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.
datatype: long
max count: 1

path: platformComparableConversionsByConversionDate
name: platform comparable conversions by conversion date
description: The number of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: activeViewAudibilityInvalidGivtMeasurableImpressionsRate
name: active view audibility invalid givt measurable impressions rate
description: The number of impressions for which Active View could measure audibility, but that were filtered out by traffic quality filters, divided by the total number of impressions measurable for audibility. Only includes GIVT (general invalid traffic) impressions.
datatype: double
max count: 1

path: assetPinnedAsHeadlinePositionOneCount
name: asset pinned as headline position one count
description: Number of entities in which the asset is pinned to headline 1. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
datatype: long
max count: 1

path: averageTargetRoas
name: average target roas
description: The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
datatype: double
max count: 1

path: combinedQueries
name: combined queries
description: The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241) for details.
datatype: long
max count: 1

path: costConvertedCurrencyPerPlatformComparableConversion
name: cost converted currency per platform comparable conversion
description: The cost of the platform comparable conversion in the currency of the authorized customer.
datatype: double
max count: 1

path: activeViewViewability
name: active view viewability
description: The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
datatype: double
max count: 1

path: allAverageCartSize
name: all average cart size
description: All average cart size is the average number of products in each order attributed to your ads. Includes the amount from the average_cart_size metric, plus avg. cart size from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: double
max count: 1

path: auctionInsightSearchImpressionShare
name: auction insight search impression share
description: 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.
datatype: double
max count: 1

path: valuePerAllConversionsByConversionDate
name: value per all conversions by conversion date
description: 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 [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009).
datatype: double
max count: 1

path: historicalCreativeQualityScore
name: historical creative quality score
description: The creative historical quality score.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: BELOW_AVERAGE
in: AVERAGE
in: ABOVE_AVERAGE

path: controlImpressions
name: control impressions
description: The impressions metric on the control arm of the experiment. The treatment impressions value can be selected by using `impressions`.
datatype: long
max count: 1

path: conversionsValueByConversionDate
name: conversions value by conversion date
description: The value of conversions. This only includes conversion actions which `include_in_conversions_metric` 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 [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009).
datatype: double
max count: 1

path: searchRankLostTopImpressionShare
name: search rank lost top impression share
description: 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.
datatype: double
max count: 1

path: uniqueUsers
name: unique users
description: 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.
datatype: long
max count: 1

path: currentModelAttributedConversions
name: current model attributed conversions
description: Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: controlCostMicros
name: control cost micros
description: The cost metric on the control arm of the experiment. The treatment cost value can be selected by using `cost_micros`.
datatype: long
max count: 1

path: gmailSaves
name: gmail saves
description: The number of times someone has saved your Gmail ad to their inbox as a message.
datatype: long
max count: 1

path: conversionValueMarginOfError
name: conversion value margin of error
description: The margin of error when estimating the experiment's effect on conversion value. Together with `conversion_value_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `conversion_value_change_point_estimate`.
datatype: double
max count: 1

path: historicalQualityScore
name: historical quality score
description: The historical quality score.
datatype: long
max count: 1

path: activeViewAudibleQuartileP100Rate
name: active view audible quartile p100rate
description: The number of impressions that were audible at the fourth quartile of the ad playback, divided by the total number of impressions measurable for audibility.
datatype: double
max count: 1

path: searchClickShare
name: search click share
description: 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.
datatype: double
max count: 1

path: hotelExpectedCommissionCost
name: hotel expected commission cost
description: Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency.
datatype: double
max count: 1

path: contentImpressionShare
name: content impression share
description: 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.
datatype: double
max count: 1

path: allCrossSellRevenueMicros
name: all cross sell revenue micros
description: All cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. Includes the amount from the cross_sell_revenue_micros metric, plus cross-sell revenue from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: invalidClicks
name: invalid clicks
description: Number of clicks Google considers illegitimate and doesn't charge you for.
datatype: long
max count: 1

path: allLeadGrossProfitMicros
name: all lead gross profit micros
description: All 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). Includes the amount from the lead_gross_profit_micros metric, plus lead gross profit from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: costOfGoodsSoldMicros
name: cost of goods sold micros
description: 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.
datatype: long
max count: 1

path: conversionValuePerCostMarginOfError
name: conversion value per cost margin of error
description: The margin of error when estimating the experiment's effect on conversion value per cost. Together with `conversion_value_per_cost_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `conversion_value_per_cost_change_point_estimate`.
datatype: double
max count: 1

path: valuePerCurrentModelAttributedConversion
name: value per current model attributed conversion
description: The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions for which the `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: averageVideoWatchTimeDurationMillis
name: average video watch time duration millis
description: Average video watch time duration in milliseconds for video impressions that started playing.
datatype: long
max count: 1

path: currentModelAttributedConversionsValuePerCost
name: current model attributed conversions value per cost
description: The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: searchImpressionShare
name: search impression share
description: 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.
datatype: double
max count: 1

path: conversionValueChangePointEstimate
name: conversion value change point estimate
description: The point estimate when estimating the experiment's effect on conversion value change. Together with `conversion_value_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(conversion_value_change_point_estimate - conversion_value_margin_of_error, conversion_value_change_point_estimate + conversion_value_margin_of_error)`.
datatype: double
max count: 1

path: auctionInsightSearchPositionAboveRate
name: auction insight search position above rate
description: 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.
datatype: double
max count: 1

path: combinedClicks
name: combined clicks
description: The number of times your ad or your site's listing in the unpaid results was clicked. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
datatype: long
max count: 1

path: costMicrosMarginOfError
name: cost micros margin of error
description: The margin of error when estimating the experiment's effect on cost. Together with `cost_micros_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `cost_micros_change_point_estimate`.
datatype: double
max count: 1

path: benchmarkCtr
name: benchmark ctr
description: 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.
datatype: double
max count: 1

path: allConversionsFromStoreVisit
name: all conversions from store visit
description: Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only.
datatype: double
max count: 1

path: auctionInsightSearchOverlapRate
name: auction insight search overlap rate
description: 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.
datatype: double
max count: 1

path: allConversionsFromClickToCall
name: all conversions from click to call
description: The number of times people clicked the "Call" button to call a business 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.
datatype: double
max count: 1

path: uniqueUsersTwoPlus
name: unique users two plus
description: This metric counts the unique individuals who were shown your video ad two or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
datatype: long
max count: 1

path: mobileFriendlyClicksPercentage
name: mobile friendly clicks percentage
description: The percentage of mobile clicks that go to a mobile-friendly page.
datatype: double
max count: 1

path: grossProfitMargin
name: gross profit margin
description: 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.
datatype: double
max count: 1

path: allConversionsFromLocationAssetMenu
name: all conversions from location asset menu
description: 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.
datatype: double
max count: 1

path: viewThroughConversionsFromLocationAssetDirections
name: view through conversions from location asset directions
description: Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
datatype: double
max count: 1

path: allOrders
name: all orders
description: All orders is total number of purchase conversions attributed to your ads. Includes the amount from the orders metric, plus orders from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: double
max count: 1

path: allConversionsFromLocationAssetStoreVisits
name: all conversions from location asset store visits
description: Estimated number of visits to the business after a chargeable ad event (click or impression). This measure is coming from Asset based location.
datatype: double
max count: 1

path: percentNewVisitors
name: percent new visitors
description: Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
datatype: double
max count: 1

path: averageCpe
name: average cpe
description: 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.
datatype: double
max count: 1

path: resultsConversionsPurchase
name: results conversions purchase
description: The purchase conversion stats for the unified goals results.
datatype: double
max count: 1

path: activeViewAudibleTwoSecondsImpressions
name: active view audible two seconds impressions
description: The number of impressions that were audible for at least 2 seconds (cumulative).
datatype: long
max count: 1

path: allConversionsFromMenu
name: all conversions from menu
description: The number of times people clicked a link to view a business's menu after clicking an ad. This metric applies to feed items only.
datatype: double
max count: 1

path: valueAdjustment
name: value adjustment
description: The conversion value rule adjustment from biddable conversions in all conversion categories.
datatype: double
max count: 1

path: allGrossProfitMicros
name: all gross profit micros
description: All gross profit is the total profit made from orders attributed to your ads minus the cost of goods sold (COGS). Includes the amount from the gross_profit_micros metric, plus gross profit from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: videoQuartileP25Rate
name: video quartile p25rate
description: Percentage of impressions where the viewer watched 25% of your video.
datatype: double
max count: 1

path: hotelAverageLeadValueMicros
name: hotel average lead value micros
description: Average lead value based on clicks.
datatype: double
max count: 1

path: activeViewAudibilityMeasurableImpressions
name: active view audibility measurable impressions
description: The number of impressions for which Active View could measure if the ad was audible.
datatype: long
max count: 1

path: averageCartSize
name: average cart size
description: 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.
datatype: double
max count: 1

path: costPerConversion
name: cost per conversion
description: The cost of ad interactions divided by conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: leadUnitsSold
name: lead units sold
description: 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.
datatype: double
max count: 1

path: controlCostPerConversion
name: control cost per conversion
description: The cost per conversion metric on the control arm of the experiment. The treatment cost per conversion value can be selected by using `cost_per_conversion`.
datatype: double
max count: 1

path: historicalLandingPageQualityScore
name: historical landing page quality score
description: The quality of historical landing page experience.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: BELOW_AVERAGE
in: AVERAGE
in: ABOVE_AVERAGE

path: currentModelAttributedConversionsFromInteractionsRate
name: current model attributed conversions from interactions rate
description: 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 include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: averageCpm
name: average cpm
description: Average cost-per-thousand impressions (CPM).
datatype: double
max count: 1

path: clicks
name: clicks
description: The number of clicks.
datatype: long
max count: 1

path: activeViewAudibleImpressionsRate
name: active view audible impressions rate
description: The number of impressions that were audible (volume > 0%) at any point during the ad playback, divided by the total number of impressions measurable for audibility.
datatype: double
max count: 1

path: costPerConversionMarginOfError
name: cost per conversion margin of error
description: The margin of error when estimating the experiment's effect on cost per conversion. Together with `cost_per_conversion_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `cost_per_conversion_change_point_estimate`.
datatype: double
max count: 1

path: allConversionsValuePerCost
name: all conversions value per cost
description: The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
datatype: double
max count: 1

path: skAdNetworkTotalConversions
name: sk ad network total conversions
description: The total number of iOS Store Kit Ad Network conversions.
datatype: long
max count: 1

path: averageTimeOnSite
name: average time on site
description: Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
datatype: double
max count: 1

path: conversionValuePerCostPValue
name: conversion value per cost pvalue
description: The p-value for the null hypothesis that the experiment has no effect on conversion value per cost. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversion value per cost, is 3%.
datatype: double
max count: 1

path: platformComparableConversionsValuePerCost
name: platform comparable conversions value per cost
description: The value of conversions divided by the cost of ad interactions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: absoluteTopImpressionPercentage
name: absolute top impression percentage
description: Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
datatype: double
max count: 1

path: activeViewCtr
name: active view ctr
description: Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
datatype: double
max count: 1

path: averageCost
name: average cost
description: The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
datatype: double
max count: 1

path: impressionsPValue
name: impressions pvalue
description: The p-value for the null hypothesis that the experiment has no effect on impressions. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on impressions, is 3%.
datatype: double
max count: 1

path: newCustomerLifetimeValue
name: new customer lifetime value
description: 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 "conversions_value" for optimization. See [About customer lifecycle goals](https://support.google.com/google-ads/answer/12080169) for more details.
datatype: double
max count: 1

path: assetPinnedTotalCount
name: asset pinned total count
description: Number of total usages in which the asset is pinned. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
datatype: long
max count: 1

path: activeViewAudibilityMeasurableImpressionsRate
name: active view audibility measurable impressions rate
description: The number of impressions for which Active View could measure if the ad was audible, divided by the total number of impressions with Active View audio enabled.
datatype: double
max count: 1

path: assetPinnedAsHeadlinePositionThreeCount
name: asset pinned as headline position three count
description: Number of entities in which the asset is pinned to headline 3. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
datatype: long
max count: 1

path: viewThroughConversionsFromLocationAssetMenu
name: view through conversions from location asset menu
description: Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
datatype: double
max count: 1

path: activeViewMeasurableCostMicros
name: active view measurable cost micros
description: The cost of the impressions you received that were measurable by Active View.
datatype: long
max count: 1

path: biddableCohortAppPostInstallConversions
name: biddable cohort app post install conversions
description: Participated in-app actions. The number of in app actions that come directly or indirectly from the campaign.
datatype: double
max count: 1

path: organicClicksPerQuery
name: organic clicks per query
description: The number of times someone clicked your site's listing in the unpaid results (organic_clicks) divided by the total number of searches that returned pages from your site (organic_queries). See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
datatype: double
max count: 1

path: publisherUnknownClicks
name: publisher unknown clicks
description: Clicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic"
datatype: long
max count: 1

path: invalidClickRate
name: invalid click rate
description: The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
datatype: double
max count: 1

path: organicImpressions
name: organic impressions
description: The number of listings for your site in the unpaid search results. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
datatype: long
max count: 1

path: currentModelAttributedConversionsFromInteractionsValuePerInteraction
name: current model attributed conversions from interactions value per interaction
description: The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: activeViewCpm
name: active view cpm
description: Average cost of viewable impressions (`active_view_impressions`).
datatype: double
max count: 1

path: activeViewMeasurability
name: active view measurability
description: The ratio of impressions that could be measured by Active View over the number of served impressions.
datatype: double
max count: 1

path: allNewCustomerLifetimeValue
name: all new customer lifetime value
description: 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 `all_conversions_value`. See [About customer lifecycle goals](https://support.google.com/google-ads/answer/12080169) for more details.
datatype: double
max count: 1

path: allLeadCostOfGoodsSoldMicros
name: all lead cost of goods sold micros
description: All lead cost of goods sold is the total cost of products sold as a result of advertising the same product. Includes the amount shown in the lead_cost_of_goods_sold_micros metric, plus lead cost of goods sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: viewThroughConversionsFromLocationAssetWebsite
name: view through conversions from location asset website
description: Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
datatype: double
max count: 1

path: biddableIndirectInstallFirstInAppConversionMicros
name: biddable indirect install first in app conversion micros
description: The number of biddable first in app conversions where the app install was driven by interaction with a web campaign.
datatype: long
max count: 1

path: engagements
name: engagements
description: 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.
datatype: long
max count: 1

path: allConversionsFromLocationAssetDirections
name: all conversions from location asset directions
description: 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.
datatype: double
max count: 1

path: phoneImpressions
name: phone impressions
description: Number of offline phone impressions.
datatype: long
max count: 1

path: uniqueUsersFivePlus
name: unique users five plus
description: This metric counts the unique individuals who were shown your video ad five or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
datatype: long
max count: 1

path: contentBudgetLostImpressionShare
name: content budget lost impression share
description: 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.
datatype: double
max count: 1

path: crossDeviceConversions
name: cross device conversions
description: 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 `all_conversions`.
datatype: double
max count: 1

path: currentModelAttributedConversionsValue
name: current model attributed conversions value
description: The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: allCostOfGoodsSoldMicros
name: all cost of goods sold micros
description: All cost of goods sold is the total cost of the products you sold in orders attributed to your ads. Includes the amount from the cost_of_goods_sold_micros metric, plus cost of goods sold from all conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: costPerConversionChangePointEstimate
name: cost per conversion change point estimate
description: The point estimate when estimating the experiment's effect on cost per conversion change. Together with `cost_per_conversion_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(cost_per_conversion_change_point_estimate - cost_per_conversion_margin_of_error, cost_per_conversion_change_point_estimate + cost_per_conversion_margin_of_error)`.
datatype: double
max count: 1

path: gmailForwards
name: gmail forwards
description: The number of times the ad was forwarded to someone else as a message.
datatype: long
max count: 1

path: searchExactMatchImpressionShare
name: search exact match impression share
description: 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.
datatype: double
max count: 1

path: searchRankLostImpressionShare
name: search rank lost impression share
description: 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.
datatype: double
max count: 1

path: allConversionsFromOtherEngagement
name: all conversions from other engagement
description: The number of other conversions (for example, posting a review or saving a location for a business) that occurred after people clicked an ad. This metric applies to feed items only.
datatype: double
max count: 1

path: eligibleImpressionsFromLocationAssetStoreReach
name: eligible impressions from location asset store reach
description: Number of impressions in which the business location was shown or the location was used for targeting. This measure is coming from Asset based location.
datatype: long
max count: 1

path: allLeadRevenueMicros
name: all lead revenue micros
description: All lead revenue is the total amount you made from products sold as a result of advertising the same product. Includes the amount shown in the lead_revenue_micros metric, plus lead revenue from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: allLeadUnitsSold
name: all lead units sold
description: All lead units sold is the total number of products sold as a result of advertising the same product. Includes the amount shown in the lead_units_sold metric, plus lead units sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: double
max count: 1

path: impressionsMarginOfError
name: impressions margin of error
description: The margin of error when estimating the experiment's effect on impressions. Together with `impressions_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `impressions_point_estimate`.
datatype: double
max count: 1

path: valuePerPlatformComparableConversionsByConversionDate
name: value per platform comparable conversions by conversion date
description: The value of platform comparable conversions divided by the number of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: activeViewAudibleThirtySecondsImpressionsRate
name: active view audible thirty seconds impressions rate
description: The number of impressions that were audible for at least 30 seconds (cumulative), divided by the total number of impressions measurable for audibility.
datatype: double
max count: 1

path: orders
name: orders
description: 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.
datatype: double
max count: 1

path: assetPinnedAsDescriptionPositionTwoCount
name: asset pinned as description position two count
description: Number of entities in which the asset is pinned to description 2. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
datatype: long
max count: 1

path: averageImpressionFrequencyPerUser
name: average impression frequency per user
description: 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.
datatype: double
max count: 1

path: videoQuartileP100Rate
name: video quartile p100rate
description: Percentage of impressions where the viewer watched all of your video.
datatype: double
max count: 1

path: organicImpressionsPerQuery
name: organic impressions per query
description: The number of times a page from your site was listed in the unpaid search results (`organic_impressions`) divided by the number of searches returning your site's listing in the unpaid results (`organic_queries`). See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
datatype: double
max count: 1

path: relativeCtr
name: relative ctr
description: 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.
datatype: double
max count: 1

path: videoTrueviewViewRate
name: video trueview view rate
description: The number of TrueView views your video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
datatype: double
max count: 1

path: viewThroughConversionsFromLocationAssetOtherEngagement
name: view through conversions from location asset other engagement
description: Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
datatype: double
max count: 1

path: platformComparableConversionsFromInteractionsRate
name: platform comparable conversions from interactions rate
description: Platform comparable 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 for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: uniqueUsersTenPlus
name: unique users ten plus
description: This metric counts the unique individuals who were shown your video ad ten or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
datatype: long
max count: 1

path: organicQueries
name: organic queries
description: The total number of searches that returned your site's listing in the unpaid results. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241) for details.
datatype: long
max count: 1

path: assetPinnedAsDescriptionPositionOneCount
name: asset pinned as description position one count
description: Number of entities in which the asset is pinned to description 1. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
datatype: long
max count: 1

path: clicksPValue
name: clicks pvalue
description: The p-value for the null hypothesis that the experiment has no effect on clicks. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on clicks, is 3%.
datatype: double
max count: 1

path: valuePerPlatformComparableConversion
name: value per platform comparable conversion
description: The value of platform comparable conversions divided by the number of platform comparable conversions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: activeViewAudibleQuartileP75Rate
name: active view audible quartile p75rate
description: The number of impressions that were audible at the third quartile of the ad playback, divided by the total number of impressions measurable for audibility.
datatype: double
max count: 1

path: activeViewImpressions
name: active view impressions
description: A measurement of how often your ad has become viewable on a Display Network site.
datatype: long
max count: 1

path: impressions
name: impressions
description: Count of how often your ad has appeared on a search results page or website on the Google Network.
datatype: long
max count: 1

path: phoneCalls
name: phone calls
description: Number of offline phone calls.
datatype: long
max count: 1

path: clicksUniqueQueryClusters
name: clicks unique query clusters
description: Unique query intent cluster count for clicks.
datatype: long
max count: 1

path: allConversionsValueByConversionDate
name: all conversions value by conversion date
description: 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 [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009).
datatype: double
max count: 1

path: videoWatchTimeDurationMillis
name: video watch time duration millis
description: Total watch time duration in milliseconds for video impressions that started playing. For a small percentage of impressions, we may not be able to measure the watch time accurately. In such cases, we adjust the total time to account for any unmeasured time by applying the average watch time of impressions that were measured.
datatype: long
max count: 1

path: impressionsPointEstimate
name: impressions point estimate
description: The point estimate when estimating the experiment's effect on impressions. Together with `impressions_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(impressions_point_estimate - impressions_margin_of_error, impressions_point_estimate + impressions_margin_of_error)`.
datatype: double
max count: 1

path: leadGrossProfitMicros
name: lead gross profit micros
description: 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.
datatype: long
max count: 1

path: videoTrueviewViewRateInFeed
name: video trueview view rate in feed
description: The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for in-feed formats.
datatype: double
max count: 1

path: allConversionsValue
name: all conversions value
description: The value of all conversions.
datatype: double
max count: 1

path: allConversionsFromStoreWebsite
name: all conversions from store website
description: The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only.
datatype: double
max count: 1

path: allConversions
name: all conversions
description: The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
datatype: double
max count: 1

path: conversionLastReceivedRequestDateTime
name: conversion last received request date time
description: 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.
datatype: string
max count: 1

path: allValueAdjustment
name: all value adjustment
description: The conversion value rule adjustment from all conversions in all conversion categories.
datatype: double
max count: 1

path: linkedSampleEntities
name: linked sample entities
description: A list of up to 20 sample linked resources in which the asset is used. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`.
datatype: string

path: messageChatRate
name: message chat rate
description: Number of message chats initiated (message_chats) divided by the number of message impressions (message_impressions). 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.
datatype: double
max count: 1

path: activeViewAudibleImpressions
name: active view audible impressions
description: The number of impressions that were audible (volume > 0%) at any point during the ad playback.
datatype: long
max count: 1

path: skAdNetworkInstalls
name: sk ad network installs
description: The number of iOS Store Kit Ad Network conversions.
datatype: long
max count: 1

path: searchVolume
name: search volume
description: Search volume range for a search term insight category.
node: SearchVolumeRangeShape
class: SearchVolumeRange
node kind: BlankNodeOrIRI
max count: 1

path: speedScore
name: speed score
description: 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.
datatype: long
max count: 1

path: searchTopImpressionShare
name: search top impression share
description: 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.
datatype: double
max count: 1

path: allConversionsFromLocationAssetOtherEngagement
name: all conversions from location asset other engagement
description: 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.
datatype: double
max count: 1

path: hotelCommissionRateMicros
name: hotel commission rate micros
description: Commission bid rate in micros. A 20% commission is represented as 200,000.
datatype: long
max count: 1

path: videoTrueviewViews
name: video trueview views
description: The number of TrueView views your video ads received.
datatype: long
max count: 1

path: activeViewMeasurableImpressions
name: active view measurable impressions
description: The number of times your ads are appearing on placements in positions where they can be seen.
datatype: long
max count: 1

path: allConversionsFromDirections
name: all conversions from directions
description: The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only.
datatype: double
max count: 1

path: combinedClicksPerQuery
name: combined clicks per query
description: The number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241) for details.
datatype: double
max count: 1

path: impressionsUniqueQueryClusters
name: impressions unique query clusters
description: Unique query intent cluster count for impressions.
datatype: long
max count: 1

path: costPerAllConversions
name: cost per all conversions
description: The cost of ad interactions divided by all conversions.
datatype: double
max count: 1

path: conversionValuePerCostChangePointEstimate
name: conversion value per cost change point estimate
description: The point estimate when estimating the experiment's effect on conversion value per cost change. Together with `conversion_value_per_cost_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(conversion_value_per_cost_change_point_estimate - conversion_value_per_cost_margin_of_error, conversion_value_per_cost_change_point_estimate + conversion_value_per_cost_margin_of_error)`.
datatype: double
max count: 1

path: hotelPriceDifferencePercentage
name: hotel price difference percentage
description: The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
datatype: double
max count: 1

path: crossDeviceConversionsValueByConversionDate
name: cross device conversions value by conversion date
description: The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009)
datatype: double
max count: 1

path: allCrossSellCostOfGoodsSoldMicros
name: all cross sell cost of goods sold micros
description: All cross-sell cost of goods sold is the total cost of products sold as a result of advertising a different product. Includes the amount from the cross_sell_cost_of_goods_sold_micros metric, plus cross-sell cost of goods sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: costMicros
name: cost micros
description: The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
datatype: long
max count: 1

path: unitsSold
name: units sold
description: 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.
datatype: double
max count: 1

path: costPerPlatformComparableConversion
name: cost per platform comparable conversion
description: The cost of ad interactions divided by the number of platform comparable conversions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: allConversionsFromLocationAssetClickToCall
name: all conversions from location asset click to call
description: 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.
datatype: double
max count: 1

path: gmailSecondaryClicks
name: gmail secondary clicks
description: The number of clicks to the landing page on the expanded state of Gmail ads.
datatype: long
max count: 1

path: ctr
name: ctr
description: The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
datatype: double
max count: 1

path: allCrossSellGrossProfitMicros
name: all cross sell gross profit micros
description: All 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). Includes the amount from the cross_sell_gross_profit_micros metric, plus cross-sell gross profit from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: assetPinnedAsHeadlinePositionTwoCount
name: asset pinned as headline position two count
description: Number of entities in which the asset is pinned to headline 2. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
datatype: long
max count: 1

path: activeViewAudibleThirtySecondsImpressions
name: active view audible thirty seconds impressions
description: The number of impressions that were audible for at least 30 seconds (cumulative).
datatype: long
max count: 1

path: allConversionsFromLocationAssetWebsite
name: all conversions from location asset website
description: 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.
datatype: double
max count: 1

path: historicalSearchPredictedCtr
name: historical search predicted ctr
description: The historical search predicted click through rate (CTR).
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: BELOW_AVERAGE
in: AVERAGE
in: ABOVE_AVERAGE

path: crossDeviceConversionsValue
name: cross device conversions value
description: The sum of the value of cross-device conversions.
datatype: double
max count: 1

path: bounceRate
name: bounce rate
description: Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
datatype: double
max count: 1

path: averageOrderValueMicros
name: average order value micros
description: 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.
datatype: long
max count: 1

path: platformComparableConversionsValueByConversionDate
name: platform comparable conversions value by conversion date
description: The value of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: allRevenueMicros
name: all revenue micros
description: All revenue is the total you made from orders attributed to your ads. Includes the amount from the revenue_micros metric, plus revenue from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
datatype: long
max count: 1

path: platformComparableConversionsFromInteractionsValuePerInteraction
name: platform comparable conversions from interactions value per interaction
description: The value of platform comparable conversions from interactions divided by the number of ad interactions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: contentRankLostImpressionShare
name: content rank lost impression share
description: 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.
datatype: double
max count: 1

path: optimizationScoreUplift
name: optimization score uplift
description: Total optimization score uplift of all recommendations.
datatype: double
max count: 1

path: searchRankLostAbsoluteTopImpressionShare
name: search rank lost absolute top impression share
description: 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.
datatype: double
max count: 1

path: controlConversionValuePerCost
name: control conversion value per cost
description: The conversion value per cost metric on the control arm of the experiment. The treatment conversion value per cost value can be selected by using `conversions_value_per_cost`.
datatype: double
max count: 1

path: allConversionsFromOrder
name: all conversions from order
description: The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only.
datatype: double
max count: 1

path: biddableAppPostInstallConversions
name: biddable app post install conversions
description: Number of in-app actions.
datatype: double
max count: 1

path: costPerConversionPValue
name: cost per conversion pvalue
description: The p-value for the null hypothesis that the experiment has no effect on cost per conversion. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on cost per conversion, is 3%.
datatype: double
max count: 1

path: leadRevenueMicros
name: lead revenue micros
description: 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.
datatype: long
max count: 1

path: averageTargetCpaMicros
name: average target cpa micros
description: The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
datatype: long
max count: 1

path: viewThroughConversionsFromLocationAssetClickToCall
name: view through conversions from location asset click to call
description: Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
datatype: double
max count: 1

path: leadCostOfGoodsSoldMicros
name: lead cost of goods sold micros
description: 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.
datatype: long
max count: 1

path: storeVisitsLastClickModelAttributedConversions
name: store visits last click model attributed conversions
description: The amount of business visits attributed by the last click model.
datatype: double
max count: 1

path: conversionsFromInteractionsRate
name: conversions from interactions rate
description: 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 `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: topImpressionPercentage
name: top impression percentage
description: The percent of your ad impressions that are shown adjacent to the top organic search results.
datatype: double
max count: 1

path: viewThroughConversions
name: view through conversions
description: 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.
datatype: long
max count: 1

path: controlConversions
name: control conversions
description: The conversions metric on the control arm of the experiment. The treatment conversions value can be selected by using `conversions`.
datatype: double
max count: 1

path: conversionsValue
name: conversions value
description: The value of conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
datatype: double
max count: 1

path: crossDeviceConversionsByConversionDate
name: cross device conversions by conversion date
description: The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009)
datatype: double
max count: 1

path: crossSellRevenueMicros
name: cross sell revenue micros
description: 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.
datatype: long
max count: 1

path: videoQuartileP50Rate
name: video quartile p50rate
description: Percentage of impressions where the viewer watched 50% of your video.
datatype: double
max count: 1

path: validAcceleratedMobilePagesClicksPercentage
name: valid accelerated mobile pages clicks percentage
description: The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
datatype: double
max count: 1

path: viewThroughConversionsFromLocationAssetStoreVisits
name: view through conversions from location asset store visits
description: Estimated number of visits to the business after an impression. This measure is coming from Asset based location.
datatype: double
max count: 1

path: videoTrueviewViewRateInStream
name: video trueview view rate in stream
description: The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for in-stream formats.
datatype: double
max count: 1

path: generalInvalidClicks
name: general invalid clicks
description: Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).
datatype: long
max count: 1

path: tagSnippets
name: tag snippets
description: Output only. The snippets used for tracking conversions.
write lifecycle: Read only
node: TagSnippetShape
class: TagSnippet
node kind: BlankNodeOrIRI

path: phoneCallDurationSeconds
name: phone call duration seconds
description: The phone call duration in seconds after which a conversion should be reported for this conversion action. The value must be between 0 and 10000, inclusive.
datatype: long
max count: 1

path: origin
name: origin
description: Output only. The conversion origin of this conversion action.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: WEBSITE
in: GOOGLE_HOSTED
in: APP
in: CALL_FROM_ADS
in: STORE
in: YOUTUBE_HOSTED
in: LOCAL_SERVICES_ADS

path: name
name: name
description: The name of the conversion action. This field is required and should not be empty when creating new conversion actions.
datatype: string
max count: 1

path: viewThroughLookbackWindowDays
name: view through lookback window days
description: The maximum number of days which may elapse between an impression and a conversion without an interaction.
datatype: long
max count: 1

path: thirdPartyAppAnalyticsSettings
name: third party app analytics settings
description: Output only. Third Party App Analytics settings for third party conversion types.
write lifecycle: Read only
node: ConversionActionThirdPartyAppAnalyticsSettingsShape
class: ConversionActionThirdPartyAppAnalyticsSettings
node kind: BlankNodeOrIRI
max count: 1

path: locationAssetAutoMigrationDoneDateTime
name: location asset auto migration done date time
description: Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH:mm:ss format.
write lifecycle: Read only
datatype: string
max count: 1

path: trackingUrlTemplate
name: tracking url template
description: The URL template for constructing a tracking URL out of parameters. Only mutable in an `update` operation.
datatype: string
max count: 1

path: offlineConversionUploadConversionActionSummary
name: offline conversion upload conversion action summary
description: Offline conversion upload summary at conversion type level.
node: OfflineConversionUploadConversionActionSummaryShape
class: OfflineConversionUploadConversionActionSummary
node kind: BlankNodeOrIRI
max count: 1

path: productGroupView
name: product group view
description: The product group view referenced in the query.
node: ProductGroupViewShape
class: ProductGroupView
node kind: BlankNodeOrIRI
max count: 1

path: thirdPartyAppAnalyticsLink
name: third party app analytics link
description: The AccountLink referenced in the query.
node: ThirdPartyAppAnalyticsLinkShape
class: ThirdPartyAppAnalyticsLink
node kind: BlankNodeOrIRI
max count: 1

path: domainCategory
name: domain category
description: The domain category referenced in the query.
node: DomainCategoryShape
class: DomainCategory
node kind: BlankNodeOrIRI
max count: 1

path: campaignCustomizer
name: campaign customizer
description: The campaign customizer referenced in the query.
node: CampaignCustomizerShape
class: CampaignCustomizer
node kind: BlankNodeOrIRI
max count: 1

path: customer
name: customer
description: The customer referenced in the query.
node: CustomerShape
class: Customer
node kind: BlankNodeOrIRI
max count: 1

path: locationInterestView
name: location interest view
description: The location interest view referenced in the query.
node: LocationInterestViewShape
class: LocationInterestView
node kind: BlankNodeOrIRI
max count: 1

path: leadFormSubmissionData
name: lead form submission data
description: The lead form user submission referenced in the query.
node: LeadFormSubmissionDataShape
class: LeadFormSubmissionData
node kind: BlankNodeOrIRI
max count: 1

path: ad
name: ad
description: The Ad referenced in the query.
node: AdShape
class: Ad
node kind: BlankNodeOrIRI
max count: 1

path: lifeEvent
name: life event
description: The life event referenced in the query.
node: LifeEventShape
class: LifeEvent
node kind: BlankNodeOrIRI
max count: 1

path: keywordPlanCampaignKeyword
name: keyword plan campaign keyword
description: The keyword plan campaign keyword referenced in the query.
node: KeywordPlanCampaignKeywordShape
class: KeywordPlanCampaignKeyword
node kind: BlankNodeOrIRI
max count: 1

path: assetGroupTopCombinationView
name: asset group top combination view
description: The asset group top combination view referenced in the query.
node: AssetGroupTopCombinationViewShape
class: AssetGroupTopCombinationView
node kind: BlankNodeOrIRI
max count: 1

path: customerNegativeCriterion
name: customer negative criterion
description: The customer negative criterion referenced in the query.
node: CustomerNegativeCriterionShape
class: CustomerNegativeCriterion
node kind: BlankNodeOrIRI
max count: 1

path: adGroupAdAssetCombinationView
name: ad group ad asset combination view
description: The ad group ad asset combination view in the query.
node: AdGroupAdAssetCombinationViewShape
class: AdGroupAdAssetCombinationView
node kind: BlankNodeOrIRI
max count: 1

path: userInterest
name: user interest
description: The user interest referenced in the query.
node: UserInterestShape
class: UserInterest
node kind: BlankNodeOrIRI
max count: 1

path: youTubeVideoUpload
name: you tube video upload
description: The YouTube video upload referenced in the query.
node: YouTubeVideoUploadShape
class: YouTubeVideoUpload
node kind: BlankNodeOrIRI
max count: 1

path: productCategoryConstant
name: product category constant
description: The product category referenced in the query.
node: ProductCategoryConstantShape
class: ProductCategoryConstant
node kind: BlankNodeOrIRI
max count: 1

path: recommendationSubscription
name: recommendation subscription
description: The recommendation subscription referenced in the query.
node: RecommendationSubscriptionShape
class: RecommendationSubscription
node kind: BlankNodeOrIRI
max count: 1

path: assetSetAsset
name: asset set asset
description: The asset set asset referenced in the query.
node: AssetSetAssetShape
class: AssetSetAsset
node kind: BlankNodeOrIRI
max count: 1

path: campaignConversionGoal
name: campaign conversion goal
description: The CampaignConversionGoal referenced in the query.
node: CampaignConversionGoalShape
class: CampaignConversionGoal
node kind: BlankNodeOrIRI
max count: 1

path: campaignAudienceView
name: campaign audience view
description: The campaign audience view referenced in the query.
node: CampaignAudienceViewShape
class: CampaignAudienceView
node kind: BlankNodeOrIRI
max count: 1

path: displayKeywordView
name: display keyword view
description: The display keyword view referenced in the query.
node: DisplayKeywordViewShape
class: DisplayKeywordView
node kind: BlankNodeOrIRI
max count: 1

path: contentCriterionView
name: content criterion view
description: The content criterion view referenced in the query.
node: ContentCriterionViewShape
class: ContentCriterionView
node kind: BlankNodeOrIRI
max count: 1

path: mediaFile
name: media file
description: The media file referenced in the query.
node: MediaFileShape
class: MediaFile
node kind: BlankNodeOrIRI
max count: 1

path: operatingSystemVersionConstant
name: operating system version constant
description: The operating system version constant referenced in the query.
node: OperatingSystemVersionConstantShape
class: OperatingSystemVersionConstant
node kind: BlankNodeOrIRI
max count: 1

path: campaign
name: campaign
description: The campaign referenced in the query.
node: CampaignShape
class: Campaign
node kind: BlankNodeOrIRI
max count: 1

path: campaignBidModifier
name: campaign bid modifier
description: The campaign bid modifier referenced in the query.
node: CampaignBidModifierShape
class: CampaignBidModifier
node kind: BlankNodeOrIRI
max count: 1

path: conversionCustomVariable
name: conversion custom variable
description: The conversion custom variable referenced in the query.
node: ConversionCustomVariableShape
class: ConversionCustomVariable
node kind: BlankNodeOrIRI
max count: 1

path: managedPlacementView
name: managed placement view
description: The managed placement view referenced in the query.
node: ManagedPlacementViewShape
class: ManagedPlacementView
node kind: BlankNodeOrIRI
max count: 1

path: campaignGoalConfig
name: campaign goal config
description: The campaign goal config referenced in the query.
node: CampaignGoalConfigShape
class: CampaignGoalConfig
node kind: BlankNodeOrIRI
max count: 1

path: multiPartyAuthReview
name: multi party auth review
description: The multi party auth review referenced in the query.
node: MultiPartyAuthReviewShape
class: MultiPartyAuthReview
node kind: BlankNodeOrIRI
max count: 1

path: webpageView
name: webpage view
description: The webpage view referenced in the query.
node: WebpageViewShape
class: WebpageView
node kind: BlankNodeOrIRI
max count: 1

path: keywordPlanAdGroup
name: keyword plan ad group
description: The keyword plan ad group referenced in the query.
node: KeywordPlanAdGroupShape
class: KeywordPlanAdGroup
node kind: BlankNodeOrIRI
max count: 1

path: topicConstant
name: topic constant
description: The topic constant referenced in the query.
node: TopicConstantShape
class: TopicConstant
node kind: BlankNodeOrIRI
max count: 1

path: adGroup
name: ad group
description: The ad group referenced in the query.
node: AdGroupShape
class: AdGroup
node kind: BlankNodeOrIRI
max count: 1

path: campaignCriterion
name: campaign criterion
description: The campaign criterion referenced in the query.
node: CampaignCriterionShape
class: CampaignCriterion
node kind: BlankNodeOrIRI
max count: 1

path: offlineConversionUploadClientSummary
name: offline conversion upload client summary
description: Offline conversion upload summary at customer level.
node: OfflineConversionUploadClientSummaryShape
class: OfflineConversionUploadClientSummary
node kind: BlankNodeOrIRI
max count: 1

path: currencyConstant
name: currency constant
description: The currency constant referenced in the query.
node: CurrencyConstantShape
class: CurrencyConstant
node kind: BlankNodeOrIRI
max count: 1

path: assetSetTypeView
name: asset set type view
description: The asset set type view referenced in the query.
node: AssetSetTypeViewShape
class: AssetSetTypeView
node kind: BlankNodeOrIRI
max count: 1

path: customAudience
name: custom audience
description: The CustomAudience referenced in the query.
node: CustomAudienceShape
class: CustomAudience
node kind: BlankNodeOrIRI
max count: 1

path: customerClient
name: customer client
description: The CustomerClient referenced in the query.
node: CustomerClientShape
class: CustomerClient
node kind: BlankNodeOrIRI
max count: 1

path: customizerAttribute
name: customizer attribute
description: The customizer attribute referenced in the query.
node: CustomizerAttributeShape
class: CustomizerAttribute
node kind: BlankNodeOrIRI
max count: 1

path: customerCustomizer
name: customer customizer
description: The customer customizer referenced in the query.
node: CustomerCustomizerShape
class: CustomerCustomizer
node kind: BlankNodeOrIRI
max count: 1

path: keywordThemeConstant
name: keyword theme constant
description: The keyword theme constant referenced in the query.
node: KeywordThemeConstantShape
class: KeywordThemeConstant
node kind: BlankNodeOrIRI
max count: 1

path: localServicesLead
name: local services lead
description: The local services lead referenced in the query.
node: LocalServicesLeadShape
class: LocalServicesLead
node kind: BlankNodeOrIRI
max count: 1

path: customInterest
name: custom interest
description: The CustomInterest referenced in the query.
node: CustomInterestShape
class: CustomInterest
node kind: BlankNodeOrIRI
max count: 1

path: productLinkInvitation
name: product link invitation
description: The product link invitation in the query.
node: ProductLinkInvitationShape
class: ProductLinkInvitation
node kind: BlankNodeOrIRI
max count: 1

path: adGroupAd
name: ad group ad
description: The ad referenced in the query.
class: AdGroupAd
node kind: BlankNodeOrIRI
max count: 1

path: keywordView
name: keyword view
description: The keyword view referenced in the query.
node: KeywordViewShape
class: KeywordView
node kind: BlankNodeOrIRI
max count: 1

path: expandedLandingPageView
name: expanded landing page view
description: The expanded landing page view referenced in the query.
node: ExpandedLandingPageViewShape
class: ExpandedLandingPageView
node kind: BlankNodeOrIRI
max count: 1

path: adGroupAssetSet
name: ad group asset set
description: The ad group asset set referenced in the query.
node: AdGroupAssetSetShape
class: AdGroupAssetSet
node kind: BlankNodeOrIRI
max count: 1

path: conversionValueRuleSet
name: conversion value rule set
description: The conversion value rule set referenced in the query.
node: ConversionValueRuleSetShape
class: ConversionValueRuleSet
node kind: BlankNodeOrIRI
max count: 1

path: genderView
name: gender view
description: The gender view referenced in the query.
node: GenderViewShape
class: GenderView
node kind: BlankNodeOrIRI
max count: 1

path: hotelPerformanceView
name: hotel performance view
description: The hotel performance view referenced in the query.
node: HotelPerformanceViewShape
class: HotelPerformanceView
node kind: BlankNodeOrIRI
max count: 1

path: assetGroupSignal
name: asset group signal
description: The asset group signal referenced in the query.
node: AssetGroupSignalShape
class: AssetGroupSignal
node kind: BlankNodeOrIRI
max count: 1

path: dynamicSearchAdsSearchTermView
name: dynamic search ads search term view
description: The dynamic search ads search term view referenced in the query.
node: DynamicSearchAdsSearchTermViewShape
class: DynamicSearchAdsSearchTermView
node kind: BlankNodeOrIRI
max count: 1

path: accountLink
name: account link
description: The AccountLink referenced in the query.
node: AccountLinkShape
class: AccountLink
node kind: BlankNodeOrIRI
max count: 1

path: localServicesEmployee
name: local services employee
description: The local services employee referenced in the query.
node: LocalServicesEmployeeShape
class: LocalServicesEmployee
node kind: BlankNodeOrIRI
max count: 1

path: conversionValueRule
name: conversion value rule
description: The conversion value rule referenced in the query.
node: ConversionValueRuleShape
class: ConversionValueRule
node kind: BlankNodeOrIRI
max count: 1

path: androidPrivacySharedKeyGoogleAdGroup
name: android privacy shared key google ad group
description: The android privacy shared key google ad group referenced in the query.
node: AndroidPrivacySharedKeyGoogleAdGroupShape
class: AndroidPrivacySharedKeyGoogleAdGroup
node kind: BlankNodeOrIRI
max count: 1

path: hotelGroupView
name: hotel group view
description: The hotel group view referenced in the query.
node: HotelGroupViewShape
class: HotelGroupView
node kind: BlankNodeOrIRI
max count: 1

path: campaignSharedSet
name: campaign shared set
description: Campaign Shared Set referenced in AWQL query.
node: CampaignSharedSetShape
class: CampaignSharedSet
node kind: BlankNodeOrIRI
max count: 1

path: aiMaxSearchTermAdCombinationView
name: ai max search term ad combination view
description: The AI Max search term ad combination view referenced in the query.
node: AiMaxSearchTermAdCombinationViewShape
class: AiMaxSearchTermAdCombinationView
node kind: BlankNodeOrIRI
max count: 1

path: videoEnhancement
name: video enhancement
description: The video enhancement referenced in the query.
node: VideoEnhancementShape
class: VideoEnhancement
node kind: BlankNodeOrIRI
max count: 1

path: adGroupSimulation
name: ad group simulation
description: The ad group simulation referenced in the query.
node: AdGroupSimulationShape
class: AdGroupSimulation
node kind: BlankNodeOrIRI
max count: 1

path: biddingStrategy
name: bidding strategy
description: The bidding strategy referenced in the query.
node: BiddingStrategyShape
class: BiddingStrategy
node kind: BlankNodeOrIRI
max count: 1

path: campaignBudget
name: campaign budget
description: The campaign budget referenced in the query.
node: CampaignBudgetShape
class: CampaignBudget
node kind: BlankNodeOrIRI
max count: 1

path: customerClientLink
name: customer client link
description: The CustomerClientLink referenced in the query.
node: CustomerClientLinkShape
class: CustomerClientLink
node kind: BlankNodeOrIRI
max count: 1

path: landingPageView
name: landing page view
description: The landing page view referenced in the query.
node: LandingPageViewShape
class: LandingPageView
node kind: BlankNodeOrIRI
max count: 1

path: assetGroupListingGroupFilter
name: asset group listing group filter
description: The asset group listing group filter referenced in the query.
node: AssetGroupListingGroupFilterShape
class: AssetGroupListingGroupFilter
node kind: BlankNodeOrIRI
max count: 1

path: localServicesLeadConversation
name: local services lead conversation
description: The local services lead conversationreferenced in the query.
node: LocalServicesLeadConversationShape
class: LocalServicesLeadConversation
node kind: BlankNodeOrIRI
max count: 1

path: combinedAudience
name: combined audience
description: The CombinedAudience referenced in the query.
node: CombinedAudienceShape
class: CombinedAudience
node kind: BlankNodeOrIRI
max count: 1

path: assetFieldTypeView
name: asset field type view
description: The asset field type view referenced in the query.
node: AssetFieldTypeViewShape
class: AssetFieldTypeView
node kind: BlankNodeOrIRI
max count: 1

path: travelActivityGroupView
name: travel activity group view
description: The travel activity group view referenced in the query.
node: TravelActivityGroupViewShape
class: TravelActivityGroupView
node kind: BlankNodeOrIRI
max count: 1

path: experiment
name: experiment
description: The experiment referenced in the query.
node: ExperimentShape
class: Experiment
node kind: BlankNodeOrIRI
max count: 1

path: userLocationView
name: user location view
description: The user location view referenced in the query.
node: UserLocationViewShape
class: UserLocationView
node kind: BlankNodeOrIRI
max count: 1

path: customConversionGoal
name: custom conversion goal
description: The CustomConversionGoal referenced in the query.
node: CustomConversionGoalShape
class: CustomConversionGoal
node kind: BlankNodeOrIRI
max count: 1

path: adParameter
name: ad parameter
description: The ad parameter referenced in the query.
node: AdParameterShape
class: AdParameter
node kind: BlankNodeOrIRI
max count: 1

path: campaignSimulation
name: campaign simulation
description: The campaign simulation referenced in the query.
node: CampaignSimulationShape
class: CampaignSimulation
node kind: BlankNodeOrIRI
max count: 1

path: customerUserAccess
name: customer user access
description: The CustomerUserAccess referenced in the query.
node: CustomerUserAccessShape
class: CustomerUserAccess
node kind: BlankNodeOrIRI
max count: 1

path: adGroupCriterionCustomizer
name: ad group criterion customizer
description: The ad group criterion customizer referenced in the query.
node: AdGroupCriterionCustomizerShape
class: AdGroupCriterionCustomizer
node kind: BlankNodeOrIRI
max count: 1

path: finalUrlExpansionAssetView
name: final url expansion asset view
description: The final url expansion asset view referenced in the query.
node: FinalUrlExpansionAssetViewShape
class: FinalUrlExpansionAssetView
node kind: BlankNodeOrIRI
max count: 1

path: parentalStatusView
name: parental status view
description: The parental status view referenced in the query.
node: ParentalStatusViewShape
class: ParentalStatusView
node kind: BlankNodeOrIRI
max count: 1

path: geographicView
name: geographic view
description: The geographic view referenced in the query.
node: GeographicViewShape
class: GeographicView
node kind: BlankNodeOrIRI
max count: 1

path: androidPrivacySharedKeyGoogleCampaign
name: android privacy shared key google campaign
description: The android privacy shared key google campaign referenced in the query.
node: AndroidPrivacySharedKeyGoogleCampaignShape
class: AndroidPrivacySharedKeyGoogleCampaign
node kind: BlankNodeOrIRI
max count: 1

path: hotelReconciliation
name: hotel reconciliation
description: The hotel reconciliation referenced in the query.
node: HotelReconciliationShape
class: HotelReconciliation
node kind: BlankNodeOrIRI
max count: 1

path: sharedCriterion
name: shared criterion
description: The shared set referenced in the query.
node: SharedCriterionShape
class: SharedCriterion
node kind: BlankNodeOrIRI
max count: 1

path: campaignDraft
name: campaign draft
description: The campaign draft referenced in the query.
node: CampaignDraftShape
class: CampaignDraft
node kind: BlankNodeOrIRI
max count: 1

path: biddingSeasonalityAdjustment
name: bidding seasonality adjustment
description: The bidding seasonality adjustment referenced in the query.
node: BiddingSeasonalityAdjustmentShape
class: BiddingSeasonalityAdjustment
node kind: BlankNodeOrIRI
max count: 1

path: customerManagerLink
name: customer manager link
description: The CustomerManagerLink referenced in the query.
node: CustomerManagerLinkShape
class: CustomerManagerLink
node kind: BlankNodeOrIRI
max count: 1

path: cartDataSalesView
name: cart data sales view
description: The cart data sales view referenced in the query.
node: CartDataSalesViewShape
class: CartDataSalesView
node kind: BlankNodeOrIRI
max count: 1

path: detailPlacementView
name: detail placement view
description: The detail placement view referenced in the query.
node: DetailPlacementViewShape
class: DetailPlacementView
node kind: BlankNodeOrIRI
max count: 1

path: assetGroupAsset
name: asset group asset
description: The asset group asset referenced in the query.
class: AssetGroupAsset
node kind: BlankNodeOrIRI
max count: 1

path: customerUserAccessInvitation
name: customer user access invitation
description: The CustomerUserAccessInvitation referenced in the query.
node: CustomerUserAccessInvitationShape
class: CustomerUserAccessInvitation
node kind: BlankNodeOrIRI
max count: 1

path: keywordPlanAdGroupKeyword
name: keyword plan ad group keyword
description: The keyword plan ad group referenced in the query.
node: KeywordPlanAdGroupKeywordShape
class: KeywordPlanAdGroupKeyword
node kind: BlankNodeOrIRI
max count: 1

path: detailedDemographic
name: detailed demographic
description: The detailed demographic referenced in the query.
node: DetailedDemographicShape
class: DetailedDemographic
node kind: BlankNodeOrIRI
max count: 1

path: remarketingAction
name: remarketing action
description: The remarketing action referenced in the query.
node: RemarketingActionShape
class: RemarketingAction
node kind: BlankNodeOrIRI
max count: 1

path: offlineUserDataJob
name: offline user data job
description: The offline user data job referenced in the query.
node: OfflineUserDataJobShape
class: OfflineUserDataJob
node kind: BlankNodeOrIRI
max count: 1

path: searchTermView
name: search term view
description: The search term view referenced in the query.
node: SearchTermViewShape
class: SearchTermView
node kind: BlankNodeOrIRI
max count: 1

path: accountBudget
name: account budget
description: The account budget in the query.
node: AccountBudgetShape
class: AccountBudget
node kind: BlankNodeOrIRI
max count: 1

path: customerSearchTermInsight
name: customer search term insight
description: The customer search term insight referenced in the query.
node: CustomerSearchTermInsightShape
class: CustomerSearchTermInsight
node kind: BlankNodeOrIRI
max count: 1

path: adGroupBidModifier
name: ad group bid modifier
description: The bid modifier referenced in the query.
node: AdGroupBidModifierShape
class: AdGroupBidModifier
node kind: BlankNodeOrIRI
max count: 1

path: assetGroup
name: asset group
description: The asset group referenced in the query.
node: AssetGroupShape
class: AssetGroup
node kind: BlankNodeOrIRI
max count: 1

path: campaignLabel
name: campaign label
description: The campaign label referenced in the query.
node: CampaignLabelShape
class: CampaignLabel
node kind: BlankNodeOrIRI
max count: 1

path: adGroupCriterionSimulation
name: ad group criterion simulation
description: The ad group criterion simulation referenced in the query.
node: AdGroupCriterionSimulationShape
class: AdGroupCriterionSimulation
node kind: BlankNodeOrIRI
max count: 1

path: accountBudgetProposal
name: account budget proposal
description: The account budget proposal referenced in the query.
node: AccountBudgetProposalShape
class: AccountBudgetProposal
node kind: BlankNodeOrIRI
max count: 1

path: campaignGroup
name: campaign group
description: Campaign Group referenced in AWQL query.
node: CampaignGroupShape
class: CampaignGroup
node kind: BlankNodeOrIRI
max count: 1

path: customerAsset
name: customer asset
description: The customer asset referenced in the query.
node: CustomerAssetShape
class: CustomerAsset
node kind: BlankNodeOrIRI
max count: 1

path: carrierConstant
name: carrier constant
description: The carrier constant referenced in the query.
node: CarrierConstantShape
class: CarrierConstant
node kind: BlankNodeOrIRI
max count: 1

path: performanceMaxPlacementView
name: performance max placement view
description: The performance max placement view referenced in the query.
node: PerformanceMaxPlacementViewShape
class: PerformanceMaxPlacementView
node kind: BlankNodeOrIRI
max count: 1

path: asset
name: asset
description: The asset referenced in the query.
class: Asset
node kind: BlankNodeOrIRI
max count: 1

path: biddingDataExclusion
name: bidding data exclusion
description: The bidding data exclusion referenced in the query.
node: BiddingDataExclusionShape
class: BiddingDataExclusion
node kind: BlankNodeOrIRI
max count: 1

path: campaignAsset
name: campaign asset
description: The campaign asset referenced in the query.
node: CampaignAssetShape
class: CampaignAsset
node kind: BlankNodeOrIRI
max count: 1

path: campaignSearchTermView
name: campaign search term view
description: The campaign-level search term view referenced in the query.
node: CampaignSearchTermViewShape
class: CampaignSearchTermView
node kind: BlankNodeOrIRI
max count: 1

path: adGroupAudienceView
name: ad group audience view
description: The ad group audience view referenced in the query.
node: AdGroupAudienceViewShape
class: AdGroupAudienceView
node kind: BlankNodeOrIRI
max count: 1

path: matchedLocationInterestView
name: matched location interest view
description: The matched location interest view referenced in the query.
node: MatchedLocationInterestViewShape
class: MatchedLocationInterestView
node kind: BlankNodeOrIRI
max count: 1

path: distanceView
name: distance view
description: The distance view referenced in the query.
node: DistanceViewShape
class: DistanceView
node kind: BlankNodeOrIRI
max count: 1

path: clickView
name: click view
description: The ClickView referenced in the query.
node: ClickViewShape
class: ClickView
node kind: BlankNodeOrIRI
max count: 1

path: topicView
name: topic view
description: The topic view referenced in the query.
node: TopicViewShape
class: TopicView
node kind: BlankNodeOrIRI
max count: 1

path: adGroupLabel
name: ad group label
description: The ad group label referenced in the query.
node: AdGroupLabelShape
class: AdGroupLabel
node kind: BlankNodeOrIRI
max count: 1

path: conversionGoalCampaignConfig
name: conversion goal campaign config
description: The ConversionGoalCampaignConfig referenced in the query.
node: ConversionGoalCampaignConfigShape
class: ConversionGoalCampaignConfig
node kind: BlankNodeOrIRI
max count: 1

path: metrics
name: metrics
description: The metrics.
node: CommonMetricsShape
class: CommonMetrics
node kind: BlankNodeOrIRI
max count: 1

path: geoTargetConstant
name: geo target constant
description: The geo target constant referenced in the query.
node: GeoTargetConstantShape
class: GeoTargetConstant
node kind: BlankNodeOrIRI
max count: 1

path: incomeRangeView
name: income range view
description: The income range view referenced in the query.
node: IncomeRangeViewShape
class: IncomeRangeView
node kind: BlankNodeOrIRI
max count: 1

path: travelActivityPerformanceView
name: travel activity performance view
description: The travel activity performance view referenced in the query.
node: TravelActivityPerformanceViewShape
class: TravelActivityPerformanceView
node kind: BlankNodeOrIRI
max count: 1

path: callView
name: call view
description: The call view referenced in the query.
node: CallViewShape
class: CallView
node kind: BlankNodeOrIRI
max count: 1

path: conversionAction
name: conversion action
description: The conversion action referenced in the query.
node: ConversionActionShape
class: ConversionAction
node kind: BlankNodeOrIRI
max count: 1

path: appliedIncentive
name: applied incentive
description: The applied incentive referenced in the query.
node: AppliedIncentiveShape
class: AppliedIncentive
node kind: BlankNodeOrIRI
max count: 1

path: customerLabel
name: customer label
description: The customer label referenced in the query.
node: CustomerLabelShape
class: CustomerLabel
node kind: BlankNodeOrIRI
max count: 1

path: ageRangeView
name: age range view
description: The age range view referenced in the query.
node: AgeRangeViewShape
class: AgeRangeView
node kind: BlankNodeOrIRI
max count: 1

path: paidOrganicSearchTermView
name: paid organic search term view
description: The paid organic search term view referenced in the query.
node: PaidOrganicSearchTermViewShape
class: PaidOrganicSearchTermView
node kind: BlankNodeOrIRI
max count: 1

path: label
name: label
description: The label referenced in the query.
node: LabelShape
class: Label
node kind: BlankNodeOrIRI
max count: 1

path: qualifyingQuestion
name: qualifying question
description: The qualifying question referenced in the query.
node: QualifyingQuestionShape
class: QualifyingQuestion
node kind: BlankNodeOrIRI
max count: 1

path: adGroupCriterionLabel
name: ad group criterion label
description: The ad group criterion label referenced in the query.
node: AdGroupCriterionLabelShape
class: AdGroupCriterionLabel
node kind: BlankNodeOrIRI
max count: 1

path: detailContentSuitabilityPlacementView
name: detail content suitability placement view
description: The detail content suitability placement view referenced in the query.
node: DetailContentSuitabilityPlacementViewShape
class: DetailContentSuitabilityPlacementView
node kind: BlankNodeOrIRI
max count: 1

path: localServicesVerificationArtifact
name: local services verification artifact
description: The local services verification artifact referenced in the query.
node: LocalServicesVerificationArtifactShape
class: LocalServicesVerificationArtifact
node kind: BlankNodeOrIRI
max count: 1

path: productLink
name: product link
description: The product link referenced in the query.
node: ProductLinkShape
class: ProductLink
node kind: BlankNodeOrIRI
max count: 1

path: sharedSet
name: shared set
description: The shared set referenced in the query.
node: SharedSetShape
class: SharedSet
node kind: BlankNodeOrIRI
max count: 1

path: userList
name: user list
description: The user list referenced in the query.
node: UserListShape
class: UserList
node kind: BlankNodeOrIRI
max count: 1

path: mobileAppCategoryConstant
name: mobile app category constant
description: The mobile app category constant referenced in the query.
node: MobileAppCategoryConstantShape
class: MobileAppCategoryConstant
node kind: BlankNodeOrIRI
max count: 1

path: campaignAggregateAssetView
name: campaign aggregate asset view
description: The campaign aggregate asset view referenced in the query.
node: CampaignAggregateAssetViewShape
class: CampaignAggregateAssetView
node kind: BlankNodeOrIRI
max count: 1

path: batchJob
name: batch job
description: The batch job referenced in the query.
node: BatchJobShape
class: BatchJob
node kind: BlankNodeOrIRI
max count: 1

path: recommendation
name: recommendation
description: The recommendation referenced in the query.
class: Recommendation
node kind: BlankNodeOrIRI
max count: 1

path: adGroupAdLabel
name: ad group ad label
description: The ad group ad label referenced in the query.
node: AdGroupAdLabelShape
class: AdGroupAdLabel
node kind: BlankNodeOrIRI
max count: 1

path: assetSet
name: asset set
description: The asset set referenced in the query.
node: AssetSetShape
class: AssetSet
node kind: BlankNodeOrIRI
max count: 1

path: perStoreView
name: per store view
description: The per store view referenced in the query.
node: PerStoreViewShape
class: PerStoreView
node kind: BlankNodeOrIRI
max count: 1

path: campaignLifecycleGoal
name: campaign lifecycle goal
description: The campaign lifecycle goal referenced in the query.
node: CampaignLifecycleGoalShape
class: CampaignLifecycleGoal
node kind: BlankNodeOrIRI
max count: 1

path: billingSetup
name: billing setup
description: The billing setup referenced in the query.
node: BillingSetupShape
class: BillingSetup
node kind: BlankNodeOrIRI
max count: 1

path: targetingExpansionView
name: targeting expansion view
description: The Targeting expansion view referenced in the query.
node: TargetingExpansionViewShape
class: TargetingExpansionView
node kind: BlankNodeOrIRI
max count: 1

path: experimentArm
name: experiment arm
description: The experiment arm referenced in the query.
node: ExperimentArmShape
class: ExperimentArm
node kind: BlankNodeOrIRI
max count: 1

path: mobileDeviceConstant
name: mobile device constant
description: The mobile device constant referenced in the query.
node: MobileDeviceConstantShape
class: MobileDeviceConstant
node kind: BlankNodeOrIRI
max count: 1

path: changeStatus
name: change status
description: The ChangeStatus referenced in the query.
node: ChangeStatusShape
class: ChangeStatus
node kind: BlankNodeOrIRI
max count: 1

path: shoppingPerformanceView
name: shopping performance view
description: The shopping performance view referenced in the query.
node: ShoppingPerformanceViewShape
class: ShoppingPerformanceView
node kind: BlankNodeOrIRI
max count: 1

path: customerAssetSet
name: customer asset set
description: The customer asset set referenced in the query.
node: CustomerAssetSetShape
class: CustomerAssetSet
node kind: BlankNodeOrIRI
max count: 1

path: campaignSearchTermInsight
name: campaign search term insight
description: The campaign search term insight referenced in the query.
node: CampaignSearchTermInsightShape
class: CampaignSearchTermInsight
node kind: BlankNodeOrIRI
max count: 1

path: assetGroupProductGroupView
name: asset group product group view
description: The asset group product group view referenced in the query.
node: AssetGroupProductGroupViewShape
class: AssetGroupProductGroupView
node kind: BlankNodeOrIRI
max count: 1

path: campaignAssetSet
name: campaign asset set
description: The campaign asset set referenced in the query.
node: CampaignAssetSetShape
class: CampaignAssetSet
node kind: BlankNodeOrIRI
max count: 1

path: appTopCombinationView
name: app top combination view
description: The app top combination view in the query.
node: AppTopCombinationViewShape
class: AppTopCombinationView
node kind: BlankNodeOrIRI
max count: 1

path: accessibleBiddingStrategy
name: accessible bidding strategy
description: The accessible bidding strategy referenced in the query.
node: AccessibleBiddingStrategyShape
class: AccessibleBiddingStrategy
node kind: BlankNodeOrIRI
max count: 1

path: locationView
name: location view
description: The location view referenced in the query.
node: LocationViewShape
class: LocationView
node kind: BlankNodeOrIRI
max count: 1

path: hotelCheckInDate
name: hotel check in date
description: Hotel check-in date. Formatted as yyyy-MM-dd.
datatype: string
max count: 1

path: skAdNetworkPostbackSequenceIndex
name: sk ad network postback sequence index
description: iOS Store Kit Ad Network postback sequence index.
datatype: long
max count: 1

path: searchTermMatchSource
name: search term match source
description: Specifies the source for how the search term was matched, which reveals the type of ad campaign responsible. Use this to distinguish between automated campaigns (like AI Max, Dynamic Search Ads) and keyword-based campaigns (Standard).
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ADVERTISER_PROVIDED_KEYWORD
in: AI_MAX_KEYWORDLESS
in: AI_MAX_BROAD_MATCH
in: DYNAMIC_SEARCH_ADS
in: PERFORMANCE_MAX
in: VERTICAL_ADS_DATA_FEED

path: productCustomAttribute2
name: product custom attribute2
description: Custom attribute 2 of the product.
datatype: string
max count: 1

path: productFeedLabel
name: product feed label
description: Feed label of the product.
datatype: string
max count: 1

path: activityAccountId
name: activity account id
description: Activity account ID.
datatype: long
max count: 1

path: skAdNetworkSourceType
name: sk ad network source type
description: 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.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNAVAILABLE
in: WEBSITE
in: MOBILE_APPLICATION

path: assetGroup
name: asset group
description: Resource name of the asset group.
datatype: string
max count: 1

path: geoTargetProvince
name: geo target province
description: Resource name of the geo target constant that represents a province.
datatype: string
max count: 1

path: productChannel
name: product channel
description: Channel of the product.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ONLINE
in: LOCAL

path: skAdNetworkUserType
name: sk ad network user type
description: iOS Store Kit Ad Network user type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNAVAILABLE
in: NEW_INSTALLER
in: REINSTALLER

path: adjustedGender
name: adjusted gender
description: Adjusted gender. This is the gender of the user after applying modeling to get more accurate age and gender information. Currently, both adjusted_age_range and adjusted_gender need to be selected together to get valid reach stats. These segmentations are only available for allowlisted customers.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: MALE
in: FEMALE
in: UNDETERMINED

path: geoTargetCounty
name: geo target county
description: Resource name of the geo target constant that represents a county.
datatype: string
max count: 1

path: geoTargetCity
name: geo target city
description: Resource name of the geo target constant that represents a city.
datatype: string
max count: 1

path: adNetworkType
name: ad network type
description: Ad network type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: SEARCH
in: SEARCH_PARTNERS
in: CONTENT
in: MIXED
in: YOUTUBE
in: GOOGLE_TV
in: GOOGLE_OWNED_CHANNELS
in: GMAIL
in: DISCOVER
in: MAPS

path: keyword
name: keyword
description: Keyword criterion.
node: KeywordShape
class: Keyword
node kind: BlankNodeOrIRI
max count: 1

path: slot
name: slot
description: Position of the ad.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: SEARCH_SIDE
in: SEARCH_TOP
in: SEARCH_OTHER
in: CONTENT
in: SEARCH_PARTNER_TOP
in: SEARCH_PARTNER_OTHER
in: MIXED

path: clickType
name: click type
description: Click type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: APP_DEEPLINK
in: BREADCRUMBS
in: BROADBAND_PLAN
in: CALL_TRACKING
in: CALLS
in: CLICK_ON_ENGAGEMENT_AD
in: GET_DIRECTIONS
in: LOCATION_EXPANSION
in: LOCATION_FORMAT_CALL
in: LOCATION_FORMAT_DIRECTIONS
in: LOCATION_FORMAT_IMAGE
in: LOCATION_FORMAT_LANDING_PAGE
in: LOCATION_FORMAT_MAP
in: LOCATION_FORMAT_STORE_INFO
in: LOCATION_FORMAT_TEXT
in: MOBILE_CALL_TRACKING
in: OFFER_PRINTS
in: OTHER
in: PRODUCT_EXTENSION_CLICKS
in: PRODUCT_LISTING_AD_CLICKS
in: SITELINKS
in: STORE_LOCATOR
in: URL_CLICKS
in: VIDEO_APP_STORE_CLICKS
in: VIDEO_CALL_TO_ACTION_CLICKS
in: VIDEO_CARD_ACTION_HEADLINE_CLICKS
in: VIDEO_END_CAP_CLICKS
in: VIDEO_WEBSITE_CLICKS
in: VISUAL_SITELINKS
in: WIRELESS_PLAN
in: PRODUCT_LISTING_AD_LOCAL
in: PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL
in: PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE
in: PRODUCT_LISTING_ADS_COUPON
in: PRODUCT_LISTING_AD_TRANSACTABLE
in: PRODUCT_AD_APP_DEEPLINK
in: SHOWCASE_AD_CATEGORY_LINK
in: SHOWCASE_AD_LOCAL_STOREFRONT_LINK
in: SHOWCASE_AD_ONLINE_PRODUCT_LINK
in: SHOWCASE_AD_LOCAL_PRODUCT_LINK
in: PROMOTION_EXTENSION
in: SWIPEABLE_GALLERY_AD_HEADLINE
in: SWIPEABLE_GALLERY_AD_SWIPES
in: SWIPEABLE_GALLERY_AD_SEE_MORE
in: SWIPEABLE_GALLERY_AD_SITELINK_ONE
in: SWIPEABLE_GALLERY_AD_SITELINK_TWO
in: SWIPEABLE_GALLERY_AD_SITELINK_THREE
in: SWIPEABLE_GALLERY_AD_SITELINK_FOUR
in: SWIPEABLE_GALLERY_AD_SITELINK_FIVE
in: HOTEL_PRICE
in: PRICE_EXTENSION
in: HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION
in: SHOPPING_COMPARISON_LISTING
in: CROSS_NETWORK
in: AD_IMAGE
in: TRAVEL_ASSETS
in: VEHICLE_ASSETS
in: PRODUCT_ASSETS
in: VIDEO_CHANNEL_CLICK
in: VIDEO_RELATED_VIDEOS_CLICK
in: CLICK_TO_MESSAGE_THIRD_PARTY_CLICK
in: CLICK_TO_MESSAGE_LANDING_PAGE_CLICK

path: productCustomAttribute4
name: product custom attribute4
description: Custom attribute 4 of the product.
datatype: string
max count: 1

path: verticalAdsListingCity
name: vertical ads listing city
description: The city where the vertical ads listing is located.
datatype: string
max count: 1

path: productCountry
name: product country
description: Resource name of the geo target constant for the country of sale of the product.
datatype: string
max count: 1

path: verticalAdsPartnerAccount
name: vertical ads partner account
description: A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads.
datatype: long
max count: 1

path: landingPageSource
name: landing page source
description: The source of a landing page in the landing page report.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ADVERTISER
in: AUTOMATIC

path: conversionAction
name: conversion action
description: Resource name of the conversion action.
datatype: string
max count: 1

path: productTitle
name: product title
description: Title of the product.
datatype: string
max count: 1

path: searchTermMatchType
name: search term match type
description: Match type of the keyword that triggered the ad. This segment is for use with keyword_view. For other resources, use match_type. While match_type is filtered to Broad, Exact, Phrase and Ai Max, search_term_match_type includes variants like Near Exact and Near Phrase.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: BROAD
in: EXACT
in: PHRASE
in: NEAR_EXACT
in: NEAR_PHRASE
in: AI_MAX
in: PERFORMANCE_MAX

path: skAdNetworkAdEventType
name: sk ad network ad event type
description: iOS Store Kit Ad Network ad event type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNAVAILABLE
in: INTERACTION
in: VIEW

path: activityCountry
name: activity country
description: The country where the travel activity is available.
datatype: string
max count: 1

path: geoTargetCanton
name: geo target canton
description: Resource name of the geo target constant that represents a canton.
datatype: string
max count: 1

path: productSoldCategoryLevel3
name: product sold category level3
description: Category (level 3) of the product sold.
datatype: string
max count: 1

path: verticalAdsListingVenue
name: vertical ads listing venue
description: The name of the venue for the vertical ads listing, for example, the venue for a concert event.
datatype: string
max count: 1

path: productTypeL4
name: product type l4
description: Type (level 4) of the product.
datatype: string
max count: 1

path: hotelRateRuleId
name: hotel rate rule id
description: Hotel rate rule ID.
datatype: string
max count: 1

path: verticalAdsVertical
name: vertical ads vertical
description: Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: HOTELS
in: VACATION_RENTALS
in: RENTAL_CARS
in: EVENTS
in: THINGS_TO_DO
in: FLIGHTS

path: assetInteractionTarget
name: asset interaction target
description: 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 interaction_on_this_asset is true, it means the interactions are on this specific asset and when interaction_on_this_asset 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.
node: AssetInteractionTargetShape
class: AssetInteractionTarget
node kind: BlankNodeOrIRI
max count: 1

path: productTypeL1
name: product type l1
description: Type (level 1) of the product.
datatype: string
max count: 1

path: verticalAdsListingBrand
name: vertical ads listing brand
description: The brand associated with a specific listing within a Vertical Ads context, for example, the brand of a car rental, a vacation home, or an event.
datatype: string
max count: 1

path: productSoldTypeL3
name: product sold type l3
description: Type (level 3) of the product sold.
datatype: string
max count: 1

path: geoTargetRegion
name: geo target region
description: Resource name of the geo target constant that represents a region.
datatype: string
max count: 1

path: hotelCountry
name: hotel country
description: Hotel country.
datatype: string
max count: 1

path: recommendationType
name: recommendation type
description: Recommendation type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: CAMPAIGN_BUDGET
in: KEYWORD
in: TEXT_AD
in: TARGET_CPA_OPT_IN
in: MAXIMIZE_CONVERSIONS_OPT_IN
in: ENHANCED_CPC_OPT_IN
in: SEARCH_PARTNERS_OPT_IN
in: MAXIMIZE_CLICKS_OPT_IN
in: OPTIMIZE_AD_ROTATION
in: KEYWORD_MATCH_TYPE
in: MOVE_UNUSED_BUDGET
in: FORECASTING_CAMPAIGN_BUDGET
in: TARGET_ROAS_OPT_IN
in: RESPONSIVE_SEARCH_AD
in: MARGINAL_ROI_CAMPAIGN_BUDGET
in: USE_BROAD_MATCH_KEYWORD
in: RESPONSIVE_SEARCH_AD_ASSET
in: UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX
in: RESPONSIVE_SEARCH_AD_IMPROVE_AD_STRENGTH
in: DISPLAY_EXPANSION_OPT_IN
in: UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX
in: RAISE_TARGET_CPA_BID_TOO_LOW
in: FORECASTING_SET_TARGET_ROAS
in: CALLOUT_ASSET
in: SITELINK_ASSET
in: CALL_ASSET
in: SHOPPING_ADD_AGE_GROUP
in: SHOPPING_ADD_COLOR
in: SHOPPING_ADD_GENDER
in: SHOPPING_ADD_GTIN
in: SHOPPING_ADD_MORE_IDENTIFIERS
in: SHOPPING_ADD_SIZE
in: SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN
in: SHOPPING_FIX_DISAPPROVED_PRODUCTS
in: SHOPPING_TARGET_ALL_OFFERS
in: SHOPPING_FIX_SUSPENDED_MERCHANT_CENTER_ACCOUNT
in: SHOPPING_FIX_MERCHANT_CENTER_ACCOUNT_SUSPENSION_WARNING
in: SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX
in: DYNAMIC_IMAGE_EXTENSION_OPT_IN
in: RAISE_TARGET_CPA
in: LOWER_TARGET_ROAS
in: PERFORMANCE_MAX_OPT_IN
in: IMPROVE_PERFORMANCE_MAX_AD_STRENGTH
in: MIGRATE_DYNAMIC_SEARCH_ADS_CAMPAIGN_TO_PERFORMANCE_MAX
in: FORECASTING_SET_TARGET_CPA
in: SET_TARGET_CPA
in: SET_TARGET_ROAS
in: MAXIMIZE_CONVERSION_VALUE_OPT_IN
in: IMPROVE_GOOGLE_TAG_COVERAGE
in: PERFORMANCE_MAX_FINAL_URL_OPT_IN
in: REFRESH_CUSTOMER_MATCH_LIST
in: CUSTOM_AUDIENCE_OPT_IN
in: LEAD_FORM_ASSET
in: IMPROVE_DEMAND_GEN_AD_STRENGTH

path: geoTargetCountry
name: geo target country
description: Resource name of the geo target constant that represents a country.
datatype: string
max count: 1

path: productSoldCustomAttribute2
name: product sold custom attribute2
description: Custom attribute 2 of the product sold.
datatype: string
max count: 1

path: adSubNetworkType
name: ad sub network type
description: Ad sub network type. Currently only available for ads running as part of DemandGen campaigns on YouTube and has to always be selected together with ad_network_type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNSEGMENTED
in: YOUTUBE_INSTREAM
in: YOUTUBE_INFEED
in: YOUTUBE_SHORTS

path: travelDestinationCity
name: travel destination city
description: The city the user is searching for at query time.
datatype: string
max count: 1

path: verticalAdsEventParticipantDisplayNames
name: vertical ads event participant display names
description: The display names of participants in an event listing, like performers, speakers, or teams.
datatype: string
max count: 1

path: skAdNetworkSourceDomain
name: sk ad network source domain
description: 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.
datatype: string
max count: 1

path: conversionAttributionEventType
name: conversion attribution event type
description: Conversion attribution event type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: IMPRESSION
in: INTERACTION
in: ENGAGED_VIEW

path: hotelClass
name: hotel class
description: Hotel class.
datatype: int
max count: 1

path: productCondition
name: product condition
description: Condition of the product.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: NEW
in: REFURBISHED
in: USED

path: verticalAdsListingCountry
name: vertical ads listing country
description: The country where the vertical ads listing is located.
datatype: string
max count: 1

path: productStoreId
name: product store id
description: Store ID of the product.
datatype: string
max count: 1

path: month
name: month
description: Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
datatype: string
max count: 1

path: dayOfWeek
name: day of week
description: Day of the week, for example, MONDAY.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: MONDAY
in: TUESDAY
in: WEDNESDAY
in: THURSDAY
in: FRIDAY
in: SATURDAY
in: SUNDAY

path: geoTargetMostSpecificLocation
name: geo target most specific location
description: Resource name of the geo target constant that represents the most specific location.
datatype: string
max count: 1

path: hour
name: hour
description: Hour of day as a number between 0 and 23, inclusive.
datatype: int
max count: 1

path: hotelRateType
name: hotel rate type
description: Hotel rate type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNAVAILABLE
in: PUBLIC_RATE
in: QUALIFIED_RATE
in: PRIVATE_RATE

path: geoTargetDistrict
name: geo target district
description: Resource name of the geo target constant that represents a district.
datatype: string
max count: 1

path: productCategoryLevel4
name: product category level4
description: Category (level 4) of the product.
datatype: string
max count: 1

path: quarter
name: quarter
description: 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.
datatype: string
max count: 1

path: hotelDateSelectionType
name: hotel date selection type
description: Hotel date selection type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: DEFAULT_SELECTION
in: USER_SELECTED

path: conversionAdjustment
name: conversion adjustment
description: 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.
datatype: boolean
max count: 1

path: activityRating
name: activity rating
description: Activity rating.
datatype: long
max count: 1

path: webpage
name: webpage
description: Resource name of the ad group criterion that represents webpage criterion.
datatype: string
max count: 1

path: skAdNetworkSourceApp
name: sk ad network source app
description: 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.
node: SkAdNetworkSourceAppShape
class: SkAdNetworkSourceApp
node kind: BlankNodeOrIRI
max count: 1

path: adUsingProductData
name: ad using product data
description: Indicates whether an ad is using product data from a Google Merchant Center feed. This segment is only available for PMax campaigns and will not return data when any other campaign type is selected.
datatype: boolean
max count: 1

path: adUsingVideo
name: ad using video
description: Indicates whether an ad is using a video asset. This segment is only available for PMax campaigns and will not return data when any other campaign type is selected.
datatype: boolean
max count: 1

path: geoTargetState
name: geo target state
description: Resource name of the geo target constant that represents a state.
datatype: string
max count: 1

path: budgetCampaignAssociationStatus
name: budget campaign association status
description: Budget campaign association status.
node: BudgetCampaignAssociationStatusShape
class: BudgetCampaignAssociationStatus
node kind: BlankNodeOrIRI
max count: 1

path: verticalAdsListingRegion
name: vertical ads listing region
description: The region where the vertical ads listing is located.
datatype: string
max count: 1

path: adjustedAgeRange
name: adjusted age range
description: Adjusted age range. This is the age range of the user after applying modeling to get more accurate age and gender information. Currently, both adjusted_age_range and adjusted_gender need to be selected together to get valid reach stats. These segmentations are only available for allowlisted customers.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: AGE_RANGE_18_24
in: AGE_RANGE_25_34
in: AGE_RANGE_35_44
in: AGE_RANGE_45_54
in: AGE_RANGE_55_64
in: AGE_RANGE_65_UP
in: AGE_RANGE_UNDETERMINED

path: productSoldTypeL1
name: product sold type l1
description: Type (level 1) of the product sold.
datatype: string
max count: 1

path: verticalAdsHotelClass
name: vertical ads hotel class
description: The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed.
datatype: long
max count: 1

path: searchSubcategory
name: search subcategory
description: A search term subcategory. An empty string denotes the catch-all subcategory for search terms that didn't fit into another subcategory.
datatype: string
max count: 1

path: externalActivityId
name: external activity id
description: Advertiser supplied activity ID.
datatype: string
max count: 1

path: productLanguage
name: product language
description: Resource name of the language constant for the language of the product.
datatype: string
max count: 1

path: hotelBookingWindowDays
name: hotel booking window days
description: Hotel booking window in days.
datatype: long
max count: 1

path: device
name: device
description: Device to which metrics apply.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: MOBILE
in: TABLET
in: DESKTOP
in: CONNECTED_TV
in: OTHER

path: monthOfYear
name: month of year
description: Month of the year, for example, January.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: JANUARY
in: FEBRUARY
in: MARCH
in: APRIL
in: MAY
in: JUNE
in: JULY
in: AUGUST
in: SEPTEMBER
in: OCTOBER
in: NOVEMBER
in: DECEMBER

path: productSoldTypeL4
name: product sold type l4
description: Type (level 4) of the product sold.
datatype: string
max count: 1

path: hotelCenterId
name: hotel center id
description: Hotel center ID.
datatype: long
max count: 1

path: productSoldTypeL2
name: product sold type l2
description: Type (level 2) of the product sold.
datatype: string
max count: 1

path: campaign
name: campaign
description: Resource name of the campaign.
datatype: string
max count: 1

path: productSoldCategoryLevel2
name: product sold category level2
description: Category (level 2) of the product sold.
datatype: string
max count: 1

path: productSoldCategoryLevel5
name: product sold category level5
description: Category (level 5) of the product sold.
datatype: string
max count: 1

path: searchTermTargetingStatus
name: search term targeting status
description: Indicates whether the search term is currently one of your targeted or excluded keywords.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ADDED
in: EXCLUDED
in: ADDED_EXCLUDED
in: NONE

path: adFormatType
name: ad format type
description: Ad Format type.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: OTHER
in: UNSEGMENTED
in: INSTREAM_SKIPPABLE
in: INSTREAM_NON_SKIPPABLE
in: INFEED
in: BUMPER
in: OUTSTREAM
in: MASTHEAD
in: AUDIO
in: SHORTS
in: PAUSE
in: VERTICAL_ADS_PROMOTION
in: VERTICAL_ADS_BOOKING_LINK
in: TEXT

path: hotelPriceBucket
name: hotel price bucket
description: Hotel price bucket.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: LOWEST_UNIQUE
in: LOWEST_TIED
in: NOT_LOWEST
in: ONLY_PARTNER_SHOWN

path: activityState
name: activity state
description: The state where the travel activity is available.
datatype: string
max count: 1

path: productCategoryLevel2
name: product category level2
description: Category (level 2) of the product.
datatype: string
max count: 1

path: productCategoryLevel3
name: product category level3
description: Category (level 3) of the product.
datatype: string
max count: 1

path: skAdNetworkCoarseConversionValue
name: sk ad network coarse conversion value
description: iOS Store Kit Ad Network coarse conversion value.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNAVAILABLE
in: LOW
in: MEDIUM
in: HIGH
in: NONE

path: hotelLengthOfStay
name: hotel length of stay
description: Hotel length of stay.
datatype: int
max count: 1

path: productSoldItemId
name: product sold item id
description: Item ID of the product sold.
datatype: string
max count: 1

path: productCategoryLevel5
name: product category level5
description: Category (level 5) of the product.
datatype: string
max count: 1

path: skAdNetworkFineConversionValue
name: sk ad network fine conversion value
description: iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign.
datatype: long
max count: 1

path: adGroup
name: ad group
description: Resource name of the ad group.
datatype: string
max count: 1

path: matchType
name: match type
description: The match type of the keyword that triggered the ad. This segment is for use with keyword_view. For other resources, use search_term_match_type. While match_type is filtered to Broad, Exact, Phrase and Ai Max, search_term_match_type includes variants like Near Exact, Near Phrase.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: BROAD
in: EXACT
in: PHRASE
in: AI_MAX

path: hotelCity
name: hotel city
description: Hotel city.
datatype: string
max count: 1

path: productCategoryLevel1
name: product category level1
description: Category (level 1) of the product.
datatype: string
max count: 1

path: geoTargetAirport
name: geo target airport
description: Resource name of the geo target constant that represents an airport.
datatype: string
max count: 1

path: productSoldCategoryLevel1
name: product sold category level1
description: Category (level 1) of the product sold.
datatype: string
max count: 1

path: conversionLagBucket
name: conversion lag bucket
description: An enum value representing the number of days between the impression and the conversion.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: LESS_THAN_ONE_DAY
in: ONE_TO_TWO_DAYS
in: TWO_TO_THREE_DAYS
in: THREE_TO_FOUR_DAYS
in: FOUR_TO_FIVE_DAYS
in: FIVE_TO_SIX_DAYS
in: SIX_TO_SEVEN_DAYS
in: SEVEN_TO_EIGHT_DAYS
in: EIGHT_TO_NINE_DAYS
in: NINE_TO_TEN_DAYS
in: TEN_TO_ELEVEN_DAYS
in: ELEVEN_TO_TWELVE_DAYS
in: TWELVE_TO_THIRTEEN_DAYS
in: THIRTEEN_TO_FOURTEEN_DAYS
in: FOURTEEN_TO_TWENTY_ONE_DAYS
in: TWENTY_ONE_TO_THIRTY_DAYS
in: THIRTY_TO_FORTY_FIVE_DAYS
in: FORTY_FIVE_TO_SIXTY_DAYS
in: SIXTY_TO_NINETY_DAYS

path: mobileDevicePlatform
name: mobile device platform
description: Mobile device platform to which metrics apply.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: ANDROID
in: IOS
in: OTHER_MOBILE
in: DESKTOP

path: productCustomAttribute3
name: product custom attribute3
description: Custom attribute 3 of the product.
datatype: string
max count: 1

path: productSoldCustomAttribute0
name: product sold custom attribute0
description: Custom attribute 0 of the product sold.
datatype: string
max count: 1

path: year
name: year
description: Year, formatted as yyyy.
datatype: int
max count: 1

path: externalConversionSource
name: external conversion source
description: External conversion source.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: WEBPAGE
in: ANALYTICS
in: UPLOAD
in: AD_CALL_METRICS
in: WEBSITE_CALL_METRICS
in: STORE_VISITS
in: ANDROID_IN_APP
in: IOS_IN_APP
in: IOS_FIRST_OPEN
in: APP_UNSPECIFIED
in: ANDROID_FIRST_OPEN
in: UPLOAD_CALLS
in: FIREBASE
in: CLICK_TO_CALL
in: SALESFORCE
in: STORE_SALES_CRM
in: STORE_SALES_PAYMENT_NETWORK
in: GOOGLE_PLAY
in: THIRD_PARTY_APP_ANALYTICS
in: GOOGLE_ATTRIBUTION
in: STORE_SALES_DIRECT_UPLOAD
in: STORE_SALES
in: SEARCH_ADS_360
in: GOOGLE_HOSTED
in: FLOODLIGHT
in: ANALYTICS_SEARCH_ADS_360
in: FIREBASE_SEARCH_ADS_360
in: DISPLAY_AND_VIDEO_360_FLOODLIGHT

path: productSoldTitle
name: product sold title
description: Title of the product sold.
datatype: string
max count: 1

path: productChannelExclusivity
name: product channel exclusivity
description: Channel exclusivity of the product.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: SINGLE_CHANNEL
in: MULTI_CHANNEL

path: productSoldCustomAttribute3
name: product sold custom attribute3
description: Custom attribute 3 of the product sold.
datatype: string
max count: 1

path: travelDestinationCountry
name: travel destination country
description: The country the user is searching for at query time.
datatype: string
max count: 1

path: searchTerm
name: search term
description: A search term.
datatype: string
max count: 1

path: productCustomAttribute0
name: product custom attribute0
description: Custom attribute 0 of the product.
datatype: string
max count: 1

path: interactionOnThisExtension
name: interaction on this extension
description: Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
datatype: boolean
max count: 1

path: skAdNetworkAttributionCredit
name: sk ad network attribution credit
description: iOS Store Kit Ad Network attribution credit
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNAVAILABLE
in: WON
in: CONTRIBUTED

path: geoTargetMetro
name: geo target metro
description: Resource name of the geo target constant that represents a metro.
datatype: string
max count: 1

path: productMerchantId
name: product merchant id
description: Merchant ID of the product.
datatype: long
max count: 1

path: activityCity
name: activity city
description: The city where the travel activity is available.
datatype: string
max count: 1

path: skAdNetworkRedistributedFineConversionValue
name: sk ad network redistributed fine conversion value
description: iOS Store Kit Ad Network redistributed fine conversion value. Google uses modeling on observed conversion values(obtained from Apple) to calculate conversions from SKAN postbacks where NULLs are returned. This column represents the sum of the modeled conversion values and the observed conversion values. See https://support.google.com/google-ads/answer/14892597 to lean more.
datatype: long
max count: 1

path: productBrand
name: product brand
description: Brand of the product.
datatype: string
max count: 1

path: conversionActionName
name: conversion action name
description: Conversion action name.
datatype: string
max count: 1

path: week
name: week
description: Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
datatype: string
max count: 1

path: productSoldCategoryLevel4
name: product sold category level4
description: Category (level 4) of the product sold.
datatype: string
max count: 1

path: verticalAdsListing
name: vertical ads listing
description: The listing associated with a listing impression, click or conversion.
datatype: string
max count: 1

path: conversionActionCategory
name: conversion action category
description: Conversion action category.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: DEFAULT
in: PAGE_VIEW
in: PURCHASE
in: SIGNUP
in: DOWNLOAD
in: ADD_TO_CART
in: BEGIN_CHECKOUT
in: SUBSCRIBE_PAID
in: PHONE_CALL_LEAD
in: IMPORTED_LEAD
in: SUBMIT_LEAD_FORM
in: BOOK_APPOINTMENT
in: REQUEST_QUOTE
in: GET_DIRECTIONS
in: OUTBOUND_CLICK
in: CONTACT
in: ENGAGEMENT
in: STORE_VISIT
in: STORE_SALE
in: QUALIFIED_LEAD
in: CONVERTED_LEAD
in: YOUTUBE_FOLLOW_ON_VIEWS

path: productSoldCustomAttribute1
name: product sold custom attribute1
description: Custom attribute 1 of the product sold.
datatype: string
max count: 1

path: productSoldBrand
name: product sold brand
description: Brand of the product sold.
datatype: string
max count: 1

path: verticalAdsListingUserRating
name: vertical ads listing user rating
description: Integer value specifying the user rating of the vertical ads listing as a number from 1 to 5, where 5 is the best. The value will always be within this range.
datatype: long
max count: 1

path: hotelCheckInDayOfWeek
name: hotel check in day of week
description: Hotel check-in day of week.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: MONDAY
in: TUESDAY
in: WEDNESDAY
in: THURSDAY
in: FRIDAY
in: SATURDAY
in: SUNDAY

path: productCustomAttribute1
name: product custom attribute1
description: Custom attribute 1 of the product.
datatype: string
max count: 1

path: customAttribute1
name: custom attribute1
description: Output only. The custom attribute 1 of the product as provided by the merchant.
write lifecycle: Read only
datatype: string
max count: 1

path: categoryLevel3
name: category level3
description: Output only. The category level 3 of the product.
write lifecycle: Read only
datatype: string
max count: 1

path: condition
name: condition
description: Output only. The condition of the product as provided by the merchant.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: NEW
in: REFURBISHED
in: USED

path: customAttribute2
name: custom attribute2
description: Output only. The custom attribute 2 of the product as provided by the merchant.
write lifecycle: Read only
datatype: string
max count: 1

path: campaign
name: campaign
description: Output only. A campaign that includes the product. This field is selectable only in the campaign scope, which requires an equality filter on `campaign`.
write lifecycle: Read only
datatype: string
max count: 1

path: availability
name: availability
description: Output only. The availability of the product as provided by the merchant.
write lifecycle: Read only
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: IN_STOCK
in: OUT_OF_STOCK
in: PREORDER

path: title
name: title
description: Output only. The title of the product as provided by the merchant.
write lifecycle: Read only
datatype: string
max count: 1

path: priceMicros
name: price micros
description: Output only. The price of the product in micros as provided by the merchant, in the currency specified in `currency_code` (e.g. $2.97 is reported as 2970000).
write lifecycle: Read only
datatype: long
max count: 1

path: targetCountries
name: target countries
description: Output only. Upper-case two-letter ISO 3166-1 code of the regions where the product is intended to be shown in ads.
write lifecycle: Read only
datatype: string

path: closingReason
name: closing reason
description: Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open.
datatype: string
max count: 1
in: UNSPECIFIED
in: UNKNOWN
in: UNUSED

path: eligibleForSearch
name: eligible for search
description: Indicates if this user list is eligible for Google Search Network.
datatype: boolean
max count: 1

path: name
name: name
description: Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`.
datatype: string
max count: 1

path: sizeForSearch
name: size for search
description: Output only. Estimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only.
write lifecycle: Read only
datatype: long
max count: 1

path: matchRatePercentage
name: match rate percentage
description: Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. This field is read-only.
write lifecycle: Read only
datatype: int
max count: 1

path: textAdRecommendation
name: text ad recommendation
description: Output only. Add expanded text ad recommendation.
write lifecycle: Read only
class: RecommendationTextAdRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: targetCpaOptInRecommendation
name: target cpa opt in recommendation
description: Output only. The TargetCPA opt-in recommendation.
write lifecycle: Read only
node: RecommendationTargetCpaOptInRecommendationShape
class: RecommendationTargetCpaOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: improvePerformanceMaxAdStrengthRecommendation
name: improve performance max ad strength recommendation
description: Output only. The improve Performance Max ad strength recommendation.
write lifecycle: Read only
node: RecommendationImprovePerformanceMaxAdStrengthRecommendationShape
class: RecommendationImprovePerformanceMaxAdStrengthRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: forecastingSetTargetCpaRecommendation
name: forecasting set target cpa recommendation
description: Output only. The forecasting set target CPA recommendation.
write lifecycle: Read only
node: RecommendationForecastingSetTargetCpaRecommendationShape
class: RecommendationForecastingSetTargetCpaRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: maximizeClicksOptInRecommendation
name: maximize clicks opt in recommendation
description: Output only. The MaximizeClicks Opt-In recommendation.
write lifecycle: Read only
node: RecommendationMaximizeClicksOptInRecommendationShape
class: RecommendationMaximizeClicksOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: campaignBudget
name: campaign budget
description: Output only. The budget targeted by this recommendation. This will be set only when the recommendation affects a single campaign budget. This field will be set for the following recommendation types: CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET, MOVE_UNUSED_BUDGET
write lifecycle: Read only
datatype: string
max count: 1

path: performanceMaxOptInRecommendation
name: performance max opt in recommendation
description: Output only. The Performance Max Opt In recommendation.
write lifecycle: Read only
node: RecommendationPerformanceMaxOptInRecommendationShape
class: RecommendationPerformanceMaxOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingTargetAllOffersRecommendation
name: shopping target all offers recommendation
description: Output only. The shopping target all offers recommendation.
write lifecycle: Read only
node: RecommendationShoppingTargetAllOffersRecommendationShape
class: RecommendationShoppingTargetAllOffersRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingFixSuspendedMerchantCenterAccountRecommendation
name: shopping fix suspended merchant center account recommendation
description: Output only. The shopping fix suspended Merchant Center account recommendation.
write lifecycle: Read only
node: RecommendationShoppingMerchantCenterAccountSuspensionRecommendationShape
class: RecommendationShoppingMerchantCenterAccountSuspensionRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingAddColorRecommendation
name: shopping add color recommendation
description: Output only. The shopping add color recommendation.
write lifecycle: Read only
node: RecommendationShoppingOfferAttributeRecommendationShape
class: RecommendationShoppingOfferAttributeRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: improveDemandGenAdStrengthRecommendation
name: improve demand gen ad strength recommendation
description: Output only. The improve Demand Gen ad strength recommendation.
write lifecycle: Read only
node: RecommendationImproveDemandGenAdStrengthRecommendationShape
class: RecommendationImproveDemandGenAdStrengthRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: responsiveSearchAdAssetRecommendation
name: responsive search ad asset recommendation
description: Output only. The responsive search ad asset recommendation.
write lifecycle: Read only
class: RecommendationResponsiveSearchAdAssetRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingAddMoreIdentifiersRecommendation
name: shopping add more identifiers recommendation
description: Output only. The shopping add more identifiers recommendation.
write lifecycle: Read only
node: RecommendationShoppingOfferAttributeRecommendationShape
class: RecommendationShoppingOfferAttributeRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: raiseTargetCpaBidTooLowRecommendation
name: raise target cpa bid too low recommendation
description: Output only. The raise target CPA bid too low recommendation.
write lifecycle: Read only
node: RecommendationRaiseTargetCpaBidTooLowRecommendationShape
class: RecommendationRaiseTargetCpaBidTooLowRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingAddAgeGroupRecommendation
name: shopping add age group recommendation
description: Output only. The shopping add age group recommendation.
write lifecycle: Read only
node: RecommendationShoppingOfferAttributeRecommendationShape
class: RecommendationShoppingOfferAttributeRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: moveUnusedBudgetRecommendation
name: move unused budget recommendation
description: Output only. The move unused budget recommendation.
write lifecycle: Read only
node: RecommendationMoveUnusedBudgetRecommendationShape
class: RecommendationMoveUnusedBudgetRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingAddGenderRecommendation
name: shopping add gender recommendation
description: Output only. The shopping add gender recommendation.
write lifecycle: Read only
node: RecommendationShoppingOfferAttributeRecommendationShape
class: RecommendationShoppingOfferAttributeRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: useBroadMatchKeywordRecommendation
name: use broad match keyword recommendation
description: Output only. The use broad match keyword recommendation.
write lifecycle: Read only
node: RecommendationUseBroadMatchKeywordRecommendationShape
class: RecommendationUseBroadMatchKeywordRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingFixDisapprovedProductsRecommendation
name: shopping fix disapproved products recommendation
description: Output only. The shopping fix disapproved products recommendation.
write lifecycle: Read only
node: RecommendationShoppingFixDisapprovedProductsRecommendationShape
class: RecommendationShoppingFixDisapprovedProductsRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: shoppingAddProductsToCampaignRecommendation
name: shopping add products to campaign recommendation
description: Output only. The shopping add products to campaign recommendation.
write lifecycle: Read only
node: RecommendationShoppingAddProductsToCampaignRecommendationShape
class: RecommendationShoppingAddProductsToCampaignRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: maximizeConversionValueOptInRecommendation
name: maximize conversion value opt in recommendation
description: Output only. The Maximize Conversion Value opt-in recommendation.
write lifecycle: Read only
node: RecommendationMaximizeConversionValueOptInRecommendationShape
class: RecommendationMaximizeConversionValueOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: callAssetRecommendation
name: call asset recommendation
description: Output only. The call asset recommendation.
write lifecycle: Read only
node: RecommendationCallAssetRecommendationShape
class: RecommendationCallAssetRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: refreshCustomerMatchListRecommendation
name: refresh customer match list recommendation
description: Output only. The refresh customer list recommendation.
write lifecycle: Read only
node: RecommendationRefreshCustomerMatchListRecommendationShape
class: RecommendationRefreshCustomerMatchListRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: enhancedCpcOptInRecommendation
name: enhanced cpc opt in recommendation
description: Output only. The Enhanced Cost-Per-Click Opt-In recommendation.
write lifecycle: Read only
node: RecommendationEnhancedCpcOptInRecommendationShape
class: RecommendationEnhancedCpcOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: searchPartnersOptInRecommendation
name: search partners opt in recommendation
description: Output only. The Search Partners Opt-In recommendation.
write lifecycle: Read only
node: RecommendationSearchPartnersOptInRecommendationShape
class: RecommendationSearchPartnersOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: upgradeSmartShoppingCampaignToPerformanceMaxRecommendation
name: upgrade smart shopping campaign to performance max recommendation
description: Output only. The upgrade a Smart Shopping campaign to a Performance Max campaign recommendation.
write lifecycle: Read only
node: RecommendationUpgradeSmartShoppingCampaignToPerformanceMaxRecommendationShape
class: RecommendationUpgradeSmartShoppingCampaignToPerformanceMaxRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: leadFormAssetRecommendation
name: lead form asset recommendation
description: Output only. The lead form asset recommendation.
write lifecycle: Read only
node: RecommendationLeadFormAssetRecommendationShape
class: RecommendationLeadFormAssetRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: maximizeConversionsOptInRecommendation
name: maximize conversions opt in recommendation
description: Output only. The MaximizeConversions Opt-In recommendation.
write lifecycle: Read only
node: RecommendationMaximizeConversionsOptInRecommendationShape
class: RecommendationMaximizeConversionsOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: sitelinkAssetRecommendation
name: sitelink asset recommendation
description: Output only. The sitelink asset recommendation.
write lifecycle: Read only
node: RecommendationSitelinkAssetRecommendationShape
class: RecommendationSitelinkAssetRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: setTargetCpaRecommendation
name: set target cpa recommendation
description: Output only. The set target CPA recommendation.
write lifecycle: Read only
node: RecommendationForecastingSetTargetCpaRecommendationShape
class: RecommendationForecastingSetTargetCpaRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: dismissed
name: dismissed
description: Output only. Whether the recommendation is dismissed or not.
write lifecycle: Read only
datatype: boolean
max count: 1

path: optimizeAdRotationRecommendation
name: optimize ad rotation recommendation
description: Output only. The Optimize Ad Rotation recommendation.
write lifecycle: Read only
node: RecommendationOptimizeAdRotationRecommendationShape
class: RecommendationOptimizeAdRotationRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: customAudienceOptInRecommendation
name: custom audience opt in recommendation
description: Output only. The custom audience opt in recommendation.
write lifecycle: Read only
node: RecommendationCustomAudienceOptInRecommendationShape
class: RecommendationCustomAudienceOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: calloutAssetRecommendation
name: callout asset recommendation
description: Output only. The callout asset recommendation.
write lifecycle: Read only
node: RecommendationCalloutAssetRecommendationShape
class: RecommendationCalloutAssetRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: impact
name: impact
description: Output only. The impact on account performance as a result of applying the recommendation.
write lifecycle: Read only
node: RecommendationRecommendationImpactShape
class: RecommendationRecommendationImpact
node kind: BlankNodeOrIRI
max count: 1

path: shoppingMigrateRegularShoppingCampaignOffersToPerformanceMaxRecommendation
name: shopping migrate regular shopping campaign offers to performance max recommendation
description: Output only. The shopping migrate Regular Shopping Campaign offers to Performance Max recommendation.
write lifecycle: Read only
node: RecommendationShoppingMigrateRegularShoppingCampaignOffersToPerformanceMaxRecommendationShape
class: RecommendationShoppingMigrateRegularShoppingCampaignOffersToPerformanceMaxRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: displayExpansionOptInRecommendation
name: display expansion opt in recommendation
description: Output only. The Display Expansion opt-in recommendation.
write lifecycle: Read only
node: RecommendationDisplayExpansionOptInRecommendationShape
class: RecommendationDisplayExpansionOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: raiseTargetCpaRecommendation
name: raise target cpa recommendation
description: Output only. Recommendation to raise Target CPA.
write lifecycle: Read only
node: RecommendationRaiseTargetCpaRecommendationShape
class: RecommendationRaiseTargetCpaRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: campaign
name: campaign
description: Output only. The campaign targeted by this recommendation. This field will be set for the following recommendation types: CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN, USE_BROAD_MATCH_KEYWORD, KEYWORD, KEYWORD_MATCH_TYPE, UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, SEARCH_PARTNERS_OPT_IN, DISPLAY_EXPANSION_OPT_IN, SITELINK_EXTENSION, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD, UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX, RAISE_TARGET_CPA_BID_TOO_LOW, FORECASTING_SET_TARGET_ROAS, SHOPPING_ADD_AGE_GROUP, SHOPPING_ADD_COLOR, SHOPPING_ADD_GENDER, SHOPPING_ADD_SIZE, SHOPPING_ADD_GTIN, SHOPPING_ADD_MORE_IDENTIFIERS, SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN, SHOPPING_FIX_DISAPPROVED_PRODUCTS, SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX, DYNAMIC_IMAGE_EXTENSION_OPT_IN, RAISE_TARGET_CPA, LOWER_TARGET_ROAS, FORECASTING_SET_TARGET_CPA, SET_TARGET_CPA, SET_TARGET_ROAS, MAXIMIZE_CONVERSION_VALUE_OPT_IN, IMPROVE_GOOGLE_TAG_COVERAGE, PERFORMANCE_MAX_FINAL_URL_OPT_IN
write lifecycle: Read only
datatype: string
max count: 1

path: resourceName
name: resource name
description: Immutable. The resource name of the recommendation. `customers/{customer_id}/recommendations/{recommendation_id}`
write lifecycle: Create only
datatype: string
max count: 1

path: targetRoasOptInRecommendation
name: target roas opt in recommendation
description: Output only. The Target ROAS opt-in recommendation.
write lifecycle: Read only
node: RecommendationTargetRoasOptInRecommendationShape
class: RecommendationTargetRoasOptInRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: adGroup
name: ad group
description: Output only. The ad group targeted by this recommendation. This will be set only when the recommendation affects a single ad group. This field will be set for the following recommendation types: KEYWORD, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, TEXT_AD
write lifecycle: Read only
datatype: string
max count: 1

path: campaignBudgetRecommendation
name: campaign budget recommendation
description: Output only. The campaign budget recommendation.
write lifecycle: Read only
node: RecommendationCampaignBudgetRecommendationShape
class: RecommendationCampaignBudgetRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: improveGoogleTagCoverageRecommendation
name: improve google tag coverage recommendation
description: Output only. Recommendation to deploy Google Tag on more pages.
write lifecycle: Read only
node: RecommendationImproveGoogleTagCoverageRecommendationShape
class: RecommendationImproveGoogleTagCoverageRecommendation
node kind: BlankNodeOrIRI
max count: 1

path: responsiveSearchAdRecommendation
name: responsive search ad recommendation
description: Output only. The add responsive search ad recommendation.
write lifecycle: Read only
class: RecommendationResponsiveSearchAdRecommendation
node kind: BlankNodeOrIRI
max count: 1