Idea Hub API (ideahub:v1beta)

2023-01-13

5 new methods | New API

Additions

    Methods
  • ideahub.platforms.properties.ideas.list

      Parameter Order : parent

      HTTP Method : GET

      Path : v1beta/{+parent}/ideas

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

      Parameters :

        pageSize

          Format : int32

          Type : integer

          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.

          Location : query

        pageToken

          Description : Used to fetch next page.

          Type : string

          Location : query

        orderBy

          Description : Order semantics described below.

          Location : query

          Type : string

        filter

          Type : string

          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.

          Location : query

        parent

          Type : string

          Location : path

          Pattern : ^platforms/[^/]+/properties/[^/]+$

          Required : Yes

          Description : Required. If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}

      Flat Path : v1beta/platforms/{platformsId}/properties/{propertiesId}/ideas

  • ideahub.platforms.properties.ideaStates.patch

      Path : v1beta/{+name}

      Parameter Order : name

      Flat Path : v1beta/platforms/{platformsId}/properties/{propertiesId}/ideaStates/{ideaStatesId}

      Description : Update an idea state resource.

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^platforms/[^/]+/properties/[^/]+/ideaStates/[^/]+$

          Description : Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}

          Type : string

        updateMask

          Format : google-fieldmask

          Location : query

          Description : The list of fields to be updated.

          Type : string

      HTTP Method : PATCH

  • ideahub.platforms.properties.topicStates.patch

      Path : v1beta/{+name}

      HTTP Method : PATCH

      Parameters :

        updateMask

          Description : The list of fields to be updated.

          Location : query

          Type : string

          Format : google-fieldmask

        name

          Description : Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}

          Location : path

          Pattern : ^platforms/[^/]+/properties/[^/]+/topicStates/[^/]+$

          Type : string

          Required : Yes

      Description : Update a topic state resource.

      Flat Path : v1beta/platforms/{platformsId}/properties/{propertiesId}/topicStates/{topicStatesId}

      Parameter Order : name

  • ideahub.platforms.properties.locales.list

      Parameters :

        parent

          Location : path

          Type : string

          Required : Yes

          Description : Required. The web property to check idea availability for Format: platforms/{platform}/property/{property}

          Pattern : ^platforms/[^/]+/properties/[^/]+$

        pageSize

          Format : int32

          Location : query

          Type : integer

          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.

        pageToken

          Type : string

          Location : query

          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.

      Flat Path : v1beta/platforms/{platformsId}/properties/{propertiesId}/locales

      Path : v1beta/{+parent}/locales

      Description : Returns which locales ideas are available in for a given Creator.

      Parameter Order : parent

      HTTP Method : GET

  • ideahub.platforms.properties.ideaActivities.create

      Parameter Order : parent

      HTTP Method : POST

      Description : Creates an idea activity entry.

      Path : v1beta/{+parent}/ideaActivities

      Parameters :

        parent

          Pattern : ^platforms/[^/]+/properties/[^/]+$

          Description : Required. The parent resource where this idea activity will be created. Format: platforms/{platform}/property/{property}

          Location : path

          Type : string

          Required : Yes

      Flat Path : v1beta/platforms/{platformsId}/properties/{propertiesId}/ideaActivities