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-07-16 18:28:29 UTC)
  * on 2015-07-22 at 12:39:14 UTC 
  * Modify at your own risk.
  */
 
 package com.google.api.services.webmasters.model;

Model definition for SearchAnalyticsQueryRequest.

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 Webmaster Tools 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 SearchAnalyticsQueryRequest extends com.google.api.client.json.GenericJson {

  
[Optional; Default is "auto"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. Note: If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid. The value may be null.
 
   private java.lang.String aggregationType;

  
[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains "buy"' to see only data where the query string contains the substring "buy" (not case- sensitive). You can filter by a dimension without grouping by it. The value may be null.
 
[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions. The value may be null.
 
   private java.util.List<java.lang.Stringdimensions;

  
[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range. The value may be null.
 
   private java.lang.String endDate;

  
[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive). The value may be null.
 
   private java.lang.Integer rowLimit;

  
[Optional; Default is "web"] The search type to filter for. The value may be null.
 
   private java.lang.String searchType;

  
[Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range. The value may be null.
 
  private java.lang.String startDate;

  
[Optional; Default is "auto"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. Note: If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.

Returns:
value or null for none
    return ;
  }

  
[Optional; Default is "auto"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. Note: If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.

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

  
[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains "buy"' to see only data where the query string contains the substring "buy" (not case- sensitive). You can filter by a dimension without grouping by it.

Returns:
value or null for none
    return ;
  }

  
[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains "buy"' to see only data where the query string contains the substring "buy" (not case- sensitive). You can filter by a dimension without grouping by it.

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

  
[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.

Returns:
value or null for none
    return ;
  }

  
[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.

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

  
[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.

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

  
[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.

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

  
[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive).

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

  
[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 5,000 (inclusive).

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

  
[Optional; Default is "web"] The search type to filter for.

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

  
[Optional; Default is "web"] The search type to filter for.

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

  
[Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.

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

  
[Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.

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