jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroup 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.AdGroupTarget;
import jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroupServiceDeviceAppType;
import jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroupServiceDeviceOsType;
import jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroupServiceDeviceType;
import jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroupServiceLabel;
import jp.co.yahoo.adsdisplayapi.v15.model.GuaranteedAdGroupServiceUserStatus;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">GuaranteedAdGroupオブジェクトは、予約型の広告グループ情報を保持します。</div> <div lang=\"en\">The Guaranteed Ad Group object is a container for storing ad group information of guaranteed campaign.</div> 
 */
@ApiModel(description = "GuaranteedAdGroupオブジェクトは、予約型の広告グループ情報を保持します。
 The Guaranteed Ad Group object is a container for storing ad group information of guaranteed campaign. ")
@JsonPropertyOrder({
  GuaranteedAdGroup.JSON_PROPERTY_ACCOUNT_ID,
  GuaranteedAdGroup.JSON_PROPERTY_AD_GROUP_ID,
  GuaranteedAdGroup.JSON_PROPERTY_AD_GROUP_NAME,
  GuaranteedAdGroup.JSON_PROPERTY_CAMPAIGN_ID,
  GuaranteedAdGroup.JSON_PROPERTY_CAMPAIGN_NAME,
  GuaranteedAdGroup.JSON_PROPERTY_DEVICE,
  GuaranteedAdGroup.JSON_PROPERTY_DEVICE_APP,
  GuaranteedAdGroup.JSON_PROPERTY_DEVICE_OS,
  GuaranteedAdGroup.JSON_PROPERTY_LABELS,
  GuaranteedAdGroup.JSON_PROPERTY_USER_STATUS,
  GuaranteedAdGroup.JSON_PROPERTY_AD_GROUP_TARGETS,
  GuaranteedAdGroup.JSON_PROPERTY_IS_CREATIVE_PROFILE
})
@JsonTypeName("GuaranteedAdGroup")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class GuaranteedAdGroup {
  public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
  private Long accountId;

  public static final String JSON_PROPERTY_AD_GROUP_ID = "adGroupId";
  private Long adGroupId;

  public static final String JSON_PROPERTY_AD_GROUP_NAME = "adGroupName";
  private String adGroupName;

  public static final String JSON_PROPERTY_CAMPAIGN_ID = "campaignId";
  private Long campaignId;

  public static final String JSON_PROPERTY_CAMPAIGN_NAME = "campaignName";
  private String campaignName;

  public static final String JSON_PROPERTY_DEVICE = "device";
  private List device = null;

  public static final String JSON_PROPERTY_DEVICE_APP = "deviceApp";
  private List deviceApp = null;

  public static final String JSON_PROPERTY_DEVICE_OS = "deviceOs";
  private List deviceOs = null;

  public static final String JSON_PROPERTY_LABELS = "labels";
  private List labels = null;

  public static final String JSON_PROPERTY_USER_STATUS = "userStatus";
  private GuaranteedAdGroupServiceUserStatus userStatus;

  public static final String JSON_PROPERTY_AD_GROUP_TARGETS = "adGroupTargets";
  private List adGroupTargets = null;

  public static final String JSON_PROPERTY_IS_CREATIVE_PROFILE = "isCreativeProfile";
  private Boolean isCreativeProfile;

  public GuaranteedAdGroup() { 
  }

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

   /**
   * <div lang=\"ja\"> アカウントIDです。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 </div> <div lang=\"en\"> Account ID.<br> Although this field will be returned in the response, it will be ignored on input. </div> 
   * @return accountId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " アカウントIDです。
 このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 
  Account ID.
 Although this field will be returned in the response, it will be ignored on input.  ")
  @JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getAccountId() {
    return accountId;
  }


  @JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAccountId(Long accountId) {
    this.accountId = accountId;
  }


  public GuaranteedAdGroup adGroupId(Long adGroupId) {
    
    this.adGroupId = adGroupId;
    return this;
  }

   /**
   * <div lang=\"ja\"> 広告グループIDです。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 </div> <div lang=\"en\"> Ad group ID.<br> Although this field will be returned in the response, it will be ignored on input. </div> 
   * @return adGroupId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " 広告グループIDです。
 このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 
  Ad group ID.
 Although this field will be returned in the response, it will be ignored on input.  ")
  @JsonProperty(JSON_PROPERTY_AD_GROUP_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getAdGroupId() {
    return adGroupId;
  }


  @JsonProperty(JSON_PROPERTY_AD_GROUP_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAdGroupId(Long adGroupId) {
    this.adGroupId = adGroupId;
  }


  public GuaranteedAdGroup adGroupName(String adGroupName) {
    
    this.adGroupName = adGroupName;
    return this;
  }

   /**
   * <div lang=\"ja\"> 広告グループ名です。<br> このフィールドは、ADD時は必須となり、SET時は省略可能となります。 </div> <div lang=\"en\"> Ad group name.<br> This field is required in ADD operation, and will be optional in SET operation. </div> 
   * @return adGroupName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " 広告グループ名です。
 このフィールドは、ADD時は必須となり、SET時は省略可能となります。 
  Ad group name.
 This field is required in ADD operation, and will be optional in SET operation.  ")
  @JsonProperty(JSON_PROPERTY_AD_GROUP_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getAdGroupName() {
    return adGroupName;
  }


  @JsonProperty(JSON_PROPERTY_AD_GROUP_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAdGroupName(String adGroupName) {
    this.adGroupName = adGroupName;
  }


  public GuaranteedAdGroup campaignId(Long campaignId) {
    
    this.campaignId = campaignId;
    return this;
  }

   /**
   * <div lang=\"ja\"> キャンペーンIDです。<br> このフィールドは、リクエストの場合は必須です。 </div> <div lang=\"en\"> Campaign ID.<br> This field is required in requests. </div> 
   * @return campaignId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " キャンペーンIDです。
 このフィールドは、リクエストの場合は必須です。 
  Campaign ID.
 This field is required in requests.  ")
  @JsonProperty(JSON_PROPERTY_CAMPAIGN_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getCampaignId() {
    return campaignId;
  }


  @JsonProperty(JSON_PROPERTY_CAMPAIGN_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCampaignId(Long campaignId) {
    this.campaignId = campaignId;
  }


  public GuaranteedAdGroup campaignName(String campaignName) {
    
    this.campaignName = campaignName;
    return this;
  }

   /**
   * <div lang=\"ja\"> キャンペーン名です。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。<br> *ADD時、このフィールドは返却されません。 </div> <div lang=\"en\"> Campaign name.<br> Although this field will be returned in the response, it will be ignored on input.<br> *This field will not be returned in ADD operation. </div> 
   * @return campaignName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " キャンペーン名です。
 このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。
 *ADD時、このフィールドは返却されません。 
  Campaign name.
 Although this field will be returned in the response, it will be ignored on input.
 *This field will not be returned in ADD operation.  ")
  @JsonProperty(JSON_PROPERTY_CAMPAIGN_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getCampaignName() {
    return campaignName;
  }


  @JsonProperty(JSON_PROPERTY_CAMPAIGN_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCampaignName(String campaignName) {
    this.campaignName = campaignName;
  }


  public GuaranteedAdGroup device(List device) {
    
    this.device = device;
    return this;
  }

  public GuaranteedAdGroup addDeviceItem(GuaranteedAdGroupServiceDeviceType deviceItem) {
    if (this.device == null) {
      this.device = new ArrayList<>();
    }
    this.device.add(deviceItem);
    return this;
  }

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

  public List getDevice() {
    return device;
  }


  @JsonProperty(JSON_PROPERTY_DEVICE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDevice(List device) {
    this.device = device;
  }


  public GuaranteedAdGroup deviceApp(List deviceApp) {
    
    this.deviceApp = deviceApp;
    return this;
  }

  public GuaranteedAdGroup addDeviceAppItem(GuaranteedAdGroupServiceDeviceAppType deviceAppItem) {
    if (this.deviceApp == null) {
      this.deviceApp = new ArrayList<>();
    }
    this.deviceApp.add(deviceAppItem);
    return this;
  }

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

  public List getDeviceApp() {
    return deviceApp;
  }


  @JsonProperty(JSON_PROPERTY_DEVICE_APP)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDeviceApp(List deviceApp) {
    this.deviceApp = deviceApp;
  }


  public GuaranteedAdGroup deviceOs(List deviceOs) {
    
    this.deviceOs = deviceOs;
    return this;
  }

  public GuaranteedAdGroup addDeviceOsItem(GuaranteedAdGroupServiceDeviceOsType deviceOsItem) {
    if (this.deviceOs == null) {
      this.deviceOs = new ArrayList<>();
    }
    this.deviceOs.add(deviceOsItem);
    return this;
  }

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

  public List getDeviceOs() {
    return deviceOs;
  }


  @JsonProperty(JSON_PROPERTY_DEVICE_OS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDeviceOs(List deviceOs) {
    this.deviceOs = deviceOs;
  }


  public GuaranteedAdGroup labels(List labels) {
    
    this.labels = labels;
    return this;
  }

  public GuaranteedAdGroup addLabelsItem(GuaranteedAdGroupServiceLabel labelsItem) {
    if (this.labels == null) {
      this.labels = new ArrayList<>();
    }
    this.labels.add(labelsItem);
    return this;
  }

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

  public List getLabels() {
    return labels;
  }


  @JsonProperty(JSON_PROPERTY_LABELS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setLabels(List labels) {
    this.labels = labels;
  }


  public GuaranteedAdGroup userStatus(GuaranteedAdGroupServiceUserStatus userStatus) {
    
    this.userStatus = userStatus;
    return this;
  }

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

  public GuaranteedAdGroupServiceUserStatus getUserStatus() {
    return userStatus;
  }


  @JsonProperty(JSON_PROPERTY_USER_STATUS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setUserStatus(GuaranteedAdGroupServiceUserStatus userStatus) {
    this.userStatus = userStatus;
  }


  public GuaranteedAdGroup adGroupTargets(List adGroupTargets) {
    
    this.adGroupTargets = adGroupTargets;
    return this;
  }

  public GuaranteedAdGroup addAdGroupTargetsItem(AdGroupTarget adGroupTargetsItem) {
    if (this.adGroupTargets == null) {
      this.adGroupTargets = new ArrayList<>();
    }
    this.adGroupTargets.add(adGroupTargetsItem);
    return this;
  }

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

  public List getAdGroupTargets() {
    return adGroupTargets;
  }


  @JsonProperty(JSON_PROPERTY_AD_GROUP_TARGETS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAdGroupTargets(List adGroupTargets) {
    this.adGroupTargets = adGroupTargets;
  }


  public GuaranteedAdGroup isCreativeProfile(Boolean isCreativeProfile) {
    
    this.isCreativeProfile = isCreativeProfile;
    return this;
  }

   /**
   * <div lang=\"ja\"> trueの場合、クリエイティブプロファイルで追加された広告グループであることを示します。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 </div> <div lang=\"en\"> If the value of this field is true, it indicates that the ad group was added using a creative profile.<br> Although this field will be returned in the response, it will be ignored on input. </div> 
   * @return isCreativeProfile
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " trueの場合、クリエイティブプロファイルで追加された広告グループであることを示します。
 このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 
  If the value of this field is true, it indicates that the ad group was added using a creative profile.
 Although this field will be returned in the response, it will be ignored on input.  ")
  @JsonProperty(JSON_PROPERTY_IS_CREATIVE_PROFILE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean getIsCreativeProfile() {
    return isCreativeProfile;
  }


  @JsonProperty(JSON_PROPERTY_IS_CREATIVE_PROFILE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setIsCreativeProfile(Boolean isCreativeProfile) {
    this.isCreativeProfile = isCreativeProfile;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    GuaranteedAdGroup guaranteedAdGroup = (GuaranteedAdGroup) o;
    return Objects.equals(this.accountId, guaranteedAdGroup.accountId) &&
        Objects.equals(this.adGroupId, guaranteedAdGroup.adGroupId) &&
        Objects.equals(this.adGroupName, guaranteedAdGroup.adGroupName) &&
        Objects.equals(this.campaignId, guaranteedAdGroup.campaignId) &&
        Objects.equals(this.campaignName, guaranteedAdGroup.campaignName) &&
        Objects.equals(this.device, guaranteedAdGroup.device) &&
        Objects.equals(this.deviceApp, guaranteedAdGroup.deviceApp) &&
        Objects.equals(this.deviceOs, guaranteedAdGroup.deviceOs) &&
        Objects.equals(this.labels, guaranteedAdGroup.labels) &&
        Objects.equals(this.userStatus, guaranteedAdGroup.userStatus) &&
        Objects.equals(this.adGroupTargets, guaranteedAdGroup.adGroupTargets) &&
        Objects.equals(this.isCreativeProfile, guaranteedAdGroup.isCreativeProfile);
  }

  @Override
  public int hashCode() {
    return Objects.hash(accountId, adGroupId, adGroupName, campaignId, campaignName, device, deviceApp, deviceOs, labels, userStatus, adGroupTargets, isCreativeProfile);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class GuaranteedAdGroup {\n");
    sb.append("    accountId: ").append(toIndentedString(accountId)).append("\n");
    sb.append("    adGroupId: ").append(toIndentedString(adGroupId)).append("\n");
    sb.append("    adGroupName: ").append(toIndentedString(adGroupName)).append("\n");
    sb.append("    campaignId: ").append(toIndentedString(campaignId)).append("\n");
    sb.append("    campaignName: ").append(toIndentedString(campaignName)).append("\n");
    sb.append("    device: ").append(toIndentedString(device)).append("\n");
    sb.append("    deviceApp: ").append(toIndentedString(deviceApp)).append("\n");
    sb.append("    deviceOs: ").append(toIndentedString(deviceOs)).append("\n");
    sb.append("    labels: ").append(toIndentedString(labels)).append("\n");
    sb.append("    userStatus: ").append(toIndentedString(userStatus)).append("\n");
    sb.append("    adGroupTargets: ").append(toIndentedString(adGroupTargets)).append("\n");
    sb.append("    isCreativeProfile: ").append(toIndentedString(isCreativeProfile)).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    ");
  }

}