Ad

An ad.

Fields

resource_name

string

Immutable. The resource name of the ad. Ad resource names have the form:

customers/{customer_id}/ads/{ad_id}

final_urls[]

string

The list of possible final URLs after all cross-domain redirects for the ad.

final_app_urls[]

FinalAppUrl

A list of final app URLs that will be used on mobile if the user has the specific app installed.

final_mobile_urls[]

string

The list of possible final mobile URLs after all cross-domain redirects for the ad.

url_custom_parameters[]

CustomParameter

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.

type

AdType

Output only. The type of ad.

device_preference

Device

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.

url_collections[]

UrlCollection

Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.

system_managed_resource_source

SystemManagedResourceSource

Output only. If this ad is system managed, then this field will indicate the source. This field is read-only.

id

int64

Output only. The ID of the ad.

tracking_url_template

string

The URL template for constructing a tracking URL.

final_url_suffix

string

The suffix to use when constructing a final URL.

display_url

string

The URL that appears in the ad description for some ad formats.

added_by_google_ads

bool

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.

name

string

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, ShoppingComparisonListingAd and VideoAd.
Union field

ad_data

ad_data. Details pertinent to the ad type. Exactly one value must be set. ad_data can be only one of the following:

text_ad

TextAdInfo

Immutable. Details pertaining to a text ad.

expanded_text_ad

ExpandedTextAdInfo

Details pertaining to an expanded text ad.

call_ad

CallAdInfo

Details pertaining to a call ad.

expanded_dynamic_search_ad

ExpandedDynamicSearchAdInfo

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.

hotel_ad

HotelAdInfo

Details pertaining to a hotel ad.

shopping_smart_ad

ShoppingSmartAdInfo

Details pertaining to a Smart Shopping ad.

shopping_product_ad

ShoppingProductAdInfo

Details pertaining to a Shopping product ad.

image_ad

ImageAdInfo

Immutable. Details pertaining to an Image ad.

video_ad

VideoAdInfo

Details pertaining to a Video ad.

video_responsive_ad

VideoResponsiveAdInfo

Details pertaining to a Video responsive ad.

responsive_search_ad

ResponsiveSearchAdInfo

Details pertaining to a responsive search ad.

legacy_responsive_display_ad

LegacyResponsiveDisplayAdInfo

Details pertaining to a legacy responsive display ad.

app_ad

AppAdInfo

Details pertaining to an app ad.

legacy_app_install_ad

LegacyAppInstallAdInfo

Immutable. Details pertaining to a legacy app install ad.

responsive_display_ad

ResponsiveDisplayAdInfo

Details pertaining to a responsive display ad.

local_ad

LocalAdInfo

Details pertaining to a local ad.

display_upload_ad

DisplayUploadAdInfo

Details pertaining to a display upload ad.

app_engagement_ad

AppEngagementAdInfo

Details pertaining to an app engagement ad.

shopping_comparison_listing_ad

ShoppingComparisonListingAdInfo

Details pertaining to a Shopping Comparison Listing ad.

smart_campaign_ad

SmartCampaignAdInfo

Details pertaining to a Smart campaign ad.

app_pre_registration_ad

AppPreRegistrationAdInfo

Details pertaining to an app pre-registration ad.

discovery_multi_asset_ad

DiscoveryMultiAssetAdInfo

Details pertaining to a discovery multi asset ad.

discovery_video_responsive_ad

DiscoveryVideoResponsiveAdInfo

Details pertaining to a discovery video responsive ad.

demand_gen_product_ad

DemandGenProductAdInfo

Details pertaining to a Demand Gen product ad.

travel_ad

TravelAdInfo

Details pertaining to a travel ad.