Package com.google.ads.googleads.v10.common

Class LeadFormAsset

  • All Implemented Interfaces:
    LeadFormAssetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class LeadFormAsset
extends com.google.protobuf.GeneratedMessageV3
implements LeadFormAssetOrBuilder
     A Lead Form asset.
    Protobuf type google.ads.googleads.v10.common.LeadFormAsset
    See Also:
    Serialized Form

    • Field Detail

      • BUSINESS_NAME_FIELD_NUMBER

        public static final int BUSINESS_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CALL_TO_ACTION_TYPE_FIELD_NUMBER

        public static final int CALL_TO_ACTION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CALL_TO_ACTION_DESCRIPTION_FIELD_NUMBER

        public static final int CALL_TO_ACTION_DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRIVACY_POLICY_URL_FIELD_NUMBER

        public static final int PRIVACY_POLICY_URL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POST_SUBMIT_HEADLINE_FIELD_NUMBER

        public static final int POST_SUBMIT_HEADLINE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POST_SUBMIT_DESCRIPTION_FIELD_NUMBER

        public static final int POST_SUBMIT_DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DELIVERY_METHODS_FIELD_NUMBER

        public static final int DELIVERY_METHODS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POST_SUBMIT_CALL_TO_ACTION_TYPE_FIELD_NUMBER

        public static final int POST_SUBMIT_CALL_TO_ACTION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BACKGROUND_IMAGE_ASSET_FIELD_NUMBER

        public static final int BACKGROUND_IMAGE_ASSET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESIRED_INTENT_FIELD_NUMBER

        public static final int DESIRED_INTENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_DISCLOSURE_FIELD_NUMBER

        public static final int CUSTOM_DISCLOSURE_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

      • getBusinessName

        public java.lang.String getBusinessName()
         Required. The name of the business being advertised.
        string business_name = 10 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBusinessName in interface LeadFormAssetOrBuilder
        Returns:
        The businessName.

      • getBusinessNameBytes

        public com.google.protobuf.ByteString getBusinessNameBytes()
         Required. The name of the business being advertised.
        string business_name = 10 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBusinessNameBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for businessName.

      • getCallToActionTypeValue

        public int getCallToActionTypeValue()
         Required. Pre-defined display text that encourages user to expand the form.
        .google.ads.googleads.v10.enums.LeadFormCallToActionTypeEnum.LeadFormCallToActionType call_to_action_type = 17 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCallToActionTypeValue in interface LeadFormAssetOrBuilder
        Returns:
        The enum numeric value on the wire for callToActionType.

      • getCallToActionDescription

        public java.lang.String getCallToActionDescription()
         Required. Text giving a clear value proposition of what users expect once they expand
 the form.
        string call_to_action_description = 18 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCallToActionDescription in interface LeadFormAssetOrBuilder
        Returns:
        The callToActionDescription.

      • getCallToActionDescriptionBytes

        public com.google.protobuf.ByteString getCallToActionDescriptionBytes()
         Required. Text giving a clear value proposition of what users expect once they expand
 the form.
        string call_to_action_description = 18 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCallToActionDescriptionBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for callToActionDescription.

      • getHeadline

        public java.lang.String getHeadline()
         Required. Headline of the expanded form to describe what the form is asking for or
 facilitating.
        string headline = 12 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getHeadline in interface LeadFormAssetOrBuilder
        Returns:
        The headline.

      • getHeadlineBytes

        public com.google.protobuf.ByteString getHeadlineBytes()
         Required. Headline of the expanded form to describe what the form is asking for or
 facilitating.
        string headline = 12 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getHeadlineBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for headline.

      • getDescription

        public java.lang.String getDescription()
         Required. Detailed description of the expanded form to describe what the form is
 asking for or facilitating.
        string description = 13 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDescription in interface LeadFormAssetOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Required. Detailed description of the expanded form to describe what the form is
 asking for or facilitating.
        string description = 13 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDescriptionBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for description.

      • getPrivacyPolicyUrl

        public java.lang.String getPrivacyPolicyUrl()
         Required. Link to a page describing the policy on how the collected data is handled
 by the advertiser/business.
        string privacy_policy_url = 14 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPrivacyPolicyUrl in interface LeadFormAssetOrBuilder
        Returns:
        The privacyPolicyUrl.

      • getPrivacyPolicyUrlBytes

        public com.google.protobuf.ByteString getPrivacyPolicyUrlBytes()
         Required. Link to a page describing the policy on how the collected data is handled
 by the advertiser/business.
        string privacy_policy_url = 14 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPrivacyPolicyUrlBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for privacyPolicyUrl.

      • hasPostSubmitHeadline

        public boolean hasPostSubmitHeadline()
         Headline of text shown after form submission that describes how the
 advertiser will follow up with the user.
        optional string post_submit_headline = 15;
        Specified by:
        hasPostSubmitHeadline in interface LeadFormAssetOrBuilder
        Returns:
        Whether the postSubmitHeadline field is set.

      • getPostSubmitHeadline

        public java.lang.String getPostSubmitHeadline()
         Headline of text shown after form submission that describes how the
 advertiser will follow up with the user.
        optional string post_submit_headline = 15;
        Specified by:
        getPostSubmitHeadline in interface LeadFormAssetOrBuilder
        Returns:
        The postSubmitHeadline.

      • getPostSubmitHeadlineBytes

        public com.google.protobuf.ByteString getPostSubmitHeadlineBytes()
         Headline of text shown after form submission that describes how the
 advertiser will follow up with the user.
        optional string post_submit_headline = 15;
        Specified by:
        getPostSubmitHeadlineBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for postSubmitHeadline.

      • hasPostSubmitDescription

        public boolean hasPostSubmitDescription()
         Detailed description shown after form submission that describes how the
 advertiser will follow up with the user.
        optional string post_submit_description = 16;
        Specified by:
        hasPostSubmitDescription in interface LeadFormAssetOrBuilder
        Returns:
        Whether the postSubmitDescription field is set.

      • getPostSubmitDescription

        public java.lang.String getPostSubmitDescription()
         Detailed description shown after form submission that describes how the
 advertiser will follow up with the user.
        optional string post_submit_description = 16;
        Specified by:
        getPostSubmitDescription in interface LeadFormAssetOrBuilder
        Returns:
        The postSubmitDescription.

      • getPostSubmitDescriptionBytes

        public com.google.protobuf.ByteString getPostSubmitDescriptionBytes()
         Detailed description shown after form submission that describes how the
 advertiser will follow up with the user.
        optional string post_submit_description = 16;
        Specified by:
        getPostSubmitDescriptionBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for postSubmitDescription.

      • getFieldsCount

        public int getFieldsCount()
         Ordered list of input fields.
        repeated .google.ads.googleads.v10.common.LeadFormField fields = 8;
        Specified by:
        getFieldsCount in interface LeadFormAssetOrBuilder

      • getDeliveryMethodsList

        public java.util.List<LeadFormDeliveryMethod> getDeliveryMethodsList()
         Configured methods for collected lead data to be delivered to advertiser.
 Only one method typed as WebhookDelivery can be configured.
        repeated .google.ads.googleads.v10.common.LeadFormDeliveryMethod delivery_methods = 9;
        Specified by:
        getDeliveryMethodsList in interface LeadFormAssetOrBuilder

      • getDeliveryMethodsOrBuilderList

        public java.util.List<? extends LeadFormDeliveryMethodOrBuilder> getDeliveryMethodsOrBuilderList()
         Configured methods for collected lead data to be delivered to advertiser.
 Only one method typed as WebhookDelivery can be configured.
        repeated .google.ads.googleads.v10.common.LeadFormDeliveryMethod delivery_methods = 9;
        Specified by:
        getDeliveryMethodsOrBuilderList in interface LeadFormAssetOrBuilder

      • getDeliveryMethodsCount

        public int getDeliveryMethodsCount()
         Configured methods for collected lead data to be delivered to advertiser.
 Only one method typed as WebhookDelivery can be configured.
        repeated .google.ads.googleads.v10.common.LeadFormDeliveryMethod delivery_methods = 9;
        Specified by:
        getDeliveryMethodsCount in interface LeadFormAssetOrBuilder

      • getDeliveryMethods

        public LeadFormDeliveryMethod getDeliveryMethods​(int index)
         Configured methods for collected lead data to be delivered to advertiser.
 Only one method typed as WebhookDelivery can be configured.
        repeated .google.ads.googleads.v10.common.LeadFormDeliveryMethod delivery_methods = 9;
        Specified by:
        getDeliveryMethods in interface LeadFormAssetOrBuilder

      • getDeliveryMethodsOrBuilder

        public LeadFormDeliveryMethodOrBuilder getDeliveryMethodsOrBuilder​(int index)
         Configured methods for collected lead data to be delivered to advertiser.
 Only one method typed as WebhookDelivery can be configured.
        repeated .google.ads.googleads.v10.common.LeadFormDeliveryMethod delivery_methods = 9;
        Specified by:
        getDeliveryMethodsOrBuilder in interface LeadFormAssetOrBuilder

      • getPostSubmitCallToActionTypeValue

        public int getPostSubmitCallToActionTypeValue()
         Pre-defined display text that encourages user action after the form is
 submitted.
        .google.ads.googleads.v10.enums.LeadFormPostSubmitCallToActionTypeEnum.LeadFormPostSubmitCallToActionType post_submit_call_to_action_type = 19;
        Specified by:
        getPostSubmitCallToActionTypeValue in interface LeadFormAssetOrBuilder
        Returns:
        The enum numeric value on the wire for postSubmitCallToActionType.

      • hasBackgroundImageAsset

        public boolean hasBackgroundImageAsset()
         Asset resource name of the background image. The minimum size is 600x314
 and the aspect ratio must be 1.91:1 (+-1%).
        optional string background_image_asset = 20;
        Specified by:
        hasBackgroundImageAsset in interface LeadFormAssetOrBuilder
        Returns:
        Whether the backgroundImageAsset field is set.

      • getBackgroundImageAsset

        public java.lang.String getBackgroundImageAsset()
         Asset resource name of the background image. The minimum size is 600x314
 and the aspect ratio must be 1.91:1 (+-1%).
        optional string background_image_asset = 20;
        Specified by:
        getBackgroundImageAsset in interface LeadFormAssetOrBuilder
        Returns:
        The backgroundImageAsset.

      • getBackgroundImageAssetBytes

        public com.google.protobuf.ByteString getBackgroundImageAssetBytes()
         Asset resource name of the background image. The minimum size is 600x314
 and the aspect ratio must be 1.91:1 (+-1%).
        optional string background_image_asset = 20;
        Specified by:
        getBackgroundImageAssetBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for backgroundImageAsset.

      • getDesiredIntentValue

        public int getDesiredIntentValue()
         Desired intent for the lead form, e.g. more volume or more qualified.
        .google.ads.googleads.v10.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21;
        Specified by:
        getDesiredIntentValue in interface LeadFormAssetOrBuilder
        Returns:
        The enum numeric value on the wire for desiredIntent.

      • hasCustomDisclosure

        public boolean hasCustomDisclosure()
         Custom disclosure shown along with Google disclaimer on the lead form.
 Accessible to allowed customers only.
        optional string custom_disclosure = 22;
        Specified by:
        hasCustomDisclosure in interface LeadFormAssetOrBuilder
        Returns:
        Whether the customDisclosure field is set.

      • getCustomDisclosure

        public java.lang.String getCustomDisclosure()
         Custom disclosure shown along with Google disclaimer on the lead form.
 Accessible to allowed customers only.
        optional string custom_disclosure = 22;
        Specified by:
        getCustomDisclosure in interface LeadFormAssetOrBuilder
        Returns:
        The customDisclosure.

      • getCustomDisclosureBytes

        public com.google.protobuf.ByteString getCustomDisclosureBytes()
         Custom disclosure shown along with Google disclaimer on the lead form.
 Accessible to allowed customers only.
        optional string custom_disclosure = 22;
        Specified by:
        getCustomDisclosureBytes in interface LeadFormAssetOrBuilder
        Returns:
        The bytes for customDisclosure.

      • 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 LeadFormAsset parseFrom​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static LeadFormAsset getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<LeadFormAsset> parser()

      • getParserForType

        public com.google.protobuf.Parser<LeadFormAsset> 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 LeadFormAsset getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder