Class Ad

  • All Implemented Interfaces:
    AdOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class Ad
    extends com.google.protobuf.GeneratedMessageV3
    implements AdOrBuilder
     An ad.
     
    Protobuf type google.ads.googleads.v10.resources.Ad
    See Also:
    Serialized Form
    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FINAL_URLS_FIELD_NUMBER

        public static final int FINAL_URLS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FINAL_APP_URLS_FIELD_NUMBER

        public static final int FINAL_APP_URLS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FINAL_MOBILE_URLS_FIELD_NUMBER

        public static final int FINAL_MOBILE_URLS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TRACKING_URL_TEMPLATE_FIELD_NUMBER

        public static final int TRACKING_URL_TEMPLATE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FINAL_URL_SUFFIX_FIELD_NUMBER

        public static final int FINAL_URL_SUFFIX_FIELD_NUMBER
        See Also:
        Constant Field Values
      • URL_CUSTOM_PARAMETERS_FIELD_NUMBER

        public static final int URL_CUSTOM_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DISPLAY_URL_FIELD_NUMBER

        public static final int DISPLAY_URL_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ADDED_BY_GOOGLE_ADS_FIELD_NUMBER

        public static final int ADDED_BY_GOOGLE_ADS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DEVICE_PREFERENCE_FIELD_NUMBER

        public static final int DEVICE_PREFERENCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • URL_COLLECTIONS_FIELD_NUMBER

        public static final int URL_COLLECTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SYSTEM_MANAGED_RESOURCE_SOURCE_FIELD_NUMBER

        public static final int SYSTEM_MANAGED_RESOURCE_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPANDED_TEXT_AD_FIELD_NUMBER

        public static final int EXPANDED_TEXT_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPANDED_DYNAMIC_SEARCH_AD_FIELD_NUMBER

        public static final int EXPANDED_DYNAMIC_SEARCH_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SHOPPING_SMART_AD_FIELD_NUMBER

        public static final int SHOPPING_SMART_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SHOPPING_PRODUCT_AD_FIELD_NUMBER

        public static final int SHOPPING_PRODUCT_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • VIDEO_RESPONSIVE_AD_FIELD_NUMBER

        public static final int VIDEO_RESPONSIVE_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RESPONSIVE_SEARCH_AD_FIELD_NUMBER

        public static final int RESPONSIVE_SEARCH_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • LEGACY_RESPONSIVE_DISPLAY_AD_FIELD_NUMBER

        public static final int LEGACY_RESPONSIVE_DISPLAY_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • LEGACY_APP_INSTALL_AD_FIELD_NUMBER

        public static final int LEGACY_APP_INSTALL_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RESPONSIVE_DISPLAY_AD_FIELD_NUMBER

        public static final int RESPONSIVE_DISPLAY_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DISPLAY_UPLOAD_AD_FIELD_NUMBER

        public static final int DISPLAY_UPLOAD_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • APP_ENGAGEMENT_AD_FIELD_NUMBER

        public static final int APP_ENGAGEMENT_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SHOPPING_COMPARISON_LISTING_AD_FIELD_NUMBER

        public static final int SHOPPING_COMPARISON_LISTING_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SMART_CAMPAIGN_AD_FIELD_NUMBER

        public static final int SMART_CAMPAIGN_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • APP_PRE_REGISTRATION_AD_FIELD_NUMBER

        public static final int APP_PRE_REGISTRATION_AD_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the ad.
         Ad resource names have the form:
         `customers/{customer_id}/ads/{ad_id}`
         
        string resource_name = 37 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface AdOrBuilder
        Returns:
        The resourceName.
      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the ad.
         Ad resource names have the form:
         `customers/{customer_id}/ads/{ad_id}`
         
        string resource_name = 37 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface AdOrBuilder
        Returns:
        The bytes for resourceName.
      • hasId

        public boolean hasId()
         Output only. The ID of the ad.
         
        optional int64 id = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface AdOrBuilder
        Returns:
        Whether the id field is set.
      • getId

        public long getId()
         Output only. The ID of the ad.
         
        optional int64 id = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface AdOrBuilder
        Returns:
        The id.
      • getFinalUrlsList

        public com.google.protobuf.ProtocolStringList getFinalUrlsList()
         The list of possible final URLs after all cross-domain redirects for the
         ad.
         
        repeated string final_urls = 41;
        Specified by:
        getFinalUrlsList in interface AdOrBuilder
        Returns:
        A list containing the finalUrls.
      • getFinalUrlsCount

        public int getFinalUrlsCount()
         The list of possible final URLs after all cross-domain redirects for the
         ad.
         
        repeated string final_urls = 41;
        Specified by:
        getFinalUrlsCount in interface AdOrBuilder
        Returns:
        The count of finalUrls.
      • getFinalUrls

        public java.lang.String getFinalUrls​(int index)
         The list of possible final URLs after all cross-domain redirects for the
         ad.
         
        repeated string final_urls = 41;
        Specified by:
        getFinalUrls in interface AdOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The finalUrls at the given index.
      • getFinalUrlsBytes

        public com.google.protobuf.ByteString getFinalUrlsBytes​(int index)
         The list of possible final URLs after all cross-domain redirects for the
         ad.
         
        repeated string final_urls = 41;
        Specified by:
        getFinalUrlsBytes in interface AdOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the finalUrls at the given index.
      • getFinalAppUrlsList

        public java.util.List<FinalAppUrl> getFinalAppUrlsList()
         A list of final app URLs that will be used on mobile if the user has the
         specific app installed.
         
        repeated .google.ads.googleads.v10.common.FinalAppUrl final_app_urls = 35;
        Specified by:
        getFinalAppUrlsList in interface AdOrBuilder
      • getFinalAppUrlsOrBuilderList

        public java.util.List<? extends FinalAppUrlOrBuilder> getFinalAppUrlsOrBuilderList()
         A list of final app URLs that will be used on mobile if the user has the
         specific app installed.
         
        repeated .google.ads.googleads.v10.common.FinalAppUrl final_app_urls = 35;
        Specified by:
        getFinalAppUrlsOrBuilderList in interface AdOrBuilder
      • getFinalAppUrlsCount

        public int getFinalAppUrlsCount()
         A list of final app URLs that will be used on mobile if the user has the
         specific app installed.
         
        repeated .google.ads.googleads.v10.common.FinalAppUrl final_app_urls = 35;
        Specified by:
        getFinalAppUrlsCount in interface AdOrBuilder
      • getFinalAppUrls

        public FinalAppUrl getFinalAppUrls​(int index)
         A list of final app URLs that will be used on mobile if the user has the
         specific app installed.
         
        repeated .google.ads.googleads.v10.common.FinalAppUrl final_app_urls = 35;
        Specified by:
        getFinalAppUrls in interface AdOrBuilder
      • getFinalAppUrlsOrBuilder

        public FinalAppUrlOrBuilder getFinalAppUrlsOrBuilder​(int index)
         A list of final app URLs that will be used on mobile if the user has the
         specific app installed.
         
        repeated .google.ads.googleads.v10.common.FinalAppUrl final_app_urls = 35;
        Specified by:
        getFinalAppUrlsOrBuilder in interface AdOrBuilder
      • getFinalMobileUrlsList

        public com.google.protobuf.ProtocolStringList getFinalMobileUrlsList()
         The list of possible final mobile URLs after all cross-domain redirects
         for the ad.
         
        repeated string final_mobile_urls = 42;
        Specified by:
        getFinalMobileUrlsList in interface AdOrBuilder
        Returns:
        A list containing the finalMobileUrls.
      • getFinalMobileUrlsCount

        public int getFinalMobileUrlsCount()
         The list of possible final mobile URLs after all cross-domain redirects
         for the ad.
         
        repeated string final_mobile_urls = 42;
        Specified by:
        getFinalMobileUrlsCount in interface AdOrBuilder
        Returns:
        The count of finalMobileUrls.
      • getFinalMobileUrls

        public java.lang.String getFinalMobileUrls​(int index)
         The list of possible final mobile URLs after all cross-domain redirects
         for the ad.
         
        repeated string final_mobile_urls = 42;
        Specified by:
        getFinalMobileUrls in interface AdOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The finalMobileUrls at the given index.
      • getFinalMobileUrlsBytes

        public com.google.protobuf.ByteString getFinalMobileUrlsBytes​(int index)
         The list of possible final mobile URLs after all cross-domain redirects
         for the ad.
         
        repeated string final_mobile_urls = 42;
        Specified by:
        getFinalMobileUrlsBytes in interface AdOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the finalMobileUrls at the given index.
      • hasTrackingUrlTemplate

        public boolean hasTrackingUrlTemplate()
         The URL template for constructing a tracking URL.
         
        optional string tracking_url_template = 43;
        Specified by:
        hasTrackingUrlTemplate in interface AdOrBuilder
        Returns:
        Whether the trackingUrlTemplate field is set.
      • getTrackingUrlTemplate

        public java.lang.String getTrackingUrlTemplate()
         The URL template for constructing a tracking URL.
         
        optional string tracking_url_template = 43;
        Specified by:
        getTrackingUrlTemplate in interface AdOrBuilder
        Returns:
        The trackingUrlTemplate.
      • getTrackingUrlTemplateBytes

        public com.google.protobuf.ByteString getTrackingUrlTemplateBytes()
         The URL template for constructing a tracking URL.
         
        optional string tracking_url_template = 43;
        Specified by:
        getTrackingUrlTemplateBytes in interface AdOrBuilder
        Returns:
        The bytes for trackingUrlTemplate.
      • hasFinalUrlSuffix

        public boolean hasFinalUrlSuffix()
         The suffix to use when constructing a final URL.
         
        optional string final_url_suffix = 44;
        Specified by:
        hasFinalUrlSuffix in interface AdOrBuilder
        Returns:
        Whether the finalUrlSuffix field is set.
      • getFinalUrlSuffix

        public java.lang.String getFinalUrlSuffix()
         The suffix to use when constructing a final URL.
         
        optional string final_url_suffix = 44;
        Specified by:
        getFinalUrlSuffix in interface AdOrBuilder
        Returns:
        The finalUrlSuffix.
      • getFinalUrlSuffixBytes

        public com.google.protobuf.ByteString getFinalUrlSuffixBytes()
         The suffix to use when constructing a final URL.
         
        optional string final_url_suffix = 44;
        Specified by:
        getFinalUrlSuffixBytes in interface AdOrBuilder
        Returns:
        The bytes for finalUrlSuffix.
      • getUrlCustomParametersList

        public java.util.List<CustomParameter> getUrlCustomParametersList()
         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, please use url custom parameter operations.
         
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 10;
        Specified by:
        getUrlCustomParametersList in interface AdOrBuilder
      • getUrlCustomParametersOrBuilderList

        public java.util.List<? extends CustomParameterOrBuilder> getUrlCustomParametersOrBuilderList()
         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, please use url custom parameter operations.
         
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 10;
        Specified by:
        getUrlCustomParametersOrBuilderList in interface AdOrBuilder
      • getUrlCustomParametersCount

        public int getUrlCustomParametersCount()
         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, please use url custom parameter operations.
         
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 10;
        Specified by:
        getUrlCustomParametersCount in interface AdOrBuilder
      • getUrlCustomParameters

        public CustomParameter getUrlCustomParameters​(int index)
         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, please use url custom parameter operations.
         
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 10;
        Specified by:
        getUrlCustomParameters in interface AdOrBuilder
      • getUrlCustomParametersOrBuilder

        public CustomParameterOrBuilder getUrlCustomParametersOrBuilder​(int index)
         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, please use url custom parameter operations.
         
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 10;
        Specified by:
        getUrlCustomParametersOrBuilder in interface AdOrBuilder
      • hasDisplayUrl

        public boolean hasDisplayUrl()
         The URL that appears in the ad description for some ad formats.
         
        optional string display_url = 45;
        Specified by:
        hasDisplayUrl in interface AdOrBuilder
        Returns:
        Whether the displayUrl field is set.
      • getDisplayUrl

        public java.lang.String getDisplayUrl()
         The URL that appears in the ad description for some ad formats.
         
        optional string display_url = 45;
        Specified by:
        getDisplayUrl in interface AdOrBuilder
        Returns:
        The displayUrl.
      • getDisplayUrlBytes

        public com.google.protobuf.ByteString getDisplayUrlBytes()
         The URL that appears in the ad description for some ad formats.
         
        optional string display_url = 45;
        Specified by:
        getDisplayUrlBytes in interface AdOrBuilder
        Returns:
        The bytes for displayUrl.
      • getTypeValue

        public int getTypeValue()
         Output only. The type of ad.
         
        .google.ads.googleads.v10.enums.AdTypeEnum.AdType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeValue in interface AdOrBuilder
        Returns:
        The enum numeric value on the wire for type.
      • getType

        public AdTypeEnum.AdType getType()
         Output only. The type of ad.
         
        .google.ads.googleads.v10.enums.AdTypeEnum.AdType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getType in interface AdOrBuilder
        Returns:
        The type.
      • hasAddedByGoogleAds

        public boolean hasAddedByGoogleAds()
         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.
         
        optional bool added_by_google_ads = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasAddedByGoogleAds in interface AdOrBuilder
        Returns:
        Whether the addedByGoogleAds field is set.
      • getAddedByGoogleAds

        public boolean getAddedByGoogleAds()
         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.
         
        optional bool added_by_google_ads = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAddedByGoogleAds in interface AdOrBuilder
        Returns:
        The addedByGoogleAds.
      • getDevicePreferenceValue

        public int getDevicePreferenceValue()
         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.v10.enums.DeviceEnum.Device device_preference = 20;
        Specified by:
        getDevicePreferenceValue in interface AdOrBuilder
        Returns:
        The enum numeric value on the wire for devicePreference.
      • getDevicePreference

        public DeviceEnum.Device getDevicePreference()
         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.v10.enums.DeviceEnum.Device device_preference = 20;
        Specified by:
        getDevicePreference in interface AdOrBuilder
        Returns:
        The devicePreference.
      • getUrlCollectionsList

        public java.util.List<UrlCollection> getUrlCollectionsList()
         Additional URLs for the ad that are tagged with a unique identifier that
         can be referenced from other fields in the ad.
         
        repeated .google.ads.googleads.v10.common.UrlCollection url_collections = 26;
        Specified by:
        getUrlCollectionsList in interface AdOrBuilder
      • getUrlCollectionsOrBuilderList

        public java.util.List<? extends UrlCollectionOrBuilder> getUrlCollectionsOrBuilderList()
         Additional URLs for the ad that are tagged with a unique identifier that
         can be referenced from other fields in the ad.
         
        repeated .google.ads.googleads.v10.common.UrlCollection url_collections = 26;
        Specified by:
        getUrlCollectionsOrBuilderList in interface AdOrBuilder
      • getUrlCollectionsCount

        public int getUrlCollectionsCount()
         Additional URLs for the ad that are tagged with a unique identifier that
         can be referenced from other fields in the ad.
         
        repeated .google.ads.googleads.v10.common.UrlCollection url_collections = 26;
        Specified by:
        getUrlCollectionsCount in interface AdOrBuilder
      • getUrlCollections

        public UrlCollection getUrlCollections​(int index)
         Additional URLs for the ad that are tagged with a unique identifier that
         can be referenced from other fields in the ad.
         
        repeated .google.ads.googleads.v10.common.UrlCollection url_collections = 26;
        Specified by:
        getUrlCollections in interface AdOrBuilder
      • getUrlCollectionsOrBuilder

        public UrlCollectionOrBuilder getUrlCollectionsOrBuilder​(int index)
         Additional URLs for the ad that are tagged with a unique identifier that
         can be referenced from other fields in the ad.
         
        repeated .google.ads.googleads.v10.common.UrlCollection url_collections = 26;
        Specified by:
        getUrlCollectionsOrBuilder in interface AdOrBuilder
      • hasName

        public boolean hasName()
         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.
         
        optional string name = 47 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasName in interface AdOrBuilder
        Returns:
        Whether the name field is set.
      • getName

        public java.lang.String getName()
         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.
         
        optional string name = 47 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface AdOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         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.
         
        optional string name = 47 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface AdOrBuilder
        Returns:
        The bytes for name.
      • getSystemManagedResourceSourceValue

        public int getSystemManagedResourceSourceValue()
         Output only. If this ad is system managed, then this field will indicate the source.
         This field is read-only.
         
        .google.ads.googleads.v10.enums.SystemManagedResourceSourceEnum.SystemManagedResourceSource system_managed_resource_source = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSystemManagedResourceSourceValue in interface AdOrBuilder
        Returns:
        The enum numeric value on the wire for systemManagedResourceSource.
      • getSystemManagedResourceSource

        public SystemManagedResourceSourceEnum.SystemManagedResourceSource getSystemManagedResourceSource()
         Output only. If this ad is system managed, then this field will indicate the source.
         This field is read-only.
         
        .google.ads.googleads.v10.enums.SystemManagedResourceSourceEnum.SystemManagedResourceSource system_managed_resource_source = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSystemManagedResourceSource in interface AdOrBuilder
        Returns:
        The systemManagedResourceSource.
      • hasTextAd

        public boolean hasTextAd()
         Immutable. Details pertaining to a text ad.
         
        .google.ads.googleads.v10.common.TextAdInfo text_ad = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasTextAd in interface AdOrBuilder
        Returns:
        Whether the textAd field is set.
      • getTextAd

        public TextAdInfo getTextAd()
         Immutable. Details pertaining to a text ad.
         
        .google.ads.googleads.v10.common.TextAdInfo text_ad = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTextAd in interface AdOrBuilder
        Returns:
        The textAd.
      • getTextAdOrBuilder

        public TextAdInfoOrBuilder getTextAdOrBuilder()
         Immutable. Details pertaining to a text ad.
         
        .google.ads.googleads.v10.common.TextAdInfo text_ad = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTextAdOrBuilder in interface AdOrBuilder
      • hasExpandedTextAd

        public boolean hasExpandedTextAd()
         Details pertaining to an expanded text ad.
         
        .google.ads.googleads.v10.common.ExpandedTextAdInfo expanded_text_ad = 7;
        Specified by:
        hasExpandedTextAd in interface AdOrBuilder
        Returns:
        Whether the expandedTextAd field is set.
      • getExpandedTextAd

        public ExpandedTextAdInfo getExpandedTextAd()
         Details pertaining to an expanded text ad.
         
        .google.ads.googleads.v10.common.ExpandedTextAdInfo expanded_text_ad = 7;
        Specified by:
        getExpandedTextAd in interface AdOrBuilder
        Returns:
        The expandedTextAd.
      • hasCallAd

        public boolean hasCallAd()
         Details pertaining to a call ad.
         
        .google.ads.googleads.v10.common.CallAdInfo call_ad = 49;
        Specified by:
        hasCallAd in interface AdOrBuilder
        Returns:
        Whether the callAd field is set.
      • getCallAd

        public CallAdInfo getCallAd()
         Details pertaining to a call ad.
         
        .google.ads.googleads.v10.common.CallAdInfo call_ad = 49;
        Specified by:
        getCallAd in interface AdOrBuilder
        Returns:
        The callAd.
      • hasExpandedDynamicSearchAd

        public boolean hasExpandedDynamicSearchAd()
         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.
         
        .google.ads.googleads.v10.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasExpandedDynamicSearchAd in interface AdOrBuilder
        Returns:
        Whether the expandedDynamicSearchAd field is set.
      • getExpandedDynamicSearchAd

        public ExpandedDynamicSearchAdInfo getExpandedDynamicSearchAd()
         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.
         
        .google.ads.googleads.v10.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getExpandedDynamicSearchAd in interface AdOrBuilder
        Returns:
        The expandedDynamicSearchAd.
      • getExpandedDynamicSearchAdOrBuilder

        public ExpandedDynamicSearchAdInfoOrBuilder getExpandedDynamicSearchAdOrBuilder()
         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.
         
        .google.ads.googleads.v10.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getExpandedDynamicSearchAdOrBuilder in interface AdOrBuilder
      • hasHotelAd

        public boolean hasHotelAd()
         Details pertaining to a hotel ad.
         
        .google.ads.googleads.v10.common.HotelAdInfo hotel_ad = 15;
        Specified by:
        hasHotelAd in interface AdOrBuilder
        Returns:
        Whether the hotelAd field is set.
      • getHotelAd

        public HotelAdInfo getHotelAd()
         Details pertaining to a hotel ad.
         
        .google.ads.googleads.v10.common.HotelAdInfo hotel_ad = 15;
        Specified by:
        getHotelAd in interface AdOrBuilder
        Returns:
        The hotelAd.
      • hasShoppingSmartAd

        public boolean hasShoppingSmartAd()
         Details pertaining to a Smart Shopping ad.
         
        .google.ads.googleads.v10.common.ShoppingSmartAdInfo shopping_smart_ad = 17;
        Specified by:
        hasShoppingSmartAd in interface AdOrBuilder
        Returns:
        Whether the shoppingSmartAd field is set.
      • getShoppingSmartAd

        public ShoppingSmartAdInfo getShoppingSmartAd()
         Details pertaining to a Smart Shopping ad.
         
        .google.ads.googleads.v10.common.ShoppingSmartAdInfo shopping_smart_ad = 17;
        Specified by:
        getShoppingSmartAd in interface AdOrBuilder
        Returns:
        The shoppingSmartAd.
      • hasShoppingProductAd

        public boolean hasShoppingProductAd()
         Details pertaining to a Shopping product ad.
         
        .google.ads.googleads.v10.common.ShoppingProductAdInfo shopping_product_ad = 18;
        Specified by:
        hasShoppingProductAd in interface AdOrBuilder
        Returns:
        Whether the shoppingProductAd field is set.
      • getShoppingProductAd

        public ShoppingProductAdInfo getShoppingProductAd()
         Details pertaining to a Shopping product ad.
         
        .google.ads.googleads.v10.common.ShoppingProductAdInfo shopping_product_ad = 18;
        Specified by:
        getShoppingProductAd in interface AdOrBuilder
        Returns:
        The shoppingProductAd.
      • hasGmailAd

        public boolean hasGmailAd()
         Immutable. Details pertaining to a Gmail ad.
         
        .google.ads.googleads.v10.common.GmailAdInfo gmail_ad = 21 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasGmailAd in interface AdOrBuilder
        Returns:
        Whether the gmailAd field is set.
      • getGmailAd

        public GmailAdInfo getGmailAd()
         Immutable. Details pertaining to a Gmail ad.
         
        .google.ads.googleads.v10.common.GmailAdInfo gmail_ad = 21 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getGmailAd in interface AdOrBuilder
        Returns:
        The gmailAd.
      • getGmailAdOrBuilder

        public GmailAdInfoOrBuilder getGmailAdOrBuilder()
         Immutable. Details pertaining to a Gmail ad.
         
        .google.ads.googleads.v10.common.GmailAdInfo gmail_ad = 21 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getGmailAdOrBuilder in interface AdOrBuilder
      • hasImageAd

        public boolean hasImageAd()
         Immutable. Details pertaining to an Image ad.
         
        .google.ads.googleads.v10.common.ImageAdInfo image_ad = 22 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasImageAd in interface AdOrBuilder
        Returns:
        Whether the imageAd field is set.
      • getImageAd

        public ImageAdInfo getImageAd()
         Immutable. Details pertaining to an Image ad.
         
        .google.ads.googleads.v10.common.ImageAdInfo image_ad = 22 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getImageAd in interface AdOrBuilder
        Returns:
        The imageAd.
      • getImageAdOrBuilder

        public ImageAdInfoOrBuilder getImageAdOrBuilder()
         Immutable. Details pertaining to an Image ad.
         
        .google.ads.googleads.v10.common.ImageAdInfo image_ad = 22 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getImageAdOrBuilder in interface AdOrBuilder
      • hasVideoAd

        public boolean hasVideoAd()
         Details pertaining to a Video ad.
         
        .google.ads.googleads.v10.common.VideoAdInfo video_ad = 24;
        Specified by:
        hasVideoAd in interface AdOrBuilder
        Returns:
        Whether the videoAd field is set.
      • getVideoAd

        public VideoAdInfo getVideoAd()
         Details pertaining to a Video ad.
         
        .google.ads.googleads.v10.common.VideoAdInfo video_ad = 24;
        Specified by:
        getVideoAd in interface AdOrBuilder
        Returns:
        The videoAd.
      • hasVideoResponsiveAd

        public boolean hasVideoResponsiveAd()
         Details pertaining to a Video responsive ad.
         
        .google.ads.googleads.v10.common.VideoResponsiveAdInfo video_responsive_ad = 39;
        Specified by:
        hasVideoResponsiveAd in interface AdOrBuilder
        Returns:
        Whether the videoResponsiveAd field is set.
      • getVideoResponsiveAd

        public VideoResponsiveAdInfo getVideoResponsiveAd()
         Details pertaining to a Video responsive ad.
         
        .google.ads.googleads.v10.common.VideoResponsiveAdInfo video_responsive_ad = 39;
        Specified by:
        getVideoResponsiveAd in interface AdOrBuilder
        Returns:
        The videoResponsiveAd.
      • hasResponsiveSearchAd

        public boolean hasResponsiveSearchAd()
         Details pertaining to a responsive search ad.
         
        .google.ads.googleads.v10.common.ResponsiveSearchAdInfo responsive_search_ad = 25;
        Specified by:
        hasResponsiveSearchAd in interface AdOrBuilder
        Returns:
        Whether the responsiveSearchAd field is set.
      • getResponsiveSearchAd

        public ResponsiveSearchAdInfo getResponsiveSearchAd()
         Details pertaining to a responsive search ad.
         
        .google.ads.googleads.v10.common.ResponsiveSearchAdInfo responsive_search_ad = 25;
        Specified by:
        getResponsiveSearchAd in interface AdOrBuilder
        Returns:
        The responsiveSearchAd.
      • hasLegacyResponsiveDisplayAd

        public boolean hasLegacyResponsiveDisplayAd()
         Details pertaining to a legacy responsive display ad.
         
        .google.ads.googleads.v10.common.LegacyResponsiveDisplayAdInfo legacy_responsive_display_ad = 28;
        Specified by:
        hasLegacyResponsiveDisplayAd in interface AdOrBuilder
        Returns:
        Whether the legacyResponsiveDisplayAd field is set.
      • getLegacyResponsiveDisplayAd

        public LegacyResponsiveDisplayAdInfo getLegacyResponsiveDisplayAd()
         Details pertaining to a legacy responsive display ad.
         
        .google.ads.googleads.v10.common.LegacyResponsiveDisplayAdInfo legacy_responsive_display_ad = 28;
        Specified by:
        getLegacyResponsiveDisplayAd in interface AdOrBuilder
        Returns:
        The legacyResponsiveDisplayAd.
      • hasAppAd

        public boolean hasAppAd()
         Details pertaining to an app ad.
         
        .google.ads.googleads.v10.common.AppAdInfo app_ad = 29;
        Specified by:
        hasAppAd in interface AdOrBuilder
        Returns:
        Whether the appAd field is set.
      • getAppAd

        public AppAdInfo getAppAd()
         Details pertaining to an app ad.
         
        .google.ads.googleads.v10.common.AppAdInfo app_ad = 29;
        Specified by:
        getAppAd in interface AdOrBuilder
        Returns:
        The appAd.
      • hasLegacyAppInstallAd

        public boolean hasLegacyAppInstallAd()
         Immutable. Details pertaining to a legacy app install ad.
         
        .google.ads.googleads.v10.common.LegacyAppInstallAdInfo legacy_app_install_ad = 30 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasLegacyAppInstallAd in interface AdOrBuilder
        Returns:
        Whether the legacyAppInstallAd field is set.
      • getLegacyAppInstallAd

        public LegacyAppInstallAdInfo getLegacyAppInstallAd()
         Immutable. Details pertaining to a legacy app install ad.
         
        .google.ads.googleads.v10.common.LegacyAppInstallAdInfo legacy_app_install_ad = 30 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLegacyAppInstallAd in interface AdOrBuilder
        Returns:
        The legacyAppInstallAd.
      • getLegacyAppInstallAdOrBuilder

        public LegacyAppInstallAdInfoOrBuilder getLegacyAppInstallAdOrBuilder()
         Immutable. Details pertaining to a legacy app install ad.
         
        .google.ads.googleads.v10.common.LegacyAppInstallAdInfo legacy_app_install_ad = 30 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLegacyAppInstallAdOrBuilder in interface AdOrBuilder
      • hasResponsiveDisplayAd

        public boolean hasResponsiveDisplayAd()
         Details pertaining to a responsive display ad.
         
        .google.ads.googleads.v10.common.ResponsiveDisplayAdInfo responsive_display_ad = 31;
        Specified by:
        hasResponsiveDisplayAd in interface AdOrBuilder
        Returns:
        Whether the responsiveDisplayAd field is set.
      • getResponsiveDisplayAd

        public ResponsiveDisplayAdInfo getResponsiveDisplayAd()
         Details pertaining to a responsive display ad.
         
        .google.ads.googleads.v10.common.ResponsiveDisplayAdInfo responsive_display_ad = 31;
        Specified by:
        getResponsiveDisplayAd in interface AdOrBuilder
        Returns:
        The responsiveDisplayAd.
      • hasLocalAd

        public boolean hasLocalAd()
         Details pertaining to a local ad.
         
        .google.ads.googleads.v10.common.LocalAdInfo local_ad = 32;
        Specified by:
        hasLocalAd in interface AdOrBuilder
        Returns:
        Whether the localAd field is set.
      • getLocalAd

        public LocalAdInfo getLocalAd()
         Details pertaining to a local ad.
         
        .google.ads.googleads.v10.common.LocalAdInfo local_ad = 32;
        Specified by:
        getLocalAd in interface AdOrBuilder
        Returns:
        The localAd.
      • hasDisplayUploadAd

        public boolean hasDisplayUploadAd()
         Details pertaining to a display upload ad.
         
        .google.ads.googleads.v10.common.DisplayUploadAdInfo display_upload_ad = 33;
        Specified by:
        hasDisplayUploadAd in interface AdOrBuilder
        Returns:
        Whether the displayUploadAd field is set.
      • getDisplayUploadAd

        public DisplayUploadAdInfo getDisplayUploadAd()
         Details pertaining to a display upload ad.
         
        .google.ads.googleads.v10.common.DisplayUploadAdInfo display_upload_ad = 33;
        Specified by:
        getDisplayUploadAd in interface AdOrBuilder
        Returns:
        The displayUploadAd.
      • hasAppEngagementAd

        public boolean hasAppEngagementAd()
         Details pertaining to an app engagement ad.
         
        .google.ads.googleads.v10.common.AppEngagementAdInfo app_engagement_ad = 34;
        Specified by:
        hasAppEngagementAd in interface AdOrBuilder
        Returns:
        Whether the appEngagementAd field is set.
      • getAppEngagementAd

        public AppEngagementAdInfo getAppEngagementAd()
         Details pertaining to an app engagement ad.
         
        .google.ads.googleads.v10.common.AppEngagementAdInfo app_engagement_ad = 34;
        Specified by:
        getAppEngagementAd in interface AdOrBuilder
        Returns:
        The appEngagementAd.
      • hasShoppingComparisonListingAd

        public boolean hasShoppingComparisonListingAd()
         Details pertaining to a Shopping Comparison Listing ad.
         
        .google.ads.googleads.v10.common.ShoppingComparisonListingAdInfo shopping_comparison_listing_ad = 36;
        Specified by:
        hasShoppingComparisonListingAd in interface AdOrBuilder
        Returns:
        Whether the shoppingComparisonListingAd field is set.
      • getShoppingComparisonListingAd

        public ShoppingComparisonListingAdInfo getShoppingComparisonListingAd()
         Details pertaining to a Shopping Comparison Listing ad.
         
        .google.ads.googleads.v10.common.ShoppingComparisonListingAdInfo shopping_comparison_listing_ad = 36;
        Specified by:
        getShoppingComparisonListingAd in interface AdOrBuilder
        Returns:
        The shoppingComparisonListingAd.
      • hasSmartCampaignAd

        public boolean hasSmartCampaignAd()
         Details pertaining to a Smart campaign ad.
         
        .google.ads.googleads.v10.common.SmartCampaignAdInfo smart_campaign_ad = 48;
        Specified by:
        hasSmartCampaignAd in interface AdOrBuilder
        Returns:
        Whether the smartCampaignAd field is set.
      • getSmartCampaignAd

        public SmartCampaignAdInfo getSmartCampaignAd()
         Details pertaining to a Smart campaign ad.
         
        .google.ads.googleads.v10.common.SmartCampaignAdInfo smart_campaign_ad = 48;
        Specified by:
        getSmartCampaignAd in interface AdOrBuilder
        Returns:
        The smartCampaignAd.
      • hasAppPreRegistrationAd

        public boolean hasAppPreRegistrationAd()
         Details pertaining to an app pre-registration ad.
         
        .google.ads.googleads.v10.common.AppPreRegistrationAdInfo app_pre_registration_ad = 50;
        Specified by:
        hasAppPreRegistrationAd in interface AdOrBuilder
        Returns:
        Whether the appPreRegistrationAd field is set.
      • getAppPreRegistrationAd

        public AppPreRegistrationAdInfo getAppPreRegistrationAd()
         Details pertaining to an app pre-registration ad.
         
        .google.ads.googleads.v10.common.AppPreRegistrationAdInfo app_pre_registration_ad = 50;
        Specified by:
        getAppPreRegistrationAd in interface AdOrBuilder
        Returns:
        The appPreRegistrationAd.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Ad parseFrom​(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Ad parseFrom​(java.nio.ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Ad parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Ad parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Ad parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Ad parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Ad parseFrom​(java.io.InputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Ad parseFrom​(java.io.InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Ad parseDelimitedFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Ad parseDelimitedFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Ad parseFrom​(com.google.protobuf.CodedInputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Ad parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public Ad.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • newBuilder

        public static Ad.Builder newBuilder()
      • newBuilder

        public static Ad.Builder newBuilder​(Ad prototype)
      • toBuilder

        public Ad.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Ad.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Ad getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Ad> parser()
      • getParserForType

        public com.google.protobuf.Parser<Ad> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Ad getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder