All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jp.co.yahoo.adssearchapi.v14.model.CampaignCriterionServiceSelector Maven / Gradle / Ivy

Go to download

Yahoo! JAPAN Ads Search Ads API library for Java

There is a newer version: 8.1.1-spring5
Show 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.
 
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.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.CampaignCriterionServiceUse;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">CampaignCriterionServiceSelectorオブジェクトは、操作の対象となるキャンペーンのクライテリアを表します。</div> <div lang=\"en\">CampaignCriterionServiceSelector object describes campaign criteria for operation.</div> 
 */
@ApiModel(description = "
CampaignCriterionServiceSelectorオブジェクトは、操作の対象となるキャンペーンのクライテリアを表します。
 
CampaignCriterionServiceSelector object describes campaign criteria for operation.
 ")
@JsonPropertyOrder({
  CampaignCriterionServiceSelector.JSON_PROPERTY_ACCOUNT_ID,
  CampaignCriterionServiceSelector.JSON_PROPERTY_CAMPAIGN_IDS,
  CampaignCriterionServiceSelector.JSON_PROPERTY_CRITERION_IDS,
  CampaignCriterionServiceSelector.JSON_PROPERTY_NUMBER_RESULTS,
  CampaignCriterionServiceSelector.JSON_PROPERTY_START_INDEX,
  CampaignCriterionServiceSelector.JSON_PROPERTY_USE
})
@JsonTypeName("CampaignCriterionServiceSelector")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CampaignCriterionServiceSelector {
  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_CRITERION_IDS = "criterionIds";
  private List criterionIds = 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 CampaignCriterionServiceUse use;

  public CampaignCriterionServiceSelector() { 
  }

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

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

  public CampaignCriterionServiceSelector 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\">Criterion ID array.<br> If no criterionIds, all of criterionIds under the campaign ID are returned.</div> 
   * @return criterionIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "
クライテリオンIDの配列です。
 指定しない場合は、キャンペーンID以下のすべてのクライテリアが含まれます。
 
Criterion ID array.
 If no criterionIds, all of criterionIds under the campaign ID are returned.
 ")
  @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 CampaignCriterionServiceSelector 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 CampaignCriterionServiceSelector 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;
  }


  public CampaignCriterionServiceSelector use(CampaignCriterionServiceUse use) {
    
    this.use = use;
    return this;
  }

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

  public CampaignCriterionServiceUse getUse() {
    return use;
  }


  @JsonProperty(JSON_PROPERTY_USE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setUse(CampaignCriterionServiceUse use) {
    this.use = use;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    CampaignCriterionServiceSelector campaignCriterionServiceSelector = (CampaignCriterionServiceSelector) o;
    return Objects.equals(this.accountId, campaignCriterionServiceSelector.accountId) &&
        Objects.equals(this.campaignIds, campaignCriterionServiceSelector.campaignIds) &&
        Objects.equals(this.criterionIds, campaignCriterionServiceSelector.criterionIds) &&
        Objects.equals(this.numberResults, campaignCriterionServiceSelector.numberResults) &&
        Objects.equals(this.startIndex, campaignCriterionServiceSelector.startIndex) &&
        Objects.equals(this.use, campaignCriterionServiceSelector.use);
  }

  @Override
  public int hashCode() {
    return Objects.hash(accountId, campaignIds, criterionIds, numberResults, startIndex, use);
  }

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

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy