jp.co.yahoo.adssearchapi.v14.model.BiddingSeasonalityAdjustment 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
Show all versions of ads-search-api-lib Show documentation
Yahoo! JAPAN Ads Search Ads API library for Java
/*
* Yahoo!広告 検索広告 API リファレンス / Yahoo! JAPAN Ads Search Ads API Reference
* Yahoo!広告 検索広告 APIのWebサービスについて説明します。 Search Ads API Web Services supported in Yahoo! JAPAN Ads API.
*
* The version of the OpenAPI document: v14
*
*
* 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.v14.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 java.util.ArrayList;
import java.util.List;
import jp.co.yahoo.adssearchapi.v14.model.BiddingSeasonalityAdjustmentServiceDevices;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* <div lang=\"ja\">BiddingSeasonalityAdjustment オブジェクトは、自動入札のスポット調整を表します。</div> <div lang=\"en\">BiddingSeasonalityAdjustment object describes bidding seasonality adjustment information.</div>
*/
@ApiModel(description = "BiddingSeasonalityAdjustment オブジェクトは、自動入札のスポット調整を表します。 BiddingSeasonalityAdjustment object describes bidding seasonality adjustment information. ")
@JsonPropertyOrder({
BiddingSeasonalityAdjustment.JSON_PROPERTY_ACCOUNT_ID,
BiddingSeasonalityAdjustment.JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_NAME,
BiddingSeasonalityAdjustment.JSON_PROPERTY_DESCRIPTION,
BiddingSeasonalityAdjustment.JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_ID,
BiddingSeasonalityAdjustment.JSON_PROPERTY_DEVICES,
BiddingSeasonalityAdjustment.JSON_PROPERTY_START_DATE_TIME,
BiddingSeasonalityAdjustment.JSON_PROPERTY_END_DATE_TIME,
BiddingSeasonalityAdjustment.JSON_PROPERTY_CONVERSION_RATE,
BiddingSeasonalityAdjustment.JSON_PROPERTY_CAMPAIGN_IDS
})
@JsonTypeName("BiddingSeasonalityAdjustment")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class BiddingSeasonalityAdjustment {
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
private Long accountId;
public static final String JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_NAME = "biddingSeasonalityAdjustmentName";
private String biddingSeasonalityAdjustmentName;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;
public static final String JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_ID = "biddingSeasonalityAdjustmentId";
private Long biddingSeasonalityAdjustmentId;
public static final String JSON_PROPERTY_DEVICES = "devices";
private List devices = null;
public static final String JSON_PROPERTY_START_DATE_TIME = "startDateTime";
private String startDateTime;
public static final String JSON_PROPERTY_END_DATE_TIME = "endDateTime";
private String endDateTime;
public static final String JSON_PROPERTY_CONVERSION_RATE = "conversionRate";
private Double conversionRate;
public static final String JSON_PROPERTY_CAMPAIGN_IDS = "campaignIds";
private List campaignIds = null;
public BiddingSeasonalityAdjustment() {
}
public BiddingSeasonalityAdjustment accountId(Long accountId) {
this.accountId = accountId;
return this;
}
/**
* <div lang=\"ja\">アカウントIDです。</div> <div lang=\"en\">Account ID.</div>
* @return accountId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "アカウントIDです。 Account ID. ")
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getAccountId() {
return accountId;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAccountId(Long accountId) {
this.accountId = accountId;
}
public BiddingSeasonalityAdjustment biddingSeasonalityAdjustmentName(String biddingSeasonalityAdjustmentName) {
this.biddingSeasonalityAdjustmentName = biddingSeasonalityAdjustmentName;
return this;
}
/**
* <div lang=\"ja\">自動入札のスポット調整名です。<br> ADDおよびSET時、このフィールドは必須となります。<br> ※256文字以内になります。</div> <div lang=\"en\">Bidding seasonality adjustment name.<br> This field is required in ADD and SET operation.<br> *Up to 256 characters.</div>
* @return biddingSeasonalityAdjustmentName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "自動入札のスポット調整名です。
ADDおよびSET時、このフィールドは必須となります。
※256文字以内になります。 Bidding seasonality adjustment name.
This field is required in ADD and SET operation.
*Up to 256 characters. ")
@JsonProperty(JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBiddingSeasonalityAdjustmentName() {
return biddingSeasonalityAdjustmentName;
}
@JsonProperty(JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBiddingSeasonalityAdjustmentName(String biddingSeasonalityAdjustmentName) {
this.biddingSeasonalityAdjustmentName = biddingSeasonalityAdjustmentName;
}
public BiddingSeasonalityAdjustment description(String description) {
this.description = description;
return this;
}
/**
* <div lang=\"ja\">自動入札のスポット調整の説明です。<br> このフィールドは、省略可能となります。<br> ※500文字以内になります。</div> <div lang=\"en\">Bidding Seasonality Adjustment description.<br> This field is optional.<br> *Up to 500 characters.</div>
* @return description
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "自動入札のスポット調整の説明です。
このフィールドは、省略可能となります。
※500文字以内になります。 Bidding Seasonality Adjustment description.
This field is optional.
*Up to 500 characters. ")
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDescription(String description) {
this.description = description;
}
public BiddingSeasonalityAdjustment biddingSeasonalityAdjustmentId(Long biddingSeasonalityAdjustmentId) {
this.biddingSeasonalityAdjustmentId = biddingSeasonalityAdjustmentId;
return this;
}
/**
* <div lang=\"ja\">自動入札のスポット調整IDです。<br> SET及びREMOVE時、このフィールドは必須です。</div> <div lang=\"en\">Bidding seasonality adjustment ID.<br> This field is required in SET and REMOVE operation.</div>
* @return biddingSeasonalityAdjustmentId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "自動入札のスポット調整IDです。
SET及びREMOVE時、このフィールドは必須です。 Bidding seasonality adjustment ID.
This field is required in SET and REMOVE operation. ")
@JsonProperty(JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getBiddingSeasonalityAdjustmentId() {
return biddingSeasonalityAdjustmentId;
}
@JsonProperty(JSON_PROPERTY_BIDDING_SEASONALITY_ADJUSTMENT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBiddingSeasonalityAdjustmentId(Long biddingSeasonalityAdjustmentId) {
this.biddingSeasonalityAdjustmentId = biddingSeasonalityAdjustmentId;
}
public BiddingSeasonalityAdjustment devices(List devices) {
this.devices = devices;
return this;
}
public BiddingSeasonalityAdjustment addDevicesItem(BiddingSeasonalityAdjustmentServiceDevices devicesItem) {
if (this.devices == null) {
this.devices = new ArrayList<>();
}
this.devices.add(devicesItem);
return this;
}
/**
* Get devices
* @return devices
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_DEVICES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getDevices() {
return devices;
}
@JsonProperty(JSON_PROPERTY_DEVICES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDevices(List devices) {
this.devices = devices;
}
public BiddingSeasonalityAdjustment startDateTime(String startDateTime) {
this.startDateTime = startDateTime;
return this;
}
/**
* <div lang=\"ja\">ルール適用開始日です。<br> ADD時、このフィールドは必須です。<br> ※YYYYMMDDHHmmss形式です。<br> ※リクエスト日は2037/12/30まで 指定可能です。<br> ※startDateTime〜endDateTimeが14日を超える場合はエラーになります。</div> <div lang=\"en\">Start date of rule setting.<br> This field is required in ADD operation.<br> *In YYYYMMDDHHmmss format<br> *Request date can be set up to 2037/12/30<br> *If startDateTime〜endDateTime exceeds 14 days, an error will occur.</div>
* @return startDateTime
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ルール適用開始日です。
ADD時、このフィールドは必須です。
※YYYYMMDDHHmmss形式です。
※リクエスト日は2037/12/30まで 指定可能です。
※startDateTime〜endDateTimeが14日を超える場合はエラーになります。 Start date of rule setting.
This field is required in ADD operation.
*In YYYYMMDDHHmmss format
*Request date can be set up to 2037/12/30
*If startDateTime〜endDateTime exceeds 14 days, an error will occur. ")
@JsonProperty(JSON_PROPERTY_START_DATE_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getStartDateTime() {
return startDateTime;
}
@JsonProperty(JSON_PROPERTY_START_DATE_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStartDateTime(String startDateTime) {
this.startDateTime = startDateTime;
}
public BiddingSeasonalityAdjustment endDateTime(String endDateTime) {
this.endDateTime = endDateTime;
return this;
}
/**
* <div lang=\"ja\">ルール適用終了日です。<br> ADD時、このフィールドは必須です。<br> ※YYYYMMDDHHmmss形式です。<br> ※リクエスト日は2037/12/30まで 指定可能です。<br> ※startDateTime〜endDateTimeが14日を超える場合はエラーになります。</div> <div lang=\"en\">End date of rule setting.<br> This field is required in ADD operation.<br> *In YYYYMMDDHHmmss format<br> *Request date can be set up to 2037/12/30<br> *If startDateTime〜endDateTime exceeds 14 days, an error will occur.</div>
* @return endDateTime
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ルール適用終了日です。
ADD時、このフィールドは必須です。
※YYYYMMDDHHmmss形式です。
※リクエスト日は2037/12/30まで 指定可能です。
※startDateTime〜endDateTimeが14日を超える場合はエラーになります。 End date of rule setting.
This field is required in ADD operation.
*In YYYYMMDDHHmmss format
*Request date can be set up to 2037/12/30
*If startDateTime〜endDateTime exceeds 14 days, an error will occur. ")
@JsonProperty(JSON_PROPERTY_END_DATE_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEndDateTime() {
return endDateTime;
}
@JsonProperty(JSON_PROPERTY_END_DATE_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEndDateTime(String endDateTime) {
this.endDateTime = endDateTime;
}
public BiddingSeasonalityAdjustment conversionRate(Double conversionRate) {
this.conversionRate = conversionRate;
return this;
}
/**
* <div lang=\"ja\">コンバージョン率を調整する値です。<br> ADD時、このフィールドは必須となります。<br> ※制限値:0.1 ~ 10 </div> <div lang=\"en\">Value to adjust conversion rate.<br> This field is required in ADD operation.<br> *Range limit: 0.1 ~ 10 </div>
* @return conversionRate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "コンバージョン率を調整する値です。
ADD時、このフィールドは必須となります。
※制限値:0.1 ~ 10 Value to adjust conversion rate.
This field is required in ADD operation.
*Range limit: 0.1 ~ 10 ")
@JsonProperty(JSON_PROPERTY_CONVERSION_RATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getConversionRate() {
return conversionRate;
}
@JsonProperty(JSON_PROPERTY_CONVERSION_RATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setConversionRate(Double conversionRate) {
this.conversionRate = conversionRate;
}
public BiddingSeasonalityAdjustment campaignIds(List campaignIds) {
this.campaignIds = campaignIds;
return this;
}
public BiddingSeasonalityAdjustment addCampaignIdsItem(Long campaignIdsItem) {
if (this.campaignIds == null) {
this.campaignIds = new ArrayList<>();
}
this.campaignIds.add(campaignIdsItem);
return this;
}
/**
* <div lang=\"ja\">キャンペーンIDです。<br> ADD時、このフィールドは必須となります。</div> <div lang=\"en\">Campaign ID.<br> This field is required in ADD operation.</div>
* @return campaignIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "キャンペーンIDです。
ADD時、このフィールドは必須となります。 Campaign ID.
This field is required in ADD operation. ")
@JsonProperty(JSON_PROPERTY_CAMPAIGN_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getCampaignIds() {
return campaignIds;
}
@JsonProperty(JSON_PROPERTY_CAMPAIGN_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCampaignIds(List campaignIds) {
this.campaignIds = campaignIds;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
BiddingSeasonalityAdjustment biddingSeasonalityAdjustment = (BiddingSeasonalityAdjustment) o;
return Objects.equals(this.accountId, biddingSeasonalityAdjustment.accountId) &&
Objects.equals(this.biddingSeasonalityAdjustmentName, biddingSeasonalityAdjustment.biddingSeasonalityAdjustmentName) &&
Objects.equals(this.description, biddingSeasonalityAdjustment.description) &&
Objects.equals(this.biddingSeasonalityAdjustmentId, biddingSeasonalityAdjustment.biddingSeasonalityAdjustmentId) &&
Objects.equals(this.devices, biddingSeasonalityAdjustment.devices) &&
Objects.equals(this.startDateTime, biddingSeasonalityAdjustment.startDateTime) &&
Objects.equals(this.endDateTime, biddingSeasonalityAdjustment.endDateTime) &&
Objects.equals(this.conversionRate, biddingSeasonalityAdjustment.conversionRate) &&
Objects.equals(this.campaignIds, biddingSeasonalityAdjustment.campaignIds);
}
@Override
public int hashCode() {
return Objects.hash(accountId, biddingSeasonalityAdjustmentName, description, biddingSeasonalityAdjustmentId, devices, startDateTime, endDateTime, conversionRate, campaignIds);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BiddingSeasonalityAdjustment {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" biddingSeasonalityAdjustmentName: ").append(toIndentedString(biddingSeasonalityAdjustmentName)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" biddingSeasonalityAdjustmentId: ").append(toIndentedString(biddingSeasonalityAdjustmentId)).append("\n");
sb.append(" devices: ").append(toIndentedString(devices)).append("\n");
sb.append(" startDateTime: ").append(toIndentedString(startDateTime)).append("\n");
sb.append(" endDateTime: ").append(toIndentedString(endDateTime)).append("\n");
sb.append(" conversionRate: ").append(toIndentedString(conversionRate)).append("\n");
sb.append(" campaignIds: ").append(toIndentedString(campaignIds)).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 ");
}
}