/*
 * 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.searchads360.v0.model;

/**
 * A unified sitelink asset.
 *
 * <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 Search Ads 360 Reporting 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 GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset extends com.google.api.client.json.GenericJson {

  /**
   * List of non-overlapping schedules specifying all time intervals for which the asset may serve.
   * There can be a maximum of 6 schedules per day, 42 in total.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GoogleAdsSearchads360V0CommonAdScheduleInfo> adScheduleTargets;

  static {
    // hack to force ProGuard to consider GoogleAdsSearchads360V0CommonAdScheduleInfo used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GoogleAdsSearchads360V0CommonAdScheduleInfo.class);
  }

  /**
   * First line of the description for the sitelink. If set, the length should be between 1 and 35,
   * inclusive, and description2 must also be set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description1;

  /**
   * Second line of the description for the sitelink. If set, the length should be between 1 and 35,
   * inclusive, and description1 must also be set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description2;

  /**
   * Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String endDate;

  /**
   * URL display text for the sitelink. The length of this string should be between 1 and 25,
   * inclusive.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String linkText;

  /**
   * Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to
   * Microsoft Ads.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean mobilePreferred;

  /**
   * Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String startDate;

  /**
   * ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long trackingId;

  /**
   * Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean useSearcherTimeZone;

  /**
   * List of non-overlapping schedules specifying all time intervals for which the asset may serve.
   * There can be a maximum of 6 schedules per day, 42 in total.
   * @return value or {@code null} for none
   */
  public java.util.List<GoogleAdsSearchads360V0CommonAdScheduleInfo> getAdScheduleTargets() {
    return adScheduleTargets;
  }

  /**
   * List of non-overlapping schedules specifying all time intervals for which the asset may serve.
   * There can be a maximum of 6 schedules per day, 42 in total.
   * @param adScheduleTargets adScheduleTargets or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setAdScheduleTargets(java.util.List<GoogleAdsSearchads360V0CommonAdScheduleInfo> adScheduleTargets) {
    this.adScheduleTargets = adScheduleTargets;
    return this;
  }

  /**
   * First line of the description for the sitelink. If set, the length should be between 1 and 35,
   * inclusive, and description2 must also be set.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription1() {
    return description1;
  }

  /**
   * First line of the description for the sitelink. If set, the length should be between 1 and 35,
   * inclusive, and description2 must also be set.
   * @param description1 description1 or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setDescription1(java.lang.String description1) {
    this.description1 = description1;
    return this;
  }

  /**
   * Second line of the description for the sitelink. If set, the length should be between 1 and 35,
   * inclusive, and description1 must also be set.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription2() {
    return description2;
  }

  /**
   * Second line of the description for the sitelink. If set, the length should be between 1 and 35,
   * inclusive, and description1 must also be set.
   * @param description2 description2 or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setDescription2(java.lang.String description2) {
    this.description2 = description2;
    return this;
  }

  /**
   * Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
   * @return value or {@code null} for none
   */
  public java.lang.String getEndDate() {
    return endDate;
  }

  /**
   * Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
   * @param endDate endDate or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setEndDate(java.lang.String endDate) {
    this.endDate = endDate;
    return this;
  }

  /**
   * URL display text for the sitelink. The length of this string should be between 1 and 25,
   * inclusive.
   * @return value or {@code null} for none
   */
  public java.lang.String getLinkText() {
    return linkText;
  }

  /**
   * URL display text for the sitelink. The length of this string should be between 1 and 25,
   * inclusive.
   * @param linkText linkText or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setLinkText(java.lang.String linkText) {
    this.linkText = linkText;
    return this;
  }

  /**
   * Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to
   * Microsoft Ads.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getMobilePreferred() {
    return mobilePreferred;
  }

  /**
   * Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to
   * Microsoft Ads.
   * @param mobilePreferred mobilePreferred or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setMobilePreferred(java.lang.Boolean mobilePreferred) {
    this.mobilePreferred = mobilePreferred;
    return this;
  }

  /**
   * Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
   * @return value or {@code null} for none
   */
  public java.lang.String getStartDate() {
    return startDate;
  }

  /**
   * Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
   * @param startDate startDate or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setStartDate(java.lang.String startDate) {
    this.startDate = startDate;
    return this;
  }

  /**
   * ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field.
   * @return value or {@code null} for none
   */
  public java.lang.Long getTrackingId() {
    return trackingId;
  }

  /**
   * ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field.
   * @param trackingId trackingId or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setTrackingId(java.lang.Long trackingId) {
    this.trackingId = trackingId;
    return this;
  }

  /**
   * Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUseSearcherTimeZone() {
    return useSearcherTimeZone;
  }

  /**
   * Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads.
   * @param useSearcherTimeZone useSearcherTimeZone or {@code null} for none
   */
  public GoogleAdsSearchads360V0CommonUnifiedSitelinkAsset setUseSearcherTimeZone(java.lang.Boolean useSearcherTimeZone) {
    this.useSearcherTimeZone = useSearcherTimeZone;
    return this;
  }

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

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

}
