com.google.api.services.realtimebidding.v1.model.AddTargetedPublishersRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-realtimebidding Show documentation
There is a newer version: v1-rev20240930-2.0.0
Show newest version
/*
 * 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.realtimebidding.v1.model;

/**
 * A request to start targeting the provided publishers in a specific pretargeting configuration.
 * The pretargeting configuration itself specifies how these publishers are targeted in
 * PretargetingConfig.publisherTargeting.
 *
 *  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 Real-time Bidding API. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class AddTargetedPublishersRequest extends com.google.api.client.json.GenericJson {

  /**
   * A list of publisher IDs to target in the pretargeting configuration. These values will be added
   * to the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values.
   * Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See
   * https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List publisherIds;

  /**
   * Required. The targeting mode that should be applied to the list of publisher IDs. If are
   * existing publisher IDs, must be equal to the existing
   * PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error will be
   * returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String targetingMode;

  /**
   * A list of publisher IDs to target in the pretargeting configuration. These values will be added
   * to the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values.
   * Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See
   * https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
   * @return value or {@code null} for none
   */
  public java.util.List getPublisherIds() {
    return publisherIds;
  }

  /**
   * A list of publisher IDs to target in the pretargeting configuration. These values will be added
   * to the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values.
   * Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See
   * https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
   * @param publisherIds publisherIds or {@code null} for none
   */
  public AddTargetedPublishersRequest setPublisherIds(java.util.List publisherIds) {
    this.publisherIds = publisherIds;
    return this;
  }

  /**
   * Required. The targeting mode that should be applied to the list of publisher IDs. If are
   * existing publisher IDs, must be equal to the existing
   * PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error will be
   * returned.
   * @return value or {@code null} for none
   */
  public java.lang.String getTargetingMode() {
    return targetingMode;
  }

  /**
   * Required. The targeting mode that should be applied to the list of publisher IDs. If are
   * existing publisher IDs, must be equal to the existing
   * PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error will be
   * returned.
   * @param targetingMode targetingMode or {@code null} for none
   */
  public AddTargetedPublishersRequest setTargetingMode(java.lang.String targetingMode) {
    this.targetingMode = targetingMode;
    return this;
  }

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

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

}