diff options
Diffstat (limited to 'google/ads/googleads/v0/resources/ad.proto')
| -rw-r--r-- | google/ads/googleads/v0/resources/ad.proto | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/google/ads/googleads/v0/resources/ad.proto b/google/ads/googleads/v0/resources/ad.proto new file mode 100644 index 000000000..c5576a5f1 --- /dev/null +++ b/google/ads/googleads/v0/resources/ad.proto @@ -0,0 +1,119 @@ +// Copyright 2018 Google LLC. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +syntax = "proto3"; + +package google.ads.googleads.v0.resources; + +import "google/ads/googleads/v0/common/ad_type_infos.proto"; +import "google/ads/googleads/v0/common/custom_parameter.proto"; +import "google/ads/googleads/v0/enums/ad_type.proto"; +import "google/ads/googleads/v0/enums/device.proto"; +import "google/protobuf/wrappers.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/resources;resources"; +option java_multiple_files = true; +option java_outer_classname = "AdProto"; +option java_package = "com.google.ads.googleads.v0.resources"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources"; +// Proto file describing the ad type. + +// An ad. +message Ad { + // The ID of the ad. + google.protobuf.Int64Value id = 1; + + // The list of possible final URLs after all cross-domain redirects for the + // ad. + repeated google.protobuf.StringValue final_urls = 2; + + // The list of possible final mobile URLs after all cross-domain redirects + // for the ad. + repeated google.protobuf.StringValue final_mobile_urls = 16; + + // The URL template for constructing a tracking URL. + google.protobuf.StringValue tracking_url_template = 12; + + // The list of mappings that can be used to substitute custom parameter tags + // in a + // `tracking_url_template`, `final_urls`, or `mobile_final_urls`. + repeated google.ads.googleads.v0.common.CustomParameter url_custom_parameters = 10; + + // The URL that appears in the ad description for some ad formats. + google.protobuf.StringValue display_url = 4; + + // The type of ad. + google.ads.googleads.v0.enums.AdTypeEnum.AdType type = 5; + + // 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. + google.protobuf.BoolValue added_by_google_ads = 19; + + // 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, e.g. if no other ads are available. + // If unspecified (no device preference), all devices are targeted. + // This is only supported by some ad types. + google.ads.googleads.v0.enums.DeviceEnum.Device device_preference = 20; + + // 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. + google.protobuf.StringValue name = 23; + + // Details pertinent to the ad type. Exactly one value must be set. + oneof ad_data { + // Details pertaining to a text ad. + google.ads.googleads.v0.common.TextAdInfo text_ad = 6; + + // Details pertaining to an expanded text ad. + google.ads.googleads.v0.common.ExpandedTextAdInfo expanded_text_ad = 7; + + // Details pertaining to a Dynamic Search Ad. + google.ads.googleads.v0.common.DynamicSearchAdInfo dynamic_search_ad = 8; + + // Details pertaining to a responsive display ad. + google.ads.googleads.v0.common.ResponsiveDisplayAdInfo responsive_display_ad = 9; + + // Details pertaining to a call-only ad. + google.ads.googleads.v0.common.CallOnlyAdInfo call_only_ad = 13; + + // 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. + google.ads.googleads.v0.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14; + + // Details pertaining to a hotel ad. + google.ads.googleads.v0.common.HotelAdInfo hotel_ad = 15; + + // Details pertaining to a Smart Shopping ad. + google.ads.googleads.v0.common.ShoppingSmartAdInfo shopping_smart_ad = 17; + + // Details pertaining to a Shopping product ad. + google.ads.googleads.v0.common.ShoppingProductAdInfo shopping_product_ad = 18; + + // Details pertaining to a Gmail ad. + google.ads.googleads.v0.common.GmailAdInfo gmail_ad = 21; + + // Details pertaining to an Image ad. + google.ads.googleads.v0.common.ImageAdInfo image_ad = 22; + } +} |