jp.co.yahoo.adsdisplayapi.v13.model.AdGroupAdServiceCarousel 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: v13
 * 
 *
 * 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.v13.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.v13.model.AdGroupAdServiceIsRemoveFlg;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\"> AdGroupAdServiceCarouselオブジェクトはカルーセル広告の詳細情報を表します。<br> ※SET時には、現在のCarouselsに含まれるCarouselが全て指定したCarouselsに置き換わります。<br> ※特定のCarousel単体を指定して変更することはできません。 </div> <div lang=\"en\"> AdGroupAdServiceCarousel object describes the detailed information of carousel ad.<br> *In SET operation, all Carousel included in the current Carousels will be replaced with the specified Carousels.<br> *Cannot specify a specific Carousel alone. </div> 
 */
@ApiModel(description = " AdGroupAdServiceCarouselオブジェクトはカルーセル広告の詳細情報を表します。
 ※SET時には、現在のCarouselsに含まれるCarouselが全て指定したCarouselsに置き換わります。
 ※特定のCarousel単体を指定して変更することはできません。 
  AdGroupAdServiceCarousel object describes the detailed information of carousel ad.
 *In SET operation, all Carousel included in the current Carousels will be replaced with the specified Carousels.
 *Cannot specify a specific Carousel alone.  ")
@JsonPropertyOrder({
  AdGroupAdServiceCarousel.JSON_PROPERTY_DISPLAY_ORDER,
  AdGroupAdServiceCarousel.JSON_PROPERTY_MEDIA_ID,
  AdGroupAdServiceCarousel.JSON_PROPERTY_HEADLINE,
  AdGroupAdServiceCarousel.JSON_PROPERTY_DESCRIPTION,
  AdGroupAdServiceCarousel.JSON_PROPERTY_DISAPPROVAL_REASON_CODES,
  AdGroupAdServiceCarousel.JSON_PROPERTY_FINAL_URL,
  AdGroupAdServiceCarousel.JSON_PROPERTY_SMARTPHONE_FINAL_URL,
  AdGroupAdServiceCarousel.JSON_PROPERTY_IS_REMOVE_SMARTPHONE_FINAL_URL
})
@JsonTypeName("AdGroupAdServiceCarousel")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class AdGroupAdServiceCarousel {
  public static final String JSON_PROPERTY_DISPLAY_ORDER = "displayOrder";
  private Long displayOrder;

  public static final String JSON_PROPERTY_MEDIA_ID = "mediaId";
  private Long mediaId;

  public static final String JSON_PROPERTY_HEADLINE = "headline";
  private String headline;

  public static final String JSON_PROPERTY_DESCRIPTION = "description";
  private String description;

  public static final String JSON_PROPERTY_DISAPPROVAL_REASON_CODES = "disapprovalReasonCodes";
  private List disapprovalReasonCodes = null;

  public static final String JSON_PROPERTY_FINAL_URL = "finalUrl";
  private String finalUrl;

  public static final String JSON_PROPERTY_SMARTPHONE_FINAL_URL = "smartphoneFinalUrl";
  private String smartphoneFinalUrl;

  public static final String JSON_PROPERTY_IS_REMOVE_SMARTPHONE_FINAL_URL = "isRemoveSmartphoneFinalUrl";
  private AdGroupAdServiceIsRemoveFlg isRemoveSmartphoneFinalUrl;

  public AdGroupAdServiceCarousel() { 
  }

  public AdGroupAdServiceCarousel displayOrder(Long displayOrder) {
    
    this.displayOrder = displayOrder;
    return this;
  }

   /**
   * <div lang=\"ja\"> カルーセルの表示順です。<br> ADDおよびSET時、このフィールドは省略可能となります。<br> ※指定しない場合は自動で設定されます。 </div> <div lang=\"en\"> Carousel display order.<br> This field is optional in ADD and SET operation.<br> *If not specified, it will be set automatically. </div> 
   * @return displayOrder
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " カルーセルの表示順です。
 ADDおよびSET時、このフィールドは省略可能となります。
 ※指定しない場合は自動で設定されます。 
  Carousel display order.
 This field is optional in ADD and SET operation.
 *If not specified, it will be set automatically.  ")
  @JsonProperty(JSON_PROPERTY_DISPLAY_ORDER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getDisplayOrder() {
    return displayOrder;
  }


  @JsonProperty(JSON_PROPERTY_DISPLAY_ORDER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDisplayOrder(Long displayOrder) {
    this.displayOrder = displayOrder;
  }


  public AdGroupAdServiceCarousel mediaId(Long mediaId) {
    
    this.mediaId = mediaId;
    return this;
  }

   /**
   * <div lang=\"ja\"> メディアIDです。<br> このフィールドは、ADD時およびSET時に必須です。 </div> <div lang=\"en\"> Media ID.<br> This field is requred in ADD and SET operation. </div> 
   * @return mediaId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " メディアIDです。
 このフィールドは、ADD時およびSET時に必須です。 
  Media ID.
 This field is requred in ADD and SET operation.  ")
  @JsonProperty(JSON_PROPERTY_MEDIA_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getMediaId() {
    return mediaId;
  }


  @JsonProperty(JSON_PROPERTY_MEDIA_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMediaId(Long mediaId) {
    this.mediaId = mediaId;
  }


  public AdGroupAdServiceCarousel headline(String headline) {
    
    this.headline = headline;
    return this;
  }

   /**
   * <div lang=\"ja\"> 広告のタイトルです。<br> このフィールドは、ADD時およびSET時に必須です。 </div> <div lang=\"en\"> Ad title.<br> This field is requred in ADD and SET operation. </div> 
   * @return headline
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " 広告のタイトルです。
 このフィールドは、ADD時およびSET時に必須です。 
  Ad title.
 This field is requred in ADD and SET operation.  ")
  @JsonProperty(JSON_PROPERTY_HEADLINE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getHeadline() {
    return headline;
  }


  @JsonProperty(JSON_PROPERTY_HEADLINE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setHeadline(String headline) {
    this.headline = headline;
  }


  public AdGroupAdServiceCarousel description(String description) {
    
    this.description = description;
    return this;
  }

   /**
   * <div lang=\"ja\"> 広告の説明文です。<br> このフィールドは、ADD時およびSET時に必須です。 </div> <div lang=\"en\"> Ad description.<br> This field is requred in ADD and SET operation. </div> 
   * @return description
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " 広告の説明文です。
 このフィールドは、ADD時およびSET時に必須です。 
  Ad description.
 This field is requred in ADD and SET operation.  ")
  @JsonProperty(JSON_PROPERTY_DESCRIPTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getDescription() {
    return description;
  }


  @JsonProperty(JSON_PROPERTY_DESCRIPTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDescription(String description) {
    this.description = description;
  }


  public AdGroupAdServiceCarousel disapprovalReasonCodes(List disapprovalReasonCodes) {
    
    this.disapprovalReasonCodes = disapprovalReasonCodes;
    return this;
  }

  public AdGroupAdServiceCarousel addDisapprovalReasonCodesItem(String disapprovalReasonCodesItem) {
    if (this.disapprovalReasonCodes == null) {
      this.disapprovalReasonCodes = new ArrayList<>();
    }
    this.disapprovalReasonCodes.add(disapprovalReasonCodesItem);
    return this;
  }

   /**
   * <div lang=\"ja\"> 掲載拒否の理由です。<br> このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 </div> <div lang=\"en\"> Reject reason on editorial review.<br> Although this field will be returned in the response, it will be ignored on input. </div> 
   * @return disapprovalReasonCodes
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " 掲載拒否の理由です。
 このフィールドは、レスポンスの際に返却されますが、リクエストの際には無視されます。 
  Reject reason on editorial review.
 Although this field will be returned in the response, it will be ignored on input.  ")
  @JsonProperty(JSON_PROPERTY_DISAPPROVAL_REASON_CODES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getDisapprovalReasonCodes() {
    return disapprovalReasonCodes;
  }


  @JsonProperty(JSON_PROPERTY_DISAPPROVAL_REASON_CODES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDisapprovalReasonCodes(List disapprovalReasonCodes) {
    this.disapprovalReasonCodes = disapprovalReasonCodes;
  }


  public AdGroupAdServiceCarousel finalUrl(String finalUrl) {
    
    this.finalUrl = finalUrl;
    return this;
  }

   /**
   * <div lang=\"ja\">最終リンク先URLです。<br> このフィールドは、ADD時は必須となり、SET時は省略可能となります。<br> </div> <div lang=\"en\">Final URL.<br> This field is required in ADD operation, and will be optional in SET operation.<br> </div> 
   * @return finalUrl
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "最終リンク先URLです。
 このフィールドは、ADD時は必須となり、SET時は省略可能となります。
 
 Final URL.
 This field is required in ADD operation, and will be optional in SET operation.
  ")
  @JsonProperty(JSON_PROPERTY_FINAL_URL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getFinalUrl() {
    return finalUrl;
  }


  @JsonProperty(JSON_PROPERTY_FINAL_URL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFinalUrl(String finalUrl) {
    this.finalUrl = finalUrl;
  }


  public AdGroupAdServiceCarousel smartphoneFinalUrl(String smartphoneFinalUrl) {
    
    this.smartphoneFinalUrl = smartphoneFinalUrl;
    return this;
  }

   /**
   * <div lang=\"ja\">スマートフォン向けURLです。<br> ADDおよびSET時、このフィールドは省略可能となります。<br> キャンペーン目的「アプリ訴求」の場合は、ADD、SETのどちらも指定できません。 </div> <div lang=\"en\">Final URL (smartphone).<br> This field is optional in ADD and SET operation.<br> Not allowed for ADD and SET when a campaign goal is \"app promotion.\" </div> 
   * @return smartphoneFinalUrl
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "スマートフォン向けURLです。
 ADDおよびSET時、このフィールドは省略可能となります。
 キャンペーン目的「アプリ訴求」の場合は、ADD、SETのどちらも指定できません。 
 Final URL (smartphone).
 This field is optional in ADD and SET operation.
 Not allowed for ADD and SET when a campaign goal is \"app promotion.\"  ")
  @JsonProperty(JSON_PROPERTY_SMARTPHONE_FINAL_URL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getSmartphoneFinalUrl() {
    return smartphoneFinalUrl;
  }


  @JsonProperty(JSON_PROPERTY_SMARTPHONE_FINAL_URL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSmartphoneFinalUrl(String smartphoneFinalUrl) {
    this.smartphoneFinalUrl = smartphoneFinalUrl;
  }


  public AdGroupAdServiceCarousel isRemoveSmartphoneFinalUrl(AdGroupAdServiceIsRemoveFlg isRemoveSmartphoneFinalUrl) {
    
    this.isRemoveSmartphoneFinalUrl = isRemoveSmartphoneFinalUrl;
    return this;
  }

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

  public AdGroupAdServiceIsRemoveFlg getIsRemoveSmartphoneFinalUrl() {
    return isRemoveSmartphoneFinalUrl;
  }


  @JsonProperty(JSON_PROPERTY_IS_REMOVE_SMARTPHONE_FINAL_URL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setIsRemoveSmartphoneFinalUrl(AdGroupAdServiceIsRemoveFlg isRemoveSmartphoneFinalUrl) {
    this.isRemoveSmartphoneFinalUrl = isRemoveSmartphoneFinalUrl;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    AdGroupAdServiceCarousel adGroupAdServiceCarousel = (AdGroupAdServiceCarousel) o;
    return Objects.equals(this.displayOrder, adGroupAdServiceCarousel.displayOrder) &&
        Objects.equals(this.mediaId, adGroupAdServiceCarousel.mediaId) &&
        Objects.equals(this.headline, adGroupAdServiceCarousel.headline) &&
        Objects.equals(this.description, adGroupAdServiceCarousel.description) &&
        Objects.equals(this.disapprovalReasonCodes, adGroupAdServiceCarousel.disapprovalReasonCodes) &&
        Objects.equals(this.finalUrl, adGroupAdServiceCarousel.finalUrl) &&
        Objects.equals(this.smartphoneFinalUrl, adGroupAdServiceCarousel.smartphoneFinalUrl) &&
        Objects.equals(this.isRemoveSmartphoneFinalUrl, adGroupAdServiceCarousel.isRemoveSmartphoneFinalUrl);
  }

  @Override
  public int hashCode() {
    return Objects.hash(displayOrder, mediaId, headline, description, disapprovalReasonCodes, finalUrl, smartphoneFinalUrl, isRemoveSmartphoneFinalUrl);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class AdGroupAdServiceCarousel {\n");
    sb.append("    displayOrder: ").append(toIndentedString(displayOrder)).append("\n");
    sb.append("    mediaId: ").append(toIndentedString(mediaId)).append("\n");
    sb.append("    headline: ").append(toIndentedString(headline)).append("\n");
    sb.append("    description: ").append(toIndentedString(description)).append("\n");
    sb.append("    disapprovalReasonCodes: ").append(toIndentedString(disapprovalReasonCodes)).append("\n");
    sb.append("    finalUrl: ").append(toIndentedString(finalUrl)).append("\n");
    sb.append("    smartphoneFinalUrl: ").append(toIndentedString(smartphoneFinalUrl)).append("\n");
    sb.append("    isRemoveSmartphoneFinalUrl: ").append(toIndentedString(isRemoveSmartphoneFinalUrl)).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    ");
  }

}