com.google.api.services.dfareporting.model.ClickThroughUrl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dfareporting Show documentation
The 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.dfareporting.model;

/**
 * Click-through URL
 *
 *  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 Campaign Manager 360 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 ClickThroughUrl extends com.google.api.client.json.GenericJson {

  /**
   * Read-only convenience field representing the actual URL that will be used for this click-
   * through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's
   * default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and
   * a landingPageId is specified then that landing page's URL is assigned to this field. - If
   * neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String computedClickThroughUrl;

  /**
   * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the
   * landingPageId field is left unset.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String customClickThroughUrl;

  /**
   * Whether the campaign default landing page is used.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean defaultLandingPage;

  /**
   * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is
   * set to false.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long landingPageId;

  /**
   * Read-only convenience field representing the actual URL that will be used for this click-
   * through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's
   * default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and
   * a landingPageId is specified then that landing page's URL is assigned to this field. - If
   * neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
   * @return value or {@code null} for none
   */
  public java.lang.String getComputedClickThroughUrl() {
    return computedClickThroughUrl;
  }

  /**
   * Read-only convenience field representing the actual URL that will be used for this click-
   * through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's
   * default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and
   * a landingPageId is specified then that landing page's URL is assigned to this field. - If
   * neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
   * @param computedClickThroughUrl computedClickThroughUrl or {@code null} for none
   */
  public ClickThroughUrl setComputedClickThroughUrl(java.lang.String computedClickThroughUrl) {
    this.computedClickThroughUrl = computedClickThroughUrl;
    return this;
  }

  /**
   * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the
   * landingPageId field is left unset.
   * @return value or {@code null} for none
   */
  public java.lang.String getCustomClickThroughUrl() {
    return customClickThroughUrl;
  }

  /**
   * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the
   * landingPageId field is left unset.
   * @param customClickThroughUrl customClickThroughUrl or {@code null} for none
   */
  public ClickThroughUrl setCustomClickThroughUrl(java.lang.String customClickThroughUrl) {
    this.customClickThroughUrl = customClickThroughUrl;
    return this;
  }

  /**
   * Whether the campaign default landing page is used.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDefaultLandingPage() {
    return defaultLandingPage;
  }

  /**
   * Whether the campaign default landing page is used.
   * @param defaultLandingPage defaultLandingPage or {@code null} for none
   */
  public ClickThroughUrl setDefaultLandingPage(java.lang.Boolean defaultLandingPage) {
    this.defaultLandingPage = defaultLandingPage;
    return this;
  }

  /**
   * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is
   * set to false.
   * @return value or {@code null} for none
   */
  public java.lang.Long getLandingPageId() {
    return landingPageId;
  }

  /**
   * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is
   * set to false.
   * @param landingPageId landingPageId or {@code null} for none
   */
  public ClickThroughUrl setLandingPageId(java.lang.Long landingPageId) {
    this.landingPageId = landingPageId;
    return this;
  }

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

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

}