1{
2 "basePath": "",
3 "baseUrl": "https://ideahub.googleapis.com/",
4 "batchPath": "batch",
5 "canonicalName": "Ideahub",
6 "description": "This is an invitation-only API.",
7 "discoveryVersion": "v1",
8 "documentationLink": "https://console.cloud.google.com/apis/library/ideahub.googleapis.com",
9 "fullyEncodeReservedExpansion": true,
10 "icons": {
11 "x16": "http://www.google.com/images/icons/product/search-16.gif",
12 "x32": "http://www.google.com/images/icons/product/search-32.gif"
13 },
14 "id": "ideahub:v1beta",
15 "kind": "discovery#restDescription",
16 "mtlsRootUrl": "https://ideahub.mtls.googleapis.com/",
17 "name": "ideahub",
18 "ownerDomain": "google.com",
19 "ownerName": "Google",
20 "parameters": {
21 "$.xgafv": {
22 "description": "V1 error format.",
23 "enum": [
24 "1",
25 "2"
26 ],
27 "enumDescriptions": [
28 "v1 error format",
29 "v2 error format"
30 ],
31 "location": "query",
32 "type": "string"
33 },
34 "access_token": {
35 "description": "OAuth access token.",
36 "location": "query",
37 "type": "string"
38 },
39 "alt": {
40 "default": "json",
41 "description": "Data format for response.",
42 "enum": [
43 "json",
44 "media",
45 "proto"
46 ],
47 "enumDescriptions": [
48 "Responses with Content-Type of application/json",
49 "Media download with context-dependent Content-Type",
50 "Responses with Content-Type of application/x-protobuf"
51 ],
52 "location": "query",
53 "type": "string"
54 },
55 "callback": {
56 "description": "JSONP",
57 "location": "query",
58 "type": "string"
59 },
60 "fields": {
61 "description": "Selector specifying which fields to include in a partial response.",
62 "location": "query",
63 "type": "string"
64 },
65 "key": {
66 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
67 "location": "query",
68 "type": "string"
69 },
70 "oauth_token": {
71 "description": "OAuth 2.0 token for the current user.",
72 "location": "query",
73 "type": "string"
74 },
75 "prettyPrint": {
76 "default": "true",
77 "description": "Returns response with indentations and line breaks.",
78 "location": "query",
79 "type": "boolean"
80 },
81 "quotaUser": {
82 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
83 "location": "query",
84 "type": "string"
85 },
86 "uploadType": {
87 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
88 "location": "query",
89 "type": "string"
90 },
91 "upload_protocol": {
92 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
93 "location": "query",
94 "type": "string"
95 }
96 },
97 "protocol": "rest",
98 "resources": {
99 "platforms": {
100 "resources": {
101 "properties": {
102 "resources": {
103 "ideaActivities": {
104 "methods": {
105 "create": {
106 "description": "Creates an idea activity entry.",
107 "flatPath": "v1beta/platforms/{platformsId}/properties/{propertiesId}/ideaActivities",
108 "httpMethod": "POST",
109 "id": "ideahub.platforms.properties.ideaActivities.create",
110 "parameterOrder": [
111 "parent"
112 ],
113 "parameters": {
114 "parent": {
115 "description": "Required. The parent resource where this idea activity will be created. Format: platforms/{platform}/property/{property}",
116 "location": "path",
117 "pattern": "^platforms/[^/]+/properties/[^/]+$",
118 "required": true,
119 "type": "string"
120 }
121 },
122 "path": "v1beta/{+parent}/ideaActivities",
123 "request": {
124 "$ref": "GoogleSearchIdeahubV1betaIdeaActivity"
125 },
126 "response": {
127 "$ref": "GoogleSearchIdeahubV1betaIdeaActivity"
128 }
129 }
130 }
131 },
132 "ideaStates": {
133 "methods": {
134 "patch": {
135 "description": "Update an idea state resource.",
136 "flatPath": "v1beta/platforms/{platformsId}/properties/{propertiesId}/ideaStates/{ideaStatesId}",
137 "httpMethod": "PATCH",
138 "id": "ideahub.platforms.properties.ideaStates.patch",
139 "parameterOrder": [
140 "name"
141 ],
142 "parameters": {
143 "name": {
144 "description": "Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}",
145 "location": "path",
146 "pattern": "^platforms/[^/]+/properties/[^/]+/ideaStates/[^/]+$",
147 "required": true,
148 "type": "string"
149 },
150 "updateMask": {
151 "description": "The list of fields to be updated.",
152 "format": "google-fieldmask",
153 "location": "query",
154 "type": "string"
155 }
156 },
157 "path": "v1beta/{+name}",
158 "request": {
159 "$ref": "GoogleSearchIdeahubV1betaIdeaState"
160 },
161 "response": {
162 "$ref": "GoogleSearchIdeahubV1betaIdeaState"
163 }
164 }
165 }
166 },
167 "ideas": {
168 "methods": {
169 "list": {
170 "description": "List ideas for a given Creator and filter and sort options.",
171 "flatPath": "v1beta/platforms/{platformsId}/properties/{propertiesId}/ideas",
172 "httpMethod": "GET",
173 "id": "ideahub.platforms.properties.ideas.list",
174 "parameterOrder": [
175 "parent"
176 ],
177 "parameters": {
178 "filter": {
179 "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions are implicitly combined, as if the `AND` operator was always used. The `OR` operator is currently unsupported. * Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas. If set to false, fetches all except saved ideas. Can't be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be simultaneously used with `saved(bool)`. The `false` value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)` The length of this field should be no more than 500 characters.",
180 "location": "query",
181 "type": "string"
182 },
183 "orderBy": {
184 "description": "Order semantics described below.",
185 "location": "query",
186 "type": "string"
187 },
188 "pageSize": {
189 "description": "The maximum number of ideas per page. If unspecified, at most 10 ideas will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.",
190 "format": "int32",
191 "location": "query",
192 "type": "integer"
193 },
194 "pageToken": {
195 "description": "Used to fetch next page.",
196 "location": "query",
197 "type": "string"
198 },
199 "parent": {
200 "description": "Required. If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}",
201 "location": "path",
202 "pattern": "^platforms/[^/]+/properties/[^/]+$",
203 "required": true,
204 "type": "string"
205 }
206 },
207 "path": "v1beta/{+parent}/ideas",
208 "response": {
209 "$ref": "GoogleSearchIdeahubV1betaListIdeasResponse"
210 }
211 }
212 }
213 },
214 "locales": {
215 "methods": {
216 "list": {
217 "description": "Returns which locales ideas are available in for a given Creator.",
218 "flatPath": "v1beta/platforms/{platformsId}/properties/{propertiesId}/locales",
219 "httpMethod": "GET",
220 "id": "ideahub.platforms.properties.locales.list",
221 "parameterOrder": [
222 "parent"
223 ],
224 "parameters": {
225 "pageSize": {
226 "description": "The maximum number of locales to return. The service may return fewer than this value. If unspecified, at most 100 locales will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
227 "format": "int32",
228 "location": "query",
229 "type": "integer"
230 },
231 "pageToken": {
232 "description": "A page token, received from a previous `ListAvailableLocales` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAvailableLocales` must match the call that provided the page token.",
233 "location": "query",
234 "type": "string"
235 },
236 "parent": {
237 "description": "Required. The web property to check idea availability for Format: platforms/{platform}/property/{property}",
238 "location": "path",
239 "pattern": "^platforms/[^/]+/properties/[^/]+$",
240 "required": true,
241 "type": "string"
242 }
243 },
244 "path": "v1beta/{+parent}/locales",
245 "response": {
246 "$ref": "GoogleSearchIdeahubV1betaListAvailableLocalesResponse"
247 }
248 }
249 }
250 },
251 "topicStates": {
252 "methods": {
253 "patch": {
254 "description": "Update a topic state resource.",
255 "flatPath": "v1beta/platforms/{platformsId}/properties/{propertiesId}/topicStates/{topicStatesId}",
256 "httpMethod": "PATCH",
257 "id": "ideahub.platforms.properties.topicStates.patch",
258 "parameterOrder": [
259 "name"
260 ],
261 "parameters": {
262 "name": {
263 "description": "Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}",
264 "location": "path",
265 "pattern": "^platforms/[^/]+/properties/[^/]+/topicStates/[^/]+$",
266 "required": true,
267 "type": "string"
268 },
269 "updateMask": {
270 "description": "The list of fields to be updated.",
271 "format": "google-fieldmask",
272 "location": "query",
273 "type": "string"
274 }
275 },
276 "path": "v1beta/{+name}",
277 "request": {
278 "$ref": "GoogleSearchIdeahubV1betaTopicState"
279 },
280 "response": {
281 "$ref": "GoogleSearchIdeahubV1betaTopicState"
282 }
283 }
284 }
285 }
286 }
287 }
288 }
289 }
290 },
291 "revision": "20211029",
292 "rootUrl": "https://ideahub.googleapis.com/",
293 "schemas": {
294 "GoogleSearchIdeahubV1betaAvailableLocale": {
295 "description": "Represents locales that are available for a web property.",
296 "id": "GoogleSearchIdeahubV1betaAvailableLocale",
297 "properties": {
298 "locale": {
299 "description": "A string in BCP 47 format, without a resource prefix.",
300 "type": "string"
301 },
302 "name": {
303 "description": "A string in BCP 47 format, prefixed with the platform and property name, and \"locales/\". Format: platforms/{platform}/properties/{property}/locales/{locale}",
304 "type": "string"
305 }
306 },
307 "type": "object"
308 },
309 "GoogleSearchIdeahubV1betaIdea": {
310 "description": "A single Idea that we want to show the end user.",
311 "id": "GoogleSearchIdeahubV1betaIdea",
312 "properties": {
313 "name": {
314 "description": "Unique identifier for the idea. Format: ideas/{ideaId}",
315 "type": "string"
316 },
317 "text": {
318 "description": "The idea’s text.",
319 "type": "string"
320 },
321 "topics": {
322 "description": "The Topics that match the idea.",
323 "items": {
324 "$ref": "GoogleSearchIdeahubV1betaTopic"
325 },
326 "type": "array"
327 }
328 },
329 "type": "object"
330 },
331 "GoogleSearchIdeahubV1betaIdeaActivity": {
332 "description": "An idea activity entry.",
333 "id": "GoogleSearchIdeahubV1betaIdeaActivity",
334 "properties": {
335 "ideas": {
336 "description": "The Idea IDs for this entry. If empty, topics should be set.",
337 "items": {
338 "type": "string"
339 },
340 "type": "array"
341 },
342 "name": {
343 "description": "Unique identifier for the idea activity. The name is ignored when creating an idea activity. Format: platforms/{platform}/properties/{property}/ideaActivities/{idea_activity}",
344 "type": "string"
345 },
346 "topics": {
347 "description": "The Topic IDs for this entry. If empty, ideas should be set.",
348 "items": {
349 "type": "string"
350 },
351 "type": "array"
352 },
353 "type": {
354 "description": "The type of activity performed.",
355 "enum": [
356 "TYPE_UNSPECIFIED",
357 "POST_DRAFTED",
358 "POST_PUBLISHED",
359 "POST_DELETED",
360 "POST_UNPUBLISHED"
361 ],
362 "enumDescriptions": [
363 "An unspecified, unknown type of idea activity.",
364 "An idea activity type indicating a post has been drafted.",
365 "An idea activity type indicating a post has been published.",
366 "An idea activity type indicating a post has been deleted.",
367 "An idea activity type indicating a post has been unpublished."
368 ],
369 "type": "string"
370 },
371 "uri": {
372 "description": "The uri the activity relates to.",
373 "type": "string"
374 }
375 },
376 "type": "object"
377 },
378 "GoogleSearchIdeahubV1betaIdeaState": {
379 "description": "Represents idea state specific to a web property.",
380 "id": "GoogleSearchIdeahubV1betaIdeaState",
381 "properties": {
382 "dismissed": {
383 "description": "Whether the idea is dismissed.",
384 "type": "boolean"
385 },
386 "name": {
387 "description": "Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}",
388 "type": "string"
389 },
390 "saved": {
391 "description": "Whether the idea is saved.",
392 "type": "boolean"
393 }
394 },
395 "type": "object"
396 },
397 "GoogleSearchIdeahubV1betaListAvailableLocalesResponse": {
398 "description": "Response for whether ideas are available for a given web property on a platform, for the currently logged-in user.",
399 "id": "GoogleSearchIdeahubV1betaListAvailableLocalesResponse",
400 "properties": {
401 "availableLocales": {
402 "description": "Locales for which ideas are available for the given Creator.",
403 "items": {
404 "$ref": "GoogleSearchIdeahubV1betaAvailableLocale"
405 },
406 "type": "array"
407 },
408 "nextPageToken": {
409 "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
410 "type": "string"
411 }
412 },
413 "type": "object"
414 },
415 "GoogleSearchIdeahubV1betaListIdeasResponse": {
416 "id": "GoogleSearchIdeahubV1betaListIdeasResponse",
417 "properties": {
418 "ideas": {
419 "description": "Results for the ListIdeasRequest.",
420 "items": {
421 "$ref": "GoogleSearchIdeahubV1betaIdea"
422 },
423 "type": "array"
424 },
425 "nextPageToken": {
426 "description": "Used to fetch the next page in a subsequent request.",
427 "type": "string"
428 }
429 },
430 "type": "object"
431 },
432 "GoogleSearchIdeahubV1betaTopic": {
433 "description": "Represents a Topic umbrella for a list of questions that a Creator may want to respond to.",
434 "id": "GoogleSearchIdeahubV1betaTopic",
435 "properties": {
436 "displayName": {
437 "description": "String displayed to the creator indicating the name of the Topic.",
438 "type": "string"
439 },
440 "mid": {
441 "description": "The mID of the topic.",
442 "type": "string"
443 },
444 "name": {
445 "description": "Unique identifier for the topic. Format: topics/{topic}",
446 "type": "string"
447 }
448 },
449 "type": "object"
450 },
451 "GoogleSearchIdeahubV1betaTopicState": {
452 "description": "Represents topic state specific to a web property.",
453 "id": "GoogleSearchIdeahubV1betaTopicState",
454 "properties": {
455 "dismissed": {
456 "description": "Whether the topic is dismissed.",
457 "type": "boolean"
458 },
459 "name": {
460 "description": "Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}",
461 "type": "string"
462 },
463 "saved": {
464 "description": "Whether the topic is saved.",
465 "type": "boolean"
466 }
467 },
468 "type": "object"
469 }
470 },
471 "servicePath": "",
472 "title": "Idea Hub API",
473 "version": "v1beta",
474 "version_module": true
475}View as plain text