jp.co.yahoo.adssearchapi.v12.model.AdGroupRetargetingList 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: 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.AdGroupRetargetingListServiceCriterionTargetList;
import jp.co.yahoo.adssearchapi.v12.model.AdGroupRetargetingListServiceExcludedType;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* <div lang=\"ja\">AdGroupRetargetingListは、広告グループレベルでのターゲットリスト設定を保持するオブジェクトです。</div> <div lang=\"en\">AdGroupRetargetingList is an object that holds ad group user list information.</div>
*/
@ApiModel(description = "AdGroupRetargetingListは、広告グループレベルでのターゲットリスト設定を保持するオブジェクトです。 AdGroupRetargetingList is an object that holds ad group user list information. ")
@JsonPropertyOrder({
AdGroupRetargetingList.JSON_PROPERTY_ACCOUNT_ID,
AdGroupRetargetingList.JSON_PROPERTY_AD_GROUP_ID,
AdGroupRetargetingList.JSON_PROPERTY_AD_GROUP_NAME,
AdGroupRetargetingList.JSON_PROPERTY_BID_MULTIPLIER,
AdGroupRetargetingList.JSON_PROPERTY_CAMPAIGN_ID,
AdGroupRetargetingList.JSON_PROPERTY_CAMPAIGN_NAME,
AdGroupRetargetingList.JSON_PROPERTY_CRITERION_TARGET_LIST,
AdGroupRetargetingList.JSON_PROPERTY_EXCLUDED_TYPE
})
@JsonTypeName("AdGroupRetargetingList")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class AdGroupRetargetingList {
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
private Long accountId;
public static final String JSON_PROPERTY_AD_GROUP_ID = "adGroupId";
private Long adGroupId;
public static final String JSON_PROPERTY_AD_GROUP_NAME = "adGroupName";
private String adGroupName;
public static final String JSON_PROPERTY_BID_MULTIPLIER = "bidMultiplier";
private Double bidMultiplier;
public static final String JSON_PROPERTY_CAMPAIGN_ID = "campaignId";
private Long campaignId;
public static final String JSON_PROPERTY_CAMPAIGN_NAME = "campaignName";
private String campaignName;
public static final String JSON_PROPERTY_CRITERION_TARGET_LIST = "criterionTargetList";
private AdGroupRetargetingListServiceCriterionTargetList criterionTargetList;
public static final String JSON_PROPERTY_EXCLUDED_TYPE = "excludedType";
private AdGroupRetargetingListServiceExcludedType excludedType;
public AdGroupRetargetingList() {
}
public AdGroupRetargetingList accountId(Long accountId) {
this.accountId = accountId;
return this;
}
/**
* <div lang=\"ja\">アカウントIDです。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。</div> <div lang=\"en\">Account ID.<br> Although this field will be returned in the response, it will be ignored on input.</div>
* @return accountId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "アカウントIDです。
このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 Account ID.
Although this field will be returned in the response, it will be ignored on input. ")
@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 AdGroupRetargetingList adGroupId(Long adGroupId) {
this.adGroupId = adGroupId;
return this;
}
/**
* <div lang=\"ja\">広告グループIDです。<br> このフィールドは、いずれの場合でも必須です。</div> <div lang=\"en\">Ad group ID.<br> This field is required in any cases.</div>
* @return adGroupId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "広告グループIDです。
このフィールドは、いずれの場合でも必須です。 Ad group ID.
This field is required in any cases. ")
@JsonProperty(JSON_PROPERTY_AD_GROUP_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getAdGroupId() {
return adGroupId;
}
@JsonProperty(JSON_PROPERTY_AD_GROUP_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAdGroupId(Long adGroupId) {
this.adGroupId = adGroupId;
}
public AdGroupRetargetingList adGroupName(String adGroupName) {
this.adGroupName = adGroupName;
return this;
}
/**
* <div lang=\"ja\">広告グループ名です。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。</div> <div lang=\"en\">Ad group name.<br> Although this field will be returned in the response, it will be ignored on input.</div>
* @return adGroupName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "広告グループ名です。
このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 Ad group name.
Although this field will be returned in the response, it will be ignored on input. ")
@JsonProperty(JSON_PROPERTY_AD_GROUP_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAdGroupName() {
return adGroupName;
}
@JsonProperty(JSON_PROPERTY_AD_GROUP_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAdGroupName(String adGroupName) {
this.adGroupName = adGroupName;
}
public AdGroupRetargetingList bidMultiplier(Double bidMultiplier) {
this.bidMultiplier = bidMultiplier;
return this;
}
/**
* <div lang=\"ja\"> CPC上昇値です。<br> 0.10～10.00まで指定できます。<br> また、0を指定した場合、広告は配信されません。<br> CPC上昇値の値は小数点第二位まで指定可能です。<br> このフィールドは省略可能となります。その際、デフォルト設定値は1.0となります。 </div> <div lang=\"en\"> Maximum CPC increase value.<br> Can be specified between 0.10 to 10.00.<br> When specified '0', the ad will not be delivered.<br> Maximum CPC increase value can be specified up to two decimal places.<br> This field is optional. The default value will be 1.0. </div>
* @return bidMultiplier
**/
@javax.annotation.Nullable
@ApiModelProperty(value = " CPC上昇値です。
0.10～10.00まで指定できます。
また、0を指定した場合、広告は配信されません。
CPC上昇値の値は小数点第二位まで指定可能です。
このフィールドは省略可能となります。その際、デフォルト設定値は1.0となります。 Maximum CPC increase value.
Can be specified between 0.10 to 10.00.
When specified '0', the ad will not be delivered.
Maximum CPC increase value can be specified up to two decimal places.
This field is optional. The default value will be 1.0. ")
@JsonProperty(JSON_PROPERTY_BID_MULTIPLIER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getBidMultiplier() {
return bidMultiplier;
}
@JsonProperty(JSON_PROPERTY_BID_MULTIPLIER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBidMultiplier(Double bidMultiplier) {
this.bidMultiplier = bidMultiplier;
}
public AdGroupRetargetingList campaignId(Long campaignId) {
this.campaignId = campaignId;
return this;
}
/**
* <div lang=\"ja\">キャンペーンIDです。<br> このフィールドは、いずれの場合でも必須です。</div> <div lang=\"en\">Campaign ID.<br> This field is required in any cases.</div>
* @return campaignId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "キャンペーンIDです。
このフィールドは、いずれの場合でも必須です。 Campaign ID.
This field is required in any cases. ")
@JsonProperty(JSON_PROPERTY_CAMPAIGN_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getCampaignId() {
return campaignId;
}
@JsonProperty(JSON_PROPERTY_CAMPAIGN_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCampaignId(Long campaignId) {
this.campaignId = campaignId;
}
public AdGroupRetargetingList campaignName(String campaignName) {
this.campaignName = campaignName;
return this;
}
/**
* <div lang=\"ja\">キャンペーン名です。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。</div> <div lang=\"en\">Campaign name.<br> Although this field will be returned in the response, it will be ignored on input.</div>
* @return campaignName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "キャンペーン名です。
このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 Campaign name.
Although this field will be returned in the response, it will be ignored on input. ")
@JsonProperty(JSON_PROPERTY_CAMPAIGN_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCampaignName() {
return campaignName;
}
@JsonProperty(JSON_PROPERTY_CAMPAIGN_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCampaignName(String campaignName) {
this.campaignName = campaignName;
}
public AdGroupRetargetingList criterionTargetList(AdGroupRetargetingListServiceCriterionTargetList criterionTargetList) {
this.criterionTargetList = criterionTargetList;
return this;
}
/**
* Get criterionTargetList
* @return criterionTargetList
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CRITERION_TARGET_LIST)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AdGroupRetargetingListServiceCriterionTargetList getCriterionTargetList() {
return criterionTargetList;
}
@JsonProperty(JSON_PROPERTY_CRITERION_TARGET_LIST)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCriterionTargetList(AdGroupRetargetingListServiceCriterionTargetList criterionTargetList) {
this.criterionTargetList = criterionTargetList;
}
public AdGroupRetargetingList excludedType(AdGroupRetargetingListServiceExcludedType excludedType) {
this.excludedType = excludedType;
return this;
}
/**
* Get excludedType
* @return excludedType
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_EXCLUDED_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AdGroupRetargetingListServiceExcludedType getExcludedType() {
return excludedType;
}
@JsonProperty(JSON_PROPERTY_EXCLUDED_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setExcludedType(AdGroupRetargetingListServiceExcludedType excludedType) {
this.excludedType = excludedType;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
AdGroupRetargetingList adGroupRetargetingList = (AdGroupRetargetingList) o;
return Objects.equals(this.accountId, adGroupRetargetingList.accountId) &&
Objects.equals(this.adGroupId, adGroupRetargetingList.adGroupId) &&
Objects.equals(this.adGroupName, adGroupRetargetingList.adGroupName) &&
Objects.equals(this.bidMultiplier, adGroupRetargetingList.bidMultiplier) &&
Objects.equals(this.campaignId, adGroupRetargetingList.campaignId) &&
Objects.equals(this.campaignName, adGroupRetargetingList.campaignName) &&
Objects.equals(this.criterionTargetList, adGroupRetargetingList.criterionTargetList) &&
Objects.equals(this.excludedType, adGroupRetargetingList.excludedType);
}
@Override
public int hashCode() {
return Objects.hash(accountId, adGroupId, adGroupName, bidMultiplier, campaignId, campaignName, criterionTargetList, excludedType);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class AdGroupRetargetingList {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" adGroupId: ").append(toIndentedString(adGroupId)).append("\n");
sb.append(" adGroupName: ").append(toIndentedString(adGroupName)).append("\n");
sb.append(" bidMultiplier: ").append(toIndentedString(bidMultiplier)).append("\n");
sb.append(" campaignId: ").append(toIndentedString(campaignId)).append("\n");
sb.append(" campaignName: ").append(toIndentedString(campaignName)).append("\n");
sb.append(" criterionTargetList: ").append(toIndentedString(criterionTargetList)).append("\n");
sb.append(" excludedType: ").append(toIndentedString(excludedType)).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 ");
}
}