com.google.ads.googleads.v10.resources.AdGroupBidModifierOrBuilder Maven / Gradle / Ivy

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

package com.google.ads.googleads.v10.resources;

public interface AdGroupBidModifierOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v10.resources.AdGroupBidModifier)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the ad group bid modifier.
   * Ad group bid modifier resource names have the form:
   * `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Immutable. The resource name of the ad group bid modifier.
   * Ad group bid modifier resource names have the form:
   * `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Immutable. The ad group to which this criterion belongs.
   * 
   *
   * optional string ad_group = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return Whether the adGroup field is set.
   */
  boolean hasAdGroup();
  /**
   *    * Immutable. The ad group to which this criterion belongs.
   * 
   *
   * optional string ad_group = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The adGroup.
   */
  java.lang.String getAdGroup();
  /**
   *    * Immutable. The ad group to which this criterion belongs.
   * 
   *
   * optional string ad_group = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for adGroup.
   */
  com.google.protobuf.ByteString
      getAdGroupBytes();

  /**
   *    * Output only. The ID of the criterion to bid modify.
   * This field is ignored for mutates.
   * 
   *
   * optional int64 criterion_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the criterionId field is set.
   */
  boolean hasCriterionId();
  /**
   *    * Output only. The ID of the criterion to bid modify.
   * This field is ignored for mutates.
   * 
   *
   * optional int64 criterion_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The criterionId.
   */
  long getCriterionId();

  /**
   *    * The modifier for the bid when the criterion matches. The modifier must be
   * in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent.
   * Use 0 to opt out of a Device type.
   * 
   *
   * optional double bid_modifier = 15;
   * @return Whether the bidModifier field is set.
   */
  boolean hasBidModifier();
  /**
   *    * The modifier for the bid when the criterion matches. The modifier must be
   * in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent.
   * Use 0 to opt out of a Device type.
   * 
   *
   * optional double bid_modifier = 15;
   * @return The bidModifier.
   */
  double getBidModifier();

  /**
   *    * Output only. The base ad group from which this draft/trial adgroup bid modifier was
   * created. If ad_group is a base ad group then this field will be equal to
   * ad_group. If the ad group was created in the draft or trial and has no
   * corresponding base ad group, then this field will be null.
   * This field is readonly.
   * 
   *
   * optional string base_ad_group = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return Whether the baseAdGroup field is set.
   */
  boolean hasBaseAdGroup();
  /**
   *    * Output only. The base ad group from which this draft/trial adgroup bid modifier was
   * created. If ad_group is a base ad group then this field will be equal to
   * ad_group. If the ad group was created in the draft or trial and has no
   * corresponding base ad group, then this field will be null.
   * This field is readonly.
   * 
   *
   * optional string base_ad_group = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The baseAdGroup.
   */
  java.lang.String getBaseAdGroup();
  /**
   *    * Output only. The base ad group from which this draft/trial adgroup bid modifier was
   * created. If ad_group is a base ad group then this field will be equal to
   * ad_group. If the ad group was created in the draft or trial and has no
   * corresponding base ad group, then this field will be null.
   * This field is readonly.
   * 
   *
   * optional string base_ad_group = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for baseAdGroup.
   */
  com.google.protobuf.ByteString
      getBaseAdGroupBytes();

  /**
   *    * Output only. Bid modifier source.
   * 
   *
   * .google.ads.googleads.v10.enums.BidModifierSourceEnum.BidModifierSource bid_modifier_source = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for bidModifierSource.
   */
  int getBidModifierSourceValue();
  /**
   *    * Output only. Bid modifier source.
   * 
   *
   * .google.ads.googleads.v10.enums.BidModifierSourceEnum.BidModifierSource bid_modifier_source = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bidModifierSource.
   */
  com.google.ads.googleads.v10.enums.BidModifierSourceEnum.BidModifierSource getBidModifierSource();

  /**
   *    * Immutable. Criterion for hotel date selection (default dates versus user selected).
   * 
   *
   * .google.ads.googleads.v10.common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the hotelDateSelectionType field is set.
   */
  boolean hasHotelDateSelectionType();
  /**
   *    * Immutable. Criterion for hotel date selection (default dates versus user selected).
   * 
   *
   * .google.ads.googleads.v10.common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The hotelDateSelectionType.
   */
  com.google.ads.googleads.v10.common.HotelDateSelectionTypeInfo getHotelDateSelectionType();
  /**
   *    * Immutable. Criterion for hotel date selection (default dates versus user selected).
   * 
   *
   * .google.ads.googleads.v10.common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v10.common.HotelDateSelectionTypeInfoOrBuilder getHotelDateSelectionTypeOrBuilder();

  /**
   *    * Immutable. Criterion for number of days prior to the stay the booking is being made.
   * 
   *
   * .google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the hotelAdvanceBookingWindow field is set.
   */
  boolean hasHotelAdvanceBookingWindow();
  /**
   *    * Immutable. Criterion for number of days prior to the stay the booking is being made.
   * 
   *
   * .google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The hotelAdvanceBookingWindow.
   */
  com.google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfo getHotelAdvanceBookingWindow();
  /**
   *    * Immutable. Criterion for number of days prior to the stay the booking is being made.
   * 
   *
   * .google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfoOrBuilder getHotelAdvanceBookingWindowOrBuilder();

  /**
   *    * Immutable. Criterion for length of hotel stay in nights.
   * 
   *
   * .google.ads.googleads.v10.common.HotelLengthOfStayInfo hotel_length_of_stay = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the hotelLengthOfStay field is set.
   */
  boolean hasHotelLengthOfStay();
  /**
   *    * Immutable. Criterion for length of hotel stay in nights.
   * 
   *
   * .google.ads.googleads.v10.common.HotelLengthOfStayInfo hotel_length_of_stay = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The hotelLengthOfStay.
   */
  com.google.ads.googleads.v10.common.HotelLengthOfStayInfo getHotelLengthOfStay();
  /**
   *    * Immutable. Criterion for length of hotel stay in nights.
   * 
   *
   * .google.ads.googleads.v10.common.HotelLengthOfStayInfo hotel_length_of_stay = 7 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v10.common.HotelLengthOfStayInfoOrBuilder getHotelLengthOfStayOrBuilder();

  /**
   *    * Immutable. Criterion for day of the week the booking is for.
   * 
   *
   * .google.ads.googleads.v10.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the hotelCheckInDay field is set.
   */
  boolean hasHotelCheckInDay();
  /**
   *    * Immutable. Criterion for day of the week the booking is for.
   * 
   *
   * .google.ads.googleads.v10.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The hotelCheckInDay.
   */
  com.google.ads.googleads.v10.common.HotelCheckInDayInfo getHotelCheckInDay();
  /**
   *    * Immutable. Criterion for day of the week the booking is for.
   * 
   *
   * .google.ads.googleads.v10.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v10.common.HotelCheckInDayInfoOrBuilder getHotelCheckInDayOrBuilder();

  /**
   *    * Immutable. A device criterion.
   * 
   *
   * .google.ads.googleads.v10.common.DeviceInfo device = 11 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the device field is set.
   */
  boolean hasDevice();
  /**
   *    * Immutable. A device criterion.
   * 
   *
   * .google.ads.googleads.v10.common.DeviceInfo device = 11 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The device.
   */
  com.google.ads.googleads.v10.common.DeviceInfo getDevice();
  /**
   *    * Immutable. A device criterion.
   * 
   *
   * .google.ads.googleads.v10.common.DeviceInfo device = 11 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v10.common.DeviceInfoOrBuilder getDeviceOrBuilder();

  /**
   *    * Immutable. A preferred content criterion.
   * 
   *
   * .google.ads.googleads.v10.common.PreferredContentInfo preferred_content = 12 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the preferredContent field is set.
   */
  boolean hasPreferredContent();
  /**
   *    * Immutable. A preferred content criterion.
   * 
   *
   * .google.ads.googleads.v10.common.PreferredContentInfo preferred_content = 12 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The preferredContent.
   */
  com.google.ads.googleads.v10.common.PreferredContentInfo getPreferredContent();
  /**
   *    * Immutable. A preferred content criterion.
   * 
   *
   * .google.ads.googleads.v10.common.PreferredContentInfo preferred_content = 12 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v10.common.PreferredContentInfoOrBuilder getPreferredContentOrBuilder();

  /**
   *    * Immutable. Criterion for a hotel check-in date range.
   * 
   *
   * .google.ads.googleads.v10.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the hotelCheckInDateRange field is set.
   */
  boolean hasHotelCheckInDateRange();
  /**
   *    * Immutable. Criterion for a hotel check-in date range.
   * 
   *
   * .google.ads.googleads.v10.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The hotelCheckInDateRange.
   */
  com.google.ads.googleads.v10.common.HotelCheckInDateRangeInfo getHotelCheckInDateRange();
  /**
   *    * Immutable. Criterion for a hotel check-in date range.
   * 
   *
   * .google.ads.googleads.v10.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(.google.api.field_behavior) = IMMUTABLE];
   */
  com.google.ads.googleads.v10.common.HotelCheckInDateRangeInfoOrBuilder getHotelCheckInDateRangeOrBuilder();

  public com.google.ads.googleads.v10.resources.AdGroupBidModifier.CriterionCase getCriterionCase();
}