GoogleApi.IdeaHub.V1beta.Api.Platforms (google_api_idea_hub v0.2.0) View Source

API calls for all endpoints tagged Platforms.

Link to this section Summary

Functions

ideahub_platforms_properties_idea_activities_create(connection, parent, optional_params \\ [], opts \\ [])

Creates an idea activity entry.

ideahub_platforms_properties_idea_states_patch(connection, name, optional_params \\ [], opts \\ [])

Update an idea state resource.

ideahub_platforms_properties_ideas_list(connection, parent, optional_params \\ [], opts \\ [])

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

ideahub_platforms_properties_locales_list(connection, parent, optional_params \\ [], opts \\ [])

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

ideahub_platforms_properties_topic_states_patch(connection, name, optional_params \\ [], opts \\ [])

Update a topic state resource.

Link to this section Functions

ideahub_platforms_properties_idea_activities_create(connection, parent, optional_params \\ [], opts \\ [])

Specs

ideahub_platforms_properties_idea_activities_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaIdeaActivity.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an idea activity entry.

Parameters

connection (type: GoogleApi.IdeaHub.V1beta.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent resource where this idea activity will be created. Format: platforms/{platform}/property/{property}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaIdeaActivity.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaIdeaActivity{}} on success
{:error, info} on failure

ideahub_platforms_properties_idea_states_patch(connection, name, optional_params \\ [], opts \\ [])

Specs

ideahub_platforms_properties_idea_states_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaIdeaState.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update an idea state resource.

Parameters

connection (type: GoogleApi.IdeaHub.V1beta.Connection.t) - Connection to server
name (type: String.t) - Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (type: String.t) - The list of fields to be updated.
- :body (type: GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaIdeaState.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaIdeaState{}} on success
{:error, info} on failure

ideahub_platforms_properties_ideas_list(connection, parent, optional_params \\ [], opts \\ [])

Specs

ideahub_platforms_properties_ideas_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaListIdeasResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.IdeaHub.V1beta.Connection.t) - Connection to server
parent (type: String.t) - Required. If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :filter (type: String.t) - 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 (type: String.t) - Order semantics described below.
- :pageSize (type: 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 (type: String.t) - Used to fetch next page.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaListIdeasResponse{}} on success
{:error, info} on failure

ideahub_platforms_properties_locales_list(connection, parent, optional_params \\ [], opts \\ [])

Specs

ideahub_platforms_properties_locales_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaListAvailableLocalesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.IdeaHub.V1beta.Connection.t) - Connection to server
parent (type: String.t) - Required. The web property to check idea availability for Format: platforms/{platform}/property/{property}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - 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.t) - 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.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaListAvailableLocalesResponse{}} on success
{:error, info} on failure

ideahub_platforms_properties_topic_states_patch(connection, name, optional_params \\ [], opts \\ [])

Specs

ideahub_platforms_properties_topic_states_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaTopicState.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update a topic state resource.

Parameters

connection (type: GoogleApi.IdeaHub.V1beta.Connection.t) - Connection to server
name (type: String.t) - Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (type: String.t) - The list of fields to be updated.
- :body (type: GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaTopicState.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.IdeaHub.V1beta.Model.GoogleSearchIdeahubV1betaTopicState{}} on success
{:error, info} on failure