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

com.adzerk.sdk.generated.model.Placement Maven / Gradle / Ivy

/*
 * Adzerk Decision API
 * Adzerk Decision API
 *
 * The version of the OpenAPI document: 1.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package com.adzerk.sdk.generated.model;

import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.io.Serializable;

/**
 * Placement
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2020-04-13T12:24:36.097-04:00[America/New_York]")
public class Placement implements Serializable {
  private static final long serialVersionUID = 1L;

  public static final String SERIALIZED_NAME_DIV_NAME = "divName";
  @SerializedName(SERIALIZED_NAME_DIV_NAME)
  private String divName;

  public static final String SERIALIZED_NAME_NETWORK_ID = "networkId";
  @SerializedName(SERIALIZED_NAME_NETWORK_ID)
  private Integer networkId;

  public static final String SERIALIZED_NAME_SITE_ID = "siteId";
  @SerializedName(SERIALIZED_NAME_SITE_ID)
  private Integer siteId;

  public static final String SERIALIZED_NAME_AD_TYPES = "adTypes";
  @SerializedName(SERIALIZED_NAME_AD_TYPES)
  private List adTypes = null;

  public static final String SERIALIZED_NAME_ZONE_IDS = "zoneIds";
  @SerializedName(SERIALIZED_NAME_ZONE_IDS)
  private List zoneIds = null;

  public static final String SERIALIZED_NAME_CAMPAIGN_ID = "campaignId";
  @SerializedName(SERIALIZED_NAME_CAMPAIGN_ID)
  private Integer campaignId;

  public static final String SERIALIZED_NAME_FLIGHT_ID = "flightId";
  @SerializedName(SERIALIZED_NAME_FLIGHT_ID)
  private Integer flightId;

  public static final String SERIALIZED_NAME_AD_ID = "adId";
  @SerializedName(SERIALIZED_NAME_AD_ID)
  private Integer adId;

  public static final String SERIALIZED_NAME_CLICK_URL = "clickUrl";
  @SerializedName(SERIALIZED_NAME_CLICK_URL)
  private String clickUrl;

  public static final String SERIALIZED_NAME_PROPERTIES = "properties";
  @SerializedName(SERIALIZED_NAME_PROPERTIES)
  private Object properties;

  public static final String SERIALIZED_NAME_EVENT_IDS = "eventIds";
  @SerializedName(SERIALIZED_NAME_EVENT_IDS)
  private List eventIds = null;

  public static final String SERIALIZED_NAME_OVERRIDES = "overrides";
  @SerializedName(SERIALIZED_NAME_OVERRIDES)
  private Object overrides;

  public static final String SERIALIZED_NAME_CONTENT_KEYS = "contentKeys";
  @SerializedName(SERIALIZED_NAME_CONTENT_KEYS)
  private Map contentKeys = null;

  public static final String SERIALIZED_NAME_COUNT = "count";
  @SerializedName(SERIALIZED_NAME_COUNT)
  private Integer count;

  public static final String SERIALIZED_NAME_PROPORTIONALITY = "proportionality";
  @SerializedName(SERIALIZED_NAME_PROPORTIONALITY)
  private Boolean proportionality;

  public static final String SERIALIZED_NAME_ECPM_PARTITION = "ecpmPartition";
  @SerializedName(SERIALIZED_NAME_ECPM_PARTITION)
  private String ecpmPartition;


  public Placement divName(String divName) {
    
    this.divName = divName;
    return this;
  }

   /**
   * A unique name for the placement defined by you
   * @return divName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "A unique name for the placement defined by you")

  public String getDivName() {
    return divName;
  }


  public void setDivName(String divName) {
    this.divName = divName;
  }


  public Placement networkId(Integer networkId) {
    
    this.networkId = networkId;
    return this;
  }

   /**
   * The numeric network id
   * @return networkId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "The numeric network id")

  public Integer getNetworkId() {
    return networkId;
  }


  public void setNetworkId(Integer networkId) {
    this.networkId = networkId;
  }


  public Placement siteId(Integer siteId) {
    
    this.siteId = siteId;
    return this;
  }

   /**
   * The numeric site id
   * @return siteId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "The numeric site id")

  public Integer getSiteId() {
    return siteId;
  }


  public void setSiteId(Integer siteId) {
    this.siteId = siteId;
  }


  public Placement adTypes(List adTypes) {
    
    this.adTypes = adTypes;
    return this;
  }

  public Placement addAdTypesItem(Integer adTypesItem) {
    if (this.adTypes == null) {
      this.adTypes = new ArrayList();
    }
    this.adTypes.add(adTypesItem);
    return this;
  }

   /**
   * One or more integer ad types. More info [here](https://dev.adzerk.com/docs/ad-sizes)
   * @return adTypes
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "One or more integer ad types. More info [here](https://dev.adzerk.com/docs/ad-sizes)")

  public List getAdTypes() {
    return adTypes;
  }


  public void setAdTypes(List adTypes) {
    this.adTypes = adTypes;
  }


  public Placement zoneIds(List zoneIds) {
    
    this.zoneIds = zoneIds;
    return this;
  }

  public Placement addZoneIdsItem(Integer zoneIdsItem) {
    if (this.zoneIds == null) {
      this.zoneIds = new ArrayList();
    }
    this.zoneIds.add(zoneIdsItem);
    return this;
  }

   /**
   * Zone IDs to use
   * @return zoneIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "Zone IDs to use")

  public List getZoneIds() {
    return zoneIds;
  }


  public void setZoneIds(List zoneIds) {
    this.zoneIds = zoneIds;
  }


  public Placement campaignId(Integer campaignId) {
    
    this.campaignId = campaignId;
    return this;
  }

   /**
   * A numeric campaign id; if specified, only consider ads in that campaign
   * @return campaignId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "A numeric campaign id; if specified, only consider ads in that campaign")

  public Integer getCampaignId() {
    return campaignId;
  }


  public void setCampaignId(Integer campaignId) {
    this.campaignId = campaignId;
  }


  public Placement flightId(Integer flightId) {
    
    this.flightId = flightId;
    return this;
  }

   /**
   * A numeric ad (flight-creative map) id; if specified, only serve that ad if possible
   * @return flightId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "A numeric ad (flight-creative map) id; if specified, only serve that ad if possible")

  public Integer getFlightId() {
    return flightId;
  }


  public void setFlightId(Integer flightId) {
    this.flightId = flightId;
  }


  public Placement adId(Integer adId) {
    
    this.adId = adId;
    return this;
  }

   /**
   * A numeric ad (flight-creative map) id; if specified, only serve that ad if possible
   * @return adId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "A numeric ad (flight-creative map) id; if specified, only serve that ad if possible")

  public Integer getAdId() {
    return adId;
  }


  public void setAdId(Integer adId) {
    this.adId = adId;
  }


  public Placement clickUrl(String clickUrl) {
    
    this.clickUrl = clickUrl;
    return this;
  }

   /**
   * The ad's click-through URL
   * @return clickUrl
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "The ad's click-through URL")

  public String getClickUrl() {
    return clickUrl;
  }


  public void setClickUrl(String clickUrl) {
    this.clickUrl = clickUrl;
  }


  public Placement properties(Object properties) {
    
    this.properties = properties;
    return this;
  }

   /**
   * A map of key/value pairs used for [Custom Targeting](https://dev.adzerk.com/docs/custom-targeting)
   * @return properties
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "A map of key/value pairs used for [Custom Targeting](https://dev.adzerk.com/docs/custom-targeting)")

  public Object getProperties() {
    return properties;
  }


  public void setProperties(Object properties) {
    this.properties = properties;
  }


  public Placement eventIds(List eventIds) {
    
    this.eventIds = eventIds;
    return this;
  }

  public Placement addEventIdsItem(Integer eventIdsItem) {
    if (this.eventIds == null) {
      this.eventIds = new ArrayList();
    }
    this.eventIds.add(eventIdsItem);
    return this;
  }

   /**
   * An array of numeric event types. Requests tracking URLs for custom events. See here for [Event Tracking IDs](https://dev.adzerk.com/v1.0/docs/custom-event-tracking)
   * @return eventIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "An array of numeric event types. Requests tracking URLs for custom events. See here for [Event Tracking IDs](https://dev.adzerk.com/v1.0/docs/custom-event-tracking)")

  public List getEventIds() {
    return eventIds;
  }


  public void setEventIds(List eventIds) {
    this.eventIds = eventIds;
  }


  public Placement overrides(Object overrides) {
    
    this.overrides = overrides;
    return this;
  }

   /**
   * An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding
   * @return overrides
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding")

  public Object getOverrides() {
    return overrides;
  }


  public void setOverrides(Object overrides) {
    this.overrides = overrides;
  }


  public Placement contentKeys(Map contentKeys) {
    
    this.contentKeys = contentKeys;
    return this;
  }

  public Placement putContentKeysItem(String key, Integer contentKeysItem) {
    if (this.contentKeys == null) {
      this.contentKeys = new HashMap();
    }
    this.contentKeys.put(key, contentKeysItem);
    return this;
  }

   /**
   * A map of key/value pairs used with [ContentDB](https://dev.adzerk.com/docs/contentdb-1). The format is `\"contentKeys\": {\"schema\": \"contentKey\"}`
   * @return contentKeys
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "A map of key/value pairs used with [ContentDB](https://dev.adzerk.com/docs/contentdb-1). The format is `\"contentKeys\": {\"schema\": \"contentKey\"}`")

  public Map getContentKeys() {
    return contentKeys;
  }


  public void setContentKeys(Map contentKeys) {
    this.contentKeys = contentKeys;
  }


  public Placement count(Integer count) {
    
    this.count = count;
    return this;
  }

   /**
   * (BETA) The number of ads to return per placement. Integer between 1 and 20
   * @return count
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "(BETA) The number of ads to return per placement. Integer between 1 and 20")

  public Integer getCount() {
    return count;
  }


  public void setCount(Integer count) {
    this.count = count;
  }


  public Placement proportionality(Boolean proportionality) {
    
    this.proportionality = proportionality;
    return this;
  }

   /**
   * (BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals
   * @return proportionality
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "(BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals")

  public Boolean getProportionality() {
    return proportionality;
  }


  public void setProportionality(Boolean proportionality) {
    this.proportionality = proportionality;
  }


  public Placement ecpmPartition(String ecpmPartition) {
    
    this.ecpmPartition = ecpmPartition;
    return this;
  }

   /**
   * (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions
   * @return ecpmPartition
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "(BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions")

  public String getEcpmPartition() {
    return ecpmPartition;
  }


  public void setEcpmPartition(String ecpmPartition) {
    this.ecpmPartition = ecpmPartition;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Placement placement = (Placement) o;
    return Objects.equals(this.divName, placement.divName) &&
        Objects.equals(this.networkId, placement.networkId) &&
        Objects.equals(this.siteId, placement.siteId) &&
        Objects.equals(this.adTypes, placement.adTypes) &&
        Objects.equals(this.zoneIds, placement.zoneIds) &&
        Objects.equals(this.campaignId, placement.campaignId) &&
        Objects.equals(this.flightId, placement.flightId) &&
        Objects.equals(this.adId, placement.adId) &&
        Objects.equals(this.clickUrl, placement.clickUrl) &&
        Objects.equals(this.properties, placement.properties) &&
        Objects.equals(this.eventIds, placement.eventIds) &&
        Objects.equals(this.overrides, placement.overrides) &&
        Objects.equals(this.contentKeys, placement.contentKeys) &&
        Objects.equals(this.count, placement.count) &&
        Objects.equals(this.proportionality, placement.proportionality) &&
        Objects.equals(this.ecpmPartition, placement.ecpmPartition);
  }

  @Override
  public int hashCode() {
    return Objects.hash(divName, networkId, siteId, adTypes, zoneIds, campaignId, flightId, adId, clickUrl, properties, eventIds, overrides, contentKeys, count, proportionality, ecpmPartition);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Placement {\n");
    sb.append("    divName: ").append(toIndentedString(divName)).append("\n");
    sb.append("    networkId: ").append(toIndentedString(networkId)).append("\n");
    sb.append("    siteId: ").append(toIndentedString(siteId)).append("\n");
    sb.append("    adTypes: ").append(toIndentedString(adTypes)).append("\n");
    sb.append("    zoneIds: ").append(toIndentedString(zoneIds)).append("\n");
    sb.append("    campaignId: ").append(toIndentedString(campaignId)).append("\n");
    sb.append("    flightId: ").append(toIndentedString(flightId)).append("\n");
    sb.append("    adId: ").append(toIndentedString(adId)).append("\n");
    sb.append("    clickUrl: ").append(toIndentedString(clickUrl)).append("\n");
    sb.append("    properties: ").append(toIndentedString(properties)).append("\n");
    sb.append("    eventIds: ").append(toIndentedString(eventIds)).append("\n");
    sb.append("    overrides: ").append(toIndentedString(overrides)).append("\n");
    sb.append("    contentKeys: ").append(toIndentedString(contentKeys)).append("\n");
    sb.append("    count: ").append(toIndentedString(count)).append("\n");
    sb.append("    proportionality: ").append(toIndentedString(proportionality)).append("\n");
    sb.append("    ecpmPartition: ").append(toIndentedString(ecpmPartition)).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(java.lang.Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

}





© 2015 - 2024 Weber Informatics LLC | Privacy Policy