| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.query.html">query</a> . <a href="cloudsearch_v1.query.sources.html">sources</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list">list(requestOptions_languageCode=None, pageToken=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, requestOptions_debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 88 | <code class="details" id="close">close()</code> |
| 89 | <pre>Close httplib2 connections.</pre> |
| 90 | </div> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 92 | <div class="method"> |
| 93 | <code class="details" id="list">list(requestOptions_languageCode=None, pageToken=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, requestOptions_debugOptions_enableDebugging=None, x__xgafv=None)</code> |
| 94 | <pre>Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 95 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 96 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 97 | requestOptions_languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 98 | pageToken: string, Number of sources to return in the response. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 99 | requestOptions_searchApplicationId: string, The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922). |
| 100 | requestOptions_timeZone: string, Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. |
| 101 | requestOptions_debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { # List sources response. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 111 | "nextPageToken": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | "sources": [ |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | { # List of sources that the user can search using the query API. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 114 | "shortName": "A String", # A short name or alias for the source. This value can be used with the 'source' operator. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | "displayName": "A String", # Display name of the data source. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 116 | "operators": [ # List of all operators applicable for this source. |
| 117 | { # The definition of a operator that can be used in a Search/Suggest request. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 118 | "isFacetable": True or False, # Can this operator be used to get facets. |
| 119 | "enumValues": [ # Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 120 | "A String", |
| 121 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 122 | "lessThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using the less-than operator. |
| 123 | "greaterThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using the greater-than operator. |
| 124 | "isReturnable": True or False, # Will the property associated with this facet be returned as part of search results. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 125 | "type": "A String", # Type of the operator. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 126 | "objectType": "A String", # Name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators. |
| 127 | "displayName": "A String", # Display name of the operator |
| 128 | "isRepeatable": True or False, # Indicates if multiple values can be set for this property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 129 | "isSuggestable": True or False, # Can get suggestions for this field. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 130 | "operatorName": "A String", # The name of the operator. |
| 131 | "isSortable": True or False, # Can this operator be used to sort results. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 132 | }, |
| 133 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 134 | "source": { # Defines sources for the suggest/search APIs. # Name of the source |
| 135 | "name": "A String", # Source name for content indexed by the Indexing API. |
| 136 | "predefinedSource": "A String", # Predefined content source for Google Apps. |
| 137 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 138 | }, |
| 139 | ], |
| 140 | }</pre> |
| 141 | </div> |
| 142 | |
| 143 | <div class="method"> |
| 144 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 145 | <pre>Retrieves the next page of results. |
| 146 | |
| 147 | Args: |
| 148 | previous_request: The request for the previous page. (required) |
| 149 | previous_response: The response from the request for the previous page. (required) |
| 150 | |
| 151 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 153 | page. Returns None if there are no more items in the collection. |
| 154 | </pre> |
| 155 | </div> |
| 156 | |
| 157 | </body></html> |