Idea Hub API . ideas

Instance Methods

close()

Close httplib2 connections.

list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)

List ideas for a given Creator and filter and sort options.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(filter=None, orderBy=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)
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'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.
  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:

    {
  "ideas": [ # Results for the ListIdeasRequest.
    { # A single Idea that we want to show the end user.
      "name": "A String", # Unique identifier for the idea. Format: ideas/{ideaId}
      "text": "A String", # The idea’s text.
      "topics": [ # The Topics that match the idea.
        { # Represents a Topic umbrella for a list of questions that a Creator may want to respond to.
          "displayName": "A String", # String displayed to the creator indicating the name of the Topic.
          "mid": "A String", # The mID of the topic.
          "name": "A String", # Unique identifier for the topic. Format: topics/{topic}
        },
      ],
    },
  ],
  "nextPageToken": "A String", # Used to fetch the next page in a subsequent request.
}
list_next()
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 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.