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

Asset

Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.

JSON representation
{
  "resourceName": string,
  "type": enum (AssetType),
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "source": enum (AssetSource),
  "policySummary": {
    object (AssetPolicySummary)
  },
  "id": string,
  "name": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string,

  // Union field asset_data can be only one of the following:
  "youtubeVideoAsset": {
    object (YoutubeVideoAsset)
  },
  "mediaBundleAsset": {
    object (MediaBundleAsset)
  },
  "imageAsset": {
    object (ImageAsset)
  },
  "textAsset": {
    object (TextAsset)
  },
  "leadFormAsset": {
    object (LeadFormAsset)
  },
  "bookOnGoogleAsset": {
    object (BookOnGoogleAsset)
  },
  "promotionAsset": {
    object (PromotionAsset)
  },
  "calloutAsset": {
    object (CalloutAsset)
  },
  "structuredSnippetAsset": {
    object (StructuredSnippetAsset)
  },
  "sitelinkAsset": {
    object (SitelinkAsset)
  },
  "pageFeedAsset": {
    object (PageFeedAsset)
  },
  "dynamicEducationAsset": {
    object (DynamicEducationAsset)
  },
  "mobileAppAsset": {
    object (MobileAppAsset)
  },
  "hotelCalloutAsset": {
    object (HotelCalloutAsset)
  },
  "callAsset": {
    object (CallAsset)
  },
  "priceAsset": {
    object (PriceAsset)
  },
  "callToActionAsset": {
    object (CallToActionAsset)
  },
  "dynamicRealEstateAsset": {
    object (DynamicRealEstateAsset)
  },
  "dynamicCustomAsset": {
    object (DynamicCustomAsset)
  },
  "dynamicHotelsAndRentalsAsset": {
    object (DynamicHotelsAndRentalsAsset)
  },
  "dynamicFlightsAsset": {
    object (DynamicFlightsAsset)
  },
  "discoveryCarouselCardAsset": {
    object (DiscoveryCarouselCardAsset)
  },
  "dynamicTravelAsset": {
    object (DynamicTravelAsset)
  },
  "dynamicLocalAsset": {
    object (DynamicLocalAsset)
  },
  "dynamicJobsAsset": {
    object (DynamicJobsAsset)
  }
  // End of list of possible types for union field asset_data.
}
Fields
resourceName

string

Immutable. The resource name of the asset. Asset resource names have the form:

customers/{customerId}/assets/{asset_id}

type

enum (AssetType)

Output only. Type of the asset.

finalUrls[]

string

A list of possible final URLs after all cross domain redirects.

finalMobileUrls[]

string

A list of possible final mobile URLs after all cross domain redirects.

urlCustomParameters[]

object (CustomParameter)

A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.

source

enum (AssetSource)

Output only. Source of the asset.

policySummary

object (AssetPolicySummary)

Output only. Policy information for the asset.

id

string (int64 format)

Output only. The ID of the asset.

name

string

Optional name of the asset.

trackingUrlTemplate

string

URL template for constructing a tracking URL.

finalUrlSuffix

string

URL template for appending params to landing page URLs served with parallel tracking.

Union field asset_data. The specific type of the asset. asset_data can be only one of the following:
youtubeVideoAsset

object (YoutubeVideoAsset)

Immutable. A YouTube video asset.

mediaBundleAsset

object (MediaBundleAsset)

Immutable. A media bundle asset.

imageAsset

object (ImageAsset)

Output only. An image asset.

textAsset

object (TextAsset)

Immutable. A text asset.

leadFormAsset

object (LeadFormAsset)

A lead form asset.

bookOnGoogleAsset

object (BookOnGoogleAsset)

A book on google asset.

promotionAsset

object (PromotionAsset)

A promotion asset.

calloutAsset

object (CalloutAsset)

A callout asset.

structuredSnippetAsset

object (StructuredSnippetAsset)

A structured snippet asset.

pageFeedAsset

object (PageFeedAsset)

A page feed asset.

dynamicEducationAsset

object (DynamicEducationAsset)

A dynamic education asset.

mobileAppAsset

object (MobileAppAsset)

A mobile app asset.

hotelCalloutAsset

object (HotelCalloutAsset)

A hotel callout asset.

callAsset

object (CallAsset)

A call asset.

priceAsset

object (PriceAsset)

A price asset.

callToActionAsset

object (CallToActionAsset)

Immutable. A call to action asset.

dynamicRealEstateAsset

object (DynamicRealEstateAsset)

A dynamic real estate asset.

dynamicCustomAsset

object (DynamicCustomAsset)

A dynamic custom asset.

dynamicHotelsAndRentalsAsset

object (DynamicHotelsAndRentalsAsset)

A dynamic hotels and rentals asset.

dynamicFlightsAsset

object (DynamicFlightsAsset)

A dynamic flights asset.

dynamicTravelAsset

object (DynamicTravelAsset)

A dynamic travel asset.

dynamicLocalAsset

object (DynamicLocalAsset)

A dynamic local asset.

dynamicJobsAsset

object (DynamicJobsAsset)

A dynamic jobs asset.

AssetType

Enum describing possible types of asset.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
YOUTUBE_VIDEO YouTube video asset.
MEDIA_BUNDLE Media bundle asset.
IMAGE Image asset.
TEXT Text asset.
LEAD_FORM Lead form asset.
BOOK_ON_GOOGLE Book on Google asset.
PROMOTION Promotion asset.
CALLOUT Callout asset.
STRUCTURED_SNIPPET Structured Snippet asset.
PAGE_FEED Page Feed asset.
DYNAMIC_EDUCATION Dynamic Education asset.
MOBILE_APP Mobile app asset.
HOTEL_CALLOUT Hotel callout asset.
CALL Call asset.
PRICE Price asset.
CALL_TO_ACTION Call to action asset.
DYNAMIC_REAL_ESTATE Dynamic real estate asset.
DYNAMIC_CUSTOM Dynamic custom asset.
DYNAMIC_HOTELS_AND_RENTALS Dynamic hotels and rentals asset.
DYNAMIC_FLIGHTS Dynamic flights asset.
DYNAMIC_TRAVEL Dynamic travel asset.
DYNAMIC_LOCAL Dynamic local asset.
DYNAMIC_JOBS Dynamic jobs asset.

AssetPolicySummary

Contains policy information for an asset.

JSON representation
{
  "policyTopicEntries": [
    {
      object (PolicyTopicEntry)
    }
  ],
  "reviewStatus": enum (PolicyReviewStatus),
  "approvalStatus": enum (PolicyApprovalStatus)
}
Fields
policyTopicEntries[]

object (PolicyTopicEntry)

Output only. The list of policy findings for this asset.

reviewStatus

enum (PolicyReviewStatus)

Output only. Where in the review process this asset is.

approvalStatus

enum (PolicyApprovalStatus)

Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries.

YoutubeVideoAsset

A YouTube asset.

JSON representation
{
  "youtubeVideoTitle": string,
  "youtubeVideoId": string
}
Fields
youtubeVideoTitle

string

YouTube video title.

youtubeVideoId

string

YouTube video id. This is the 11 character string value used in the YouTube video URL.

MediaBundleAsset

A MediaBundle asset.

JSON representation
{
  "data": string
}
Fields
data

string (bytes format)

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.

A base64-encoded string.

ImageAsset

An Image asset.

JSON representation
{
  "mimeType": enum (MimeType),
  "fullSize": {
    object (ImageDimension)
  },
  "data": string,
  "fileSize": string
}
Fields
mimeType

enum (MimeType)

MIME type of the image asset.

fullSize

object (ImageDimension)

Metadata for this image at its original size.

data

string (bytes format)

The raw bytes data of an image. This field is mutate only.

A base64-encoded string.

fileSize

string (int64 format)

File size of the image asset in bytes.

ImageDimension

Metadata for an image at a certain size, either original or resized.

JSON representation
{
  "heightPixels": string,
  "widthPixels": string,
  "url": string
}
Fields
heightPixels

string (int64 format)

Height of the image.

widthPixels

string (int64 format)

Width of the image.

url

string

A URL that returns the image with this height and width.

TextAsset

A Text asset.

JSON representation
{
  "text": string
}
Fields
text

string

Text content of the text asset.

LeadFormAsset

A Lead Form asset.

JSON representation
{
  "businessName": string,
  "callToActionType": enum (LeadFormCallToActionType),
  "callToActionDescription": string,
  "headline": string,
  "description": string,
  "privacyPolicyUrl": string,
  "fields": [
    {
      object (LeadFormField)
    }
  ],
  "customQuestionFields": [
    {
      object (LeadFormCustomQuestionField)
    }
  ],
  "deliveryMethods": [
    {
      object (LeadFormDeliveryMethod)
    }
  ],
  "postSubmitCallToActionType": enum (LeadFormPostSubmitCallToActionType),
  "desiredIntent": enum (LeadFormDesiredIntent),
  "postSubmitHeadline": string,
  "postSubmitDescription": string,
  "backgroundImageAsset": string,
  "customDisclosure": string
}
Fields
businessName

string

Required. The name of the business being advertised.

callToActionType

enum (LeadFormCallToActionType)

Required. Pre-defined display text that encourages user to expand the form.

callToActionDescription

string

Required. Text giving a clear value proposition of what users expect once they expand the form.

headline

string

Required. Headline of the expanded form to describe what the form is asking for or facilitating.

description

string

Required. Detailed description of the expanded form to describe what the form is asking for or facilitating.

privacyPolicyUrl

string

Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business.

fields[]

object (LeadFormField)

Ordered list of input fields.

customQuestionFields[]

object (LeadFormCustomQuestionField)

Ordered list of custom question fields.

deliveryMethods[]

object (LeadFormDeliveryMethod)

Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured.

postSubmitCallToActionType

enum (LeadFormPostSubmitCallToActionType)

Pre-defined display text that encourages user action after the form is submitted.

desiredIntent

enum (LeadFormDesiredIntent)

Desired intent for the lead form, e.g. more volume or more qualified.

postSubmitHeadline

string

Headline of text shown after form submission that describes how the advertiser will follow up with the user.

postSubmitDescription

string

Detailed description shown after form submission that describes how the advertiser will follow up with the user.

backgroundImageAsset

string

Asset resource name of the background image. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%).

customDisclosure

string

Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only.

LeadFormCallToActionType

Enum describing the type of call-to-action phrases in a lead form.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LEARN_MORE Learn more.
GET_QUOTE Get quote.
APPLY_NOW Apply now.
SIGN_UP Sign Up.
CONTACT_US Contact us.
SUBSCRIBE Subscribe.
DOWNLOAD Download.
BOOK_NOW Book now.
GET_OFFER Get offer.
REGISTER Register.
GET_INFO Get info.
REQUEST_DEMO Request a demo.
JOIN_NOW Join now.
GET_STARTED Get started.

LeadFormField

One input field instance within a form.

JSON representation
{
  "inputType": enum (LeadFormFieldUserInputType),
  "singleChoiceAnswers": {
    object (LeadFormSingleChoiceAnswers)
  }
}
Fields
inputType

enum (LeadFormFieldUserInputType)

Describes the input type, which may be a predefined type such as "full name" or a pre-vetted question like "Do you own a car?".

singleChoiceAnswers

object (LeadFormSingleChoiceAnswers)

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.

LeadFormSingleChoiceAnswers

Defines possible answers for a single choice question, usually presented as a single-choice drop-down list.

JSON representation
{
  "answers": [
    string
  ]
}
Fields
answers[]

string

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.

LeadFormCustomQuestionField

One custom question input field instance within a form.

JSON representation
{
  "customQuestionText": string,
  "singleChoiceAnswers": {
    object (LeadFormSingleChoiceAnswers)
  }
}
Fields
customQuestionText

string

The exact custom question field text (e.g. "Do you own a car?").

singleChoiceAnswers

object (LeadFormSingleChoiceAnswers)

Answer configuration for a single choice question. Minimum of 2 answers and maximum of 12 allowed.

LeadFormDeliveryMethod

A configuration of how leads are delivered to the advertiser.

JSON representation
{
  "webhook": {
    object (WebhookDelivery)
  }
}
Fields
webhook

object (WebhookDelivery)

Webhook method of delivery.

WebhookDelivery

Google notifies the advertiser of leads by making HTTP calls to an endpoint they specify. The requests contain JSON matching a schema that Google publishes as part of form ads documentation.

JSON representation
{
  "advertiserWebhookUrl": string,
  "googleSecret": string,
  "payloadSchemaVersion": string
}
Fields
advertiserWebhookUrl

string

Webhook url specified by advertiser to send the lead.

googleSecret

string

Anti-spoofing secret set by the advertiser as part of the webhook payload.

payloadSchemaVersion

string (int64 format)

The schema version that this delivery instance will use.

LeadFormPostSubmitCallToActionType

Enum describing the type of post-submit call-to-action phrases for a lead form.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
VISIT_SITE Visit site.
DOWNLOAD Download.
LEARN_MORE Learn more.
SHOP_NOW Shop now.

LeadFormDesiredIntent

Enum describing the desired level of intent of generated leads.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LOW_INTENT Deliver more leads at a potentially lower quality.
HIGH_INTENT Deliver leads that are more qualified.

BookOnGoogleAsset

A Book on Google asset. Used to redirect user to book through Google. Book on Google will change the redirect url to book directly through Google.

PromotionAsset

A Promotion asset.

JSON representation
{
  "promotionTarget": string,
  "discountModifier": enum (PromotionExtensionDiscountModifier),
  "redemptionStartDate": string,
  "redemptionEndDate": string,
  "occasion": enum (PromotionExtensionOccasion),
  "languageCode": string,
  "startDate": string,
  "endDate": string,
  "adScheduleTargets": [
    {
      object (AdScheduleInfo)
    }
  ],

  // Union field discount_type can be only one of the following:
  "percentOff": string,
  "moneyAmountOff": {
    object (Money)
  }
  // End of list of possible types for union field discount_type.

  // Union field promotion_trigger can be only one of the following:
  "promotionCode": string,
  "ordersOverAmount": {
    object (Money)
  }
  // End of list of possible types for union field promotion_trigger.
}
Fields
promotionTarget

string

Required. A freeform description of what the promotion is targeting.

discountModifier

enum (PromotionExtensionDiscountModifier)

A modifier for qualification of the discount.

redemptionStartDate

string

Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.

redemptionEndDate

string

Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.

occasion

enum (PromotionExtensionOccasion)

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.

languageCode

string

The language of the promotion. Represented as BCP 47 language tag.

startDate

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

endDate

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

adScheduleTargets[]

object (AdScheduleInfo)

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.

Union field discount_type. Discount type, can be percentage off or amount off. discount_type can be only one of the following:
percentOff

string (int64 format)

Percentage off discount in the promotion. 1,000,000 = 100%. Either this or moneyAmountOff is required.

moneyAmountOff

object (Money)

Money amount off for discount in the promotion. Either this or percentOff is required.

Union field promotion_trigger. Promotion trigger. Can be by promotion code or promo by eligible order amount. promotion_trigger can be only one of the following:
promotionCode

string

A code the user should use in order to be eligible for the promotion.

ordersOverAmount

object (Money)

The amount the total order needs to be for the user to be eligible for the promotion.

CalloutAsset

A Callout asset.

JSON representation
{
  "calloutText": string,
  "startDate": string,
  "endDate": string,
  "adScheduleTargets": [
    {
      object (AdScheduleInfo)
    }
  ]
}
Fields
calloutText

string

Required. The callout text. The length of this string should be between 1 and 25, inclusive.

startDate

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

endDate

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

adScheduleTargets[]

object (AdScheduleInfo)

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.

StructuredSnippetAsset

A Structured Snippet asset.

JSON representation
{
  "header": string,
  "values": [
    string
  ]
}
Fields
header

string

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

values[]

string

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.

SitelinkAsset

A Sitelink asset.

JSON representation
{
  "linkText": string,
  "description1": string,
  "description2": string,
  "startDate": string,
  "endDate": string,
  "adScheduleTargets": [
    {
      object (AdScheduleInfo)
    }
  ]
}
Fields
description1

string

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.

description2

string

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.

startDate

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

endDate

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

adScheduleTargets[]

object (AdScheduleInfo)

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.

PageFeedAsset

A Page Feed asset.

JSON representation
{
  "pageUrl": string,
  "labels": [
    string
  ]
}
Fields
pageUrl

string

Required. The webpage that advertisers want to target.

labels[]

string

Labels used to group the page urls.

DynamicEducationAsset

A Dynamic Education asset.

JSON representation
{
  "programId": string,
  "locationId": string,
  "programName": string,
  "subject": string,
  "programDescription": string,
  "schoolName": string,
  "address": string,
  "contextualKeywords": [
    string
  ],
  "androidAppLink": string,
  "similarProgramIds": [
    string
  ],
  "iosAppLink": string,
  "iosAppStoreId": string,
  "thumbnailImageUrl": string,
  "imageUrl": string
}
Fields
programId

string

Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.

locationId

string

Location ID which can be any sequence of letters and digits and must be unique.

programName

string

Required. Program name, e.g. Nursing. Required.

subject

string

Subject of study, e.g. Health.

programDescription

string

Program description, e.g. Nursing Certification.

schoolName

string

School name, e.g. Mountain View School of Nursing.

address

string

School address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403

contextualKeywords[]

string

Contextual keywords, e.g. Nursing certification, Health, Mountain View.

similarProgramIds[]

string

Similar program IDs.

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.

thumbnailImageUrl

string

Thumbnail image url, e.g. http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset.

imageUrl

string

Image url, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

MobileAppAsset

An asset representing a mobile app.

JSON representation
{
  "appId": string,
  "appStore": enum (MobileAppVendor),
  "linkText": string,
  "startDate": string,
  "endDate": string
}
Fields
appId

string

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.

appStore

enum (MobileAppVendor)

Required. The application store that distributes this specific app.

startDate

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

endDate

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

HotelCalloutAsset

An asset representing a hotel callout.

JSON representation
{
  "text": string,
  "languageCode": string
}
Fields
text

string

Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive.

languageCode

string

Required. The language of the hotel callout. Represented as BCP 47 language tag.

CallAsset

A Call asset.

JSON representation
{
  "countryCode": string,
  "phoneNumber": string,
  "callConversionReportingState": enum (CallConversionReportingState),
  "callConversionAction": string,
  "adScheduleTargets": [
    {
      object (AdScheduleInfo)
    }
  ]
}
Fields
countryCode

string

Required. Two-letter country code of the phone number. Examples: 'US', 'us'.

phoneNumber

string

Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'

callConversionReportingState

enum (CallConversionReportingState)

Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.

callConversionAction

string

The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if callConversionReportingState is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.

adScheduleTargets[]

object (AdScheduleInfo)

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.

PriceAsset

An asset representing a list of price offers.

JSON representation
{
  "type": enum (PriceExtensionType),
  "priceQualifier": enum (PriceExtensionPriceQualifier),
  "languageCode": string,
  "priceOfferings": [
    {
      object (PriceOffering)
    }
  ]
}
Fields
type

enum (PriceExtensionType)

Required. The type of the price asset.

priceQualifier

enum (PriceExtensionPriceQualifier)

The price qualifier of the price asset.

languageCode

string

Required. The language of the price asset. Represented as BCP 47 language tag.

priceOfferings[]

object (PriceOffering)

The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive.

PriceOffering

A single price offering within a PriceAsset.

JSON representation
{
  "header": string,
  "description": string,
  "price": {
    object (Money)
  },
  "unit": enum (PriceExtensionPriceUnit),
  "finalUrl": string,
  "finalMobileUrl": string
}
Fields
header

string

Required. The header of the price offering. The length of this string should be between 1 and 25, inclusive.

description

string

Required. The description of the price offering. The length of this string should be between 1 and 25, inclusive.

price

object (Money)

Required. The price value of the price offering.

unit

enum (PriceExtensionPriceUnit)

The price unit of the price offering.

finalUrl

string

Required. The final URL after all cross domain redirects.

finalMobileUrl

string

The final mobile URL after all cross domain redirects.

CallToActionAsset

A call to action asset.

JSON representation
{
  "callToAction": enum (CallToActionType)
}
Fields
callToAction

enum (CallToActionType)

Call to action.

CallToActionType

Enum describing possible types of call to action.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LEARN_MORE The call to action type is learn more.
GET_QUOTE The call to action type is get quote.
APPLY_NOW The call to action type is apply now.
SIGN_UP The call to action type is sign up.
CONTACT_US The call to action type is contact us.
SUBSCRIBE The call to action type is subscribe.
DOWNLOAD The call to action type is download.
BOOK_NOW The call to action type is book now.
SHOP_NOW The call to action type is shop now.

DynamicRealEstateAsset

A dynamic real estate asset.

JSON representation
{
  "listingId": string,
  "listingName": string,
  "cityName": string,
  "description": string,
  "address": string,
  "price": string,
  "imageUrl": string,
  "propertyType": string,
  "listingType": string,
  "contextualKeywords": [
    string
  ],
  "formattedPrice": string,
  "androidAppLink": string,
  "iosAppLink": string,
  "iosAppStoreId": string,
  "similarListingIds": [
    string
  ]
}
Fields
listingId

string

Required. Listing ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.

listingName

string

Required. Listing name, e.g. Boulevard Bungalow. Required.

cityName

string

City name, e.g. Mountain View, California.

description

string

Description, e.g. 3 beds, 2 baths, 1568 sq. ft.

address

string

Address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403

price

string

Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark. e.g. 200,000.00 USD.

imageUrl

string

Image URL, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

propertyType

string

Property type, e.g. House.

listingType

string

Listing type, e.g. For sale.

contextualKeywords[]

string

Contextual keywords, e.g. For sale; Houses for sale.

formattedPrice

string

Formatted price which can be any characters. If set, this attribute will be used instead of 'price', e.g. Starting at $200,000.00.

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.

similarListingIds[]

string

Similar listing IDs.

DynamicCustomAsset

A dynamic custom asset.

JSON representation
{
  "id": string,
  "id2": string,
  "itemTitle": string,
  "itemSubtitle": string,
  "itemDescription": string,
  "itemAddress": string,
  "itemCategory": string,
  "price": string,
  "salePrice": string,
  "formattedPrice": string,
  "formattedSalePrice": string,
  "imageUrl": string,
  "contextualKeywords": [
    string
  ],
  "androidAppLink": string,
  "iosAppLink": string,
  "iosAppStoreId": string,
  "similarIds": [
    string
  ]
}
Fields
id

string

Required. ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag, e.g. sedan. Required.

id2

string

ID2 which can be any sequence of letters and digits, e.g. red. ID sequence (ID + ID2) must be unique.

itemTitle

string

Required. Item title, e.g. Mid-size sedan. Required.

itemSubtitle

string

Item subtitle, e.g. At your Mountain View dealership.

itemDescription

string

Item description, e.g. Best selling mid-size car.

itemAddress

string

Item address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403

itemCategory

string

Item category, e.g. Sedans.

price

string

Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 20,000.00 USD.

salePrice

string

Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 15,000.00 USD. Must be less than the 'price' field.

formattedPrice

string

Formatted price which can be any characters. If set, this attribute will be used instead of 'price', e.g. Starting at $20,000.00.

formattedSalePrice

string

Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', e.g. On sale for $15,000.00.

imageUrl

string

Image URL, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

contextualKeywords[]

string

Contextual keywords, e.g. Sedans, 4 door sedans.

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.

similarIds[]

string

Similar IDs.

DynamicHotelsAndRentalsAsset

A dynamic hotels and rentals asset.

JSON representation
{
  "propertyId": string,
  "propertyName": string,
  "imageUrl": string,
  "destinationName": string,
  "description": string,
  "price": string,
  "salePrice": string,
  "starRating": string,
  "category": string,
  "contextualKeywords": [
    string
  ],
  "address": string,
  "androidAppLink": string,
  "iosAppLink": string,
  "iosAppStoreId": string,
  "formattedPrice": string,
  "formattedSalePrice": string,
  "similarPropertyIds": [
    string
  ]
}
Fields
propertyId

string

Required. Property ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.

propertyName

string

Required. Property name, e.g. Mountain View Hotel. Required.

imageUrl

string

Image URL, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

destinationName

string

Destination name, e.g. Downtown Mountain View.

description

string

Description, e.g. Close to SJC Airport.

price

string

Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 100.00 USD.

salePrice

string

ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD. Must be less than the 'price' field.

starRating

string (int64 format)

Star rating. Must be a number between 1 to 5, inclusive.

category

string

Category, e.g. Hotel suite.

contextualKeywords[]

string

Contextual keywords, e.g. Mountain View "Hotels", South Bay hotels.

address

string

Address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.

formattedPrice

string

Formatted price which can be any characters. If set, this attribute will be used instead of 'price', e.g. Starting at $100.00.

formattedSalePrice

string

Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', e.g. On sale for $80.00.

similarPropertyIds[]

string

Similar property IDs.

DynamicFlightsAsset

A dynamic flights asset.

JSON representation
{
  "destinationId": string,
  "originId": string,
  "flightDescription": string,
  "imageUrl": string,
  "destinationName": string,
  "originName": string,
  "flightPrice": string,
  "flightSalePrice": string,
  "formattedPrice": string,
  "formattedSalePrice": string,
  "androidAppLink": string,
  "iosAppLink": string,
  "iosAppStoreId": string,
  "similarDestinationIds": [
    string
  ],
  "customMapping": string
}
Fields
destinationId

string

Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.

originId

string

Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.

flightDescription

string

Required. Flight description, e.g. Book your ticket. Required.

imageUrl

string

Image URL, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

destinationName

string

Destination name, e.g. Paris.

originName

string

Origin name, e.g. London.

flightPrice

string

Flight price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark. e.g. 100.00 USD.

flightSalePrice

string

Flight sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD. Must be less than the 'flightPrice' field.

formattedPrice

string

Formatted price which can be any characters. If set, this attribute will be used instead of 'price', e.g. Starting at $100.00.

formattedSalePrice

string

Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', e.g. On sale for $80.00.

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.

similarDestinationIds[]

string

Similar destination IDs, e.g. PAR,LON.

customMapping

string

A custom field which can be multiple key to values mapping separated by delimiters (",", "|" and ":"), in the forms of ": , , ... , | : , ... , | ... | : , ... ," e.g. wifi: most | aircraft: 320, 77W | flights: 42 | legroom: 32".

DiscoveryCarouselCardAsset

A Discovery Carousel Card asset.

JSON representation
{
  "marketingImageAsset": string,
  "squareMarketingImageAsset": string,
  "portraitMarketingImageAsset": string,
  "headline": string,
  "callToActionText": string
}
Fields
marketingImageAsset

string

Asset resource name of the associated 1.91:1 marketing image. This and/or square marketing image asset is required.

squareMarketingImageAsset

string

Asset resource name of the associated square marketing image. This and/or a marketing image asset is required.

portraitMarketingImageAsset

string

Asset resource name of the associated 4:5 portrait marketing image.

headline

string

Required. Headline of the carousel card.

callToActionText

string

Call to action text.

DynamicTravelAsset

A dynamic travel asset.

JSON representation
{
  "destinationId": string,
  "originId": string,
  "title": string,
  "destinationName": string,
  "destinationAddress": string,
  "originName": string,
  "price": string,
  "salePrice": string,
  "formattedPrice": string,
  "formattedSalePrice": string,
  "category": string,
  "contextualKeywords": [
    string
  ],
  "similarDestinationIds": [
    string
  ],
  "imageUrl": string,
  "androidAppLink": string,
  "iosAppLink": string,
  "iosAppStoreId": string
}
Fields
destinationId

string

Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.

originId

string

Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.

title

string

Required. Title, e.g. Book your train ticket. Required.

destinationName

string

Destination name, e.g. Paris.

destinationAddress

string

Destination address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403.

originName

string

Origin name, e.g. London.

price

string

Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark. e.g. 100.00 USD.

salePrice

string

Sale price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD. Must be less than the 'price' field.

formattedPrice

string

Formatted price which can be any characters. If set, this attribute will be used instead of 'price', e.g. Starting at $100.00.

formattedSalePrice

string

Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', e.g. On sale for $80.00.

category

string

Category, e.g. Express.

contextualKeywords[]

string

Contextual keywords, e.g. Paris trains.

similarDestinationIds[]

string

Similar destination IDs, e.g. NYC.

imageUrl

string

Image URL, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.

DynamicLocalAsset

A dynamic local asset.

JSON representation
{
  "dealId": string,
  "dealName": string,
  "subtitle": string,
  "description": string,
  "price": string,
  "salePrice": string,
  "imageUrl": string,
  "address": string,
  "category": string,
  "contextualKeywords": [
    string
  ],
  "formattedPrice": string,
  "formattedSalePrice": string,
  "androidAppLink": string,
  "similarDealIds": [
    string
  ],
  "iosAppLink": string,
  "iosAppStoreId": string
}
Fields
dealId

string

Required. Deal ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.

dealName

string

Required. Deal name, e.g. 50% off at Mountain View Grocers. Required.

subtitle

string

Subtitle, e.g. Groceries.

description

string

Description, e.g. Save on your weekly bill.

price

string

Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 100.00 USD.

salePrice

string

Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD. Must be less than the 'price' field.

imageUrl

string

Image URL, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

address

string

Address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403.

category

string

Category, e.g. Food.

contextualKeywords[]

string

Contextual keywords, e.g. Save groceries coupons.

formattedPrice

string

Formatted price which can be any characters. If set, this attribute will be used instead of 'price', e.g. Starting at $100.00.

formattedSalePrice

string

Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', e.g. On sale for $80.00.

similarDealIds[]

string

Similar deal IDs, e.g. 1275.

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.

DynamicJobsAsset

A dynamic jobs asset.

JSON representation
{
  "jobId": string,
  "locationId": string,
  "jobTitle": string,
  "jobSubtitle": string,
  "description": string,
  "imageUrl": string,
  "jobCategory": string,
  "contextualKeywords": [
    string
  ],
  "address": string,
  "salary": string,
  "androidAppLink": string,
  "similarJobIds": [
    string
  ],
  "iosAppLink": string,
  "iosAppStoreId": string
}
Fields
jobId

string

Required. Job ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.

locationId

string

Location ID which can be any sequence of letters and digits. The ID sequence (job ID + location ID) must be unique.

jobTitle

string

Required. Job title, e.g. Software engineer. Required.

jobSubtitle

string

Job subtitle, e.g. Level II.

description

string

Description, e.g. Apply your technical skills.

imageUrl

string

Image URL, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset.

jobCategory

string

Job category, e.g. Technical.

contextualKeywords[]

string

Contextual keywords, e.g. Software engineering job.

address

string

Address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403.

salary

string

Salary, e.g. $100,000.

similarJobIds[]

string

Similar job IDs, e.g. 1275.

iosAppStoreId

string (int64 format)

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 iosAppLink field must also be present.