/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.displayvideo.v1.model;

/**
 * Settings that control the [optimized
 * targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation
 * see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class TargetingExpansionConfig extends com.google.api.client.json.GenericJson {

  /**
   * Whether to exclude first-party audiences from use in targeting expansion. This field was
   * deprecated with the launch of [optimized
   * targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to
   * `false`. If this field is set to `true` when deprecated, all positive first-party audience
   * targeting assigned to this line item will be replaced with negative targeting of the same
   * first-party audiences to ensure the continued exclusion of those audiences.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean excludeFirstPartyAudience;

  /**
   * Required. Whether optimized targeting is turned on. This field supports the following values: *
   * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is
   * turned on If this field is set to any other value, it will automatically be set to
   * `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be
   * automatically assigned if you do not set the field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String targetingExpansionLevel;

  /**
   * Whether to exclude first-party audiences from use in targeting expansion. This field was
   * deprecated with the launch of [optimized
   * targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to
   * `false`. If this field is set to `true` when deprecated, all positive first-party audience
   * targeting assigned to this line item will be replaced with negative targeting of the same
   * first-party audiences to ensure the continued exclusion of those audiences.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getExcludeFirstPartyAudience() {
    return excludeFirstPartyAudience;
  }

  /**
   * Whether to exclude first-party audiences from use in targeting expansion. This field was
   * deprecated with the launch of [optimized
   * targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to
   * `false`. If this field is set to `true` when deprecated, all positive first-party audience
   * targeting assigned to this line item will be replaced with negative targeting of the same
   * first-party audiences to ensure the continued exclusion of those audiences.
   * @param excludeFirstPartyAudience excludeFirstPartyAudience or {@code null} for none
   */
  public TargetingExpansionConfig setExcludeFirstPartyAudience(java.lang.Boolean excludeFirstPartyAudience) {
    this.excludeFirstPartyAudience = excludeFirstPartyAudience;
    return this;
  }

  /**
   * Required. Whether optimized targeting is turned on. This field supports the following values: *
   * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is
   * turned on If this field is set to any other value, it will automatically be set to
   * `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be
   * automatically assigned if you do not set the field.
   * @return value or {@code null} for none
   */
  public java.lang.String getTargetingExpansionLevel() {
    return targetingExpansionLevel;
  }

  /**
   * Required. Whether optimized targeting is turned on. This field supports the following values: *
   * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is
   * turned on If this field is set to any other value, it will automatically be set to
   * `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be
   * automatically assigned if you do not set the field.
   * @param targetingExpansionLevel targetingExpansionLevel or {@code null} for none
   */
  public TargetingExpansionConfig setTargetingExpansionLevel(java.lang.String targetingExpansionLevel) {
    this.targetingExpansionLevel = targetingExpansionLevel;
    return this;
  }

  @Override
  public TargetingExpansionConfig set(String fieldName, Object value) {
    return (TargetingExpansionConfig) super.set(fieldName, value);
  }

  @Override
  public TargetingExpansionConfig clone() {
    return (TargetingExpansionConfig) super.clone();
  }

}
