google_api_surveys v0.3.0 GoogleApi.Surveys.V2.Api.Surveys View Source
API calls for all endpoints tagged Surveys
.
Link to this section Summary
Functions
Removes a survey from view in all user GET requests.
Retrieves information about the specified survey.
Creates a survey.
Lists the surveys owned by the authenticated user.
Begins running a survey.
Stops a running survey.
Updates a survey. Currently the only property that can be updated is the owners property.
Link to this section Functions
surveys_surveys_delete(connection, survey_url_id, optional_params \\ [], opts \\ [])
View Source
surveys_surveys_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Surveys.V2.Model.SurveysDeleteResponse.t()}
| {:error, Tesla.Env.t()}
surveys_surveys_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysDeleteResponse.t()} | {:error, Tesla.Env.t()}
Removes a survey from view in all user GET requests.
Parameters
connection
(type:GoogleApi.Surveys.V2.Connection.t
) - Connection to serversurvey_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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Surveys.V2.Model.SurveysDeleteResponse{}}
on success{:error, info}
on failure
surveys_surveys_get(connection, survey_url_id, optional_params \\ [], opts \\ [])
View Source
surveys_surveys_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Surveys.V2.Model.Survey.t()} | {:error, Tesla.Env.t()}
surveys_surveys_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.Survey.t()} | {:error, Tesla.Env.t()}
Retrieves information about the specified survey.
Parameters
connection
(type:GoogleApi.Surveys.V2.Connection.t
) - Connection to serversurvey_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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Surveys.V2.Model.Survey{}}
on success{:error, info}
on failure
surveys_surveys_insert(connection, optional_params \\ [], opts \\ [])
View Source
surveys_surveys_insert(Tesla.Env.client(), keyword(), keyword()) ::
{:ok, GoogleApi.Surveys.V2.Model.Survey.t()} | {:error, Tesla.Env.t()}
surveys_surveys_insert(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.Survey.t()} | {:error, Tesla.Env.t()}
Creates a survey.
Parameters
connection
(type:GoogleApi.Surveys.V2.Connection.t
) - Connection to serveroptional_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.Survey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Surveys.V2.Model.Survey{}}
on success{:error, info}
on failure
surveys_surveys_list(connection, optional_params \\ [], opts \\ [])
View Source
surveys_surveys_list(Tesla.Env.client(), keyword(), keyword()) ::
{:ok, GoogleApi.Surveys.V2.Model.SurveysListResponse.t()}
| {:error, Tesla.Env.t()}
surveys_surveys_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysListResponse.t()} | {:error, Tesla.Env.t()}
Lists the surveys owned by the authenticated user.
Parameters
connection
(type:GoogleApi.Surveys.V2.Connection.t
) - Connection to serveroptional_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.:maxResults
(type:integer()
) -:startIndex
(type:integer()
) -:token
(type:String.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Surveys.V2.Model.SurveysListResponse{}}
on success{:error, info}
on failure
surveys_surveys_start(connection, resource_id, optional_params \\ [], opts \\ [])
View Source
surveys_surveys_start(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Surveys.V2.Model.SurveysStartResponse.t()}
| {:error, Tesla.Env.t()}
surveys_surveys_start(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysStartResponse.t()} | {:error, Tesla.Env.t()}
Begins running a survey.
Parameters
connection
(type:GoogleApi.Surveys.V2.Connection.t
) - Connection to serverresource_id
(type:String.t
) -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.SurveysStartRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Surveys.V2.Model.SurveysStartResponse{}}
on success{:error, info}
on failure
surveys_surveys_stop(connection, resource_id, optional_params \\ [], opts \\ [])
View Source
surveys_surveys_stop(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Surveys.V2.Model.SurveysStopResponse.t()}
| {:error, Tesla.Env.t()}
surveys_surveys_stop(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysStopResponse.t()} | {:error, Tesla.Env.t()}
Stops a running survey.
Parameters
connection
(type:GoogleApi.Surveys.V2.Connection.t
) - Connection to serverresource_id
(type:String.t
) -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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Surveys.V2.Model.SurveysStopResponse{}}
on success{:error, info}
on failure
surveys_surveys_update(connection, survey_url_id, optional_params \\ [], opts \\ [])
View Source
surveys_surveys_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Surveys.V2.Model.Survey.t()} | {:error, Tesla.Env.t()}
surveys_surveys_update(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.Survey.t()} | {:error, Tesla.Env.t()}
Updates a survey. Currently the only property that can be updated is the owners property.
Parameters
connection
(type:GoogleApi.Surveys.V2.Connection.t
) - Connection to serversurvey_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.Survey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Surveys.V2.Model.Survey{}}
on success{:error, info}
on failure