Skip to content

Commit

Permalink
feat(customsearch): update the api
Browse files Browse the repository at this point in the history
#### customsearch:v1

The following keys were added:
- resources.cse.methods.list.parameters.snippetLength (Total Keys: 3)
- resources.cse.resources.siterestrict.methods.list.parameters.snippetLength (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Mar 26, 2024
1 parent f8d7618 commit 269a3a7
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
5 changes: 3 additions & 2 deletions docs/dyn/customsearch_v1.cse.html
Expand Up @@ -83,7 +83,7 @@ <h2>Instance Methods</h2>
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, sort=None, start=None, x__xgafv=None)</a></code></p>
<code><a href="#list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns metadata about the search performed, metadata about the engine used for the search, and the search results.</p>
<h3>Method Details</h3>
<div class="method">
Expand All @@ -92,7 +92,7 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, sort=None, start=None, x__xgafv=None)</code>
<code class="details" id="list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)</code>
<pre>Returns metadata about the search performed, metadata about the engine used for the search, and the search results.

Args:
Expand Down Expand Up @@ -175,6 +175,7 @@ <h3>Method Details</h3>
siteSearchFilterUndefined - Filter mode unspecified.
e - Exclude results from the listed sites.
i - Include only results from the listed sites.
snippetLength: integer, Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive.
sort: string, The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).
start: integer, The index of the first result to return. The default number of results per page is 10, so `&amp;start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.
x__xgafv: string, V1 error format.
Expand Down
5 changes: 3 additions & 2 deletions docs/dyn/customsearch_v1.cse.siterestrict.html
Expand Up @@ -78,7 +78,7 @@ <h2>Instance Methods</h2>
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, sort=None, start=None, x__xgafv=None)</a></code></p>
<code><a href="#list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.</p>
<h3>Method Details</h3>
<div class="method">
Expand All @@ -87,7 +87,7 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, sort=None, start=None, x__xgafv=None)</code>
<code class="details" id="list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, snippetLength=None, sort=None, start=None, x__xgafv=None)</code>
<pre>Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.

Args:
Expand Down Expand Up @@ -170,6 +170,7 @@ <h3>Method Details</h3>
siteSearchFilterUndefined - Filter mode unspecified.
e - Exclude results from the listed sites.
i - Include only results from the listed sites.
snippetLength: integer, Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive.
sort: string, The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).
start: integer, The index of the first result to return. The default number of results per page is 10, so `&amp;start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.
x__xgafv: string, V1 error format.
Expand Down
14 changes: 13 additions & 1 deletion googleapiclient/discovery_cache/documents/customsearch.v1.json
Expand Up @@ -372,6 +372,12 @@ false
"location": "query",
"type": "string"
},
"snippetLength": {
"description": "Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive.",
"format": "int32",
"location": "query",
"type": "integer"
},
"sort": {
"description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).",
"location": "query",
Expand Down Expand Up @@ -668,6 +674,12 @@ false
"location": "query",
"type": "string"
},
"snippetLength": {
"description": "Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive.",
"format": "int32",
"location": "query",
"type": "integer"
},
"sort": {
"description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).",
"location": "query",
Expand All @@ -690,7 +702,7 @@ false
}
}
},
"revision": "20240317",
"revision": "20240324",
"rootUrl": "https://customsearch.googleapis.com/",
"schemas": {
"Promotion": {
Expand Down

0 comments on commit 269a3a7

Please sign in to comment.