jp.co.yahoo.adssearchapi.v12.model.CampaignServiceTargetImpressionShareScheme Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ads-search-api-lib Show documentation
Yahoo! JAPAN Ads Search Ads API library for Java
The newest version!
/*
 * Yahoo!広告 検索広告 API リファレンス / Yahoo! JAPAN Ads Search Ads API Reference
 * Yahoo!広告 検索広告 APIのWebサービスについて説明します。
 Search Ads API Web Services supported in Yahoo! JAPAN Ads API.
 OpenAPI Specification
 Best Practice
 Best Practice 
 *
 * The version of the OpenAPI document: v12
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package jp.co.yahoo.adssearchapi.v12.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import jp.co.yahoo.adssearchapi.v12.model.CampaignServiceTargetImpressionShareLocation;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">CampaignServiceTargetImpressionShareSchemeオブジェクトは、インプレッションシェアの目標値の自動入札設定情報を表します。 （BiddingStrategyService以外用のオブジェクトです。）<br> ADD時、BiddingStrategyTypeがTARGET_IMPRESSION_SHAREの場合、必須となり、それ以外では省略可能となります。</div> <div lang=\"en\">CampaignServiceTargetImpressionShareScheme object describes automatic bid setting information of the impression share target value. (Object for anything other than BiddingStrategyService.)<br> If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others.</div> 
 */
@ApiModel(description = "CampaignServiceTargetImpressionShareSchemeオブジェクトは、インプレッションシェアの目標値の自動入札設定情報を表します。 （BiddingStrategyService以外用のオブジェクトです。）
 ADD時、BiddingStrategyTypeがTARGET_IMPRESSION_SHAREの場合、必須となり、それ以外では省略可能となります。
 CampaignServiceTargetImpressionShareScheme object describes automatic bid setting information of the impression share target value. (Object for anything other than BiddingStrategyService.)
 If BiddingStrategyType is TARGET_IMPRESSION_SHARE, this field is required in ADD operation, and it is optional when BiddingStrategyType is the others. ")
@JsonPropertyOrder({
  CampaignServiceTargetImpressionShareScheme.JSON_PROPERTY_LOCATION,
  CampaignServiceTargetImpressionShareScheme.JSON_PROPERTY_BID_CEILING,
  CampaignServiceTargetImpressionShareScheme.JSON_PROPERTY_TARGET_IMPRESSION_SHARE
})
@JsonTypeName("CampaignServiceTargetImpressionShareScheme")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CampaignServiceTargetImpressionShareScheme {
  public static final String JSON_PROPERTY_LOCATION = "location";
  private CampaignServiceTargetImpressionShareLocation location;

  public static final String JSON_PROPERTY_BID_CEILING = "bidCeiling";
  private Long bidCeiling;

  public static final String JSON_PROPERTY_TARGET_IMPRESSION_SHARE = "targetImpressionShare";
  private Long targetImpressionShare;

  public CampaignServiceTargetImpressionShareScheme() { 
  }

  public CampaignServiceTargetImpressionShareScheme location(CampaignServiceTargetImpressionShareLocation location) {
    
    this.location = location;
    return this;
  }

   /**
   * Get location
   * @return location
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "")
  @JsonProperty(JSON_PROPERTY_LOCATION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public CampaignServiceTargetImpressionShareLocation getLocation() {
    return location;
  }


  @JsonProperty(JSON_PROPERTY_LOCATION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setLocation(CampaignServiceTargetImpressionShareLocation location) {
    this.location = location;
  }


  public CampaignServiceTargetImpressionShareScheme bidCeiling(Long bidCeiling) {
    
    this.bidCeiling = bidCeiling;
    return this;
  }

   /**
   * <div lang=\"ja\">入札価格の上限です。<br> 入札価格の上限の詳細は以下のヘルプを参照してください。<br> ・<a href=\"https://ads-help.yahoo-net.jp/s/article/H000044401?language=ja\">自動入札タイプ「ページ最上部掲載」【検索広告】</a><br> このフィールドは、ADD時は必須となり、SET時は省略可能となります。<br> ただし、他の入札戦略から「ページ最上部掲載」へ変更される場合はSET時でも必須となります。 </div> <div lang=\"en\">Bid Limit.<br> Refer to the following help.<br> * <a href=\"https://ads-help.yahoo-net.jp/s/article/H000044401?language=en_US\">Autobidding type absolute top placement [Search Ads]</a><br> This field is required in ADD operation, and will be optional in SET operation.<br> If the 'Absolute top placement' type is specified in a SET operation from another bidding strategy type, this field will be required. </div> 
   * @return bidCeiling
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "入札価格の上限です。
 入札価格の上限の詳細は以下のヘルプを参照してください。
 ・自動入札タイプ「ページ最上部掲載」【検索広告】
 このフィールドは、ADD時は必須となり、SET時は省略可能となります。
 ただし、他の入札戦略から「ページ最上部掲載」へ変更される場合はSET時でも必須となります。 
 Bid Limit.
 Refer to the following help.
 * Autobidding type absolute top placement [Search Ads]
 This field is required in ADD operation, and will be optional in SET operation.
 If the 'Absolute top placement' type is specified in a SET operation from another bidding strategy type, this field will be required.  ")
  @JsonProperty(JSON_PROPERTY_BID_CEILING)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getBidCeiling() {
    return bidCeiling;
  }


  @JsonProperty(JSON_PROPERTY_BID_CEILING)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setBidCeiling(Long bidCeiling) {
    this.bidCeiling = bidCeiling;
  }


  public CampaignServiceTargetImpressionShareScheme targetImpressionShare(Long targetImpressionShare) {
    
    this.targetImpressionShare = targetImpressionShare;
    return this;
  }

   /**
   * <div lang=\"ja\">目標のインプレッションシェアです。<br> ADD時およびSET時、このフィールドは必須となります。</div> <div lang=\"en\">Target impression share.<br> This field is required in ADD and SET operation.</div> 
   * @return targetImpressionShare
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "目標のインプレッションシェアです。
 ADD時およびSET時、このフィールドは必須となります。
 Target impression share.
 This field is required in ADD and SET operation. ")
  @JsonProperty(JSON_PROPERTY_TARGET_IMPRESSION_SHARE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getTargetImpressionShare() {
    return targetImpressionShare;
  }


  @JsonProperty(JSON_PROPERTY_TARGET_IMPRESSION_SHARE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTargetImpressionShare(Long targetImpressionShare) {
    this.targetImpressionShare = targetImpressionShare;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    CampaignServiceTargetImpressionShareScheme campaignServiceTargetImpressionShareScheme = (CampaignServiceTargetImpressionShareScheme) o;
    return Objects.equals(this.location, campaignServiceTargetImpressionShareScheme.location) &&
        Objects.equals(this.bidCeiling, campaignServiceTargetImpressionShareScheme.bidCeiling) &&
        Objects.equals(this.targetImpressionShare, campaignServiceTargetImpressionShareScheme.targetImpressionShare);
  }

  @Override
  public int hashCode() {
    return Objects.hash(location, bidCeiling, targetImpressionShare);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class CampaignServiceTargetImpressionShareScheme {\n");
    sb.append("    location: ").append(toIndentedString(location)).append("\n");
    sb.append("    bidCeiling: ").append(toIndentedString(bidCeiling)).append("\n");
    sb.append("    targetImpressionShare: ").append(toIndentedString(targetImpressionShare)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

}