com.google.ads.googleads.v17.resources.LocalServicesLeadOrBuilder 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/resources/local_services_lead.proto

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

public interface LocalServicesLeadOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.LocalServicesLead)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Output only. The resource name of the local services lead data.
   * Local Services Lead resource name have the form
   *
   * `customers/{customer_id}/localServicesLead/{local_services_lead_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Output only. The resource name of the local services lead data.
   * Local Services Lead resource name have the form
   *
   * `customers/{customer_id}/localServicesLead/{local_services_lead_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. ID of this Lead.
   * 
   *
   * int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Output only. Service category of the lead. For example:
   * `xcat:service_area_business_hvac`,
   * `xcat:service_area_business_real_estate_agent`, etc.
   * For more details see:
   * https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
   * 
   *
   * string category_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The categoryId.
   */
  java.lang.String getCategoryId();
  /**
   *    * Output only. Service category of the lead. For example:
   * `xcat:service_area_business_hvac`,
   * `xcat:service_area_business_real_estate_agent`, etc.
   * For more details see:
   * https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
   * 
   *
   * string category_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for categoryId.
   */
  com.google.protobuf.ByteString
      getCategoryIdBytes();

  /**
   *    * Output only. Service for the  category. For example: `buyer_agent`,
   * `seller_agent` for the category of
   * `xcat:service_area_business_real_estate_agent`.
   * 
   *
   * string service_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The serviceId.
   */
  java.lang.String getServiceId();
  /**
   *    * Output only. Service for the  category. For example: `buyer_agent`,
   * `seller_agent` for the category of
   * `xcat:service_area_business_real_estate_agent`.
   * 
   *
   * string service_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for serviceId.
   */
  com.google.protobuf.ByteString
      getServiceIdBytes();

  /**
   *    * Output only. Lead's contact details.
   * 
   *
   * .google.ads.googleads.v17.resources.ContactDetails contact_details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the contactDetails field is set.
   */
  boolean hasContactDetails();
  /**
   *    * Output only. Lead's contact details.
   * 
   *
   * .google.ads.googleads.v17.resources.ContactDetails contact_details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The contactDetails.
   */
  com.google.ads.googleads.v17.resources.ContactDetails getContactDetails();
  /**
   *    * Output only. Lead's contact details.
   * 
   *
   * .google.ads.googleads.v17.resources.ContactDetails contact_details = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.ContactDetailsOrBuilder getContactDetailsOrBuilder();

  /**
   *    * Output only. Type of Local Services lead: phone, message, booking, etc.
   * 
   *
   * .google.ads.googleads.v17.enums.LocalServicesLeadTypeEnum.LeadType lead_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for leadType.
   */
  int getLeadTypeValue();
  /**
   *    * Output only. Type of Local Services lead: phone, message, booking, etc.
   * 
   *
   * .google.ads.googleads.v17.enums.LocalServicesLeadTypeEnum.LeadType lead_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The leadType.
   */
  com.google.ads.googleads.v17.enums.LocalServicesLeadTypeEnum.LeadType getLeadType();

  /**
   *    * Output only. Current status of lead.
   * 
   *
   * .google.ads.googleads.v17.enums.LocalServicesLeadStatusEnum.LeadStatus lead_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for leadStatus.
   */
  int getLeadStatusValue();
  /**
   *    * Output only. Current status of lead.
   * 
   *
   * .google.ads.googleads.v17.enums.LocalServicesLeadStatusEnum.LeadStatus lead_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The leadStatus.
   */
  com.google.ads.googleads.v17.enums.LocalServicesLeadStatusEnum.LeadStatus getLeadStatus();

  /**
   *    * Output only. The date time at which lead was created by Local Services Ads.
   * The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone.
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The creationDateTime.
   */
  java.lang.String getCreationDateTime();
  /**
   *    * Output only. The date time at which lead was created by Local Services Ads.
   * The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone.
   * Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
   * 
   *
   * string creation_date_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for creationDateTime.
   */
  com.google.protobuf.ByteString
      getCreationDateTimeBytes();

  /**
   *    * Output only. Language used by the Local Services provider linked to lead.
   * See https://developers.google.com/google-ads/api/data/codes-formats#locales
   * 
   *
   * string locale = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The locale.
   */
  java.lang.String getLocale();
  /**
   *    * Output only. Language used by the Local Services provider linked to lead.
   * See https://developers.google.com/google-ads/api/data/codes-formats#locales
   * 
   *
   * string locale = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for locale.
   */
  com.google.protobuf.ByteString
      getLocaleBytes();

  /**
   *    * Output only. Note added by advertiser for the lead.
   * 
   *
   * optional .google.ads.googleads.v17.resources.Note note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the note field is set.
   */
  boolean hasNote();
  /**
   *    * Output only. Note added by advertiser for the lead.
   * 
   *
   * optional .google.ads.googleads.v17.resources.Note note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The note.
   */
  com.google.ads.googleads.v17.resources.Note getNote();
  /**
   *    * Output only. Note added by advertiser for the lead.
   * 
   *
   * optional .google.ads.googleads.v17.resources.Note note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.NoteOrBuilder getNoteOrBuilder();

  /**
   *    * Output only. True if the advertiser was charged for the lead.
   * 
   *
   * bool lead_charged = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The leadCharged.
   */
  boolean getLeadCharged();

  /**
   *    * Output only. Credit details of the lead.
   * 
   *
   * optional .google.ads.googleads.v17.resources.CreditDetails credit_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the creditDetails field is set.
   */
  boolean hasCreditDetails();
  /**
   *    * Output only. Credit details of the lead.
   * 
   *
   * optional .google.ads.googleads.v17.resources.CreditDetails credit_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The creditDetails.
   */
  com.google.ads.googleads.v17.resources.CreditDetails getCreditDetails();
  /**
   *    * Output only. Credit details of the lead.
   * 
   *
   * optional .google.ads.googleads.v17.resources.CreditDetails credit_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.CreditDetailsOrBuilder getCreditDetailsOrBuilder();
}