| yoshi-code-bot | bdce941 | 2021-06-01 00:50:02 -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="ideahub_v1alpha.html">Idea Hub API</a> . <a href="ideahub_v1alpha.ideas.html">ideas</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | bdce941 | 2021-06-01 00:50:02 -0700 | [diff] [blame] | 82 | <p class="firstline">List ideas for a given Creator and filter and sort options.</p> |
| 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"> |
| 88 | <code class="details" id="close">close()</code> |
| 89 | <pre>Close httplib2 connections.</pre> |
| 90 | </div> |
| 91 | |
| 92 | <div class="method"> |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 93 | <code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)</code> |
| yoshi-code-bot | bdce941 | 2021-06-01 00:50:02 -0700 | [diff] [blame] | 94 | <pre>List ideas for a given Creator and filter and sort options. |
| 95 | |
| 96 | Args: |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 97 | filter: string, 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. |
| yoshi-code-bot | bdce941 | 2021-06-01 00:50:02 -0700 | [diff] [blame] | 98 | orderBy: string, Order semantics described below. |
| 99 | pageSize: integer, 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. |
| 100 | pageToken: string, Used to fetch next page. |
| 101 | parent: string, If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property} |
| 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 | { |
| 111 | "ideas": [ # Results for the ListIdeasRequest. |
| 112 | { # A single Idea that we want to show the end user. |
| 113 | "name": "A String", # Unique identifier for the idea. Format: ideas/{ideaId} |
| 114 | "text": "A String", # The idea’s text. |
| 115 | "topics": [ # The Topics that match the idea. |
| 116 | { # Represents a Topic umbrella for a list of questions that a Creator may want to respond to. |
| 117 | "displayName": "A String", # String displayed to the creator indicating the name of the Topic. |
| 118 | "mid": "A String", # The mID of the topic. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 119 | "name": "A String", # Unique identifier for the topic. Format: topics/{topic} |
| yoshi-code-bot | bdce941 | 2021-06-01 00:50:02 -0700 | [diff] [blame] | 120 | }, |
| 121 | ], |
| 122 | }, |
| 123 | ], |
| 124 | "nextPageToken": "A String", # Used to fetch the next page in a subsequent request. |
| 125 | }</pre> |
| 126 | </div> |
| 127 | |
| 128 | <div class="method"> |
| 129 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 130 | <pre>Retrieves the next page of results. |
| 131 | |
| 132 | Args: |
| 133 | previous_request: The request for the previous page. (required) |
| 134 | previous_response: The response from the request for the previous page. (required) |
| 135 | |
| 136 | Returns: |
| 137 | A request object that you can call 'execute()' on to request the next |
| 138 | page. Returns None if there are no more items in the collection. |
| 139 | </pre> |
| 140 | </div> |
| 141 | |
| 142 | </body></html> |