jp.co.yahoo.adssearchapi.v14.model.AdGroupAdServiceSelector 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
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.
*
* 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.AdGroupAdServiceAdType;
import jp.co.yahoo.adssearchapi.v14.model.AdGroupAdServiceApprovalStatus;
import jp.co.yahoo.adssearchapi.v14.model.AdGroupAdServiceCreatedDateRange;
import jp.co.yahoo.adssearchapi.v14.model.AdGroupAdServiceUpdatedDateRange;
import jp.co.yahoo.adssearchapi.v14.model.AdGroupAdServiceUserStatus;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* <div lang=\"ja\">AdGroupAdServiceSelectorオブジェクトは、操作の対象とする広告およびフィルタ条件を表します。</div> <div lang=\"en\">AdGroupAdServiceSelector object describes the information and filter criteria of the Ads to be operated on.</div>
*/
@ApiModel(description = "AdGroupAdServiceSelectorオブジェクトは、操作の対象とする広告およびフィルタ条件を表します。 AdGroupAdServiceSelector object describes the information and filter criteria of the Ads to be operated on. ")
@JsonPropertyOrder({
AdGroupAdServiceSelector.JSON_PROPERTY_ACCOUNT_ID,
AdGroupAdServiceSelector.JSON_PROPERTY_CAMPAIGN_IDS,
AdGroupAdServiceSelector.JSON_PROPERTY_AD_GROUP_IDS,
AdGroupAdServiceSelector.JSON_PROPERTY_AD_IDS,
AdGroupAdServiceSelector.JSON_PROPERTY_AD_TYPES,
AdGroupAdServiceSelector.JSON_PROPERTY_APPROVAL_STATUSES,
AdGroupAdServiceSelector.JSON_PROPERTY_USER_STATUSES,
AdGroupAdServiceSelector.JSON_PROPERTY_CONTAINS_LABEL,
AdGroupAdServiceSelector.JSON_PROPERTY_LABEL_IDS,
AdGroupAdServiceSelector.JSON_PROPERTY_CREATED_DATE_RANGE,
AdGroupAdServiceSelector.JSON_PROPERTY_UPDATED_DATE_RANGE,
AdGroupAdServiceSelector.JSON_PROPERTY_NUMBER_RESULTS,
AdGroupAdServiceSelector.JSON_PROPERTY_START_INDEX
})
@JsonTypeName("AdGroupAdServiceSelector")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class AdGroupAdServiceSelector {
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
private Long accountId;
public static final String JSON_PROPERTY_CAMPAIGN_IDS = "campaignIds";
private List campaignIds = null;
public static final String JSON_PROPERTY_AD_GROUP_IDS = "adGroupIds";
private List adGroupIds = null;
public static final String JSON_PROPERTY_AD_IDS = "adIds";
private List adIds = null;
public static final String JSON_PROPERTY_AD_TYPES = "adTypes";
private List adTypes = null;
public static final String JSON_PROPERTY_APPROVAL_STATUSES = "approvalStatuses";
private List approvalStatuses = null;
public static final String JSON_PROPERTY_USER_STATUSES = "userStatuses";
private List userStatuses = null;
public static final String JSON_PROPERTY_CONTAINS_LABEL = "containsLabel";
private Boolean containsLabel;
public static final String JSON_PROPERTY_LABEL_IDS = "labelIds";
private List labelIds = null;
public static final String JSON_PROPERTY_CREATED_DATE_RANGE = "createdDateRange";
private AdGroupAdServiceCreatedDateRange createdDateRange;
public static final String JSON_PROPERTY_UPDATED_DATE_RANGE = "updatedDateRange";
private AdGroupAdServiceUpdatedDateRange updatedDateRange;
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 AdGroupAdServiceSelector() {
}
public AdGroupAdServiceSelector 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 AdGroupAdServiceSelector campaignIds(List campaignIds) {
this.campaignIds = campaignIds;
return this;
}
public AdGroupAdServiceSelector 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.<br> Ads returned will be from campaigns whose ids are included in this list.<br> An empty list means there are no campaign restrictions when selecting AdGroupAds.<br> * This field must contain distinct elements.<br>* This field cannot contain null elements.</div>
* @return campaignIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：キャンペーンID Search condition: Campaign ID.
Ads returned will be from campaigns whose ids are included in this list.
An empty list means there are no campaign restrictions when selecting AdGroupAds.
* This field must contain distinct elements.
* This field cannot contain null elements. ")
@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 AdGroupAdServiceSelector adGroupIds(List adGroupIds) {
this.adGroupIds = adGroupIds;
return this;
}
public AdGroupAdServiceSelector 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.<br> Ads returned will be from ad groups whose ids are included in this list.</div>
* @return adGroupIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：広告グループID Search condition: Ad group ID.
Ads returned will be from ad groups whose ids are included in this list. ")
@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 AdGroupAdServiceSelector adIds(List adIds) {
this.adIds = adIds;
return this;
}
public AdGroupAdServiceSelector addAdIdsItem(Long adIdsItem) {
if (this.adIds == null) {
this.adIds = new ArrayList<>();
}
this.adIds.add(adIdsItem);
return this;
}
/**
* <div lang=\"ja\">検索条件：広告ID</div> <div lang=\"en\">Search condition: Ad ID.<br> Ads will return from ads whose ids are included in this list.<br> If you omit adIds field, it will return all adIds under the adGroup.</div>
* @return adIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：広告ID Search condition: Ad ID.
Ads will return from ads whose ids are included in this list.
If you omit adIds field, it will return all adIds under the adGroup. ")
@JsonProperty(JSON_PROPERTY_AD_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getAdIds() {
return adIds;
}
@JsonProperty(JSON_PROPERTY_AD_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAdIds(List adIds) {
this.adIds = adIds;
}
public AdGroupAdServiceSelector adTypes(List adTypes) {
this.adTypes = adTypes;
return this;
}
public AdGroupAdServiceSelector addAdTypesItem(AdGroupAdServiceAdType adTypesItem) {
if (this.adTypes == null) {
this.adTypes = new ArrayList<>();
}
this.adTypes.add(adTypesItem);
return this;
}
/**
* Get adTypes
* @return adTypes
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_AD_TYPES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getAdTypes() {
return adTypes;
}
@JsonProperty(JSON_PROPERTY_AD_TYPES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAdTypes(List adTypes) {
this.adTypes = adTypes;
}
public AdGroupAdServiceSelector approvalStatuses(List approvalStatuses) {
this.approvalStatuses = approvalStatuses;
return this;
}
public AdGroupAdServiceSelector addApprovalStatusesItem(AdGroupAdServiceApprovalStatus 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 AdGroupAdServiceSelector userStatuses(List userStatuses) {
this.userStatuses = userStatuses;
return this;
}
public AdGroupAdServiceSelector addUserStatusesItem(AdGroupAdServiceUserStatus 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 AdGroupAdServiceSelector containsLabel(Boolean containsLabel) {
this.containsLabel = containsLabel;
return this;
}
/**
* <div lang=\"ja\">ラベル情報取得フラグです。<br> このフィールドは省略可能となります。その際、デフォルト値はfalseとなります。 </div> <div lang=\"en\">Flag of contains label information.<br> This field is optional. The default value will be false. </div>
* @return containsLabel
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ラベル情報取得フラグです。
このフィールドは省略可能となります。その際、デフォルト値はfalseとなります。 Flag of contains label information.
This field is optional. The default value will be false. ")
@JsonProperty(JSON_PROPERTY_CONTAINS_LABEL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getContainsLabel() {
return containsLabel;
}
@JsonProperty(JSON_PROPERTY_CONTAINS_LABEL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setContainsLabel(Boolean containsLabel) {
this.containsLabel = containsLabel;
}
public AdGroupAdServiceSelector labelIds(List labelIds) {
this.labelIds = labelIds;
return this;
}
public AdGroupAdServiceSelector addLabelIdsItem(Long labelIdsItem) {
if (this.labelIds == null) {
this.labelIds = new ArrayList<>();
}
this.labelIds.add(labelIdsItem);
return this;
}
/**
* <div lang=\"ja\">検索条件：ラベルIDです。<br> ※labelIdsを指定した場合は、取得結果にcontainsLabelの情報が付与されます。</div> <div lang=\"en\">Search condition: Label ID.<br> *When specified labelIds, containsLabel information is added to the result.</div>
* @return labelIds
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "検索条件：ラベルIDです。
※labelIdsを指定した場合は、取得結果にcontainsLabelの情報が付与されます。 Search condition: Label ID.
*When specified labelIds, containsLabel information is added to the result. ")
@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 AdGroupAdServiceSelector createdDateRange(AdGroupAdServiceCreatedDateRange createdDateRange) {
this.createdDateRange = createdDateRange;
return this;
}
/**
* Get createdDateRange
* @return createdDateRange
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CREATED_DATE_RANGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AdGroupAdServiceCreatedDateRange getCreatedDateRange() {
return createdDateRange;
}
@JsonProperty(JSON_PROPERTY_CREATED_DATE_RANGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCreatedDateRange(AdGroupAdServiceCreatedDateRange createdDateRange) {
this.createdDateRange = createdDateRange;
}
public AdGroupAdServiceSelector updatedDateRange(AdGroupAdServiceUpdatedDateRange updatedDateRange) {
this.updatedDateRange = updatedDateRange;
return this;
}
/**
* Get updatedDateRange
* @return updatedDateRange
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_UPDATED_DATE_RANGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AdGroupAdServiceUpdatedDateRange getUpdatedDateRange() {
return updatedDateRange;
}
@JsonProperty(JSON_PROPERTY_UPDATED_DATE_RANGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUpdatedDateRange(AdGroupAdServiceUpdatedDateRange updatedDateRange) {
this.updatedDateRange = updatedDateRange;
}
public AdGroupAdServiceSelector numberResults(Integer numberResults) {
this.numberResults = numberResults;
return this;
}
/**
* <div lang=\"ja\">開始位置から取得する結果の数。このフィールドは、1以上を指定する必要があります。</div> <div lang=\"en\">The number of results to retrieve starting from the initial position. This field must be greater than or equal to 1.</div>
* minimum: 1
* maximum: 10000
* @return numberResults
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "開始位置から取得する結果の数。このフィールドは、1以上を指定する必要があります。 The number of results to retrieve starting from the initial position. This field must be greater than or equal to 1. ")
@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 AdGroupAdServiceSelector startIndex(Integer startIndex) {
this.startIndex = startIndex;
return this;
}
/**
* <div lang=\"ja\">取得を開始する結果セット内の位置。このフィールドは、1以上を指定する必要があります。</div> <div lang=\"en\">The position within the result set where retrieval begins. This field must be greater than or equal to 1.</div>
* minimum: 1
* @return startIndex
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "取得を開始する結果セット内の位置。このフィールドは、1以上を指定する必要があります。 The position within the result set where retrieval begins. 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;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
AdGroupAdServiceSelector adGroupAdServiceSelector = (AdGroupAdServiceSelector) o;
return Objects.equals(this.accountId, adGroupAdServiceSelector.accountId) &&
Objects.equals(this.campaignIds, adGroupAdServiceSelector.campaignIds) &&
Objects.equals(this.adGroupIds, adGroupAdServiceSelector.adGroupIds) &&
Objects.equals(this.adIds, adGroupAdServiceSelector.adIds) &&
Objects.equals(this.adTypes, adGroupAdServiceSelector.adTypes) &&
Objects.equals(this.approvalStatuses, adGroupAdServiceSelector.approvalStatuses) &&
Objects.equals(this.userStatuses, adGroupAdServiceSelector.userStatuses) &&
Objects.equals(this.containsLabel, adGroupAdServiceSelector.containsLabel) &&
Objects.equals(this.labelIds, adGroupAdServiceSelector.labelIds) &&
Objects.equals(this.createdDateRange, adGroupAdServiceSelector.createdDateRange) &&
Objects.equals(this.updatedDateRange, adGroupAdServiceSelector.updatedDateRange) &&
Objects.equals(this.numberResults, adGroupAdServiceSelector.numberResults) &&
Objects.equals(this.startIndex, adGroupAdServiceSelector.startIndex);
}
@Override
public int hashCode() {
return Objects.hash(accountId, campaignIds, adGroupIds, adIds, adTypes, approvalStatuses, userStatuses, containsLabel, labelIds, createdDateRange, updatedDateRange, numberResults, startIndex);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class AdGroupAdServiceSelector {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" campaignIds: ").append(toIndentedString(campaignIds)).append("\n");
sb.append(" adGroupIds: ").append(toIndentedString(adGroupIds)).append("\n");
sb.append(" adIds: ").append(toIndentedString(adIds)).append("\n");
sb.append(" adTypes: ").append(toIndentedString(adTypes)).append("\n");
sb.append(" approvalStatuses: ").append(toIndentedString(approvalStatuses)).append("\n");
sb.append(" userStatuses: ").append(toIndentedString(userStatuses)).append("\n");
sb.append(" containsLabel: ").append(toIndentedString(containsLabel)).append("\n");
sb.append(" labelIds: ").append(toIndentedString(labelIds)).append("\n");
sb.append(" createdDateRange: ").append(toIndentedString(createdDateRange)).append("\n");
sb.append(" updatedDateRange: ").append(toIndentedString(updatedDateRange)).append("\n");
sb.append(" numberResults: ").append(toIndentedString(numberResults)).append("\n");
sb.append(" startIndex: ").append(toIndentedString(startIndex)).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 ");
}
}