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

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

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

  /**
   *    * Immutable. The resource name of the seasonality adjustment.
   * Seasonality adjustment resource names have the form:
   *
   * `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_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 seasonality adjustment.
   * Seasonality adjustment resource names have the form:
   *
   * `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. The ID of the seasonality adjustment.
   * 
   *
   * int64 seasonality_adjustment_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The seasonalityAdjustmentId.
   */
  long getSeasonalityAdjustmentId();

  /**
   *    * The scope of the seasonality adjustment.
   * 
   *
   * .google.ads.googleads.v17.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3;
   * @return The enum numeric value on the wire for scope.
   */
  int getScopeValue();
  /**
   *    * The scope of the seasonality adjustment.
   * 
   *
   * .google.ads.googleads.v17.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3;
   * @return The scope.
   */
  com.google.ads.googleads.v17.enums.SeasonalityEventScopeEnum.SeasonalityEventScope getScope();

  /**
   *    * Output only. The status of the seasonality adjustment.
   * 
   *
   * .google.ads.googleads.v17.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of the seasonality adjustment.
   * 
   *
   * .google.ads.googleads.v17.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus getStatus();

  /**
   *    * Required. The inclusive start time of the seasonality adjustment in
   * yyyy-MM-dd HH:mm:ss format.
   *
   * A seasonality adjustment is forward looking and should be used for events
   * that start and end in the future.
   * 
   *
   * string start_date_time = 5 [(.google.api.field_behavior) = REQUIRED];
   * @return The startDateTime.
   */
  java.lang.String getStartDateTime();
  /**
   *    * Required. The inclusive start time of the seasonality adjustment in
   * yyyy-MM-dd HH:mm:ss format.
   *
   * A seasonality adjustment is forward looking and should be used for events
   * that start and end in the future.
   * 
   *
   * string start_date_time = 5 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for startDateTime.
   */
  com.google.protobuf.ByteString
      getStartDateTimeBytes();

  /**
   *    * Required. The exclusive end time of the seasonality adjustment in
   * yyyy-MM-dd HH:mm:ss format.
   *
   * The length of [start_date_time, end_date_time) interval must be
   * within (0, 14 days].
   * 
   *
   * string end_date_time = 6 [(.google.api.field_behavior) = REQUIRED];
   * @return The endDateTime.
   */
  java.lang.String getEndDateTime();
  /**
   *    * Required. The exclusive end time of the seasonality adjustment in
   * yyyy-MM-dd HH:mm:ss format.
   *
   * The length of [start_date_time, end_date_time) interval must be
   * within (0, 14 days].
   * 
   *
   * string end_date_time = 6 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for endDateTime.
   */
  com.google.protobuf.ByteString
      getEndDateTimeBytes();

  /**
   *    * The name of the seasonality adjustment. The name can be at most 255
   * characters.
   * 
   *
   * string name = 7;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the seasonality adjustment. The name can be at most 255
   * characters.
   * 
   *
   * string name = 7;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * The description of the seasonality adjustment. The description can be at
   * most 2048 characters.
   * 
   *
   * string description = 8;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * The description of the seasonality adjustment. The description can be at
   * most 2048 characters.
   * 
   *
   * string description = 8;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * If not specified, all devices will be included in this adjustment.
   * Otherwise, only the specified targeted devices will be included in this
   * adjustment.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.DeviceEnum.Device devices = 9;
   * @return A list containing the devices.
   */
  java.util.List getDevicesList();
  /**
   *    * If not specified, all devices will be included in this adjustment.
   * Otherwise, only the specified targeted devices will be included in this
   * adjustment.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.DeviceEnum.Device devices = 9;
   * @return The count of devices.
   */
  int getDevicesCount();
  /**
   *    * If not specified, all devices will be included in this adjustment.
   * Otherwise, only the specified targeted devices will be included in this
   * adjustment.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.DeviceEnum.Device devices = 9;
   * @param index The index of the element to return.
   * @return The devices at the given index.
   */
  com.google.ads.googleads.v17.enums.DeviceEnum.Device getDevices(int index);
  /**
   *    * If not specified, all devices will be included in this adjustment.
   * Otherwise, only the specified targeted devices will be included in this
   * adjustment.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.DeviceEnum.Device devices = 9;
   * @return A list containing the enum numeric values on the wire for devices.
   */
  java.util.List
  getDevicesValueList();
  /**
   *    * If not specified, all devices will be included in this adjustment.
   * Otherwise, only the specified targeted devices will be included in this
   * adjustment.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.DeviceEnum.Device devices = 9;
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of devices at the given index.
   */
  int getDevicesValue(int index);

  /**
   *    * Conversion rate modifier estimated based on expected conversion rate
   * changes. When this field is unset or set to 1.0 no adjustment will be
   * applied to traffic. The allowed range is 0.1 to 10.0.
   * 
   *
   * double conversion_rate_modifier = 10;
   * @return The conversionRateModifier.
   */
  double getConversionRateModifier();

  /**
   *    * The seasonality adjustment will apply to the campaigns listed when the
   * scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
   * event is 2000.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
   * @return A list containing the campaigns.
   */
  java.util.List
      getCampaignsList();
  /**
   *    * The seasonality adjustment will apply to the campaigns listed when the
   * scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
   * event is 2000.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
   * @return The count of campaigns.
   */
  int getCampaignsCount();
  /**
   *    * The seasonality adjustment will apply to the campaigns listed when the
   * scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
   * event is 2000.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
   * @param index The index of the element to return.
   * @return The campaigns at the given index.
   */
  java.lang.String getCampaigns(int index);
  /**
   *    * The seasonality adjustment will apply to the campaigns listed when the
   * scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
   * event is 2000.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
   * @param index The index of the value to return.
   * @return The bytes of the campaigns at the given index.
   */
  com.google.protobuf.ByteString
      getCampaignsBytes(int index);

  /**
   *    * The seasonality adjustment will apply to all the campaigns under the listed
   * channels retroactively as well as going forward when the scope of this
   * adjustment is CHANNEL.
   * The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
   * @return A list containing the advertisingChannelTypes.
   */
  java.util.List getAdvertisingChannelTypesList();
  /**
   *    * The seasonality adjustment will apply to all the campaigns under the listed
   * channels retroactively as well as going forward when the scope of this
   * adjustment is CHANNEL.
   * The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
   * @return The count of advertisingChannelTypes.
   */
  int getAdvertisingChannelTypesCount();
  /**
   *    * The seasonality adjustment will apply to all the campaigns under the listed
   * channels retroactively as well as going forward when the scope of this
   * adjustment is CHANNEL.
   * The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
   * @param index The index of the element to return.
   * @return The advertisingChannelTypes at the given index.
   */
  com.google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelTypes(int index);
  /**
   *    * The seasonality adjustment will apply to all the campaigns under the listed
   * channels retroactively as well as going forward when the scope of this
   * adjustment is CHANNEL.
   * The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
   * @return A list containing the enum numeric values on the wire for advertisingChannelTypes.
   */
  java.util.List
  getAdvertisingChannelTypesValueList();
  /**
   *    * The seasonality adjustment will apply to all the campaigns under the listed
   * channels retroactively as well as going forward when the scope of this
   * adjustment is CHANNEL.
   * The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
   * Note: a seasonality adjustment with both advertising_channel_types and
   * campaign_ids is not supported.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of advertisingChannelTypes at the given index.
   */
  int getAdvertisingChannelTypesValue(int index);
}