com.google.api.services.content.model.DatafeedTarget Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation
There is a newer version: v2.1-rev20241217-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.content.model;

/**
 * Model definition for DatafeedTarget.
 *
 *  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 Content API for Shopping. 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 DatafeedTarget extends com.google.api.client.json.GenericJson {

  /**
   * Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included
   * in the search index, represented as a CLDR territory code.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String country;

  /**
   * The list of destinations to exclude for this target (corresponds to cleared check boxes in
   * Merchant Center). Products that are excluded from all destinations for more than 7 days are
   * automatically deleted.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List excludedDestinations;

  /**
   * Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both
   * `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20
   * uppercase letters (A-Z), numbers (0-9), and dashes (-).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String feedLabel;

  /**
   * The list of destinations to include for this target (corresponds to checked check boxes in
   * Merchant Center). Default destinations are always included unless provided in
   * `excludedDestinations`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List includedDestinations;

  /**
   * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for
   * `targets[].country`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String language;

  /**
   * The countries where the items may be displayed. Represented as a CLDR territory code. Will be
   * ignored for "product inventory" feeds.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List targetCountries;

  /**
   * Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included
   * in the search index, represented as a CLDR territory code.
   * @return value or {@code null} for none
   */
  public java.lang.String getCountry() {
    return country;
  }

  /**
   * Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included
   * in the search index, represented as a CLDR territory code.
   * @param country country or {@code null} for none
   */
  public DatafeedTarget setCountry(java.lang.String country) {
    this.country = country;
    return this;
  }

  /**
   * The list of destinations to exclude for this target (corresponds to cleared check boxes in
   * Merchant Center). Products that are excluded from all destinations for more than 7 days are
   * automatically deleted.
   * @return value or {@code null} for none
   */
  public java.util.List getExcludedDestinations() {
    return excludedDestinations;
  }

  /**
   * The list of destinations to exclude for this target (corresponds to cleared check boxes in
   * Merchant Center). Products that are excluded from all destinations for more than 7 days are
   * automatically deleted.
   * @param excludedDestinations excludedDestinations or {@code null} for none
   */
  public DatafeedTarget setExcludedDestinations(java.util.List excludedDestinations) {
    this.excludedDestinations = excludedDestinations;
    return this;
  }

  /**
   * Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both
   * `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20
   * uppercase letters (A-Z), numbers (0-9), and dashes (-).
   * @return value or {@code null} for none
   */
  public java.lang.String getFeedLabel() {
    return feedLabel;
  }

  /**
   * Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both
   * `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20
   * uppercase letters (A-Z), numbers (0-9), and dashes (-).
   * @param feedLabel feedLabel or {@code null} for none
   */
  public DatafeedTarget setFeedLabel(java.lang.String feedLabel) {
    this.feedLabel = feedLabel;
    return this;
  }

  /**
   * The list of destinations to include for this target (corresponds to checked check boxes in
   * Merchant Center). Default destinations are always included unless provided in
   * `excludedDestinations`.
   * @return value or {@code null} for none
   */
  public java.util.List getIncludedDestinations() {
    return includedDestinations;
  }

  /**
   * The list of destinations to include for this target (corresponds to checked check boxes in
   * Merchant Center). Default destinations are always included unless provided in
   * `excludedDestinations`.
   * @param includedDestinations includedDestinations or {@code null} for none
   */
  public DatafeedTarget setIncludedDestinations(java.util.List includedDestinations) {
    this.includedDestinations = includedDestinations;
    return this;
  }

  /**
   * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for
   * `targets[].country`.
   * @return value or {@code null} for none
   */
  public java.lang.String getLanguage() {
    return language;
  }

  /**
   * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for
   * `targets[].country`.
   * @param language language or {@code null} for none
   */
  public DatafeedTarget setLanguage(java.lang.String language) {
    this.language = language;
    return this;
  }

  /**
   * The countries where the items may be displayed. Represented as a CLDR territory code. Will be
   * ignored for "product inventory" feeds.
   * @return value or {@code null} for none
   */
  public java.util.List getTargetCountries() {
    return targetCountries;
  }

  /**
   * The countries where the items may be displayed. Represented as a CLDR territory code. Will be
   * ignored for "product inventory" feeds.
   * @param targetCountries targetCountries or {@code null} for none
   */
  public DatafeedTarget setTargetCountries(java.util.List targetCountries) {
    this.targetCountries = targetCountries;
    return this;
  }

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

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

}