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-06-16 at 22:43:59 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 ReportRequest extends com.google.api.client.json.GenericJson {

  
The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza. The value may be null.
 
 
   static {
     // hack to force ProGuard to consider ReportApiColumnSpec used, since otherwise it would be stripped out
     // see http://code.google.com/p/google-api-java-client/issues/detail?id=528
     com.google.api.client.util.Data.nullOf(ReportApiColumnSpec.class);
   }

  
Format that the report should be returned in. Currently csv or tsv is supported. The value may be null.
 
   private java.lang.String downloadFormat;

  
A list of filters to be applied to the report. The value may be null.
 
   private java.util.List<Filtersfilters;
 
   static {
     // hack to force ProGuard to consider Filters used, since otherwise it would be stripped out
     // see http://code.google.com/p/google-api-java-client/issues/detail?id=528
     com.google.api.client.util.Data.nullOf(Filters.class);
   }

  
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead. The value may be null.
 
Determines if removed entities should be included in the report. Defaults to false. The value may be null.
 
Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive. The value may be null.
 
   private java.lang.Integer maxRowsPerFile;

  
Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows. The value may be null.
  private java.util.List<OrderByorderBy;
  static {
    // hack to force ProGuard to consider OrderBy used, since otherwise it would be stripped out
    // see http://code.google.com/p/google-api-java-client/issues/detail?id=528
    com.google.api.client.util.Data.nullOf(OrderBy.class);
  }

  
The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required. The value may be null.
  private ReportScope reportScope;

  
Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type. The value may be null.
  private java.lang.String reportType;

  
Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000. The value may be null.
  private java.lang.Integer rowCount;

  
Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0. The value may be null.
  private java.lang.Integer startRow;

  
Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower). The value may be null.
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range. The value may be null.
  private TimeRange timeRange;

  
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false. The value may be null.
The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.

Returns:
value or null for none
    return ;
  }

  
The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.

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

  
Format that the report should be returned in. Currently csv or tsv is supported.

Returns:
value or null for none
    return ;
  }

  
Format that the report should be returned in. Currently csv or tsv is supported.

Parameters:
downloadFormat downloadFormat or null for none
  public ReportRequest setDownloadFormat(java.lang.String downloadFormat) {
    this. = downloadFormat;
    return this;
  }

  
A list of filters to be applied to the report.

Returns:
value or null for none
  public java.util.List<FiltersgetFilters() {
    return ;
  }

  
A list of filters to be applied to the report.

Parameters:
filters filters or null for none
  public ReportRequest setFilters(java.util.List<Filtersfilters) {
    this. = filters;
    return this;
  }

  
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.

Returns:
value or null for none
    return ;
  }

  
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.

Parameters:
includeDeletedEntities includeDeletedEntities or null for none
  public ReportRequest setIncludeDeletedEntities(java.lang.Boolean includeDeletedEntities) {
    this. = includeDeletedEntities;
    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.

Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.

  public boolean isIncludeDeletedEntities() {
      return false;
    }
    return ;
  }

  
Determines if removed entities should be included in the report. Defaults to false.

Returns:
value or null for none
    return ;
  }

  
Determines if removed entities should be included in the report. Defaults to false.

Parameters:
includeRemovedEntities includeRemovedEntities or null for none
  public ReportRequest setIncludeRemovedEntities(java.lang.Boolean includeRemovedEntities) {
    this. = includeRemovedEntities;
    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.

Determines if removed entities should be included in the report. Defaults to false.

  public boolean isIncludeRemovedEntities() {
      return false;
    }
    return ;
  }

  
Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.

Returns:
value or null for none
    return ;
  }

  
Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.

Parameters:
maxRowsPerFile maxRowsPerFile or null for none
  public ReportRequest setMaxRowsPerFile(java.lang.Integer maxRowsPerFile) {
    this. = maxRowsPerFile;
    return this;
  }

  
Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.

Returns:
value or null for none
  public java.util.List<OrderBygetOrderBy() {
    return ;
  }

  
Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.

Parameters:
orderBy orderBy or null for none
  public ReportRequest setOrderBy(java.util.List<OrderByorderBy) {
    this. = orderBy;
    return this;
  }

  
The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.

Returns:
value or null for none
  public ReportScope getReportScope() {
    return ;
  }

  
The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.

Parameters:
reportScope reportScope or null for none
  public ReportRequest setReportScope(ReportScope reportScope) {
    this. = reportScope;
    return this;
  }

  
Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.

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

  
Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.

Parameters:
reportType reportType or null for none
  public ReportRequest setReportType(java.lang.String reportType) {
    this. = reportType;
    return this;
  }

  
Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.

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

  
Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.

Parameters:
rowCount rowCount or null for none
  public ReportRequest setRowCount(java.lang.Integer rowCount) {
    this. = rowCount;
    return this;
  }

  
Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.

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

  
Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.

Parameters:
startRow startRow or null for none
  public ReportRequest setStartRow(java.lang.Integer startRow) {
    this. = startRow;
    return this;
  }

  
Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).

Returns:
value or null for none
    return ;
  }

  
Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).

Parameters:
statisticsCurrency statisticsCurrency or null for none
  public ReportRequest setStatisticsCurrency(java.lang.String statisticsCurrency) {
    this. = statisticsCurrency;
    return this;
  }

  
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.

Returns:
value or null for none
  public TimeRange getTimeRange() {
    return ;
  }

  
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.

Parameters:
timeRange timeRange or null for none
  public ReportRequest setTimeRange(TimeRange timeRange) {
    this. = timeRange;
    return this;
  }

  
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.

Returns:
value or null for none
    return ;
  }

  
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.

Parameters:
verifySingleTimeZone verifySingleTimeZone or null for none
  public ReportRequest setVerifySingleTimeZone(java.lang.Boolean verifySingleTimeZone) {
    this. = verifySingleTimeZone;
    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.

If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.

  public boolean isVerifySingleTimeZone() {
      return false;
    }
    return ;
  }
  public ReportRequest set(String fieldNameObject value) {
    return (ReportRequestsuper.set(fieldNamevalue);
  }
  public ReportRequest clone() {
    return (ReportRequestsuper.clone();
  }

  
Model definition for ReportRequestFilters.
  public static final class Filters extends com.google.api.client.json.GenericJson {

    
Column to perform the filter on. This can be a DoubleClick Search column or a saved column. The value may be null.
    private ReportApiColumnSpec column;

    
Operator to use in the filter. See the filter reference for a list of available operators. The value may be null.
    private java.lang.String operator;

    
A list of values to filter the column value against. The value may be null.
    private java.util.List<java.lang.Objectvalues;

    
Column to perform the filter on. This can be a DoubleClick Search column or a saved column.

Returns:
value or null for none
    public ReportApiColumnSpec getColumn() {
      return ;
    }

    
Column to perform the filter on. This can be a DoubleClick Search column or a saved column.

Parameters:
column column or null for none
    public Filters setColumn(ReportApiColumnSpec column) {
      this. = column;
      return this;
    }

    
Operator to use in the filter. See the filter reference for a list of available operators.

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

    
Operator to use in the filter. See the filter reference for a list of available operators.

Parameters:
operator operator or null for none
    public Filters setOperator(java.lang.String operator) {
      this. = operator;
      return this;
    }

    
A list of values to filter the column value against.

Returns:
value or null for none
    public java.util.List<java.lang.ObjectgetValues() {
      return ;
    }

    
A list of values to filter the column value against.

Parameters:
values values or null for none
    public Filters setValues(java.util.List<java.lang.Objectvalues) {
      this. = values;
      return this;
    }
    @Override
    public Filters set(String fieldNameObject value) {
      return (Filterssuper.set(fieldNamevalue);
    }
    @Override
    public Filters clone() {
      return (Filterssuper.clone();
    }
  }

  
Model definition for ReportRequestOrderBy.
  public static final class OrderBy extends com.google.api.client.json.GenericJson {

    
Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column. The value may be null.
    private ReportApiColumnSpec column;

    
The sort direction, which is either ascending or descending. The value may be null.
    private java.lang.String sortOrder;

    
Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.

Returns:
value or null for none
    public ReportApiColumnSpec getColumn() {
      return ;
    }

    
Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column.

Parameters:
column column or null for none
    public OrderBy setColumn(ReportApiColumnSpec column) {
      this. = column;
      return this;
    }

    
The sort direction, which is either ascending or descending.

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

    
The sort direction, which is either ascending or descending.

Parameters:
sortOrder sortOrder or null for none
    public OrderBy setSortOrder(java.lang.String sortOrder) {
      this. = sortOrder;
      return this;
    }
    @Override
    public OrderBy set(String fieldNameObject value) {
      return (OrderBysuper.set(fieldNamevalue);
    }
    @Override
    public OrderBy clone() {
      return (OrderBysuper.clone();
    }
  }

  
The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.
  public static final class ReportScope extends com.google.api.client.json.GenericJson {

    
DS ad group ID. The value may be null.
    private java.lang.Long adGroupId;

    
DS ad ID. The value may be null.
    private java.lang.Long adId;

    
DS advertiser ID. The value may be null.
    private java.lang.Long advertiserId;

    
DS agency ID. The value may be null.
    private java.lang.Long agencyId;

    
DS campaign ID. The value may be null.
    private java.lang.Long campaignId;

    
DS engine account ID. The value may be null.
    private java.lang.Long engineAccountId;

    
DS keyword ID. The value may be null.
    private java.lang.Long keywordId;

    
DS ad group ID.

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

    
DS ad group ID.

Parameters:
adGroupId adGroupId or null for none
    public ReportScope setAdGroupId(java.lang.Long adGroupId) {
      this. = adGroupId;
      return this;
    }

    
DS ad ID.

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

    
DS ad ID.

Parameters:
adId adId or null for none
    public ReportScope setAdId(java.lang.Long adId) {
      this. = adId;
      return this;
    }

    
DS advertiser ID.

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

    
DS advertiser ID.

Parameters:
advertiserId advertiserId or null for none
    public ReportScope setAdvertiserId(java.lang.Long advertiserId) {
      this. = advertiserId;
      return this;
    }

    
DS agency ID.

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

    
DS agency ID.

Parameters:
agencyId agencyId or null for none
    public ReportScope setAgencyId(java.lang.Long agencyId) {
      this. = agencyId;
      return this;
    }

    
DS campaign ID.

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

    
DS campaign ID.

Parameters:
campaignId campaignId or null for none
    public ReportScope setCampaignId(java.lang.Long campaignId) {
      this. = campaignId;
      return this;
    }

    
DS engine account ID.

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

    
DS engine account ID.

Parameters:
engineAccountId engineAccountId or null for none
    public ReportScope setEngineAccountId(java.lang.Long engineAccountId) {
      this. = engineAccountId;
      return this;
    }

    
DS keyword ID.

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

    
DS keyword ID.

Parameters:
keywordId keywordId or null for none
    public ReportScope setKeywordId(java.lang.Long keywordId) {
      this. = keywordId;
      return this;
    }
    @Override
    public ReportScope set(String fieldNameObject value) {
      return (ReportScopesuper.set(fieldNamevalue);
    }
    @Override
    public ReportScope clone() {
      return (ReportScopesuper.clone();
    }
  }

  
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
  public static final class TimeRange extends com.google.api.client.json.GenericJson {

    
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work. The value may be null.
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work. The value may be null.
Inclusive date in YYYY-MM-DD format. The value may be null.
    private java.lang.String endDate;

    
Inclusive date in YYYY-MM-DD format. The value may be null.
    private java.lang.String startDate;

    
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.

Returns:
value or null for none
    }

    
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work.

Parameters:
changedAttributesSinceTimestamp changedAttributesSinceTimestamp or null for none
    public TimeRange setChangedAttributesSinceTimestamp(com.google.api.client.util.DateTime changedAttributesSinceTimestamp) {
      this. = changedAttributesSinceTimestamp;
      return this;
    }

    
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.

Returns:
value or null for none
      return ;
    }

    
Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work.

Parameters:
changedMetricsSinceTimestamp changedMetricsSinceTimestamp or null for none
    public TimeRange setChangedMetricsSinceTimestamp(com.google.api.client.util.DateTime changedMetricsSinceTimestamp) {
      this. = changedMetricsSinceTimestamp;
      return this;
    }

    
Inclusive date in YYYY-MM-DD format.

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

    
Inclusive date in YYYY-MM-DD format.

Parameters:
endDate endDate or null for none
    public TimeRange setEndDate(java.lang.String endDate) {
      this. = endDate;
      return this;
    }

    
Inclusive date in YYYY-MM-DD format.

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

    
Inclusive date in YYYY-MM-DD format.

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