View Source GoogleApi.MyBusinessQAndA.V1.Api.Locations (google_api_my_business_q_and_a v0.2.1)

API calls for all endpoints tagged Locations.

Summary

Functions

Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.

Returns the paginated list of questions and some of its answers for a specified location. This operation is only valid if the specified location is verified.

Functions

Link to this function

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

View Source
@spec mybusinessqanda_locations_questions_answers_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessQAndA.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the answer written by the current user to a question.

Parameters

  • connection (type: GoogleApi.MyBusinessQAndA.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the question to delete an answer for.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessQAndA.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec mybusinessqanda_locations_questions_answers_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessQAndA.V1.Model.ListAnswersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the paginated list of answers for a specified question.

Parameters

  • connection (type: GoogleApi.MyBusinessQAndA.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the question to fetch answers for.
  • 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").
    • :orderBy (type: String.t) - Optional. The order to return the answers. Valid options include 'update_time desc' and 'upvote_count desc', which will return the answers sorted descendingly by the requested field. The default sort order is 'update_time desc'.
    • :pageSize (type: integer()) - Optional. How many answers to fetch per page. The default and maximum page_size values are 10.
    • :pageToken (type: String.t) - Optional. If specified, the next page of answers is retrieved.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessQAndA.V1.Model.ListAnswersResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec mybusinessqanda_locations_questions_answers_upsert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessQAndA.V1.Model.Answer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.

Parameters

  • connection (type: GoogleApi.MyBusinessQAndA.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the question to write an answer for.
  • 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.MyBusinessQAndA.V1.Model.UpsertAnswerRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessQAndA.V1.Model.Answer{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec mybusinessqanda_locations_questions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessQAndA.V1.Model.Question.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Adds a question for the specified location.

Parameters

  • connection (type: GoogleApi.MyBusinessQAndA.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the location to write a question for.
  • 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.MyBusinessQAndA.V1.Model.Question.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessQAndA.V1.Model.Question{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec mybusinessqanda_locations_questions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessQAndA.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a specific question written by the current user.

Parameters

  • connection (type: GoogleApi.MyBusinessQAndA.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the question to delete.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessQAndA.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec mybusinessqanda_locations_questions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessQAndA.V1.Model.ListQuestionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the paginated list of questions and some of its answers for a specified location. This operation is only valid if the specified location is verified.

Parameters

  • connection (type: GoogleApi.MyBusinessQAndA.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the location to fetch questions for.
  • 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").
    • :answersPerQuestion (type: integer()) - Optional. How many answers to fetch per question. The default and maximum answers_per_question values are 10.
    • :filter (type: String.t) - Optional. A filter constraining the questions to return. The only filter currently supported is "ignore_answered=true"
    • :orderBy (type: String.t) - Optional. The order to return the questions. Valid options include 'update_time desc' and 'upvote_count desc', which will return the questions sorted descendingly by the requested field. The default sort order is 'update_time desc'.
    • :pageSize (type: integer()) - Optional. How many questions to fetch per page. The default and maximum page_size values are 10.
    • :pageToken (type: String.t) - Optional. If specified, the next page of questions is retrieved.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessQAndA.V1.Model.ListQuestionsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec mybusinessqanda_locations_questions_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessQAndA.V1.Model.Question.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a specific question written by the current user.

Parameters

  • connection (type: GoogleApi.MyBusinessQAndA.V1.Connection.t) - Connection to server
  • name (type: String.t) - Immutable. The unique name for the question. locations//questions/ This field will be ignored if set during question creation.
  • 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) - Required. The specific fields to update. Only question text can be updated.
    • :body (type: GoogleApi.MyBusinessQAndA.V1.Model.Question.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessQAndA.V1.Model.Question{}} on success
  • {:error, info} on failure