google-api-client 0.40.2 → 0.41.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +66 -0
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/androidmanagement_v1/classes.rb +117 -0
- data/generated/google/apis/androidmanagement_v1/representations.rb +39 -0
- data/generated/google/apis/androidpublisher_v3.rb +1 -1
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/artifactregistry_v1beta1.rb +1 -1
- data/generated/google/apis/artifactregistry_v1beta1/classes.rb +9 -0
- data/generated/google/apis/artifactregistry_v1beta1/representations.rb +1 -0
- data/generated/google/apis/bigquerydatatransfer_v1.rb +1 -1
- data/generated/google/apis/bigquerydatatransfer_v1/classes.rb +4 -4
- data/generated/google/apis/bigtableadmin_v1.rb +1 -1
- data/generated/google/apis/bigtableadmin_v1/classes.rb +5 -10
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/classes.rb +39 -31
- data/generated/google/apis/bigtableadmin_v2/service.rb +1 -5
- data/generated/google/apis/books_v1.rb +1 -1
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/chat_v1.rb +1 -1
- data/generated/google/apis/chat_v1/classes.rb +2 -0
- data/generated/google/apis/cloudasset_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1/classes.rb +12 -3
- data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1beta1/classes.rb +948 -36
- data/generated/google/apis/cloudasset_v1beta1/representations.rb +241 -0
- data/generated/google/apis/cloudasset_v1beta1/service.rb +4 -4
- data/generated/google/apis/cloudasset_v1p4beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p4beta1/classes.rb +18 -19
- data/generated/google/apis/cloudasset_v1p4beta1/service.rb +10 -6
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +5 -6
- data/generated/google/apis/cloudidentity_v1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +14 -9
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +15 -6
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +4 -2
- data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/compute_alpha.rb +1 -1
- data/generated/google/apis/compute_alpha/classes.rb +535 -43
- data/generated/google/apis/compute_alpha/representations.rb +167 -0
- data/generated/google/apis/compute_alpha/service.rb +922 -172
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +107 -42
- data/generated/google/apis/compute_beta/representations.rb +20 -0
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +22 -10
- data/generated/google/apis/compute_v1/representations.rb +1 -0
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +21 -7
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +7 -1
- data/generated/google/apis/content_v2/representations.rb +1 -0
- data/generated/google/apis/content_v2/service.rb +10 -5
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +93 -7
- data/generated/google/apis/content_v2_1/representations.rb +37 -0
- data/generated/google/apis/content_v2_1/service.rb +10 -5
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +46 -0
- data/generated/google/apis/dataproc_v1/representations.rb +17 -0
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +12 -0
- data/generated/google/apis/dataproc_v1beta2/representations.rb +1 -0
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2/service.rb +14 -2
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/service.rb +28 -4
- data/generated/google/apis/documentai_v1beta2.rb +36 -0
- data/generated/google/apis/documentai_v1beta2/classes.rb +3284 -0
- data/generated/google/apis/documentai_v1beta2/representations.rb +1344 -0
- data/generated/google/apis/documentai_v1beta2/service.rb +269 -0
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/service.rb +26 -78
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/service.rb +18 -54
- data/generated/google/apis/fcm_v1.rb +1 -1
- data/generated/google/apis/fcm_v1/classes.rb +6 -0
- data/generated/google/apis/firebase_v1beta1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +7 -6
- data/generated/google/apis/firebase_v1beta1/service.rb +53 -49
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/service.rb +2 -0
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +910 -43
- data/generated/google/apis/healthcare_v1beta1/representations.rb +404 -0
- data/generated/google/apis/healthcare_v1beta1/service.rb +517 -0
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +5 -0
- data/generated/google/apis/iam_v1/service.rb +4 -0
- data/generated/google/apis/iamcredentials_v1.rb +2 -2
- data/generated/google/apis/iamcredentials_v1/service.rb +1 -1
- data/generated/google/apis/lifesciences_v2beta.rb +1 -1
- data/generated/google/apis/lifesciences_v2beta/classes.rb +10 -0
- data/generated/google/apis/lifesciences_v2beta/representations.rb +1 -0
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +56 -17
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +4 -4
- data/generated/google/apis/people_v1/service.rb +6 -5
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +6 -6
- data/generated/google/apis/run_v1alpha1.rb +1 -1
- data/generated/google/apis/run_v1alpha1/classes.rb +6 -6
- data/generated/google/apis/run_v1beta1.rb +1 -1
- data/generated/google/apis/secretmanager_v1.rb +1 -1
- data/generated/google/apis/secretmanager_v1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1.rb +1 -1
- data/generated/google/apis/securitycenter_v1/classes.rb +10 -10
- data/generated/google/apis/securitycenter_v1/service.rb +10 -10
- data/generated/google/apis/securitycenter_v1p1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +10 -10
- data/generated/google/apis/securitycenter_v1p1beta1/service.rb +10 -10
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +21 -2
- data/generated/google/apis/serviceconsumermanagement_v1/representations.rb +1 -0
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +21 -2
- data/generated/google/apis/serviceconsumermanagement_v1beta1/representations.rb +1 -0
- data/generated/google/apis/servicemanagement_v1.rb +1 -1
- data/generated/google/apis/servicemanagement_v1/classes.rb +117 -37
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +13 -2
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +13 -2
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +27 -2
- data/generated/google/apis/serviceusage_v1/representations.rb +2 -0
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +72 -2
- data/generated/google/apis/serviceusage_v1beta1/representations.rb +30 -0
- data/generated/google/apis/serviceusage_v1beta1/service.rb +37 -0
- data/generated/google/apis/slides_v1.rb +1 -1
- data/generated/google/apis/slides_v1/classes.rb +4 -0
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +18 -0
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +18 -0
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +18 -0
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +38 -0
- data/generated/google/apis/youtube_v3/representations.rb +27 -0
- data/generated/google/apis/youtube_v3/service.rb +32 -0
- data/lib/google/apis/version.rb +1 -1
- metadata +7 -7
- data/generated/google/apis/customsearch_v1.rb +0 -31
- data/generated/google/apis/customsearch_v1/classes.rb +0 -1606
- data/generated/google/apis/customsearch_v1/representations.rb +0 -372
- data/generated/google/apis/customsearch_v1/service.rb +0 -608
@@ -1,372 +0,0 @@
|
|
1
|
-
# Copyright 2015 Google Inc.
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
require 'date'
|
16
|
-
require 'google/apis/core/base_service'
|
17
|
-
require 'google/apis/core/json_representation'
|
18
|
-
require 'google/apis/core/hashable'
|
19
|
-
require 'google/apis/errors'
|
20
|
-
|
21
|
-
module Google
|
22
|
-
module Apis
|
23
|
-
module CustomsearchV1
|
24
|
-
|
25
|
-
class Promotion
|
26
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
27
|
-
|
28
|
-
class BodyLine
|
29
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
30
|
-
|
31
|
-
include Google::Apis::Core::JsonObjectSupport
|
32
|
-
end
|
33
|
-
|
34
|
-
class Image
|
35
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
36
|
-
|
37
|
-
include Google::Apis::Core::JsonObjectSupport
|
38
|
-
end
|
39
|
-
|
40
|
-
include Google::Apis::Core::JsonObjectSupport
|
41
|
-
end
|
42
|
-
|
43
|
-
class Result
|
44
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
45
|
-
|
46
|
-
class Image
|
47
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
48
|
-
|
49
|
-
include Google::Apis::Core::JsonObjectSupport
|
50
|
-
end
|
51
|
-
|
52
|
-
class Label
|
53
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
54
|
-
|
55
|
-
include Google::Apis::Core::JsonObjectSupport
|
56
|
-
end
|
57
|
-
|
58
|
-
include Google::Apis::Core::JsonObjectSupport
|
59
|
-
end
|
60
|
-
|
61
|
-
class Search
|
62
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
63
|
-
|
64
|
-
class Queries
|
65
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
66
|
-
|
67
|
-
class NextPage
|
68
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
69
|
-
|
70
|
-
include Google::Apis::Core::JsonObjectSupport
|
71
|
-
end
|
72
|
-
|
73
|
-
class PreviousPage
|
74
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
75
|
-
|
76
|
-
include Google::Apis::Core::JsonObjectSupport
|
77
|
-
end
|
78
|
-
|
79
|
-
class Request
|
80
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
81
|
-
|
82
|
-
include Google::Apis::Core::JsonObjectSupport
|
83
|
-
end
|
84
|
-
|
85
|
-
include Google::Apis::Core::JsonObjectSupport
|
86
|
-
end
|
87
|
-
|
88
|
-
class SearchInformation
|
89
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
90
|
-
|
91
|
-
include Google::Apis::Core::JsonObjectSupport
|
92
|
-
end
|
93
|
-
|
94
|
-
class Spelling
|
95
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
96
|
-
|
97
|
-
include Google::Apis::Core::JsonObjectSupport
|
98
|
-
end
|
99
|
-
|
100
|
-
class Url
|
101
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
102
|
-
|
103
|
-
include Google::Apis::Core::JsonObjectSupport
|
104
|
-
end
|
105
|
-
|
106
|
-
include Google::Apis::Core::JsonObjectSupport
|
107
|
-
end
|
108
|
-
|
109
|
-
class Promotion
|
110
|
-
# @private
|
111
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
112
|
-
collection :body_lines, as: 'bodyLines', class: Google::Apis::CustomsearchV1::Promotion::BodyLine, decorator: Google::Apis::CustomsearchV1::Promotion::BodyLine::Representation
|
113
|
-
|
114
|
-
property :display_link, as: 'displayLink'
|
115
|
-
property :html_title, as: 'htmlTitle'
|
116
|
-
property :image, as: 'image', class: Google::Apis::CustomsearchV1::Promotion::Image, decorator: Google::Apis::CustomsearchV1::Promotion::Image::Representation
|
117
|
-
|
118
|
-
property :link, as: 'link'
|
119
|
-
property :title, as: 'title'
|
120
|
-
end
|
121
|
-
|
122
|
-
class BodyLine
|
123
|
-
# @private
|
124
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
125
|
-
property :html_title, as: 'htmlTitle'
|
126
|
-
property :link, as: 'link'
|
127
|
-
property :title, as: 'title'
|
128
|
-
property :url, as: 'url'
|
129
|
-
end
|
130
|
-
end
|
131
|
-
|
132
|
-
class Image
|
133
|
-
# @private
|
134
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
135
|
-
property :height, as: 'height'
|
136
|
-
property :source, as: 'source'
|
137
|
-
property :width, as: 'width'
|
138
|
-
end
|
139
|
-
end
|
140
|
-
end
|
141
|
-
|
142
|
-
class Result
|
143
|
-
# @private
|
144
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
145
|
-
property :cache_id, as: 'cacheId'
|
146
|
-
property :display_link, as: 'displayLink'
|
147
|
-
property :file_format, as: 'fileFormat'
|
148
|
-
property :formatted_url, as: 'formattedUrl'
|
149
|
-
property :html_formatted_url, as: 'htmlFormattedUrl'
|
150
|
-
property :html_snippet, as: 'htmlSnippet'
|
151
|
-
property :html_title, as: 'htmlTitle'
|
152
|
-
property :image, as: 'image', class: Google::Apis::CustomsearchV1::Result::Image, decorator: Google::Apis::CustomsearchV1::Result::Image::Representation
|
153
|
-
|
154
|
-
property :kind, as: 'kind'
|
155
|
-
collection :labels, as: 'labels', class: Google::Apis::CustomsearchV1::Result::Label, decorator: Google::Apis::CustomsearchV1::Result::Label::Representation
|
156
|
-
|
157
|
-
property :link, as: 'link'
|
158
|
-
property :mime, as: 'mime'
|
159
|
-
hash :pagemap, as: 'pagemap'
|
160
|
-
property :snippet, as: 'snippet'
|
161
|
-
property :title, as: 'title'
|
162
|
-
end
|
163
|
-
|
164
|
-
class Image
|
165
|
-
# @private
|
166
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
167
|
-
property :byte_size, as: 'byteSize'
|
168
|
-
property :context_link, as: 'contextLink'
|
169
|
-
property :height, as: 'height'
|
170
|
-
property :thumbnail_height, as: 'thumbnailHeight'
|
171
|
-
property :thumbnail_link, as: 'thumbnailLink'
|
172
|
-
property :thumbnail_width, as: 'thumbnailWidth'
|
173
|
-
property :width, as: 'width'
|
174
|
-
end
|
175
|
-
end
|
176
|
-
|
177
|
-
class Label
|
178
|
-
# @private
|
179
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
180
|
-
property :display_name, as: 'displayName'
|
181
|
-
property :label_with_op, as: 'label_with_op'
|
182
|
-
property :name, as: 'name'
|
183
|
-
end
|
184
|
-
end
|
185
|
-
end
|
186
|
-
|
187
|
-
class Search
|
188
|
-
# @private
|
189
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
190
|
-
hash :context, as: 'context'
|
191
|
-
collection :items, as: 'items', class: Google::Apis::CustomsearchV1::Result, decorator: Google::Apis::CustomsearchV1::Result::Representation
|
192
|
-
|
193
|
-
property :kind, as: 'kind'
|
194
|
-
collection :promotions, as: 'promotions', class: Google::Apis::CustomsearchV1::Promotion, decorator: Google::Apis::CustomsearchV1::Promotion::Representation
|
195
|
-
|
196
|
-
property :queries, as: 'queries', class: Google::Apis::CustomsearchV1::Search::Queries, decorator: Google::Apis::CustomsearchV1::Search::Queries::Representation
|
197
|
-
|
198
|
-
property :search_information, as: 'searchInformation', class: Google::Apis::CustomsearchV1::Search::SearchInformation, decorator: Google::Apis::CustomsearchV1::Search::SearchInformation::Representation
|
199
|
-
|
200
|
-
property :spelling, as: 'spelling', class: Google::Apis::CustomsearchV1::Search::Spelling, decorator: Google::Apis::CustomsearchV1::Search::Spelling::Representation
|
201
|
-
|
202
|
-
property :url, as: 'url', class: Google::Apis::CustomsearchV1::Search::Url, decorator: Google::Apis::CustomsearchV1::Search::Url::Representation
|
203
|
-
|
204
|
-
end
|
205
|
-
|
206
|
-
class Queries
|
207
|
-
# @private
|
208
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
209
|
-
collection :next_page, as: 'nextPage', class: Google::Apis::CustomsearchV1::Search::Queries::NextPage, decorator: Google::Apis::CustomsearchV1::Search::Queries::NextPage::Representation
|
210
|
-
|
211
|
-
collection :previous_page, as: 'previousPage', class: Google::Apis::CustomsearchV1::Search::Queries::PreviousPage, decorator: Google::Apis::CustomsearchV1::Search::Queries::PreviousPage::Representation
|
212
|
-
|
213
|
-
collection :request, as: 'request', class: Google::Apis::CustomsearchV1::Search::Queries::Request, decorator: Google::Apis::CustomsearchV1::Search::Queries::Request::Representation
|
214
|
-
|
215
|
-
end
|
216
|
-
|
217
|
-
class NextPage
|
218
|
-
# @private
|
219
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
220
|
-
property :count, as: 'count'
|
221
|
-
property :cr, as: 'cr'
|
222
|
-
property :cx, as: 'cx'
|
223
|
-
property :date_restrict, as: 'dateRestrict'
|
224
|
-
property :disable_cn_tw_translation, as: 'disableCnTwTranslation'
|
225
|
-
property :exact_terms, as: 'exactTerms'
|
226
|
-
property :exclude_terms, as: 'excludeTerms'
|
227
|
-
property :file_type, as: 'fileType'
|
228
|
-
property :filter, as: 'filter'
|
229
|
-
property :gl, as: 'gl'
|
230
|
-
property :google_host, as: 'googleHost'
|
231
|
-
property :high_range, as: 'highRange'
|
232
|
-
property :hl, as: 'hl'
|
233
|
-
property :hq, as: 'hq'
|
234
|
-
property :img_color_type, as: 'imgColorType'
|
235
|
-
property :img_dominant_color, as: 'imgDominantColor'
|
236
|
-
property :img_size, as: 'imgSize'
|
237
|
-
property :img_type, as: 'imgType'
|
238
|
-
property :input_encoding, as: 'inputEncoding'
|
239
|
-
property :language, as: 'language'
|
240
|
-
property :link_site, as: 'linkSite'
|
241
|
-
property :low_range, as: 'lowRange'
|
242
|
-
property :or_terms, as: 'orTerms'
|
243
|
-
property :output_encoding, as: 'outputEncoding'
|
244
|
-
property :related_site, as: 'relatedSite'
|
245
|
-
property :rights, as: 'rights'
|
246
|
-
property :safe, as: 'safe'
|
247
|
-
property :search_terms, as: 'searchTerms'
|
248
|
-
property :search_type, as: 'searchType'
|
249
|
-
property :site_search, as: 'siteSearch'
|
250
|
-
property :site_search_filter, as: 'siteSearchFilter'
|
251
|
-
property :sort, as: 'sort'
|
252
|
-
property :start_index, as: 'startIndex'
|
253
|
-
property :start_page, as: 'startPage'
|
254
|
-
property :title, as: 'title'
|
255
|
-
property :total_results, :numeric_string => true, as: 'totalResults'
|
256
|
-
end
|
257
|
-
end
|
258
|
-
|
259
|
-
class PreviousPage
|
260
|
-
# @private
|
261
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
262
|
-
property :count, as: 'count'
|
263
|
-
property :cr, as: 'cr'
|
264
|
-
property :cx, as: 'cx'
|
265
|
-
property :date_restrict, as: 'dateRestrict'
|
266
|
-
property :disable_cn_tw_translation, as: 'disableCnTwTranslation'
|
267
|
-
property :exact_terms, as: 'exactTerms'
|
268
|
-
property :exclude_terms, as: 'excludeTerms'
|
269
|
-
property :file_type, as: 'fileType'
|
270
|
-
property :filter, as: 'filter'
|
271
|
-
property :gl, as: 'gl'
|
272
|
-
property :google_host, as: 'googleHost'
|
273
|
-
property :high_range, as: 'highRange'
|
274
|
-
property :hl, as: 'hl'
|
275
|
-
property :hq, as: 'hq'
|
276
|
-
property :img_color_type, as: 'imgColorType'
|
277
|
-
property :img_dominant_color, as: 'imgDominantColor'
|
278
|
-
property :img_size, as: 'imgSize'
|
279
|
-
property :img_type, as: 'imgType'
|
280
|
-
property :input_encoding, as: 'inputEncoding'
|
281
|
-
property :language, as: 'language'
|
282
|
-
property :link_site, as: 'linkSite'
|
283
|
-
property :low_range, as: 'lowRange'
|
284
|
-
property :or_terms, as: 'orTerms'
|
285
|
-
property :output_encoding, as: 'outputEncoding'
|
286
|
-
property :related_site, as: 'relatedSite'
|
287
|
-
property :rights, as: 'rights'
|
288
|
-
property :safe, as: 'safe'
|
289
|
-
property :search_terms, as: 'searchTerms'
|
290
|
-
property :search_type, as: 'searchType'
|
291
|
-
property :site_search, as: 'siteSearch'
|
292
|
-
property :site_search_filter, as: 'siteSearchFilter'
|
293
|
-
property :sort, as: 'sort'
|
294
|
-
property :start_index, as: 'startIndex'
|
295
|
-
property :start_page, as: 'startPage'
|
296
|
-
property :title, as: 'title'
|
297
|
-
property :total_results, :numeric_string => true, as: 'totalResults'
|
298
|
-
end
|
299
|
-
end
|
300
|
-
|
301
|
-
class Request
|
302
|
-
# @private
|
303
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
304
|
-
property :count, as: 'count'
|
305
|
-
property :cr, as: 'cr'
|
306
|
-
property :cx, as: 'cx'
|
307
|
-
property :date_restrict, as: 'dateRestrict'
|
308
|
-
property :disable_cn_tw_translation, as: 'disableCnTwTranslation'
|
309
|
-
property :exact_terms, as: 'exactTerms'
|
310
|
-
property :exclude_terms, as: 'excludeTerms'
|
311
|
-
property :file_type, as: 'fileType'
|
312
|
-
property :filter, as: 'filter'
|
313
|
-
property :gl, as: 'gl'
|
314
|
-
property :google_host, as: 'googleHost'
|
315
|
-
property :high_range, as: 'highRange'
|
316
|
-
property :hl, as: 'hl'
|
317
|
-
property :hq, as: 'hq'
|
318
|
-
property :img_color_type, as: 'imgColorType'
|
319
|
-
property :img_dominant_color, as: 'imgDominantColor'
|
320
|
-
property :img_size, as: 'imgSize'
|
321
|
-
property :img_type, as: 'imgType'
|
322
|
-
property :input_encoding, as: 'inputEncoding'
|
323
|
-
property :language, as: 'language'
|
324
|
-
property :link_site, as: 'linkSite'
|
325
|
-
property :low_range, as: 'lowRange'
|
326
|
-
property :or_terms, as: 'orTerms'
|
327
|
-
property :output_encoding, as: 'outputEncoding'
|
328
|
-
property :related_site, as: 'relatedSite'
|
329
|
-
property :rights, as: 'rights'
|
330
|
-
property :safe, as: 'safe'
|
331
|
-
property :search_terms, as: 'searchTerms'
|
332
|
-
property :search_type, as: 'searchType'
|
333
|
-
property :site_search, as: 'siteSearch'
|
334
|
-
property :site_search_filter, as: 'siteSearchFilter'
|
335
|
-
property :sort, as: 'sort'
|
336
|
-
property :start_index, as: 'startIndex'
|
337
|
-
property :start_page, as: 'startPage'
|
338
|
-
property :title, as: 'title'
|
339
|
-
property :total_results, :numeric_string => true, as: 'totalResults'
|
340
|
-
end
|
341
|
-
end
|
342
|
-
end
|
343
|
-
|
344
|
-
class SearchInformation
|
345
|
-
# @private
|
346
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
347
|
-
property :formatted_search_time, as: 'formattedSearchTime'
|
348
|
-
property :formatted_total_results, as: 'formattedTotalResults'
|
349
|
-
property :search_time, as: 'searchTime'
|
350
|
-
property :total_results, as: 'totalResults'
|
351
|
-
end
|
352
|
-
end
|
353
|
-
|
354
|
-
class Spelling
|
355
|
-
# @private
|
356
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
357
|
-
property :corrected_query, as: 'correctedQuery'
|
358
|
-
property :html_corrected_query, as: 'htmlCorrectedQuery'
|
359
|
-
end
|
360
|
-
end
|
361
|
-
|
362
|
-
class Url
|
363
|
-
# @private
|
364
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
365
|
-
property :template, as: 'template'
|
366
|
-
property :type, as: 'type'
|
367
|
-
end
|
368
|
-
end
|
369
|
-
end
|
370
|
-
end
|
371
|
-
end
|
372
|
-
end
|
@@ -1,608 +0,0 @@
|
|
1
|
-
# Copyright 2015 Google Inc.
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
require 'google/apis/core/base_service'
|
16
|
-
require 'google/apis/core/json_representation'
|
17
|
-
require 'google/apis/core/hashable'
|
18
|
-
require 'google/apis/errors'
|
19
|
-
|
20
|
-
module Google
|
21
|
-
module Apis
|
22
|
-
module CustomsearchV1
|
23
|
-
# Custom Search API
|
24
|
-
#
|
25
|
-
# Searches over a website or collection of websites
|
26
|
-
#
|
27
|
-
# @example
|
28
|
-
# require 'google/apis/customsearch_v1'
|
29
|
-
#
|
30
|
-
# Customsearch = Google::Apis::CustomsearchV1 # Alias the module
|
31
|
-
# service = Customsearch::CustomsearchService.new
|
32
|
-
#
|
33
|
-
# @see https://developers.google.com/custom-search/v1/introduction
|
34
|
-
class CustomsearchService < Google::Apis::Core::BaseService
|
35
|
-
# @return [String]
|
36
|
-
# API key. Your API key identifies your project and provides you with API access,
|
37
|
-
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
38
|
-
attr_accessor :key
|
39
|
-
|
40
|
-
# @return [String]
|
41
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
42
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
43
|
-
attr_accessor :quota_user
|
44
|
-
|
45
|
-
def initialize
|
46
|
-
super('https://customsearch.googleapis.com/', '')
|
47
|
-
@batch_path = 'batch'
|
48
|
-
end
|
49
|
-
|
50
|
-
# Returns metadata about the search performed, metadata about the custom
|
51
|
-
# search engine used for the search, and the search results.
|
52
|
-
# @param [String] c2coff
|
53
|
-
# Enables or disables [Simplified and Traditional Chinese
|
54
|
-
# Search](https://developers.google.com/custom-search/docs/xml_results#
|
55
|
-
# chineseSearch).
|
56
|
-
# The default value for this parameter is 0 (zero), meaning that the feature
|
57
|
-
# is enabled. Supported values are:
|
58
|
-
# * `1`: Disabled
|
59
|
-
# * `0`: Enabled (default)
|
60
|
-
# @param [String] cr
|
61
|
-
# Restricts search results to documents originating in a particular country.
|
62
|
-
# You may use [Boolean
|
63
|
-
# operators](https://developers.google.com/custom-search/docs/
|
64
|
-
# xml_results_appendices#booleanOperators)
|
65
|
-
# in the cr parameter's value.
|
66
|
-
# Google Search determines the country of a document by analyzing:
|
67
|
-
# * the top-level domain (TLD) of the document's URL
|
68
|
-
# * the geographic location of the Web server's IP address
|
69
|
-
# See the [Country Parameter
|
70
|
-
# Values](https://developers.google.com/custom-search/docs/
|
71
|
-
# xml_results_appendices#countryCollections)
|
72
|
-
# page for a list of valid values for this parameter.
|
73
|
-
# @param [String] cx
|
74
|
-
# The custom search engine ID to use for this request.
|
75
|
-
# @param [String] date_restrict
|
76
|
-
# Restricts results to URLs based on date. Supported values include:
|
77
|
-
# * `d[number]`: requests results from the specified number of past days.
|
78
|
-
# * `w[number]`: requests results from the specified number of past weeks.
|
79
|
-
# * `m[number]`: requests results from the specified number of past months.
|
80
|
-
# * `y[number]`: requests results from the specified number of past years.
|
81
|
-
# @param [String] exact_terms
|
82
|
-
# Identifies a phrase that all documents in the search results must contain.
|
83
|
-
# @param [String] exclude_terms
|
84
|
-
# Identifies a word or phrase that should not appear in any documents in the
|
85
|
-
# search results.
|
86
|
-
# @param [String] file_type
|
87
|
-
# Restricts results to files of a specified extension. A list of file types
|
88
|
-
# indexable by Google can be found in Search Console [Help
|
89
|
-
# Center](https://support.google.com/webmasters/answer/35287).
|
90
|
-
# @param [String] filter
|
91
|
-
# Controls turning on or off the duplicate content filter.
|
92
|
-
# * See [Automatic
|
93
|
-
# Filtering](https://developers.google.com/custom-search/docs/xml_results#
|
94
|
-
# automaticFiltering)
|
95
|
-
# for more information about Google's search results filters. Note that host
|
96
|
-
# crowding filtering applies only to multi-site searches.
|
97
|
-
# * By default, Google applies filtering to all search results to improve the
|
98
|
-
# quality of those results.
|
99
|
-
# Acceptable values are:
|
100
|
-
# * `0`: Turns off duplicate content filter.
|
101
|
-
# * `1`: Turns on duplicate content filter.
|
102
|
-
# @param [String] gl
|
103
|
-
# Geolocation of end user.
|
104
|
-
# * The `gl` parameter value is a two-letter country code. The `gl` parameter
|
105
|
-
# boosts search results whose country of origin matches the parameter value.
|
106
|
-
# See the [Country
|
107
|
-
# Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#
|
108
|
-
# countryCodes)
|
109
|
-
# page for a list of valid values.
|
110
|
-
# * Specifying a `gl` parameter value should lead to more relevant results.
|
111
|
-
# This is particularly true for international customers and, even more
|
112
|
-
# specifically, for customers in English- speaking countries other than the
|
113
|
-
# United States.
|
114
|
-
# @param [String] googlehost
|
115
|
-
# **Deprecated**. Use the `gl` parameter for a similar effect.
|
116
|
-
# The local Google domain (for example, google.com, google.de, or
|
117
|
-
# google.fr) to use to perform the search.
|
118
|
-
# @param [String] high_range
|
119
|
-
# Specifies the ending value for a search range.
|
120
|
-
# * Use `lowRange` and `highRange` to append an inclusive search range of
|
121
|
-
# `lowRange...highRange` to the query.
|
122
|
-
# @param [String] hl
|
123
|
-
# Sets the user interface language.
|
124
|
-
# * Explicitly setting this parameter improves the performance and the
|
125
|
-
# quality of your search results.
|
126
|
-
# * See the [Interface
|
127
|
-
# Languages](https://developers.google.com/custom-search/docs/xml_results#
|
128
|
-
# wsInterfaceLanguages)
|
129
|
-
# section of [Internationalizing Queries and Results
|
130
|
-
# Presentation](https://developers.google.com/custom-search/docs/xml_results#
|
131
|
-
# wsInternationalizing)
|
132
|
-
# for more information, and (Supported Interface
|
133
|
-
# Languages)[https://developers.google.com/custom-search/docs/
|
134
|
-
# xml_results_appendices#interfaceLanguages]
|
135
|
-
# for a list of supported languages.
|
136
|
-
# @param [String] hq
|
137
|
-
# Appends the specified query terms to the query, as if they were combined
|
138
|
-
# with a logical AND operator.
|
139
|
-
# @param [String] img_color_type
|
140
|
-
# Returns black and white, grayscale, transparent, or color images.
|
141
|
-
# Acceptable values are:
|
142
|
-
# * `"color"`
|
143
|
-
# * `"gray"`
|
144
|
-
# * `"mono"`: black and white
|
145
|
-
# * `"trans"`: transparent background
|
146
|
-
# @param [String] img_dominant_color
|
147
|
-
# Returns images of a specific dominant color. Acceptable values are:
|
148
|
-
# * `"black"`
|
149
|
-
# * `"blue"`
|
150
|
-
# * `"brown"`
|
151
|
-
# * `"gray"`
|
152
|
-
# * `"green"`
|
153
|
-
# * `"orange"`
|
154
|
-
# * `"pink"`
|
155
|
-
# * `"purple"`
|
156
|
-
# * `"red"`
|
157
|
-
# * `"teal"`
|
158
|
-
# * `"white"`
|
159
|
-
# * `"yellow"`
|
160
|
-
# @param [String] img_size
|
161
|
-
# Returns images of a specified size. Acceptable values are:
|
162
|
-
# * `"huge"`
|
163
|
-
# * `"icon"`
|
164
|
-
# * `"large"`
|
165
|
-
# * `"medium"`
|
166
|
-
# * `"small"`
|
167
|
-
# * `"xlarge"`
|
168
|
-
# * `"xxlarge"`
|
169
|
-
# @param [String] img_type
|
170
|
-
# Returns images of a type. Acceptable values are:
|
171
|
-
# * `"clipart"`
|
172
|
-
# * `"face"`
|
173
|
-
# * `"lineart"`
|
174
|
-
# * `"stock"`
|
175
|
-
# * `"photo"`
|
176
|
-
# * `"animated"`
|
177
|
-
# @param [String] link_site
|
178
|
-
# Specifies that all search results should contain a link to a particular
|
179
|
-
# URL.
|
180
|
-
# @param [String] low_range
|
181
|
-
# Specifies the starting value for a search range. Use `lowRange` and
|
182
|
-
# `highRange` to append an inclusive search range of `lowRange...highRange`
|
183
|
-
# to the query.
|
184
|
-
# @param [String] lr
|
185
|
-
# Restricts the search to documents written in a particular language (e.g.,
|
186
|
-
# `lr=lang_ja`).
|
187
|
-
# Acceptable values are:
|
188
|
-
# * `"lang_ar"`: Arabic
|
189
|
-
# * `"lang_bg"`: Bulgarian
|
190
|
-
# * `"lang_ca"`: Catalan
|
191
|
-
# * `"lang_cs"`: Czech
|
192
|
-
# * `"lang_da"`: Danish
|
193
|
-
# * `"lang_de"`: German
|
194
|
-
# * `"lang_el"`: Greek
|
195
|
-
# * `"lang_en"`: English
|
196
|
-
# * `"lang_es"`: Spanish
|
197
|
-
# * `"lang_et"`: Estonian
|
198
|
-
# * `"lang_fi"`: Finnish
|
199
|
-
# * `"lang_fr"`: French
|
200
|
-
# * `"lang_hr"`: Croatian
|
201
|
-
# * `"lang_hu"`: Hungarian
|
202
|
-
# * `"lang_id"`: Indonesian
|
203
|
-
# * `"lang_is"`: Icelandic
|
204
|
-
# * `"lang_it"`: Italian
|
205
|
-
# * `"lang_iw"`: Hebrew
|
206
|
-
# * `"lang_ja"`: Japanese
|
207
|
-
# * `"lang_ko"`: Korean
|
208
|
-
# * `"lang_lt"`: Lithuanian
|
209
|
-
# * `"lang_lv"`: Latvian
|
210
|
-
# * `"lang_nl"`: Dutch
|
211
|
-
# * `"lang_no"`: Norwegian
|
212
|
-
# * `"lang_pl"`: Polish
|
213
|
-
# * `"lang_pt"`: Portuguese
|
214
|
-
# * `"lang_ro"`: Romanian
|
215
|
-
# * `"lang_ru"`: Russian
|
216
|
-
# * `"lang_sk"`: Slovak
|
217
|
-
# * `"lang_sl"`: Slovenian
|
218
|
-
# * `"lang_sr"`: Serbian
|
219
|
-
# * `"lang_sv"`: Swedish
|
220
|
-
# * `"lang_tr"`: Turkish
|
221
|
-
# * `"lang_zh-CN"`: Chinese (Simplified)
|
222
|
-
# * `"lang_zh-TW"`: Chinese (Traditional)
|
223
|
-
# @param [Fixnum] num
|
224
|
-
# Number of search results to return.
|
225
|
-
# * Valid values are integers between 1 and 10, inclusive.
|
226
|
-
# @param [String] or_terms
|
227
|
-
# Provides additional search terms to check for in a document, where each
|
228
|
-
# document in the search results must contain at least one of the additional
|
229
|
-
# search terms.
|
230
|
-
# @param [String] q
|
231
|
-
# Query
|
232
|
-
# @param [String] related_site
|
233
|
-
# Specifies that all search results should be pages that are related to the
|
234
|
-
# specified URL.
|
235
|
-
# @param [String] rights
|
236
|
-
# Filters based on licensing. Supported values include: `cc_publicdomain`,
|
237
|
-
# `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and
|
238
|
-
# combinations of these. See [typical
|
239
|
-
# combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
|
240
|
-
# @param [String] safe
|
241
|
-
# Search safety level. Acceptable values are:
|
242
|
-
# * `"active"`: Enables SafeSearch filtering.
|
243
|
-
# * `"off"`: Disables SafeSearch filtering. (default)
|
244
|
-
# @param [String] search_type
|
245
|
-
# Specifies the search type: `image`. If unspecified, results are limited to
|
246
|
-
# webpages.
|
247
|
-
# Acceptable values are:
|
248
|
-
# * `"image"`: custom image search.
|
249
|
-
# @param [String] site_search
|
250
|
-
# Specifies a given site which should always be included or excluded from
|
251
|
-
# results (see `siteSearchFilter` parameter, below).
|
252
|
-
# @param [String] site_search_filter
|
253
|
-
# Controls whether to include or exclude results from the site named in the
|
254
|
-
# `siteSearch` parameter.
|
255
|
-
# Acceptable values are:
|
256
|
-
# * `"e"`: exclude
|
257
|
-
# * `"i"`: include
|
258
|
-
# @param [String] sort
|
259
|
-
# The sort expression to apply to the results.
|
260
|
-
# @param [Fixnum] start
|
261
|
-
# The index of the first result to return. The default number of results per
|
262
|
-
# page is 10, so `&start=11` would start at the top of the second page of
|
263
|
-
# results. **Note**: The JSON API will never return more than 100 results,
|
264
|
-
# even if more than 100 documents match the query, so setting the sum of
|
265
|
-
# `start + num` to a number greater than 100 will produce an error. Also note
|
266
|
-
# that the maximum value for `num` is 10.
|
267
|
-
# @param [String] fields
|
268
|
-
# Selector specifying which fields to include in a partial response.
|
269
|
-
# @param [String] quota_user
|
270
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
271
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
272
|
-
# @param [Google::Apis::RequestOptions] options
|
273
|
-
# Request-specific options
|
274
|
-
#
|
275
|
-
# @yield [result, err] Result & error if block supplied
|
276
|
-
# @yieldparam result [Google::Apis::CustomsearchV1::Search] parsed result object
|
277
|
-
# @yieldparam err [StandardError] error object if request failed
|
278
|
-
#
|
279
|
-
# @return [Google::Apis::CustomsearchV1::Search]
|
280
|
-
#
|
281
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
282
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
283
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
284
|
-
def list_cses(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
|
285
|
-
command = make_simple_command(:get, 'customsearch/v1', options)
|
286
|
-
command.response_representation = Google::Apis::CustomsearchV1::Search::Representation
|
287
|
-
command.response_class = Google::Apis::CustomsearchV1::Search
|
288
|
-
command.query['c2coff'] = c2coff unless c2coff.nil?
|
289
|
-
command.query['cr'] = cr unless cr.nil?
|
290
|
-
command.query['cx'] = cx unless cx.nil?
|
291
|
-
command.query['dateRestrict'] = date_restrict unless date_restrict.nil?
|
292
|
-
command.query['exactTerms'] = exact_terms unless exact_terms.nil?
|
293
|
-
command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil?
|
294
|
-
command.query['fileType'] = file_type unless file_type.nil?
|
295
|
-
command.query['filter'] = filter unless filter.nil?
|
296
|
-
command.query['gl'] = gl unless gl.nil?
|
297
|
-
command.query['googlehost'] = googlehost unless googlehost.nil?
|
298
|
-
command.query['highRange'] = high_range unless high_range.nil?
|
299
|
-
command.query['hl'] = hl unless hl.nil?
|
300
|
-
command.query['hq'] = hq unless hq.nil?
|
301
|
-
command.query['imgColorType'] = img_color_type unless img_color_type.nil?
|
302
|
-
command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil?
|
303
|
-
command.query['imgSize'] = img_size unless img_size.nil?
|
304
|
-
command.query['imgType'] = img_type unless img_type.nil?
|
305
|
-
command.query['linkSite'] = link_site unless link_site.nil?
|
306
|
-
command.query['lowRange'] = low_range unless low_range.nil?
|
307
|
-
command.query['lr'] = lr unless lr.nil?
|
308
|
-
command.query['num'] = num unless num.nil?
|
309
|
-
command.query['orTerms'] = or_terms unless or_terms.nil?
|
310
|
-
command.query['q'] = q unless q.nil?
|
311
|
-
command.query['relatedSite'] = related_site unless related_site.nil?
|
312
|
-
command.query['rights'] = rights unless rights.nil?
|
313
|
-
command.query['safe'] = safe unless safe.nil?
|
314
|
-
command.query['searchType'] = search_type unless search_type.nil?
|
315
|
-
command.query['siteSearch'] = site_search unless site_search.nil?
|
316
|
-
command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil?
|
317
|
-
command.query['sort'] = sort unless sort.nil?
|
318
|
-
command.query['start'] = start unless start.nil?
|
319
|
-
command.query['fields'] = fields unless fields.nil?
|
320
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
321
|
-
execute_or_queue_command(command, &block)
|
322
|
-
end
|
323
|
-
|
324
|
-
# Returns metadata about the search performed, metadata about the custom
|
325
|
-
# search engine used for the search, and the search results. Uses a small set
|
326
|
-
# of url patterns.
|
327
|
-
# @param [String] c2coff
|
328
|
-
# Enables or disables [Simplified and Traditional Chinese
|
329
|
-
# Search](https://developers.google.com/custom-search/docs/xml_results#
|
330
|
-
# chineseSearch).
|
331
|
-
# The default value for this parameter is 0 (zero), meaning that the feature
|
332
|
-
# is enabled. Supported values are:
|
333
|
-
# * `1`: Disabled
|
334
|
-
# * `0`: Enabled (default)
|
335
|
-
# @param [String] cr
|
336
|
-
# Restricts search results to documents originating in a particular country.
|
337
|
-
# You may use [Boolean
|
338
|
-
# operators](https://developers.google.com/custom-search/docs/
|
339
|
-
# xml_results_appendices#booleanOperators)
|
340
|
-
# in the cr parameter's value.
|
341
|
-
# Google Search determines the country of a document by analyzing:
|
342
|
-
# * the top-level domain (TLD) of the document's URL
|
343
|
-
# * the geographic location of the Web server's IP address
|
344
|
-
# See the [Country Parameter
|
345
|
-
# Values](https://developers.google.com/custom-search/docs/
|
346
|
-
# xml_results_appendices#countryCollections)
|
347
|
-
# page for a list of valid values for this parameter.
|
348
|
-
# @param [String] cx
|
349
|
-
# The custom search engine ID to use for this request.
|
350
|
-
# @param [String] date_restrict
|
351
|
-
# Restricts results to URLs based on date. Supported values include:
|
352
|
-
# * `d[number]`: requests results from the specified number of past days.
|
353
|
-
# * `w[number]`: requests results from the specified number of past weeks.
|
354
|
-
# * `m[number]`: requests results from the specified number of past months.
|
355
|
-
# * `y[number]`: requests results from the specified number of past years.
|
356
|
-
# @param [String] exact_terms
|
357
|
-
# Identifies a phrase that all documents in the search results must contain.
|
358
|
-
# @param [String] exclude_terms
|
359
|
-
# Identifies a word or phrase that should not appear in any documents in the
|
360
|
-
# search results.
|
361
|
-
# @param [String] file_type
|
362
|
-
# Restricts results to files of a specified extension. A list of file types
|
363
|
-
# indexable by Google can be found in Search Console [Help
|
364
|
-
# Center](https://support.google.com/webmasters/answer/35287).
|
365
|
-
# @param [String] filter
|
366
|
-
# Controls turning on or off the duplicate content filter.
|
367
|
-
# * See [Automatic
|
368
|
-
# Filtering](https://developers.google.com/custom-search/docs/xml_results#
|
369
|
-
# automaticFiltering)
|
370
|
-
# for more information about Google's search results filters. Note that host
|
371
|
-
# crowding filtering applies only to multi-site searches.
|
372
|
-
# * By default, Google applies filtering to all search results to improve the
|
373
|
-
# quality of those results.
|
374
|
-
# Acceptable values are:
|
375
|
-
# * `0`: Turns off duplicate content filter.
|
376
|
-
# * `1`: Turns on duplicate content filter.
|
377
|
-
# @param [String] gl
|
378
|
-
# Geolocation of end user.
|
379
|
-
# * The `gl` parameter value is a two-letter country code. The `gl` parameter
|
380
|
-
# boosts search results whose country of origin matches the parameter value.
|
381
|
-
# See the [Country
|
382
|
-
# Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#
|
383
|
-
# countryCodes)
|
384
|
-
# page for a list of valid values.
|
385
|
-
# * Specifying a `gl` parameter value should lead to more relevant results.
|
386
|
-
# This is particularly true for international customers and, even more
|
387
|
-
# specifically, for customers in English- speaking countries other than the
|
388
|
-
# United States.
|
389
|
-
# @param [String] googlehost
|
390
|
-
# **Deprecated**. Use the `gl` parameter for a similar effect.
|
391
|
-
# The local Google domain (for example, google.com, google.de, or
|
392
|
-
# google.fr) to use to perform the search.
|
393
|
-
# @param [String] high_range
|
394
|
-
# Specifies the ending value for a search range.
|
395
|
-
# * Use `lowRange` and `highRange` to append an inclusive search range of
|
396
|
-
# `lowRange...highRange` to the query.
|
397
|
-
# @param [String] hl
|
398
|
-
# Sets the user interface language.
|
399
|
-
# * Explicitly setting this parameter improves the performance and the
|
400
|
-
# quality of your search results.
|
401
|
-
# * See the [Interface
|
402
|
-
# Languages](https://developers.google.com/custom-search/docs/xml_results#
|
403
|
-
# wsInterfaceLanguages)
|
404
|
-
# section of [Internationalizing Queries and Results
|
405
|
-
# Presentation](https://developers.google.com/custom-search/docs/xml_results#
|
406
|
-
# wsInternationalizing)
|
407
|
-
# for more information, and (Supported Interface
|
408
|
-
# Languages)[https://developers.google.com/custom-search/docs/
|
409
|
-
# xml_results_appendices#interfaceLanguages]
|
410
|
-
# for a list of supported languages.
|
411
|
-
# @param [String] hq
|
412
|
-
# Appends the specified query terms to the query, as if they were combined
|
413
|
-
# with a logical AND operator.
|
414
|
-
# @param [String] img_color_type
|
415
|
-
# Returns black and white, grayscale, transparent, or color images.
|
416
|
-
# Acceptable values are:
|
417
|
-
# * `"color"`
|
418
|
-
# * `"gray"`
|
419
|
-
# * `"mono"`: black and white
|
420
|
-
# * `"trans"`: transparent background
|
421
|
-
# @param [String] img_dominant_color
|
422
|
-
# Returns images of a specific dominant color. Acceptable values are:
|
423
|
-
# * `"black"`
|
424
|
-
# * `"blue"`
|
425
|
-
# * `"brown"`
|
426
|
-
# * `"gray"`
|
427
|
-
# * `"green"`
|
428
|
-
# * `"orange"`
|
429
|
-
# * `"pink"`
|
430
|
-
# * `"purple"`
|
431
|
-
# * `"red"`
|
432
|
-
# * `"teal"`
|
433
|
-
# * `"white"`
|
434
|
-
# * `"yellow"`
|
435
|
-
# @param [String] img_size
|
436
|
-
# Returns images of a specified size. Acceptable values are:
|
437
|
-
# * `"huge"`
|
438
|
-
# * `"icon"`
|
439
|
-
# * `"large"`
|
440
|
-
# * `"medium"`
|
441
|
-
# * `"small"`
|
442
|
-
# * `"xlarge"`
|
443
|
-
# * `"xxlarge"`
|
444
|
-
# @param [String] img_type
|
445
|
-
# Returns images of a type. Acceptable values are:
|
446
|
-
# * `"clipart"`
|
447
|
-
# * `"face"`
|
448
|
-
# * `"lineart"`
|
449
|
-
# * `"stock"`
|
450
|
-
# * `"photo"`
|
451
|
-
# * `"animated"`
|
452
|
-
# @param [String] link_site
|
453
|
-
# Specifies that all search results should contain a link to a particular
|
454
|
-
# URL.
|
455
|
-
# @param [String] low_range
|
456
|
-
# Specifies the starting value for a search range. Use `lowRange` and
|
457
|
-
# `highRange` to append an inclusive search range of `lowRange...highRange`
|
458
|
-
# to the query.
|
459
|
-
# @param [String] lr
|
460
|
-
# Restricts the search to documents written in a particular language (e.g.,
|
461
|
-
# `lr=lang_ja`).
|
462
|
-
# Acceptable values are:
|
463
|
-
# * `"lang_ar"`: Arabic
|
464
|
-
# * `"lang_bg"`: Bulgarian
|
465
|
-
# * `"lang_ca"`: Catalan
|
466
|
-
# * `"lang_cs"`: Czech
|
467
|
-
# * `"lang_da"`: Danish
|
468
|
-
# * `"lang_de"`: German
|
469
|
-
# * `"lang_el"`: Greek
|
470
|
-
# * `"lang_en"`: English
|
471
|
-
# * `"lang_es"`: Spanish
|
472
|
-
# * `"lang_et"`: Estonian
|
473
|
-
# * `"lang_fi"`: Finnish
|
474
|
-
# * `"lang_fr"`: French
|
475
|
-
# * `"lang_hr"`: Croatian
|
476
|
-
# * `"lang_hu"`: Hungarian
|
477
|
-
# * `"lang_id"`: Indonesian
|
478
|
-
# * `"lang_is"`: Icelandic
|
479
|
-
# * `"lang_it"`: Italian
|
480
|
-
# * `"lang_iw"`: Hebrew
|
481
|
-
# * `"lang_ja"`: Japanese
|
482
|
-
# * `"lang_ko"`: Korean
|
483
|
-
# * `"lang_lt"`: Lithuanian
|
484
|
-
# * `"lang_lv"`: Latvian
|
485
|
-
# * `"lang_nl"`: Dutch
|
486
|
-
# * `"lang_no"`: Norwegian
|
487
|
-
# * `"lang_pl"`: Polish
|
488
|
-
# * `"lang_pt"`: Portuguese
|
489
|
-
# * `"lang_ro"`: Romanian
|
490
|
-
# * `"lang_ru"`: Russian
|
491
|
-
# * `"lang_sk"`: Slovak
|
492
|
-
# * `"lang_sl"`: Slovenian
|
493
|
-
# * `"lang_sr"`: Serbian
|
494
|
-
# * `"lang_sv"`: Swedish
|
495
|
-
# * `"lang_tr"`: Turkish
|
496
|
-
# * `"lang_zh-CN"`: Chinese (Simplified)
|
497
|
-
# * `"lang_zh-TW"`: Chinese (Traditional)
|
498
|
-
# @param [Fixnum] num
|
499
|
-
# Number of search results to return.
|
500
|
-
# * Valid values are integers between 1 and 10, inclusive.
|
501
|
-
# @param [String] or_terms
|
502
|
-
# Provides additional search terms to check for in a document, where each
|
503
|
-
# document in the search results must contain at least one of the additional
|
504
|
-
# search terms.
|
505
|
-
# @param [String] q
|
506
|
-
# Query
|
507
|
-
# @param [String] related_site
|
508
|
-
# Specifies that all search results should be pages that are related to the
|
509
|
-
# specified URL.
|
510
|
-
# @param [String] rights
|
511
|
-
# Filters based on licensing. Supported values include: `cc_publicdomain`,
|
512
|
-
# `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and
|
513
|
-
# combinations of these. See [typical
|
514
|
-
# combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
|
515
|
-
# @param [String] safe
|
516
|
-
# Search safety level. Acceptable values are:
|
517
|
-
# * `"active"`: Enables SafeSearch filtering.
|
518
|
-
# * `"off"`: Disables SafeSearch filtering. (default)
|
519
|
-
# @param [String] search_type
|
520
|
-
# Specifies the search type: `image`. If unspecified, results are limited to
|
521
|
-
# webpages.
|
522
|
-
# Acceptable values are:
|
523
|
-
# * `"image"`: custom image search.
|
524
|
-
# @param [String] site_search
|
525
|
-
# Specifies a given site which should always be included or excluded from
|
526
|
-
# results (see `siteSearchFilter` parameter, below).
|
527
|
-
# @param [String] site_search_filter
|
528
|
-
# Controls whether to include or exclude results from the site named in the
|
529
|
-
# `siteSearch` parameter.
|
530
|
-
# Acceptable values are:
|
531
|
-
# * `"e"`: exclude
|
532
|
-
# * `"i"`: include
|
533
|
-
# @param [String] sort
|
534
|
-
# The sort expression to apply to the results.
|
535
|
-
# @param [Fixnum] start
|
536
|
-
# The index of the first result to return. The default number of results per
|
537
|
-
# page is 10, so `&start=11` would start at the top of the second page of
|
538
|
-
# results. **Note**: The JSON API will never return more than 100 results,
|
539
|
-
# even if more than 100 documents match the query, so setting the sum of
|
540
|
-
# `start + num` to a number greater than 100 will produce an error. Also note
|
541
|
-
# that the maximum value for `num` is 10.
|
542
|
-
# @param [String] fields
|
543
|
-
# Selector specifying which fields to include in a partial response.
|
544
|
-
# @param [String] quota_user
|
545
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
546
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
547
|
-
# @param [Google::Apis::RequestOptions] options
|
548
|
-
# Request-specific options
|
549
|
-
#
|
550
|
-
# @yield [result, err] Result & error if block supplied
|
551
|
-
# @yieldparam result [Google::Apis::CustomsearchV1::Search] parsed result object
|
552
|
-
# @yieldparam err [StandardError] error object if request failed
|
553
|
-
#
|
554
|
-
# @return [Google::Apis::CustomsearchV1::Search]
|
555
|
-
#
|
556
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
557
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
558
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
559
|
-
def list_cse_siterestricts(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
|
560
|
-
command = make_simple_command(:get, 'customsearch/v1/siterestrict', options)
|
561
|
-
command.response_representation = Google::Apis::CustomsearchV1::Search::Representation
|
562
|
-
command.response_class = Google::Apis::CustomsearchV1::Search
|
563
|
-
command.query['c2coff'] = c2coff unless c2coff.nil?
|
564
|
-
command.query['cr'] = cr unless cr.nil?
|
565
|
-
command.query['cx'] = cx unless cx.nil?
|
566
|
-
command.query['dateRestrict'] = date_restrict unless date_restrict.nil?
|
567
|
-
command.query['exactTerms'] = exact_terms unless exact_terms.nil?
|
568
|
-
command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil?
|
569
|
-
command.query['fileType'] = file_type unless file_type.nil?
|
570
|
-
command.query['filter'] = filter unless filter.nil?
|
571
|
-
command.query['gl'] = gl unless gl.nil?
|
572
|
-
command.query['googlehost'] = googlehost unless googlehost.nil?
|
573
|
-
command.query['highRange'] = high_range unless high_range.nil?
|
574
|
-
command.query['hl'] = hl unless hl.nil?
|
575
|
-
command.query['hq'] = hq unless hq.nil?
|
576
|
-
command.query['imgColorType'] = img_color_type unless img_color_type.nil?
|
577
|
-
command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil?
|
578
|
-
command.query['imgSize'] = img_size unless img_size.nil?
|
579
|
-
command.query['imgType'] = img_type unless img_type.nil?
|
580
|
-
command.query['linkSite'] = link_site unless link_site.nil?
|
581
|
-
command.query['lowRange'] = low_range unless low_range.nil?
|
582
|
-
command.query['lr'] = lr unless lr.nil?
|
583
|
-
command.query['num'] = num unless num.nil?
|
584
|
-
command.query['orTerms'] = or_terms unless or_terms.nil?
|
585
|
-
command.query['q'] = q unless q.nil?
|
586
|
-
command.query['relatedSite'] = related_site unless related_site.nil?
|
587
|
-
command.query['rights'] = rights unless rights.nil?
|
588
|
-
command.query['safe'] = safe unless safe.nil?
|
589
|
-
command.query['searchType'] = search_type unless search_type.nil?
|
590
|
-
command.query['siteSearch'] = site_search unless site_search.nil?
|
591
|
-
command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil?
|
592
|
-
command.query['sort'] = sort unless sort.nil?
|
593
|
-
command.query['start'] = start unless start.nil?
|
594
|
-
command.query['fields'] = fields unless fields.nil?
|
595
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
596
|
-
execute_or_queue_command(command, &block)
|
597
|
-
end
|
598
|
-
|
599
|
-
protected
|
600
|
-
|
601
|
-
def apply_command_defaults(command)
|
602
|
-
command.query['key'] = key unless key.nil?
|
603
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
604
|
-
end
|
605
|
-
end
|
606
|
-
end
|
607
|
-
end
|
608
|
-
end
|