REST Resource: customers.assets

{
  "resourceName": string,
  "type": enum (AssetType),
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "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)
  }
  // End of list of possible types for union field asset_data.
}

string

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

customers/{customerId}/assets/{asset_id}

enum (AssetType)

Output only. Type of the asset.

string

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

string

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

object (CustomParameter)

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

object (AssetPolicySummary)

Output only. Policy information for the asset.

string (int64 format)

Output only. The ID of the asset.

string

Optional name of the asset.

string

URL template for constructing a tracking URL.

string

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

object (YoutubeVideoAsset)

Immutable. A YouTube video asset.

object (MediaBundleAsset)

Immutable. A media bundle asset.

object (ImageAsset)

Output only. An image asset.

object (TextAsset)

Immutable. A text asset.

object (LeadFormAsset)

A lead form asset.

object (BookOnGoogleAsset)

A book on google asset.

object (PromotionAsset)

A promotion asset.

object (CalloutAsset)

A callout asset.

object (StructuredSnippetAsset)

A structured snippet asset.

object (SitelinkAsset)

A sitelink asset.

object (PageFeedAsset)

A page feed asset.

object (DynamicEducationAsset)

A dynamic education asset.

object (MobileAppAsset)

A mobile app asset.

object (HotelCalloutAsset)

A hotel callout asset.

object (CallAsset)

A call asset.

object (PriceAsset)

A price asset.

object (CallToActionAsset)

Immutable. A call to action asset.

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

object (PolicyTopicEntry)

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

enum (PolicyReviewStatus)

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

enum (PolicyApprovalStatus)

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

{
  "youtubeVideoTitle": string,
  "youtubeVideoId": string
}

string

YouTube video title.

string

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

{
  "data": string
}

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.

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

enum (MimeType)

MIME type of the image asset.

object (ImageDimension)

Metadata for this image at its original size.

string (bytes format)

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

A base64-encoded string.

string (int64 format)

File size of the image asset in bytes.

{
  "heightPixels": string,
  "widthPixels": string,
  "url": string
}

string (int64 format)

Height of the image.

string (int64 format)

Width of the image.

string

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

{
  "text": string
}

string

Text content of the text asset.

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

string

Required. The name of the business being advertised.

enum (LeadFormCallToActionType)

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

string

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

string

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

string

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

string

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

object (LeadFormField)

Ordered list of input fields.

object (LeadFormDeliveryMethod)

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

enum (LeadFormPostSubmitCallToActionType)

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

enum (LeadFormDesiredIntent)

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

string

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

string

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

string

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

string

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

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

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?".

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.

{
  "answers": [
    string
  ]
}

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.

{
  "webhook": {
    object (WebhookDelivery)
  }
}

object (WebhookDelivery)

Webhook method of delivery.

{
  "advertiserWebhookUrl": string,
  "googleSecret": string,
  "payloadSchemaVersion": string
}

string

Webhook url specified by advertiser to send the lead.

string

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

string (int64 format)

The schema version that this delivery instance will use.

{
  "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.
}

string

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

enum (PromotionExtensionDiscountModifier)

A modifier for qualification of the discount.

string

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

string

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

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.

string

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

string

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

string

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

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.

string (int64 format)

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

object (Money)

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

string

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

object (Money)

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

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

string

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

string

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

string

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

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.

{
  "header": string,
  "values": [
    string
  ]
}

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

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.

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

string

Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.

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.

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.

string

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

string

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

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.

{
  "pageUrl": string,
  "labels": [
    string
  ]
}

string

Required. The webpage that advertisers want to target.

string

Labels used to group the page urls.

{
  "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
}

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.

string

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

string

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

string

Subject of study, e.g. Health.

string

Program description, e.g. Nursing Certification.

string

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

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

string

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

string

Android deep link, e.g. android-app://com.example.android/http/example.com/gizmos?1234.

string

Similar program IDs.

string

iOS deep link, e.g. exampleApp://content/page.

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.

string

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

string

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

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

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.

enum (MobileAppVendor)

Required. The application store that distributes this specific app.

string

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.

string

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

string

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

{
  "text": string,
  "languageCode": string
}

string

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

string

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

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

string

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

string

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

enum (CallConversionReportingState)

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

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.

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.

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

enum (PriceExtensionType)

Required. The type of the price asset.

enum (PriceExtensionPriceQualifier)

The price qualifier of the price asset.

string

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

object (PriceOffering)

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

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

string

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

string

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

object (Money)

Required. The price value of the price offering.

enum (PriceExtensionPriceUnit)

The price unit of the price offering.

string

Required. The final URL after all cross domain redirects.

string

The final mobile URL after all cross domain redirects.

{
  "callToAction": enum (CallToActionType)
}

enum (CallToActionType)

Call to action.