AddQueryParam Method
Adds a query parameter to the QueryParams properties.
Syntax
[VB.NET] Public Sub AddQueryParam(ByVal name As String, ByVal value As String)
[C#] public void AddQueryParam(string name, string value);
Remarks
This method is used to add a query parameter to the QueryParams collection . Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the component when a Query is performed.
Common parameters available for GData are:
| Parameter | Description |
| author | Returns entries where the author name and/or email address match your query string. |
| category | Performs a category filter.
To query on multiple categories (i.e. performing an AND), you can separate categories by using forward slashes: "catA/catB". To perform an OR between categories, you can separate terms using the pipe (|) character: "catA|catB". To exclude entries that match a specified category (i.e. performing a NOT), you can prefix the term with a "-": "-categoryterm". To query for a category that has a scheme, you must place the scheme in curly braces before the category name: "{urn:google.com}public". To match a category that has no scheme, use an empty pair of curly braces: "{}". If you don't specify curly braces, then categories in any scheme will match. The above features can be combined as well. For example, "A|-{urn:google.com}B/-C" translates to (A OR (NOT B)) AND (NOT C). |
| entryID | Returns only the entry specified by the entry ID. |
| max-results | Maximum number of results to be retrieved. You can specify a very large number if you want to retrieve the entire feed. |
| published-min | The lower bound on the entry publication date (inclusive). The format of the date will depend on the DateFormat you are currently using. Unless otherwise specified, the default format used is "yyyy-MM-ddTHH:mm:ss.fffZ" (e.g. 2011-04-04T18:44:20.000Z). |
| published-max | The upper bound on the entry publication date (exclusive). The format of the date will depend on the DateFormat you are currently using. Unless otherwise specified, the default format used is "yyyy-MM-ddTHH:mm:ss.fffZ" (e.g. 2011-04-04T18:44:20.000Z). |
| q | Full-text query search (case-insensitive). List search terms are separated by spaces and the Google service will return all entries that match all of the specified search terms. A service searches on complete words (and related words with the same stem), not substrings.
To search for an exact phrase, enclose the Value in quotation marks: "exact phrase" To exclude entries that match a given term, use the form: -term. |
| start-index | 1-based index of the first result to be retrieved. |
| strict | This parameter can be set to 'True' to have the service verify that each of your query parameters are recognized by the service. If a parameter is not recognized, an error will be returned. |
| updated-min | The lower bound on the entry update date (inclusive). The format of the date will depend on the DateFormat you are currently using. Unless otherwise specified, the default format used is "yyyy-MM-ddTHH:mm:ss.fffZ" (e.g. 2011-04-04T18:44:20.000Z). |
| updated-max | The upper bound on the entry update date (exclusive). The format of the date will depend on the DateFormat you are currently using. Unless otherwise specified, the default format used is "yyyy-MM-ddTHH:mm:ss.fffZ" (e.g. 2011-04-04T18:44:20.000Z). |
Common parameters available for GSpreadsheets (in addition to the ones listed for GData) are below (categorized based on what you are querying).
When querying spreadsheets (QuerySpreadsheets) and worksheets (QueryWorksheets) the following additional query parameters can be used:
| Parameter | Description |
| title | Specifies the search terms for the title of a spreadsheet/worksheet. This parameter used without title-exact will only submit partial queries, not exact queries. Note: Matches are case-insensitive. |
| title-exact | Specifies whether the title query should be taken as an exact string. Possible values are "true" and "false". |
When querying rows (QueryRows) the following additional query parameters can be used:
| Parameter | Description |
| orderby | Specifies what column to use in ordering the entries in the feed. The available values are "position" (default) and "column:[columnName]". When ordering by position, the rows will be returned in the order in which they appear in the worksheet (i.e. Row 1, Row 2, Row 3, etc). When ordering by column, the rows will be ordered in ascending order based on the values within the given columnName (where columnName is the value of a particular header). |
| reverse | Specifies whether to sort in descending or ascending order. The available values are "true" (rows will be in descending order) and "false" (default value and rows will be in ascending order). |
| sq | Performs a structured query on the full text in the worksheet. The format of this parameter is: "[columnName][binaryOperator][value]", where columnName is the value of a particular header you want to search and value is the value that you want to search for.
The supported binaryOperator values are:
|
When querying cells (QueryCells) the following additional query parameters can be used:
| Parameter | Description |
| min-row | Positional number of minimum row returned in query (inclusive). |
| max-row | Positional number of maximum row returned in query (inclusive). |
| min-col | Positional number of minimum column returned in query (inclusive). |
| max-col | Positional number of maximum column returned in query (inclusive). |
| range | Specifies the cell or range of cells to be returned in a query. The format of the specified value should either "[cell]" (returns a single cell) or "[cell1:cell2]" (returns a range of cells from cell1 to cell2). Note there are two different notations for cells. You can use the address of a particular cell such as "A1" or you can use the row and column location such as "R1C1" (both of which specify the first cell in the worksheet). |
| return-empty | Specifies whether empty cells will be returned in the feed. The valid values are "true" (empty cells will be returned) or "false" (default). |