jp.co.yahoo.adsdisplayapi.v14.model.AdGroupTargetServiceSelector 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: 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.adsdisplayapi.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.adsdisplayapi.v14.model.AdGroupTargetServiceAreaSearchType;
import jp.co.yahoo.adsdisplayapi.v14.model.AdGroupTargetServiceSortField;
import jp.co.yahoo.adsdisplayapi.v14.model.AdGroupTargetServiceSortType;
import jp.co.yahoo.adsdisplayapi.v14.model.AdGroupTargetServiceTargetType;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

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

  public static final String JSON_PROPERTY_TARGET_TYPES = "targetTypes";
  private List targetTypes = null;

  public static final String JSON_PROPERTY_AREA_SEARCH_TYPES = "areaSearchTypes";
  private List areaSearchTypes = null;

  public static final String JSON_PROPERTY_SORT_FIELD = "sortField";
  private AdGroupTargetServiceSortField sortField;

  public static final String JSON_PROPERTY_SORT_TYPE = "sortType";
  private AdGroupTargetServiceSortType sortType;

  public static final String JSON_PROPERTY_NUMBER_RESULTS = "numberResults";
  private Integer numberResults = 1000;

  public static final String JSON_PROPERTY_START_INDEX = "startIndex";
  private Integer startIndex = 1;

  public AdGroupTargetServiceSelector() { 
  }

  public AdGroupTargetServiceSelector accountId(Long accountId) {
    
    this.accountId = accountId;
    return this;
  }

   /**
   * <div lang=\"ja\">アカウントIDです。</div> <div lang=\"en\">Account ID</div> 
   * @return accountId
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(required = true, value = "アカウントIDです。
 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 AdGroupTargetServiceSelector adGroupIds(List adGroupIds) {
    
    this.adGroupIds = adGroupIds;
    return this;
  }

  public AdGroupTargetServiceSelector 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\">Ad group ID</div> 
   * @return adGroupIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "広告グループIDです。
 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 AdGroupTargetServiceSelector campaignIds(List campaignIds) {
    
    this.campaignIds = campaignIds;
    return this;
  }

  public AdGroupTargetServiceSelector 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\">Campaign ID</div> 
   * @return campaignIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "キャンペーンIDです。
 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 AdGroupTargetServiceSelector targetTypes(List targetTypes) {
    
    this.targetTypes = targetTypes;
    return this;
  }

  public AdGroupTargetServiceSelector addTargetTypesItem(AdGroupTargetServiceTargetType targetTypesItem) {
    if (this.targetTypes == null) {
      this.targetTypes = new ArrayList<>();
    }
    this.targetTypes.add(targetTypesItem);
    return this;
  }

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

  public List getTargetTypes() {
    return targetTypes;
  }


  @JsonProperty(JSON_PROPERTY_TARGET_TYPES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTargetTypes(List targetTypes) {
    this.targetTypes = targetTypes;
  }


  public AdGroupTargetServiceSelector areaSearchTypes(List areaSearchTypes) {
    
    this.areaSearchTypes = areaSearchTypes;
    return this;
  }

  public AdGroupTargetServiceSelector addAreaSearchTypesItem(AdGroupTargetServiceAreaSearchType areaSearchTypesItem) {
    if (this.areaSearchTypes == null) {
      this.areaSearchTypes = new ArrayList<>();
    }
    this.areaSearchTypes.add(areaSearchTypesItem);
    return this;
  }

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

  public List getAreaSearchTypes() {
    return areaSearchTypes;
  }


  @JsonProperty(JSON_PROPERTY_AREA_SEARCH_TYPES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAreaSearchTypes(List areaSearchTypes) {
    this.areaSearchTypes = areaSearchTypes;
  }


  public AdGroupTargetServiceSelector sortField(AdGroupTargetServiceSortField sortField) {
    
    this.sortField = sortField;
    return this;
  }

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

  public AdGroupTargetServiceSortField getSortField() {
    return sortField;
  }


  @JsonProperty(JSON_PROPERTY_SORT_FIELD)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSortField(AdGroupTargetServiceSortField sortField) {
    this.sortField = sortField;
  }


  public AdGroupTargetServiceSelector sortType(AdGroupTargetServiceSortType sortType) {
    
    this.sortType = sortType;
    return this;
  }

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

  public AdGroupTargetServiceSortType getSortType() {
    return sortType;
  }


  @JsonProperty(JSON_PROPERTY_SORT_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSortType(AdGroupTargetServiceSortType sortType) {
    this.sortType = sortType;
  }


  public AdGroupTargetServiceSelector 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 AdGroupTargetServiceSelector 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;
    }
    AdGroupTargetServiceSelector adGroupTargetServiceSelector = (AdGroupTargetServiceSelector) o;
    return Objects.equals(this.accountId, adGroupTargetServiceSelector.accountId) &&
        Objects.equals(this.adGroupIds, adGroupTargetServiceSelector.adGroupIds) &&
        Objects.equals(this.campaignIds, adGroupTargetServiceSelector.campaignIds) &&
        Objects.equals(this.targetTypes, adGroupTargetServiceSelector.targetTypes) &&
        Objects.equals(this.areaSearchTypes, adGroupTargetServiceSelector.areaSearchTypes) &&
        Objects.equals(this.sortField, adGroupTargetServiceSelector.sortField) &&
        Objects.equals(this.sortType, adGroupTargetServiceSelector.sortType) &&
        Objects.equals(this.numberResults, adGroupTargetServiceSelector.numberResults) &&
        Objects.equals(this.startIndex, adGroupTargetServiceSelector.startIndex);
  }

  @Override
  public int hashCode() {
    return Objects.hash(accountId, adGroupIds, campaignIds, targetTypes, areaSearchTypes, sortField, sortType, numberResults, startIndex);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class AdGroupTargetServiceSelector {\n");
    sb.append("    accountId: ").append(toIndentedString(accountId)).append("\n");
    sb.append("    adGroupIds: ").append(toIndentedString(adGroupIds)).append("\n");
    sb.append("    campaignIds: ").append(toIndentedString(campaignIds)).append("\n");
    sb.append("    targetTypes: ").append(toIndentedString(targetTypes)).append("\n");
    sb.append("    areaSearchTypes: ").append(toIndentedString(areaSearchTypes)).append("\n");
    sb.append("    sortField: ").append(toIndentedString(sortField)).append("\n");
    sb.append("    sortType: ").append(toIndentedString(sortType)).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    ");
  }

}