com.google.ads.googleads.v17.common.ResponsiveDisplayAdInfoOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/common/ad_type_infos.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.common;

public interface ResponsiveDisplayAdInfoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.common.ResponsiveDisplayAdInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must
   * be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined
   * with `square_marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset marketing_images = 1;
   */
  java.util.List 
      getMarketingImagesList();
  /**
   *    * Marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must
   * be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined
   * with `square_marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset marketing_images = 1;
   */
  com.google.ads.googleads.v17.common.AdImageAsset getMarketingImages(int index);
  /**
   *    * Marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must
   * be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined
   * with `square_marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset marketing_images = 1;
   */
  int getMarketingImagesCount();
  /**
   *    * Marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must
   * be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined
   * with `square_marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset marketing_images = 1;
   */
  java.util.List 
      getMarketingImagesOrBuilderList();
  /**
   *    * Marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must
   * be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined
   * with `square_marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset marketing_images = 1;
   */
  com.google.ads.googleads.v17.common.AdImageAssetOrBuilder getMarketingImagesOrBuilder(
      int index);

  /**
   *    * Square marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must
   * be 1:1 (+-1%). At least one square `marketing_image` is required. Combined
   * with `marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_marketing_images = 2;
   */
  java.util.List 
      getSquareMarketingImagesList();
  /**
   *    * Square marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must
   * be 1:1 (+-1%). At least one square `marketing_image` is required. Combined
   * with `marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_marketing_images = 2;
   */
  com.google.ads.googleads.v17.common.AdImageAsset getSquareMarketingImages(int index);
  /**
   *    * Square marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must
   * be 1:1 (+-1%). At least one square `marketing_image` is required. Combined
   * with `marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_marketing_images = 2;
   */
  int getSquareMarketingImagesCount();
  /**
   *    * Square marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must
   * be 1:1 (+-1%). At least one square `marketing_image` is required. Combined
   * with `marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_marketing_images = 2;
   */
  java.util.List 
      getSquareMarketingImagesOrBuilderList();
  /**
   *    * Square marketing images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must
   * be 1:1 (+-1%). At least one square `marketing_image` is required. Combined
   * with `marketing_images`, the maximum is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_marketing_images = 2;
   */
  com.google.ads.googleads.v17.common.AdImageAssetOrBuilder getSquareMarketingImagesOrBuilder(
      int index);

  /**
   *    * Logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must
   * be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset logo_images = 3;
   */
  java.util.List 
      getLogoImagesList();
  /**
   *    * Logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must
   * be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset logo_images = 3;
   */
  com.google.ads.googleads.v17.common.AdImageAsset getLogoImages(int index);
  /**
   *    * Logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must
   * be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset logo_images = 3;
   */
  int getLogoImagesCount();
  /**
   *    * Logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must
   * be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset logo_images = 3;
   */
  java.util.List 
      getLogoImagesOrBuilderList();
  /**
   *    * Logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must
   * be 4:1 (+-1%). Combined with `square_logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset logo_images = 3;
   */
  com.google.ads.googleads.v17.common.AdImageAssetOrBuilder getLogoImagesOrBuilder(
      int index);

  /**
   *    * Square logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must
   * be 1:1 (+-1%). Combined with `logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_logo_images = 4;
   */
  java.util.List 
      getSquareLogoImagesList();
  /**
   *    * Square logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must
   * be 1:1 (+-1%). Combined with `logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_logo_images = 4;
   */
  com.google.ads.googleads.v17.common.AdImageAsset getSquareLogoImages(int index);
  /**
   *    * Square logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must
   * be 1:1 (+-1%). Combined with `logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_logo_images = 4;
   */
  int getSquareLogoImagesCount();
  /**
   *    * Square logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must
   * be 1:1 (+-1%). Combined with `logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_logo_images = 4;
   */
  java.util.List 
      getSquareLogoImagesOrBuilderList();
  /**
   *    * Square logo images to be used in the ad. Valid image types are GIF,
   * JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must
   * be 1:1 (+-1%). Combined with `logo_images`, the maximum is 5.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdImageAsset square_logo_images = 4;
   */
  com.google.ads.googleads.v17.common.AdImageAssetOrBuilder getSquareLogoImagesOrBuilder(
      int index);

  /**
   *    * Short format headlines for the ad. The maximum length is 30 characters.
   * At least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset headlines = 5;
   */
  java.util.List 
      getHeadlinesList();
  /**
   *    * Short format headlines for the ad. The maximum length is 30 characters.
   * At least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset headlines = 5;
   */
  com.google.ads.googleads.v17.common.AdTextAsset getHeadlines(int index);
  /**
   *    * Short format headlines for the ad. The maximum length is 30 characters.
   * At least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset headlines = 5;
   */
  int getHeadlinesCount();
  /**
   *    * Short format headlines for the ad. The maximum length is 30 characters.
   * At least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset headlines = 5;
   */
  java.util.List 
      getHeadlinesOrBuilderList();
  /**
   *    * Short format headlines for the ad. The maximum length is 30 characters.
   * At least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset headlines = 5;
   */
  com.google.ads.googleads.v17.common.AdTextAssetOrBuilder getHeadlinesOrBuilder(
      int index);

  /**
   *    * A required long format headline. The maximum length is 90 characters.
   * 
   *
   * .google.ads.googleads.v17.common.AdTextAsset long_headline = 6;
   * @return Whether the longHeadline field is set.
   */
  boolean hasLongHeadline();
  /**
   *    * A required long format headline. The maximum length is 90 characters.
   * 
   *
   * .google.ads.googleads.v17.common.AdTextAsset long_headline = 6;
   * @return The longHeadline.
   */
  com.google.ads.googleads.v17.common.AdTextAsset getLongHeadline();
  /**
   *    * A required long format headline. The maximum length is 90 characters.
   * 
   *
   * .google.ads.googleads.v17.common.AdTextAsset long_headline = 6;
   */
  com.google.ads.googleads.v17.common.AdTextAssetOrBuilder getLongHeadlineOrBuilder();

  /**
   *    * Descriptive texts for the ad. The maximum length is 90 characters. At
   * least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset descriptions = 7;
   */
  java.util.List 
      getDescriptionsList();
  /**
   *    * Descriptive texts for the ad. The maximum length is 90 characters. At
   * least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset descriptions = 7;
   */
  com.google.ads.googleads.v17.common.AdTextAsset getDescriptions(int index);
  /**
   *    * Descriptive texts for the ad. The maximum length is 90 characters. At
   * least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset descriptions = 7;
   */
  int getDescriptionsCount();
  /**
   *    * Descriptive texts for the ad. The maximum length is 90 characters. At
   * least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset descriptions = 7;
   */
  java.util.List 
      getDescriptionsOrBuilderList();
  /**
   *    * Descriptive texts for the ad. The maximum length is 90 characters. At
   * least 1 and max 5 headlines can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdTextAsset descriptions = 7;
   */
  com.google.ads.googleads.v17.common.AdTextAssetOrBuilder getDescriptionsOrBuilder(
      int index);

  /**
   *    * Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdVideoAsset youtube_videos = 8;
   */
  java.util.List 
      getYoutubeVideosList();
  /**
   *    * Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdVideoAsset youtube_videos = 8;
   */
  com.google.ads.googleads.v17.common.AdVideoAsset getYoutubeVideos(int index);
  /**
   *    * Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdVideoAsset youtube_videos = 8;
   */
  int getYoutubeVideosCount();
  /**
   *    * Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdVideoAsset youtube_videos = 8;
   */
  java.util.List 
      getYoutubeVideosOrBuilderList();
  /**
   *    * Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AdVideoAsset youtube_videos = 8;
   */
  com.google.ads.googleads.v17.common.AdVideoAssetOrBuilder getYoutubeVideosOrBuilder(
      int index);

  /**
   *    * The advertiser/brand name. Maximum display width is 25.
   * 
   *
   * optional string business_name = 17;
   * @return Whether the businessName field is set.
   */
  boolean hasBusinessName();
  /**
   *    * The advertiser/brand name. Maximum display width is 25.
   * 
   *
   * optional string business_name = 17;
   * @return The businessName.
   */
  java.lang.String getBusinessName();
  /**
   *    * The advertiser/brand name. Maximum display width is 25.
   * 
   *
   * optional string business_name = 17;
   * @return The bytes for businessName.
   */
  com.google.protobuf.ByteString
      getBusinessNameBytes();

  /**
   *    * The main color of the ad in hexadecimal, for example, #ffffff for white.
   * If one of `main_color` and `accent_color` is set, the other is required as
   * well.
   * 
   *
   * optional string main_color = 18;
   * @return Whether the mainColor field is set.
   */
  boolean hasMainColor();
  /**
   *    * The main color of the ad in hexadecimal, for example, #ffffff for white.
   * If one of `main_color` and `accent_color` is set, the other is required as
   * well.
   * 
   *
   * optional string main_color = 18;
   * @return The mainColor.
   */
  java.lang.String getMainColor();
  /**
   *    * The main color of the ad in hexadecimal, for example, #ffffff for white.
   * If one of `main_color` and `accent_color` is set, the other is required as
   * well.
   * 
   *
   * optional string main_color = 18;
   * @return The bytes for mainColor.
   */
  com.google.protobuf.ByteString
      getMainColorBytes();

  /**
   *    * The accent color of the ad in hexadecimal, for example, #ffffff for white.
   * If one of `main_color` and `accent_color` is set, the other is required as
   * well.
   * 
   *
   * optional string accent_color = 19;
   * @return Whether the accentColor field is set.
   */
  boolean hasAccentColor();
  /**
   *    * The accent color of the ad in hexadecimal, for example, #ffffff for white.
   * If one of `main_color` and `accent_color` is set, the other is required as
   * well.
   * 
   *
   * optional string accent_color = 19;
   * @return The accentColor.
   */
  java.lang.String getAccentColor();
  /**
   *    * The accent color of the ad in hexadecimal, for example, #ffffff for white.
   * If one of `main_color` and `accent_color` is set, the other is required as
   * well.
   * 
   *
   * optional string accent_color = 19;
   * @return The bytes for accentColor.
   */
  com.google.protobuf.ByteString
      getAccentColorBytes();

  /**
   *    * Advertiser's consent to allow flexible color. When true, the ad may be
   * served with different color if necessary. When false, the ad will be served
   * with the specified colors or a neutral color.
   * The default value is `true`.
   * Must be true if `main_color` and `accent_color` are not set.
   * 
   *
   * optional bool allow_flexible_color = 20;
   * @return Whether the allowFlexibleColor field is set.
   */
  boolean hasAllowFlexibleColor();
  /**
   *    * Advertiser's consent to allow flexible color. When true, the ad may be
   * served with different color if necessary. When false, the ad will be served
   * with the specified colors or a neutral color.
   * The default value is `true`.
   * Must be true if `main_color` and `accent_color` are not set.
   * 
   *
   * optional bool allow_flexible_color = 20;
   * @return The allowFlexibleColor.
   */
  boolean getAllowFlexibleColor();

  /**
   *    * The call-to-action text for the ad. Maximum display width is 30.
   * 
   *
   * optional string call_to_action_text = 21;
   * @return Whether the callToActionText field is set.
   */
  boolean hasCallToActionText();
  /**
   *    * The call-to-action text for the ad. Maximum display width is 30.
   * 
   *
   * optional string call_to_action_text = 21;
   * @return The callToActionText.
   */
  java.lang.String getCallToActionText();
  /**
   *    * The call-to-action text for the ad. Maximum display width is 30.
   * 
   *
   * optional string call_to_action_text = 21;
   * @return The bytes for callToActionText.
   */
  com.google.protobuf.ByteString
      getCallToActionTextBytes();

  /**
   *    * Prefix before price. For example, 'as low as'.
   * 
   *
   * optional string price_prefix = 22;
   * @return Whether the pricePrefix field is set.
   */
  boolean hasPricePrefix();
  /**
   *    * Prefix before price. For example, 'as low as'.
   * 
   *
   * optional string price_prefix = 22;
   * @return The pricePrefix.
   */
  java.lang.String getPricePrefix();
  /**
   *    * Prefix before price. For example, 'as low as'.
   * 
   *
   * optional string price_prefix = 22;
   * @return The bytes for pricePrefix.
   */
  com.google.protobuf.ByteString
      getPricePrefixBytes();

  /**
   *    * Promotion text used for dynamic formats of responsive ads. For example
   * 'Free two-day shipping'.
   * 
   *
   * optional string promo_text = 23;
   * @return Whether the promoText field is set.
   */
  boolean hasPromoText();
  /**
   *    * Promotion text used for dynamic formats of responsive ads. For example
   * 'Free two-day shipping'.
   * 
   *
   * optional string promo_text = 23;
   * @return The promoText.
   */
  java.lang.String getPromoText();
  /**
   *    * Promotion text used for dynamic formats of responsive ads. For example
   * 'Free two-day shipping'.
   * 
   *
   * optional string promo_text = 23;
   * @return The bytes for promoText.
   */
  com.google.protobuf.ByteString
      getPromoTextBytes();

  /**
   *    * Specifies which format the ad will be served in. Default is ALL_FORMATS.
   * 
   *
   * .google.ads.googleads.v17.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 16;
   * @return The enum numeric value on the wire for formatSetting.
   */
  int getFormatSettingValue();
  /**
   *    * Specifies which format the ad will be served in. Default is ALL_FORMATS.
   * 
   *
   * .google.ads.googleads.v17.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 16;
   * @return The formatSetting.
   */
  com.google.ads.googleads.v17.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting getFormatSetting();

  /**
   *    * Specification for various creative controls.
   * 
   *
   * .google.ads.googleads.v17.common.ResponsiveDisplayAdControlSpec control_spec = 24;
   * @return Whether the controlSpec field is set.
   */
  boolean hasControlSpec();
  /**
   *    * Specification for various creative controls.
   * 
   *
   * .google.ads.googleads.v17.common.ResponsiveDisplayAdControlSpec control_spec = 24;
   * @return The controlSpec.
   */
  com.google.ads.googleads.v17.common.ResponsiveDisplayAdControlSpec getControlSpec();
  /**
   *    * Specification for various creative controls.
   * 
   *
   * .google.ads.googleads.v17.common.ResponsiveDisplayAdControlSpec control_spec = 24;
   */
  com.google.ads.googleads.v17.common.ResponsiveDisplayAdControlSpecOrBuilder getControlSpecOrBuilder();
}