2022-10-27
▼ ▲ ideahub.ideas.list
Flat Path : v1alpha/ideas
HTTP Method : GET
Path : v1alpha/ideas
Parameters :
pageToken
Location : query
Type : string
Description : Used to fetch next page.
pageSize
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.
Type : integer
Location : query
Format : int32
orderBy
Type : string
Description : Order semantics described below.
Location : query
parent
Type : string
Location : query
Description : If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}
filter
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
Type : string
Description : List ideas for a given Creator and filter and sort options.
▼ ▲ ideahub.platforms.properties.ideaStates.patch
HTTP Method : PATCH
Path : v1alpha/{+name}
Parameters :
name
Description : Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}
Type : string
Pattern : ^platforms/[^/]+/properties/[^/]+/ideaStates/[^/]+$
Location : path
Required : Yes
updateMask
Description : The list of fields to be updated.
Location : query
Type : string
Format : google-fieldmask
Description : Update an idea state resource.
Flat Path : v1alpha/platforms/{platformsId}/properties/{propertiesId}/ideaStates/{ideaStatesId}
Parameter Order : name
▼ ▲ ideahub.platforms.properties.topicStates.patch
Parameter Order : name
Description : Update a topic state resource.
Parameters :
name
Description : Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}
Required : Yes
Pattern : ^platforms/[^/]+/properties/[^/]+/topicStates/[^/]+$
Type : string
Location : path
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : The list of fields to be updated.
HTTP Method : PATCH
Path : v1alpha/{+name}
Flat Path : v1alpha/platforms/{platformsId}/properties/{propertiesId}/topicStates/{topicStatesId}
▼ ▲ ideahub.platforms.properties.ideaActivities.create
Parameter Order : parent
Flat Path : v1alpha/platforms/{platformsId}/properties/{propertiesId}/ideaActivities
Description : Creates an idea activity entry.
Path : v1alpha/{+parent}/ideaActivities
HTTP Method : POST
Parameters :
parent
Pattern : ^platforms/[^/]+/properties/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The parent resource where this idea activity will be created. Format: platforms/{platform}/property/{property}
▼ ▲ ideahub.platforms.properties.ideas.list
Description : List ideas for a given Creator and filter and sort options.
Flat Path : v1alpha/platforms/{platformsId}/properties/{propertiesId}/ideas
Parameter Order : parent
HTTP Method : GET
Parameters :
parent
Type : string
Location : path
Required : Yes
Pattern : ^platforms/[^/]+/properties/[^/]+$
Description : If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}
pageSize
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
Type : integer
Format : int32
filter
Location : query
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.
Type : string
pageToken
Location : query
Description : Used to fetch next page.
Type : string
orderBy
Description : Order semantics described below.
Type : string
Location : query
Path : v1alpha/{+parent}/ideas
▼ ▲ ideahub.platforms.properties.locales.list
Flat Path : v1alpha/platforms/{platformsId}/properties/{propertiesId}/locales
HTTP Method : GET
Description : Returns which locales ideas are available in for a given Creator.
Path : v1alpha/{+parent}/locales
Parameters :
parent
Required : Yes
Pattern : ^platforms/[^/]+/properties/[^/]+$
Description : Required. The web property to check idea availability for Format: platforms/{platform}/property/{property}
Location : path
Type : string
pageToken
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.
Type : string
pageSize
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.
Format : int32
Type : integer
Location : query
Parameter Order : parent