legacy-libs/google-proto-files/google/ads/googleads/v0/resources/ad.proto

   1 // Copyright 2018 Google LLC.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14 //
  15
  16 syntax = "proto3";
  17
  18 package google.ads.googleads.v0.resources;
  19
  20 import "google/ads/googleads/v0/common/ad_type_infos.proto";
  21 import "google/ads/googleads/v0/common/custom_parameter.proto";
  22 import "google/ads/googleads/v0/enums/ad_type.proto";
  23 import "google/ads/googleads/v0/enums/device.proto";
  24 import "google/protobuf/wrappers.proto";
  25
  26 option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
  27 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/resources;resources";
  28 option java_multiple_files = true;
  29 option java_outer_classname = "AdProto";
  30 option java_package = "com.google.ads.googleads.v0.resources";
  31 option objc_class_prefix = "GAA";
  32 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
  33 option ruby_package = "Google::Ads::GoogleAds::V0::Resources";
  34 // Proto file describing the ad type.
  35
  36 // An ad.
  37 message Ad {
  38   // The ID of the ad.
  39   google.protobuf.Int64Value id = 1;
  40
  41   // The list of possible final URLs after all cross-domain redirects for the
  42   // ad.
  43   repeated google.protobuf.StringValue final_urls = 2;
  44
  45   // The list of possible final mobile URLs after all cross-domain redirects
  46   // for the ad.
  47   repeated google.protobuf.StringValue final_mobile_urls = 16;
  48
  49   // The URL template for constructing a tracking URL.
  50   google.protobuf.StringValue tracking_url_template = 12;
  51
  52   // The list of mappings that can be used to substitute custom parameter tags
  53   // in a
  54   // `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
  55   repeated google.ads.googleads.v0.common.CustomParameter url_custom_parameters = 10;
  56
  57   // The URL that appears in the ad description for some ad formats.
  58   google.protobuf.StringValue display_url = 4;
  59
  60   // The type of ad.
  61   google.ads.googleads.v0.enums.AdTypeEnum.AdType type = 5;
  62
  63   // Indicates if this ad was automatically added by Google Ads and not by a
  64   // user. For example, this could happen when ads are automatically created as
  65   // suggestions for new ads based on knowledge of how existing ads are
  66   // performing.
  67   google.protobuf.BoolValue added_by_google_ads = 19;
  68
  69   // The device preference for the ad. You can only specify a preference for
  70   // mobile devices. When this preference is set the ad will be preferred over
  71   // other ads when being displayed on a mobile device. The ad can still be
  72   // displayed on other device types, e.g. if no other ads are available.
  73   // If unspecified (no device preference), all devices are targeted.
  74   // This is only supported by some ad types.
  75   google.ads.googleads.v0.enums.DeviceEnum.Device device_preference = 20;
  76
  77   // The name of the ad. This is only used to be able to identify the ad. It
  78   // does not need to be unique and does not affect the served ad.
  79   google.protobuf.StringValue name = 23;
  80
  81   // Details pertinent to the ad type. Exactly one value must be set.
  82   oneof ad_data {
  83     // Details pertaining to a text ad.
  84     google.ads.googleads.v0.common.TextAdInfo text_ad = 6;
  85
  86     // Details pertaining to an expanded text ad.
  87     google.ads.googleads.v0.common.ExpandedTextAdInfo expanded_text_ad = 7;
  88
  89     // Details pertaining to a Dynamic Search Ad.
  90     google.ads.googleads.v0.common.DynamicSearchAdInfo dynamic_search_ad = 8;
  91
  92     // Details pertaining to a responsive display ad.
  93     google.ads.googleads.v0.common.ResponsiveDisplayAdInfo responsive_display_ad = 9;
  94
  95     // Details pertaining to a call-only ad.
  96     google.ads.googleads.v0.common.CallOnlyAdInfo call_only_ad = 13;
  97
  98     // Details pertaining to an Expanded Dynamic Search Ad.
  99     // This type of ad has its headline, final URLs, and display URL
 100     // auto-generated at serving time according to domain name specific
 101     // information provided by `dynamic_search_ads_setting` linked at the
 102     // campaign level.
 103     google.ads.googleads.v0.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14;
 104
 105     // Details pertaining to a hotel ad.
 106     google.ads.googleads.v0.common.HotelAdInfo hotel_ad = 15;
 107
 108     // Details pertaining to a Smart Shopping ad.
 109     google.ads.googleads.v0.common.ShoppingSmartAdInfo shopping_smart_ad = 17;
 110
 111     // Details pertaining to a Shopping product ad.
 112     google.ads.googleads.v0.common.ShoppingProductAdInfo shopping_product_ad = 18;
 113
 114     // Details pertaining to a Gmail ad.
 115     google.ads.googleads.v0.common.GmailAdInfo gmail_ad = 21;
 116
 117     // Details pertaining to an Image ad.
 118     google.ads.googleads.v0.common.ImageAdInfo image_ad = 22;
 119
 120     // Details pertaining to a Video ad.
 121     google.ads.googleads.v0.common.VideoAdInfo video_ad = 24;
 122   }
 123 }