jp.co.yahoo.adssearchapi.v12.model.AdGroupCriterionServiceSelector 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 java.util.ArrayList;
import java.util.List;
import jp.co.yahoo.adssearchapi.v12.model.AdGroupCriterionServiceApprovalStatus;
import jp.co.yahoo.adssearchapi.v12.model.AdGroupCriterionServiceBiddingKeywordCpcRange;
import jp.co.yahoo.adssearchapi.v12.model.AdGroupCriterionServiceContainsLabelId;
import jp.co.yahoo.adssearchapi.v12.model.AdGroupCriterionServiceKeyword;
import jp.co.yahoo.adssearchapi.v12.model.AdGroupCriterionServiceUse;
import jp.co.yahoo.adssearchapi.v12.model.AdGroupCriterionServiceUserStatus;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* <div lang=\"ja\">AdGroupCriterionServiceSelectorオブジェクトは、操作の対象となる広告グループのクライテリアを表します。</div> <div lang=\"en\">AdGroupCriterionServiceSelector object displays criteria of ad group to be operated.</div>
*/
@ApiModel(description = "AdGroupCriterionServiceSelectorオブジェクトは、操作の対象となる広告グループのクライテリアを表します。 AdGroupCriterionServiceSelector object displays criteria of ad group to be operated. ")
@JsonPropertyOrder({
AdGroupCriterionServiceSelector.JSON_PROPERTY_ACCOUNT_ID,
AdGroupCriterionServiceSelector.JSON_PROPERTY_AD_GROUP_IDS,
AdGroupCriterionServiceSelector.JSON_PROPERTY_APPROVAL_STATUSES,
AdGroupCriterionServiceSelector.JSON_PROPERTY_PORTFOLIO_BIDDING_IDS,
AdGroupCriterionServiceSelector.JSON_PROPERTY_CAMPAIGN_IDS,
AdGroupCriterionServiceSelector.JSON_PROPERTY_CONTAINS_LABEL_ID,
AdGroupCriterionServiceSelector.JSON_PROPERTY_CRITERION_IDS,
AdGroupCriterionServiceSelector.JSON_PROPERTY_LABEL_IDS,
AdGroupCriterionServiceSelector.JSON_PROPERTY_NUMBER_RESULTS,
AdGroupCriterionServiceSelector.JSON_PROPERTY_START_INDEX,
AdGroupCriterionServiceSelector.JSON_PROPERTY_USE,
AdGroupCriterionServiceSelector.JSON_PROPERTY_USER_STATUSES,
AdGroupCriterionServiceSelector.JSON_PROPERTY_KEYWORD,
AdGroupCriterionServiceSelector.JSON_PROPERTY_BIDDING_KEYWORD_CPC_RANGE
})
@JsonTypeName("AdGroupCriterionServiceSelector")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class AdGroupCriterionServiceSelector {
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
private Long accountId;
public static final String JSON_PROPERTY_AD_GROUP_IDS = "adGroupIds";
private List adGroupIds = null;
public static final String JSON_PROPERTY_APPROVAL_STATUSES = "approvalStatuses";
private List approvalStatuses = null;
public static final String JSON_PROPERTY_PORTFOLIO_BIDDING_IDS = "portfolioBiddingIds";
private List portfolioBiddingIds = null;
public static final String JSON_PROPERTY_CAMPAIGN_IDS = "campaignIds";
private List campaignIds = null;
public static final String JSON_PROPERTY_CONTAINS_LABEL_ID = "containsLabelId";
private AdGroupCriterionServiceContainsLabelId containsLabelId;
public static final String JSON_PROPERTY_CRITERION_IDS = "criterionIds";
private List criterionIds = null;
public static final String JSON_PROPERTY_LABEL_IDS = "labelIds";
private List labelIds = null;
public static final String JSON_PROPERTY_NUMBER_RESULTS = "numberResults";
private Integer numberResults = 500;
public static final String JSON_PROPERTY_START_INDEX = "startIndex";
private Integer startIndex = 1;
public static final String JSON_PROPERTY_USE = "use";
private AdGroupCriterionServiceUse use;
public static final String JSON_PROPERTY_USER_STATUSES = "userStatuses";
private List userStatuses = null;
public static final String JSON_PROPERTY_KEYWORD = "keyword";
private AdGroupCriterionServiceKeyword keyword;
public static final String JSON_PROPERTY_BIDDING_KEYWORD_CPC_RANGE = "biddingKeywordCpcRange";
private AdGroupCriterionServiceBiddingKeywordCpcRange biddingKeywordCpcRange;
public AdGroupCriterionServiceSelector() {
}
public AdGroupCriterionServiceSelector accountId(Long accountId) {
this.accountId = accountId;
return this;
}
/**
* <div lang=\"ja\">検索条件：アカウントID</div> <div lang=\"en\">Search condition: Account ID.</div>
* @return accountId
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "検索条件：アカウントID Search condition: Account ID. ")
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Long getAccountId() {
return accountId;
}
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setAccountId(Long accountId) {
this.accountId = accountId;
}
public AdGroupCriterionServiceSelector adGroupIds(List adGroupIds) {
this.adGroupIds = adGroupIds;
return this;
}
public AdGroupCriterionServiceSelector addAdGroupIdsItem(Long adGroupIdsItem) {
if (this.adGroupIds == null) {
this.adGroupIds = new ArrayList<>();
}
this.adGroupIds.add(adGroupIdsItem);
return this;
}
/**
* <div lang=\"ja\">検索条件：広告グループID</div> <div lang=\"en\">Search condition: Ad group ID.</div>
* @return adGroupIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：広告グループID Search condition: Ad group ID. ")
@JsonProperty(JSON_PROPERTY_AD_GROUP_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getAdGroupIds() {
return adGroupIds;
}
@JsonProperty(JSON_PROPERTY_AD_GROUP_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAdGroupIds(List adGroupIds) {
this.adGroupIds = adGroupIds;
}
public AdGroupCriterionServiceSelector approvalStatuses(List approvalStatuses) {
this.approvalStatuses = approvalStatuses;
return this;
}
public AdGroupCriterionServiceSelector addApprovalStatusesItem(AdGroupCriterionServiceApprovalStatus approvalStatusesItem) {
if (this.approvalStatuses == null) {
this.approvalStatuses = new ArrayList<>();
}
this.approvalStatuses.add(approvalStatusesItem);
return this;
}
/**
* Get approvalStatuses
* @return approvalStatuses
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_APPROVAL_STATUSES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getApprovalStatuses() {
return approvalStatuses;
}
@JsonProperty(JSON_PROPERTY_APPROVAL_STATUSES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setApprovalStatuses(List approvalStatuses) {
this.approvalStatuses = approvalStatuses;
}
public AdGroupCriterionServiceSelector portfolioBiddingIds(List portfolioBiddingIds) {
this.portfolioBiddingIds = portfolioBiddingIds;
return this;
}
public AdGroupCriterionServiceSelector addPortfolioBiddingIdsItem(Long portfolioBiddingIdsItem) {
if (this.portfolioBiddingIds == null) {
this.portfolioBiddingIds = new ArrayList<>();
}
this.portfolioBiddingIds.add(portfolioBiddingIdsItem);
return this;
}
/**
* <div lang=\"ja\">検索条件：ポートフォリオ入札ID</div> <div lang=\"en\">Search condition: Portfolio bidding ID.</div>
* @return portfolioBiddingIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：ポートフォリオ入札ID Search condition: Portfolio bidding ID. ")
@JsonProperty(JSON_PROPERTY_PORTFOLIO_BIDDING_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getPortfolioBiddingIds() {
return portfolioBiddingIds;
}
@JsonProperty(JSON_PROPERTY_PORTFOLIO_BIDDING_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPortfolioBiddingIds(List portfolioBiddingIds) {
this.portfolioBiddingIds = portfolioBiddingIds;
}
public AdGroupCriterionServiceSelector campaignIds(List campaignIds) {
this.campaignIds = campaignIds;
return this;
}
public AdGroupCriterionServiceSelector addCampaignIdsItem(Long campaignIdsItem) {
if (this.campaignIds == null) {
this.campaignIds = new ArrayList<>();
}
this.campaignIds.add(campaignIdsItem);
return this;
}
/**
* <div lang=\"ja\">検索条件：キャンペーンID</div> <div lang=\"en\">Search condition: Campaign ID.</div>
* @return campaignIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：キャンペーンID Search condition: Campaign ID. ")
@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;
}
public AdGroupCriterionServiceSelector containsLabelId(AdGroupCriterionServiceContainsLabelId containsLabelId) {
this.containsLabelId = containsLabelId;
return this;
}
/**
* Get containsLabelId
* @return containsLabelId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CONTAINS_LABEL_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AdGroupCriterionServiceContainsLabelId getContainsLabelId() {
return containsLabelId;
}
@JsonProperty(JSON_PROPERTY_CONTAINS_LABEL_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setContainsLabelId(AdGroupCriterionServiceContainsLabelId containsLabelId) {
this.containsLabelId = containsLabelId;
}
public AdGroupCriterionServiceSelector criterionIds(List criterionIds) {
this.criterionIds = criterionIds;
return this;
}
public AdGroupCriterionServiceSelector addCriterionIdsItem(Long criterionIdsItem) {
if (this.criterionIds == null) {
this.criterionIds = new ArrayList<>();
}
this.criterionIds.add(criterionIdsItem);
return this;
}
/**
* <div lang=\"ja\">検索条件：クライテリオンID<br>指定しない場合は、広告グループID以下のすべてのクライ テリアが含まれます。</div> <div lang=\"en\">Search condition: Criterion ID.<br>* All criteria under the Ad group ID will return if theres is no designation.</div>
* @return criterionIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：クライテリオンID
指定しない場合は、広告グループID以下のすべてのクライ テリアが含まれます。 Search condition: Criterion ID.
* All criteria under the Ad group ID will return if theres is no designation. ")
@JsonProperty(JSON_PROPERTY_CRITERION_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getCriterionIds() {
return criterionIds;
}
@JsonProperty(JSON_PROPERTY_CRITERION_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCriterionIds(List criterionIds) {
this.criterionIds = criterionIds;
}
public AdGroupCriterionServiceSelector labelIds(List labelIds) {
this.labelIds = labelIds;
return this;
}
public AdGroupCriterionServiceSelector addLabelIdsItem(Long labelIdsItem) {
if (this.labelIds == null) {
this.labelIds = new ArrayList<>();
}
this.labelIds.add(labelIdsItem);
return this;
}
/**
* <div lang=\"ja\">検索条件：ラベルID</div> <div lang=\"en\">Search condition: Label ID</div>
* @return labelIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：ラベルID Search condition: Label ID ")
@JsonProperty(JSON_PROPERTY_LABEL_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getLabelIds() {
return labelIds;
}
@JsonProperty(JSON_PROPERTY_LABEL_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLabelIds(List labelIds) {
this.labelIds = labelIds;
}
public AdGroupCriterionServiceSelector numberResults(Integer numberResults) {
this.numberResults = numberResults;
return this;
}
/**
* <div lang=\"ja\">ページの最大件数です。このフィールドは、1以上を指定する必要があります。</div> <div lang=\"en\">Maximum number of results to return in this page. This field must be greater than or equal to 1. Also see Entity Limits per operation.</div>
* minimum: 1
* maximum: 10000
* @return numberResults
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ページの最大件数です。このフィールドは、1以上を指定する必要があります。 Maximum number of results to return in this page. This field must be greater than or equal to 1. Also see Entity Limits per operation. ")
@JsonProperty(JSON_PROPERTY_NUMBER_RESULTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getNumberResults() {
return numberResults;
}
@JsonProperty(JSON_PROPERTY_NUMBER_RESULTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setNumberResults(Integer numberResults) {
this.numberResults = numberResults;
}
public AdGroupCriterionServiceSelector startIndex(Integer startIndex) {
this.startIndex = startIndex;
return this;
}
/**
* <div lang=\"ja\">ページの先頭のインデックスです。このフィールドは、1以上を指定する必要があります。</div> <div lang=\"en\">Index of the first result to return in this page. This field must be greater than or equal to 1.</div>
* minimum: 1
* @return startIndex
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ページの先頭のインデックスです。このフィールドは、1以上を指定する必要があります。 Index of the first result to return in this page. This field must be greater than or equal to 1. ")
@JsonProperty(JSON_PROPERTY_START_INDEX)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getStartIndex() {
return startIndex;
}
@JsonProperty(JSON_PROPERTY_START_INDEX)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStartIndex(Integer startIndex) {
this.startIndex = startIndex;
}
public AdGroupCriterionServiceSelector use(AdGroupCriterionServiceUse use) {
this.use = use;
return this;
}
/**
* Get use
* @return use
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_USE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public AdGroupCriterionServiceUse getUse() {
return use;
}
@JsonProperty(JSON_PROPERTY_USE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setUse(AdGroupCriterionServiceUse use) {
this.use = use;
}
public AdGroupCriterionServiceSelector userStatuses(List userStatuses) {
this.userStatuses = userStatuses;
return this;
}
public AdGroupCriterionServiceSelector addUserStatusesItem(AdGroupCriterionServiceUserStatus userStatusesItem) {
if (this.userStatuses == null) {
this.userStatuses = new ArrayList<>();
}
this.userStatuses.add(userStatusesItem);
return this;
}
/**
* Get userStatuses
* @return userStatuses
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_USER_STATUSES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getUserStatuses() {
return userStatuses;
}
@JsonProperty(JSON_PROPERTY_USER_STATUSES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUserStatuses(List userStatuses) {
this.userStatuses = userStatuses;
}
public AdGroupCriterionServiceSelector keyword(AdGroupCriterionServiceKeyword keyword) {
this.keyword = keyword;
return this;
}
/**
* Get keyword
* @return keyword
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_KEYWORD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AdGroupCriterionServiceKeyword getKeyword() {
return keyword;
}
@JsonProperty(JSON_PROPERTY_KEYWORD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setKeyword(AdGroupCriterionServiceKeyword keyword) {
this.keyword = keyword;
}
public AdGroupCriterionServiceSelector biddingKeywordCpcRange(AdGroupCriterionServiceBiddingKeywordCpcRange biddingKeywordCpcRange) {
this.biddingKeywordCpcRange = biddingKeywordCpcRange;
return this;
}
/**
* Get biddingKeywordCpcRange
* @return biddingKeywordCpcRange
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_BIDDING_KEYWORD_CPC_RANGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AdGroupCriterionServiceBiddingKeywordCpcRange getBiddingKeywordCpcRange() {
return biddingKeywordCpcRange;
}
@JsonProperty(JSON_PROPERTY_BIDDING_KEYWORD_CPC_RANGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBiddingKeywordCpcRange(AdGroupCriterionServiceBiddingKeywordCpcRange biddingKeywordCpcRange) {
this.biddingKeywordCpcRange = biddingKeywordCpcRange;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
AdGroupCriterionServiceSelector adGroupCriterionServiceSelector = (AdGroupCriterionServiceSelector) o;
return Objects.equals(this.accountId, adGroupCriterionServiceSelector.accountId) &&
Objects.equals(this.adGroupIds, adGroupCriterionServiceSelector.adGroupIds) &&
Objects.equals(this.approvalStatuses, adGroupCriterionServiceSelector.approvalStatuses) &&
Objects.equals(this.portfolioBiddingIds, adGroupCriterionServiceSelector.portfolioBiddingIds) &&
Objects.equals(this.campaignIds, adGroupCriterionServiceSelector.campaignIds) &&
Objects.equals(this.containsLabelId, adGroupCriterionServiceSelector.containsLabelId) &&
Objects.equals(this.criterionIds, adGroupCriterionServiceSelector.criterionIds) &&
Objects.equals(this.labelIds, adGroupCriterionServiceSelector.labelIds) &&
Objects.equals(this.numberResults, adGroupCriterionServiceSelector.numberResults) &&
Objects.equals(this.startIndex, adGroupCriterionServiceSelector.startIndex) &&
Objects.equals(this.use, adGroupCriterionServiceSelector.use) &&
Objects.equals(this.userStatuses, adGroupCriterionServiceSelector.userStatuses) &&
Objects.equals(this.keyword, adGroupCriterionServiceSelector.keyword) &&
Objects.equals(this.biddingKeywordCpcRange, adGroupCriterionServiceSelector.biddingKeywordCpcRange);
}
@Override
public int hashCode() {
return Objects.hash(accountId, adGroupIds, approvalStatuses, portfolioBiddingIds, campaignIds, containsLabelId, criterionIds, labelIds, numberResults, startIndex, use, userStatuses, keyword, biddingKeywordCpcRange);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class AdGroupCriterionServiceSelector {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" adGroupIds: ").append(toIndentedString(adGroupIds)).append("\n");
sb.append(" approvalStatuses: ").append(toIndentedString(approvalStatuses)).append("\n");
sb.append(" portfolioBiddingIds: ").append(toIndentedString(portfolioBiddingIds)).append("\n");
sb.append(" campaignIds: ").append(toIndentedString(campaignIds)).append("\n");
sb.append(" containsLabelId: ").append(toIndentedString(containsLabelId)).append("\n");
sb.append(" criterionIds: ").append(toIndentedString(criterionIds)).append("\n");
sb.append(" labelIds: ").append(toIndentedString(labelIds)).append("\n");
sb.append(" numberResults: ").append(toIndentedString(numberResults)).append("\n");
sb.append(" startIndex: ").append(toIndentedString(startIndex)).append("\n");
sb.append(" use: ").append(toIndentedString(use)).append("\n");
sb.append(" userStatuses: ").append(toIndentedString(userStatuses)).append("\n");
sb.append(" keyword: ").append(toIndentedString(keyword)).append("\n");
sb.append(" biddingKeywordCpcRange: ").append(toIndentedString(biddingKeywordCpcRange)).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 ");
}
}