com.google.ads.googleads.v17.common.LeadFormAssetOrBuilder 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/asset_types.proto

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

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

  /**
   *    * Required. The name of the business being advertised.
   * 
   *
   * string business_name = 10 [(.google.api.field_behavior) = REQUIRED];
   * @return The businessName.
   */
  java.lang.String getBusinessName();
  /**
   *    * Required. The name of the business being advertised.
   * 
   *
   * string business_name = 10 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for businessName.
   */
  com.google.protobuf.ByteString
      getBusinessNameBytes();

  /**
   *    * Required. Pre-defined display text that encourages user to expand the form.
   * 
   *
   * .google.ads.googleads.v17.enums.LeadFormCallToActionTypeEnum.LeadFormCallToActionType call_to_action_type = 17 [(.google.api.field_behavior) = REQUIRED];
   * @return The enum numeric value on the wire for callToActionType.
   */
  int getCallToActionTypeValue();
  /**
   *    * Required. Pre-defined display text that encourages user to expand the form.
   * 
   *
   * .google.ads.googleads.v17.enums.LeadFormCallToActionTypeEnum.LeadFormCallToActionType call_to_action_type = 17 [(.google.api.field_behavior) = REQUIRED];
   * @return The callToActionType.
   */
  com.google.ads.googleads.v17.enums.LeadFormCallToActionTypeEnum.LeadFormCallToActionType getCallToActionType();

  /**
   *    * 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];
   * @return The callToActionDescription.
   */
  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];
   * @return The bytes for callToActionDescription.
   */
  com.google.protobuf.ByteString
      getCallToActionDescriptionBytes();

  /**
   *    * Required. Headline of the expanded form to describe what the form is asking
   * for or facilitating.
   * 
   *
   * string headline = 12 [(.google.api.field_behavior) = REQUIRED];
   * @return The headline.
   */
  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];
   * @return The bytes for headline.
   */
  com.google.protobuf.ByteString
      getHeadlineBytes();

  /**
   *    * 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];
   * @return The description.
   */
  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];
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * 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];
   * @return The privacyPolicyUrl.
   */
  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];
   * @return The bytes for privacyPolicyUrl.
   */
  com.google.protobuf.ByteString
      getPrivacyPolicyUrlBytes();

  /**
   *    * Headline of text shown after form submission that describes how the
   * advertiser will follow up with the user.
   * 
   *
   * optional string post_submit_headline = 15;
   * @return Whether the postSubmitHeadline field is set.
   */
  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;
   * @return The postSubmitHeadline.
   */
  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;
   * @return The bytes for postSubmitHeadline.
   */
  com.google.protobuf.ByteString
      getPostSubmitHeadlineBytes();

  /**
   *    * Detailed description shown after form submission that describes how the
   * advertiser will follow up with the user.
   * 
   *
   * optional string post_submit_description = 16;
   * @return Whether the postSubmitDescription field is set.
   */
  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;
   * @return The postSubmitDescription.
   */
  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;
   * @return The bytes for postSubmitDescription.
   */
  com.google.protobuf.ByteString
      getPostSubmitDescriptionBytes();

  /**
   *    * Ordered list of input fields. This field can be updated by reordering
   * questions, but not by adding or removing questions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormField fields = 8;
   */
  java.util.List 
      getFieldsList();
  /**
   *    * Ordered list of input fields. This field can be updated by reordering
   * questions, but not by adding or removing questions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormField fields = 8;
   */
  com.google.ads.googleads.v17.common.LeadFormField getFields(int index);
  /**
   *    * Ordered list of input fields. This field can be updated by reordering
   * questions, but not by adding or removing questions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormField fields = 8;
   */
  int getFieldsCount();
  /**
   *    * Ordered list of input fields. This field can be updated by reordering
   * questions, but not by adding or removing questions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormField fields = 8;
   */
  java.util.List 
      getFieldsOrBuilderList();
  /**
   *    * Ordered list of input fields. This field can be updated by reordering
   * questions, but not by adding or removing questions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormField fields = 8;
   */
  com.google.ads.googleads.v17.common.LeadFormFieldOrBuilder getFieldsOrBuilder(
      int index);

  /**
   *    * Ordered list of custom question fields. This field is subject to a limit of
   * 5 qualifying questions per form.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormCustomQuestionField custom_question_fields = 23;
   */
  java.util.List 
      getCustomQuestionFieldsList();
  /**
   *    * Ordered list of custom question fields. This field is subject to a limit of
   * 5 qualifying questions per form.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormCustomQuestionField custom_question_fields = 23;
   */
  com.google.ads.googleads.v17.common.LeadFormCustomQuestionField getCustomQuestionFields(int index);
  /**
   *    * Ordered list of custom question fields. This field is subject to a limit of
   * 5 qualifying questions per form.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormCustomQuestionField custom_question_fields = 23;
   */
  int getCustomQuestionFieldsCount();
  /**
   *    * Ordered list of custom question fields. This field is subject to a limit of
   * 5 qualifying questions per form.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormCustomQuestionField custom_question_fields = 23;
   */
  java.util.List 
      getCustomQuestionFieldsOrBuilderList();
  /**
   *    * Ordered list of custom question fields. This field is subject to a limit of
   * 5 qualifying questions per form.
   * 
   *
   * repeated .google.ads.googleads.v17.common.LeadFormCustomQuestionField custom_question_fields = 23;
   */
  com.google.ads.googleads.v17.common.LeadFormCustomQuestionFieldOrBuilder getCustomQuestionFieldsOrBuilder(
      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.v17.common.LeadFormDeliveryMethod delivery_methods = 9;
   */
  java.util.List 
      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.v17.common.LeadFormDeliveryMethod delivery_methods = 9;
   */
  com.google.ads.googleads.v17.common.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.v17.common.LeadFormDeliveryMethod delivery_methods = 9;
   */
  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.v17.common.LeadFormDeliveryMethod delivery_methods = 9;
   */
  java.util.List 
      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.v17.common.LeadFormDeliveryMethod delivery_methods = 9;
   */
  com.google.ads.googleads.v17.common.LeadFormDeliveryMethodOrBuilder getDeliveryMethodsOrBuilder(
      int index);

  /**
   *    * Pre-defined display text that encourages user action after the form is
   * submitted.
   * 
   *
   * .google.ads.googleads.v17.enums.LeadFormPostSubmitCallToActionTypeEnum.LeadFormPostSubmitCallToActionType post_submit_call_to_action_type = 19;
   * @return The enum numeric value on the wire for postSubmitCallToActionType.
   */
  int getPostSubmitCallToActionTypeValue();
  /**
   *    * Pre-defined display text that encourages user action after the form is
   * submitted.
   * 
   *
   * .google.ads.googleads.v17.enums.LeadFormPostSubmitCallToActionTypeEnum.LeadFormPostSubmitCallToActionType post_submit_call_to_action_type = 19;
   * @return The postSubmitCallToActionType.
   */
  com.google.ads.googleads.v17.enums.LeadFormPostSubmitCallToActionTypeEnum.LeadFormPostSubmitCallToActionType getPostSubmitCallToActionType();

  /**
   *    * Asset resource name of the background image.
   * The image dimensions must be exactly 1200x628.
   * 
   *
   * optional string background_image_asset = 20;
   * @return Whether the backgroundImageAsset field is set.
   */
  boolean hasBackgroundImageAsset();
  /**
   *    * Asset resource name of the background image.
   * The image dimensions must be exactly 1200x628.
   * 
   *
   * optional string background_image_asset = 20;
   * @return The backgroundImageAsset.
   */
  java.lang.String getBackgroundImageAsset();
  /**
   *    * Asset resource name of the background image.
   * The image dimensions must be exactly 1200x628.
   * 
   *
   * optional string background_image_asset = 20;
   * @return The bytes for backgroundImageAsset.
   */
  com.google.protobuf.ByteString
      getBackgroundImageAssetBytes();

  /**
   *    * Chosen intent for the lead form, for example, more volume or more
   * qualified.
   * 
   *
   * .google.ads.googleads.v17.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21;
   * @return The enum numeric value on the wire for desiredIntent.
   */
  int getDesiredIntentValue();
  /**
   *    * Chosen intent for the lead form, for example, more volume or more
   * qualified.
   * 
   *
   * .google.ads.googleads.v17.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21;
   * @return The desiredIntent.
   */
  com.google.ads.googleads.v17.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent getDesiredIntent();

  /**
   *    * Custom disclosure shown along with Google disclaimer on the lead form.
   * Accessible to allowed customers only.
   * 
   *
   * optional string custom_disclosure = 22;
   * @return Whether the customDisclosure field is set.
   */
  boolean hasCustomDisclosure();
  /**
   *    * Custom disclosure shown along with Google disclaimer on the lead form.
   * Accessible to allowed customers only.
   * 
   *
   * optional string custom_disclosure = 22;
   * @return The customDisclosure.
   */
  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;
   * @return The bytes for customDisclosure.
   */
  com.google.protobuf.ByteString
      getCustomDisclosureBytes();
}