jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceSelector 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.CampaignServiceBudgetAmountRange;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceCreatedDateRange;
import jp.co.yahoo.adsdisplayapi.v14.model.CampaignServiceUserStatus;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

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

  public static final String JSON_PROPERTY_FEED_IDS = "feedIds";
  private List feedIds = 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_USER_STATUSES = "userStatuses";
  private List userStatuses = null;

  public static final String JSON_PROPERTY_CREATED_DATE_RANGE = "createdDateRange";
  private CampaignServiceCreatedDateRange createdDateRange;

  public static final String JSON_PROPERTY_CONVERSION_GROUP_IDS = "conversionGroupIds";
  private List conversionGroupIds = null;

  public static final String JSON_PROPERTY_CONVERSION_TRACKER_IDS = "conversionTrackerIds";
  private List conversionTrackerIds = null;

  public static final String JSON_PROPERTY_BUDGET_AMOUNT_RANGE = "budgetAmountRange";
  private CampaignServiceBudgetAmountRange budgetAmountRange;

  public CampaignServiceSelector() { 
  }

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

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

  public CampaignServiceSelector addFeedIdsItem(Long feedIdsItem) {
    if (this.feedIds == null) {
      this.feedIds = new ArrayList<>();
    }
    this.feedIds.add(feedIdsItem);
    return this;
  }

   /**
   * <div lang=\"ja\">検索条件 : フィードID</div> <div lang=\"en\">Search condition: Feed ID</div> 
   * @return feedIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "検索条件 : フィードID
 Search condition: Feed ID ")
  @JsonProperty(JSON_PROPERTY_FEED_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getFeedIds() {
    return feedIds;
  }


  @JsonProperty(JSON_PROPERTY_FEED_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFeedIds(List feedIds) {
    this.feedIds = feedIds;
  }


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

  public CampaignServiceSelector 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 CampaignServiceSelector 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: 2000
   * @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 CampaignServiceSelector 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;
  }


  public CampaignServiceSelector userStatuses(List userStatuses) {
    
    this.userStatuses = userStatuses;
    return this;
  }

  public CampaignServiceSelector addUserStatusesItem(CampaignServiceUserStatus 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 CampaignServiceSelector createdDateRange(CampaignServiceCreatedDateRange 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 CampaignServiceCreatedDateRange getCreatedDateRange() {
    return createdDateRange;
  }


  @JsonProperty(JSON_PROPERTY_CREATED_DATE_RANGE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCreatedDateRange(CampaignServiceCreatedDateRange createdDateRange) {
    this.createdDateRange = createdDateRange;
  }


  public CampaignServiceSelector conversionGroupIds(List conversionGroupIds) {
    
    this.conversionGroupIds = conversionGroupIds;
    return this;
  }

  public CampaignServiceSelector addConversionGroupIdsItem(Long conversionGroupIdsItem) {
    if (this.conversionGroupIds == null) {
      this.conversionGroupIds = new ArrayList<>();
    }
    this.conversionGroupIds.add(conversionGroupIdsItem);
    return this;
  }

   /**
   * <div lang=\"ja\">検索条件 : コンバージョングループID</div> <div lang=\"en\">Search condition: Conversion Group ID</div> 
   * @return conversionGroupIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "検索条件 : コンバージョングループID
 Search condition: Conversion Group ID ")
  @JsonProperty(JSON_PROPERTY_CONVERSION_GROUP_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getConversionGroupIds() {
    return conversionGroupIds;
  }


  @JsonProperty(JSON_PROPERTY_CONVERSION_GROUP_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setConversionGroupIds(List conversionGroupIds) {
    this.conversionGroupIds = conversionGroupIds;
  }


  public CampaignServiceSelector conversionTrackerIds(List conversionTrackerIds) {
    
    this.conversionTrackerIds = conversionTrackerIds;
    return this;
  }

  public CampaignServiceSelector addConversionTrackerIdsItem(Long conversionTrackerIdsItem) {
    if (this.conversionTrackerIds == null) {
      this.conversionTrackerIds = new ArrayList<>();
    }
    this.conversionTrackerIds.add(conversionTrackerIdsItem);
    return this;
  }

   /**
   * <div lang=\"ja\">検索条件 : コンバージョントラッカーID</div> <div lang=\"en\">Search condition: Conversion Tracking ID</div> 
   * @return conversionTrackerIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "検索条件 : コンバージョントラッカーID
 Search condition: Conversion Tracking ID ")
  @JsonProperty(JSON_PROPERTY_CONVERSION_TRACKER_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getConversionTrackerIds() {
    return conversionTrackerIds;
  }


  @JsonProperty(JSON_PROPERTY_CONVERSION_TRACKER_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setConversionTrackerIds(List conversionTrackerIds) {
    this.conversionTrackerIds = conversionTrackerIds;
  }


  public CampaignServiceSelector budgetAmountRange(CampaignServiceBudgetAmountRange budgetAmountRange) {
    
    this.budgetAmountRange = budgetAmountRange;
    return this;
  }

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

  public CampaignServiceBudgetAmountRange getBudgetAmountRange() {
    return budgetAmountRange;
  }


  @JsonProperty(JSON_PROPERTY_BUDGET_AMOUNT_RANGE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setBudgetAmountRange(CampaignServiceBudgetAmountRange budgetAmountRange) {
    this.budgetAmountRange = budgetAmountRange;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    CampaignServiceSelector campaignServiceSelector = (CampaignServiceSelector) o;
    return Objects.equals(this.accountId, campaignServiceSelector.accountId) &&
        Objects.equals(this.campaignIds, campaignServiceSelector.campaignIds) &&
        Objects.equals(this.containsLabel, campaignServiceSelector.containsLabel) &&
        Objects.equals(this.feedIds, campaignServiceSelector.feedIds) &&
        Objects.equals(this.labelIds, campaignServiceSelector.labelIds) &&
        Objects.equals(this.numberResults, campaignServiceSelector.numberResults) &&
        Objects.equals(this.startIndex, campaignServiceSelector.startIndex) &&
        Objects.equals(this.userStatuses, campaignServiceSelector.userStatuses) &&
        Objects.equals(this.createdDateRange, campaignServiceSelector.createdDateRange) &&
        Objects.equals(this.conversionGroupIds, campaignServiceSelector.conversionGroupIds) &&
        Objects.equals(this.conversionTrackerIds, campaignServiceSelector.conversionTrackerIds) &&
        Objects.equals(this.budgetAmountRange, campaignServiceSelector.budgetAmountRange);
  }

  @Override
  public int hashCode() {
    return Objects.hash(accountId, campaignIds, containsLabel, feedIds, labelIds, numberResults, startIndex, userStatuses, createdDateRange, conversionGroupIds, conversionTrackerIds, budgetAmountRange);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class CampaignServiceSelector {\n");
    sb.append("    accountId: ").append(toIndentedString(accountId)).append("\n");
    sb.append("    campaignIds: ").append(toIndentedString(campaignIds)).append("\n");
    sb.append("    containsLabel: ").append(toIndentedString(containsLabel)).append("\n");
    sb.append("    feedIds: ").append(toIndentedString(feedIds)).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("    userStatuses: ").append(toIndentedString(userStatuses)).append("\n");
    sb.append("    createdDateRange: ").append(toIndentedString(createdDateRange)).append("\n");
    sb.append("    conversionGroupIds: ").append(toIndentedString(conversionGroupIds)).append("\n");
    sb.append("    conversionTrackerIds: ").append(toIndentedString(conversionTrackerIds)).append("\n");
    sb.append("    budgetAmountRange: ").append(toIndentedString(budgetAmountRange)).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    ");
  }

}