docs/dyn/ideahub_v1alpha.ideas.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="ideahub_v1alpha.html">Idea Hub API</a> . <a href="ideahub_v1alpha.ideas.html">ideas</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)</a></code></p>
<p class="firstline">List ideas for a given Creator and filter and sort options.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)</code>
  <pre>List ideas for a given Creator and filter and sort options.

Args:
  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&#x27;t be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can&#x27;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.
  orderBy: string, Order semantics described below.
  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.
  pageToken: string, Used to fetch next page.
  parent: string, If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;ideas&quot;: [ # Results for the ListIdeasRequest.
    { # A single Idea that we want to show the end user.
      &quot;name&quot;: &quot;A String&quot;, # Unique identifier for the idea. Format: ideas/{ideaId}
      &quot;text&quot;: &quot;A String&quot;, # The idea’s text.
      &quot;topics&quot;: [ # The Topics that match the idea.
        { # Represents a Topic umbrella for a list of questions that a Creator may want to respond to.
          &quot;displayName&quot;: &quot;A String&quot;, # String displayed to the creator indicating the name of the Topic.
          &quot;mid&quot;: &quot;A String&quot;, # The mID of the topic.
          &quot;name&quot;: &quot;A String&quot;, # Unique identifier for the topic. Format: topics/{topic}
        },
      ],
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Used to fetch the next page in a subsequent request.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>