jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroupAdServiceSelector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ads-display-api-lib Show documentation
Yahoo! JAPAN Ads Display Ads API library for Java
The newest version!
/*
 * Yahoo!広告 ディスプレイ広告 API リファレンス / Yahoo! JAPAN Ads Display Ads API Reference
 * Yahoo!広告 ディスプレイ広告 APIのWebサービスについて説明します。
 Display Ads API Web Services supported in Yahoo! JAPAN Ads API.
 OpenAPI Specification
 Best Practice
 Best Practice 
 *
 * The version of the OpenAPI document: v15
 * 
 *
 * 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.adsdisplayapi.v15.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.adsdisplayapi.v15.model.GuaranteedAdGroupAdServiceAdType;
import jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroupAdServiceMainMediaFormat;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">GuaranteedAdGroupAdServiceSelectorオブジェクトは、getメソッドの検索条件（実行パラメータ）を保持します。</div> <div lang=\"en\">The GuaranteedAdGroupAdServiceSelector object is a container for storing a set of criteria (parameters) for get method.</div> 
 */
@ApiModel(description = "GuaranteedAdGroupAdServiceSelectorオブジェクトは、getメソッドの検索条件（実行パラメータ）を保持します。
 The GuaranteedAdGroupAdServiceSelector object is a container for storing a set of criteria (parameters) for get method. ")
@JsonPropertyOrder({
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_ACCOUNT_ID,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_CAMPAIGN_IDS,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_AD_GROUP_IDS,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_AD_GROUP_AD_IDS,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_CONTAINS_LABEL_ID_FLG,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_LABEL_IDS,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_MEDIA_IDS,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_AD_TYPES,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_MAIN_MEDIA_FORMATS,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_NUMBER_RESULTS,
  GuaranteedAdGroupAdServiceSelector.JSON_PROPERTY_START_INDEX
})
@JsonTypeName("GuaranteedAdGroupAdServiceSelector")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class GuaranteedAdGroupAdServiceSelector {
  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_GROUP_AD_IDS = "adGroupAdIds";
  private List adGroupAdIds = null;

  public static final String JSON_PROPERTY_CONTAINS_LABEL_ID_FLG = "containsLabelIdFlg";
  private Boolean containsLabelIdFlg;

  public static final String JSON_PROPERTY_LABEL_IDS = "labelIds";
  private List labelIds = null;

  public static final String JSON_PROPERTY_MEDIA_IDS = "mediaIds";
  private List mediaIds = null;

  public static final String JSON_PROPERTY_AD_TYPES = "adTypes";
  private List adTypes = null;

  public static final String JSON_PROPERTY_MAIN_MEDIA_FORMATS = "mainMediaFormats";
  private List mainMediaFormats = 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 GuaranteedAdGroupAdServiceSelector() { 
  }

  public GuaranteedAdGroupAdServiceSelector 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 GuaranteedAdGroupAdServiceSelector campaignIds(List campaignIds) {
    
    this.campaignIds = campaignIds;
    return this;
  }

  public GuaranteedAdGroupAdServiceSelector 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 GuaranteedAdGroupAdServiceSelector adGroupIds(List adGroupIds) {
    
    this.adGroupIds = adGroupIds;
    return this;
  }

  public GuaranteedAdGroupAdServiceSelector 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 GuaranteedAdGroupAdServiceSelector adGroupAdIds(List adGroupAdIds) {
    
    this.adGroupAdIds = adGroupAdIds;
    return this;
  }

  public GuaranteedAdGroupAdServiceSelector addAdGroupAdIdsItem(Long adGroupAdIdsItem) {
    if (this.adGroupAdIds == null) {
      this.adGroupAdIds = new ArrayList<>();
    }
    this.adGroupAdIds.add(adGroupAdIdsItem);
    return this;
  }

   /**
   * <div lang=\"ja\">検索条件 : 広告ID</div> <div lang=\"en\">Search condition: Ad ID</div> 
   * @return adGroupAdIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "検索条件 : 広告ID
 Search condition: Ad ID ")
  @JsonProperty(JSON_PROPERTY_AD_GROUP_AD_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getAdGroupAdIds() {
    return adGroupAdIds;
  }


  @JsonProperty(JSON_PROPERTY_AD_GROUP_AD_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAdGroupAdIds(List adGroupAdIds) {
    this.adGroupAdIds = adGroupAdIds;
  }


  public GuaranteedAdGroupAdServiceSelector containsLabelIdFlg(Boolean containsLabelIdFlg) {
    
    this.containsLabelIdFlg = containsLabelIdFlg;
    return this;
  }

   /**
   * <div lang=\"ja\">ラベルID取得フラグです。<br> このフィールドは省略可能となります。その際、デフォルト値はfalseとなります。 </div> <div lang=\"en\">Flag of contains label ID.<br> This field is optional. The default value will be false. </div> 
   * @return containsLabelIdFlg
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ラベルID取得フラグです。
 このフィールドは省略可能となります。その際、デフォルト値はfalseとなります。 
 Flag of contains label ID.
 This field is optional. The default value will be false.  ")
  @JsonProperty(JSON_PROPERTY_CONTAINS_LABEL_ID_FLG)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean getContainsLabelIdFlg() {
    return containsLabelIdFlg;
  }


  @JsonProperty(JSON_PROPERTY_CONTAINS_LABEL_ID_FLG)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setContainsLabelIdFlg(Boolean containsLabelIdFlg) {
    this.containsLabelIdFlg = containsLabelIdFlg;
  }


  public GuaranteedAdGroupAdServiceSelector labelIds(List labelIds) {
    
    this.labelIds = labelIds;
    return this;
  }

  public GuaranteedAdGroupAdServiceSelector 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 GuaranteedAdGroupAdServiceSelector mediaIds(List mediaIds) {
    
    this.mediaIds = mediaIds;
    return this;
  }

  public GuaranteedAdGroupAdServiceSelector addMediaIdsItem(Long mediaIdsItem) {
    if (this.mediaIds == null) {
      this.mediaIds = new ArrayList<>();
    }
    this.mediaIds.add(mediaIdsItem);
    return this;
  }

   /**
   * <div lang=\"ja\">検索条件 : 画像ID</div> <div lang=\"en\">Search condition: Media ID</div> 
   * @return mediaIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "検索条件 : 画像ID
 Search condition: Media ID ")
  @JsonProperty(JSON_PROPERTY_MEDIA_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getMediaIds() {
    return mediaIds;
  }


  @JsonProperty(JSON_PROPERTY_MEDIA_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMediaIds(List mediaIds) {
    this.mediaIds = mediaIds;
  }


  public GuaranteedAdGroupAdServiceSelector adTypes(List adTypes) {
    
    this.adTypes = adTypes;
    return this;
  }

  public GuaranteedAdGroupAdServiceSelector addAdTypesItem(GuaranteedAdGroupAdServiceAdType 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 GuaranteedAdGroupAdServiceSelector mainMediaFormats(List mainMediaFormats) {
    
    this.mainMediaFormats = mainMediaFormats;
    return this;
  }

  public GuaranteedAdGroupAdServiceSelector addMainMediaFormatsItem(GuaranteedAdGroupAdServiceMainMediaFormat mainMediaFormatsItem) {
    if (this.mainMediaFormats == null) {
      this.mainMediaFormats = new ArrayList<>();
    }
    this.mainMediaFormats.add(mainMediaFormatsItem);
    return this;
  }

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

  public List getMainMediaFormats() {
    return mainMediaFormats;
  }


  @JsonProperty(JSON_PROPERTY_MAIN_MEDIA_FORMATS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMainMediaFormats(List mainMediaFormats) {
    this.mainMediaFormats = mainMediaFormats;
  }


  public GuaranteedAdGroupAdServiceSelector 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: 500
   * @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 GuaranteedAdGroupAdServiceSelector startIndex(Integer startIndex) {
    
    this.startIndex = startIndex;
    return this;
  }

   /**
   * <div lang=\"ja\">取得を開始する結果セット内の位置。このフィールドは、0以上を指定する必要があります。</div> <div lang=\"en\">The position within the result set where retrieval begins. This field must be greater than or equal to 0.</div> 
   * minimum: 1
   * @return startIndex
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "取得を開始する結果セット内の位置。このフィールドは、0以上を指定する必要があります。
 The position within the result set where retrieval begins. This field must be greater than or equal to 0. ")
  @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;
    }
    GuaranteedAdGroupAdServiceSelector guaranteedAdGroupAdServiceSelector = (GuaranteedAdGroupAdServiceSelector) o;
    return Objects.equals(this.accountId, guaranteedAdGroupAdServiceSelector.accountId) &&
        Objects.equals(this.campaignIds, guaranteedAdGroupAdServiceSelector.campaignIds) &&
        Objects.equals(this.adGroupIds, guaranteedAdGroupAdServiceSelector.adGroupIds) &&
        Objects.equals(this.adGroupAdIds, guaranteedAdGroupAdServiceSelector.adGroupAdIds) &&
        Objects.equals(this.containsLabelIdFlg, guaranteedAdGroupAdServiceSelector.containsLabelIdFlg) &&
        Objects.equals(this.labelIds, guaranteedAdGroupAdServiceSelector.labelIds) &&
        Objects.equals(this.mediaIds, guaranteedAdGroupAdServiceSelector.mediaIds) &&
        Objects.equals(this.adTypes, guaranteedAdGroupAdServiceSelector.adTypes) &&
        Objects.equals(this.mainMediaFormats, guaranteedAdGroupAdServiceSelector.mainMediaFormats) &&
        Objects.equals(this.numberResults, guaranteedAdGroupAdServiceSelector.numberResults) &&
        Objects.equals(this.startIndex, guaranteedAdGroupAdServiceSelector.startIndex);
  }

  @Override
  public int hashCode() {
    return Objects.hash(accountId, campaignIds, adGroupIds, adGroupAdIds, containsLabelIdFlg, labelIds, mediaIds, adTypes, mainMediaFormats, numberResults, startIndex);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class GuaranteedAdGroupAdServiceSelector {\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("    adGroupAdIds: ").append(toIndentedString(adGroupAdIds)).append("\n");
    sb.append("    containsLabelIdFlg: ").append(toIndentedString(containsLabelIdFlg)).append("\n");
    sb.append("    labelIds: ").append(toIndentedString(labelIds)).append("\n");
    sb.append("    mediaIds: ").append(toIndentedString(mediaIds)).append("\n");
    sb.append("    adTypes: ").append(toIndentedString(adTypes)).append("\n");
    sb.append("    mainMediaFormats: ").append(toIndentedString(mainMediaFormats)).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    ");
  }

}