Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010 Google Inc.
   *
   * 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://code.google.com/p/google-apis-client-generator/
  * (build: 2015-03-26 20:30:19 UTC)
  * on 2015-07-01 at 01:37:24 UTC 
  * Modify at your own risk.
  */
 
 package com.google.api.services.doubleclicksearch.model;

A request object used to create a DoubleClick Search report.

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 DoubleClick Search API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author(s):
Google, Inc.
 
 @SuppressWarnings("javadoc")
 public final class ReportApiColumnSpec extends com.google.api.client.json.GenericJson {

  
Name of a DoubleClick Search column to include in the report. The value may be null.
 
   private java.lang.String columnName;

  
Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report. The value may be null.
 
   private java.lang.String customDimensionName;

  
Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. The value may be null.
 
   private java.lang.String customMetricName;

  
Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. The value may be null.
 
   private java.lang.String endDate;

  
Synchronous report only. Set to true to group by this column. Defaults to false. The value may be null.
 
   private java.lang.Boolean groupByColumn;

  
Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. The value may be null.
 
   private java.lang.String headerText;

  
The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". The value may be null.
 
   private java.lang.String platformSource;

  
Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. The value may be null.
  private java.lang.String savedColumnName;

  
Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. The value may be null.
  private java.lang.String startDate;

  
Name of a DoubleClick Search column to include in the report.

Returns:
value or null for none
  public java.lang.String getColumnName() {
    return ;
  }

  
Name of a DoubleClick Search column to include in the report.

Parameters:
columnName columnName or null for none
  public ReportApiColumnSpec setColumnName(java.lang.String columnName) {
    this. = columnName;
    return this;
  }

  
Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.

Returns:
value or null for none
    return ;
  }

  
Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.

Parameters:
customDimensionName customDimensionName or null for none
  public ReportApiColumnSpec setCustomDimensionName(java.lang.String customDimensionName) {
    this. = customDimensionName;
    return this;
  }

  
Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.

Returns:
value or null for none
    return ;
  }

  
Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.

Parameters:
customMetricName customMetricName or null for none
  public ReportApiColumnSpec setCustomMetricName(java.lang.String customMetricName) {
    this. = customMetricName;
    return this;
  }

  
Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.

Returns:
value or null for none
  public java.lang.String getEndDate() {
    return ;
  }

  
Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate.

Parameters:
endDate endDate or null for none
    this. = endDate;
    return this;
  }

  
Synchronous report only. Set to true to group by this column. Defaults to false.

Returns:
value or null for none
    return ;
  }

  
Synchronous report only. Set to true to group by this column. Defaults to false.

Parameters:
groupByColumn groupByColumn or null for none
  public ReportApiColumnSpec setGroupByColumn(java.lang.Boolean groupByColumn) {
    this. = groupByColumn;
    return this;
  }

  
Convenience method that returns only java.lang.Boolean.TRUE or java.lang.Boolean.FALSE.

Boolean properties can have four possible values: null, com.google.api.client.util.Data.NULL_BOOLEAN, java.lang.Boolean.TRUE or java.lang.Boolean.FALSE.

This method returns java.lang.Boolean.TRUE if the default of the property is java.lang.Boolean.TRUE and it is null or com.google.api.client.util.Data.NULL_BOOLEAN. java.lang.Boolean.FALSE is returned if the default of the property is java.lang.Boolean.FALSE and it is null or com.google.api.client.util.Data.NULL_BOOLEAN.

Synchronous report only. Set to true to group by this column. Defaults to false.

  public boolean isGroupByColumn() {
    if ( == null ||  == ......) {
      return false;
    }
    return ;
  }

  
Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.

Returns:
value or null for none
  public java.lang.String getHeaderText() {
    return ;
  }

  
Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.

Parameters:
headerText headerText or null for none
  public ReportApiColumnSpec setHeaderText(java.lang.String headerText) {
    this. = headerText;
    return this;
  }

  
The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight".

Returns:
value or null for none
    return ;
  }

  
The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight".

Parameters:
platformSource platformSource or null for none
  public ReportApiColumnSpec setPlatformSource(java.lang.String platformSource) {
    this. = platformSource;
    return this;
  }

  
Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.

Returns:
value or null for none
    return ;
  }

  
Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.

Parameters:
savedColumnName savedColumnName or null for none
  public ReportApiColumnSpec setSavedColumnName(java.lang.String savedColumnName) {
    this. = savedColumnName;
    return this;
  }

  
Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.

Returns:
value or null for none
  public java.lang.String getStartDate() {
    return ;
  }

  
Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate.

Parameters:
startDate startDate or null for none
  public ReportApiColumnSpec setStartDate(java.lang.String startDate) {
    this. = startDate;
    return this;
  }
  public ReportApiColumnSpec set(String fieldNameObject value) {
    return (ReportApiColumnSpecsuper.set(fieldNamevalue);
  }
  public ReportApiColumnSpec clone() {
    return (ReportApiColumnSpecsuper.clone();
  }
New to GrepCode? Check out our FAQ X