legacy-libs/google-proto-files/google/ads/googleads/v0/common/ad_type_infos.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.common;
  19
  20 import "google/ads/googleads/v0/enums/call_conversion_reporting_state.proto";
  21 import "google/ads/googleads/v0/enums/display_ad_format_setting.proto";
  22 import "google/ads/googleads/v0/enums/mime_type.proto";
  23 import "google/protobuf/wrappers.proto";
  24
  25 option csharp_namespace = "Google.Ads.GoogleAds.V0.Common";
  26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/common;common";
  27 option java_multiple_files = true;
  28 option java_outer_classname = "AdTypeInfosProto";
  29 option java_package = "com.google.ads.googleads.v0.common";
  30 option objc_class_prefix = "GAA";
  31 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Common";
  32 option ruby_package = "Google::Ads::GoogleAds::V0::Common";
  33
  34 // Proto file containing info messages for specific ad types.
  35
  36 // A text ad.
  37 message TextAdInfo {
  38   // The headline of the ad.
  39   google.protobuf.StringValue headline = 1;
  40
  41   // The first line of the ad's description.
  42   google.protobuf.StringValue description1 = 2;
  43
  44   // The second line of the ad's description.
  45   google.protobuf.StringValue description2 = 3;
  46 }
  47
  48 // An expanded text ad.
  49 message ExpandedTextAdInfo {
  50   // The first part of the ad's headline.
  51   google.protobuf.StringValue headline_part1 = 1;
  52
  53   // The second part of the ad's headline.
  54   google.protobuf.StringValue headline_part2 = 2;
  55
  56   // The third part of the ad's headline.
  57   google.protobuf.StringValue headline_part3 = 6;
  58
  59   // The description of the ad.
  60   google.protobuf.StringValue description = 3;
  61
  62   // The second description of the ad.
  63   google.protobuf.StringValue description2 = 7;
  64
  65   // The text that can appear alongside the ad's displayed URL.
  66   google.protobuf.StringValue path1 = 4;
  67
  68   // Additional text that can appear alongside the ad's displayed URL.
  69   google.protobuf.StringValue path2 = 5;
  70 }
  71
  72 // A dynamic search ad.
  73 message DynamicSearchAdInfo {
  74   // The first line of the ad's description.
  75   google.protobuf.StringValue description1 = 1;
  76
  77   // The second line of the ad's description.
  78   google.protobuf.StringValue description2 = 2;
  79 }
  80
  81 // A responsive display ad.
  82 message ResponsiveDisplayAdInfo {
  83   // The short version of the ad's headline.
  84   google.protobuf.StringValue short_headline = 1;
  85
  86   // The long version of the ad's headline.
  87   google.protobuf.StringValue long_headline = 2;
  88
  89   // The description of the ad.
  90   google.protobuf.StringValue description = 3;
  91
  92   // The business name in the ad.
  93   google.protobuf.StringValue business_name = 4;
  94
  95   // Advertiser's consent to allow flexible color. When true, the ad may be
  96   // served with different color if necessary. When false, the ad will be served
  97   // with the specified colors or a neutral color.
  98   // The default value is true.
  99   // Must be true if main_color and accent_color are not set.
 100   google.protobuf.BoolValue allow_flexible_color = 5;
 101
 102   // The accent color of the ad in hexadecimal, e.g. #ffffff for white.
 103   // If one of main_color and accent_color is set, the other is required as
 104   // well.
 105   google.protobuf.StringValue accent_color = 6;
 106
 107   // The main color of the ad in hexadecimal, e.g. #ffffff for white.
 108   // If one of main_color and accent_color is set, the other is required as
 109   // well.
 110   google.protobuf.StringValue main_color = 7;
 111
 112   // The call-to-action text for the ad.
 113   google.protobuf.StringValue call_to_action_text = 8;
 114
 115   // The MediaFile resource name of the logo image used in the ad.
 116   google.protobuf.StringValue logo_image = 9;
 117
 118   // The MediaFile resource name of the square logo image used in the ad.
 119   google.protobuf.StringValue square_logo_image = 10;
 120
 121   // The MediaFile resource name of the marketing image used in the ad.
 122   google.protobuf.StringValue marketing_image = 11;
 123
 124   // The MediaFile resource name of the square marketing image used in the ad.
 125   google.protobuf.StringValue square_marketing_image = 12;
 126
 127   // Specifies which format the ad will be served in. Default is ALL_FORMATS.
 128   google.ads.googleads.v0.enums.DisplayAdFormatSettingEnum
 129       .DisplayAdFormatSetting format_setting = 13;
 130
 131   // Prefix before price. E.g. 'as low as'.
 132   google.protobuf.StringValue price_prefix = 14;
 133
 134   // Promotion text used for dyanmic formats of responsive ads. For example
 135   // 'Free two-day shipping'.
 136   google.protobuf.StringValue promo_text = 15;
 137 }
 138
 139 // A call-only ad.
 140 message CallOnlyAdInfo {
 141   // The country code in the ad.
 142   google.protobuf.StringValue country_code = 1;
 143
 144   // The phone number in the ad.
 145   google.protobuf.StringValue phone_number = 2;
 146
 147   // The business name in the ad.
 148   google.protobuf.StringValue business_name = 3;
 149
 150   // The first line of the ad's description.
 151   google.protobuf.StringValue description1 = 4;
 152
 153   // The second line of the ad's description.
 154   google.protobuf.StringValue description2 = 5;
 155
 156   // Whether to enable call tracking for the creative. Enabling call
 157   // tracking also enables call conversions.
 158   google.protobuf.BoolValue call_tracked = 6;
 159
 160   // Whether to disable call conversion for the creative.
 161   // If set to `true`, disables call conversions even when `call_tracked` is
 162   // `true`.
 163   // If `call_tracked` is `false`, this field is ignored.
 164   google.protobuf.BoolValue disable_call_conversion = 7;
 165
 166   // The URL to be used for phone number verification.
 167   google.protobuf.StringValue phone_number_verification_url = 8;
 168
 169   // The conversion action to attribute a call conversion to. If not set a
 170   // default conversion action is used. This field only has effect if
 171   // call_tracked is set to true. Otherwise this field is ignored.
 172   google.protobuf.StringValue conversion_action = 9;
 173
 174   // The call conversion behavior of this call only ad. It can use its own call
 175   // conversion setting, inherit the account level setting, or be disabled.
 176   google.ads.googleads.v0.enums.CallConversionReportingStateEnum
 177       .CallConversionReportingState conversion_reporting_state = 10;
 178 }
 179
 180 // An expanded dynamic search ad.
 181 message ExpandedDynamicSearchAdInfo {
 182   // The description of the ad.
 183   google.protobuf.StringValue description = 1;
 184 }
 185
 186 // A hotel ad.
 187 message HotelAdInfo {}
 188
 189 // A Smart Shopping ad.
 190 message ShoppingSmartAdInfo {}
 191
 192 // A standard Shopping ad.
 193 message ShoppingProductAdInfo {}
 194
 195 // A Gmail ad.
 196 message GmailAdInfo {
 197   // The Gmail teaser.
 198   GmailTeaser teaser = 1;
 199
 200   // The MediaFile resource name of the header image. Valid image types are GIF,
 201   // JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must
 202   // be between 3:1 and 5:1 (+-1%).
 203   google.protobuf.StringValue header_image = 2;
 204
 205   // The MediaFile resource name of the marketing image. Valid image types are
 206   // GIF, JPEG and PNG. The image must either be landscape with a minimum size
 207   // of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a
 208   // minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)
 209   google.protobuf.StringValue marketing_image = 3;
 210
 211   // Headline of the marketing image.
 212   google.protobuf.StringValue marketing_image_headline = 4;
 213
 214   // Description of the marketing image.
 215   google.protobuf.StringValue marketing_image_description = 5;
 216
 217   // Display-call-to-action of the marketing image.
 218   DisplayCallToAction marketing_image_display_call_to_action = 6;
 219 }
 220
 221 // Gmail teaser data. The teaser is a small header that acts as an invitation
 222 // to view the rest of the ad (the body).
 223 message GmailTeaser {
 224   // Headline of the teaser.
 225   google.protobuf.StringValue headline = 1;
 226
 227   // Description of the teaser.
 228   google.protobuf.StringValue description = 2;
 229
 230   // Business name of the advertiser.
 231   google.protobuf.StringValue business_name = 3;
 232
 233   // The MediaFile resource name of the logo image. Valid image types are GIF,
 234   // JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must
 235   // be 1:1 (+-1%).
 236   google.protobuf.StringValue logo_image = 4;
 237 }
 238
 239 // Data for display call to action. The call to action is a piece of the ad
 240 // that prompts the user to do something. Like clicking a link or making a phone
 241 // call.
 242 message DisplayCallToAction {
 243   // Text for the display-call-to-action.
 244   google.protobuf.StringValue text = 1;
 245
 246   // Text color for the display-call-to-action in hexadecimal, e.g. #ffffff for
 247   // white.
 248   google.protobuf.StringValue text_color = 2;
 249 }
 250
 251 // An image ad.
 252 message ImageAdInfo {
 253   // Width in pixels of the full size image.
 254   google.protobuf.Int64Value pixel_width = 4;
 255
 256   // Height in pixels of the full size image.
 257   google.protobuf.Int64Value pixel_height = 5;
 258
 259   // URL of the full size image.
 260   google.protobuf.StringValue image_url = 6;
 261
 262   // Width in pixels of the preview size image.
 263   google.protobuf.Int64Value preview_pixel_width = 7;
 264
 265   // Height in pixels of the preview size image.
 266   google.protobuf.Int64Value preview_pixel_height = 8;
 267
 268   // URL of the preview size image.
 269   google.protobuf.StringValue preview_image_url = 9;
 270
 271   // The mime type of the image.
 272   google.ads.googleads.v0.enums.MimeTypeEnum.MimeType mime_type = 10;
 273
 274   // The name of the image. If the image was created from a MediaFile, this is
 275   // the MediaFile's name. If the image was created from bytes, this is empty.
 276   google.protobuf.StringValue name = 11;
 277
 278   // The image to create the ImageAd from. This can be specified in one of
 279   // two ways.
 280   // 1. An existing MediaFile resource.
 281   // 2. The raw image data as bytes.
 282   oneof image {
 283     // The MediaFile resource to use for the image.
 284     google.protobuf.StringValue media_file = 1;
 285
 286     // Raw image data as bytes.
 287     google.protobuf.BytesValue data = 2;
 288   }
 289 }
 290
 291 // Representation of video TrueView in-stream ad format (ad shown during video
 292 // playback, often at beginning, which displays a skip button a few seconds into
 293 // the video).
 294 message VideoTrueViewInStreamAdInfo {
 295   // Label on the CTA (call-to-action) button taking the user to the video ad's
 296   // final URL.
 297   // Required for TrueView for action campaigns, optional otherwise.
 298   google.protobuf.StringValue action_button_label = 1;
 299
 300   // Additional text displayed with the CTA (call-to-action) button to give
 301   // context and encourage clicking on the button.
 302   google.protobuf.StringValue action_headline = 2;
 303 }
 304
 305 // A video ad.
 306 message VideoAdInfo {
 307   // The MediaFile resource to use for the video.
 308   google.protobuf.StringValue media_file = 1;
 309
 310   // Format-specific schema for the different video formats.
 311   oneof format {
 312     // Video TrueView in-stream format.
 313     VideoTrueViewInStreamAdInfo in_stream = 2;
 314   }
 315 }