google_api_surveys v0.3.0 GoogleApi.Surveys.V2.Api.Results View Source

API calls for all endpoints tagged Results.

Link to this section Summary

Functions

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Link to this section Functions

Link to this function

surveys_results_get(connection, survey_url_id, optional_params \\ [], opts \\ []) View Source
surveys_results_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Surveys.V2.Model.SurveyResults.t()} | {:error, Tesla.Env.t()}

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

Parameters

  • connection (type: GoogleApi.Surveys.V2.Connection.t) - Connection to server
  • survey_url_id (type: String.t) - External URL ID for the survey.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.Surveys.V2.Model.ResultsGetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Surveys.V2.Model.SurveyResults{}} on success
  • {:error, info} on failure