google_api_surveys v0.2.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
Removes a survey from view in all user GET requests.
Parameters
- connection (GoogleApi.Surveys.V2.Connection): Connection to server
- survey_url_id (String.t): External URL ID for the survey.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
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
Retrieves information about the specified survey.
Parameters
- connection (GoogleApi.Surveys.V2.Connection): Connection to server
- survey_url_id (String.t): External URL ID for the survey.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.Surveys.V2.Model.Survey{}} on success {:error, info} on failure
surveys_surveys_insert(connection, optional_params \\ [], opts \\ []) View Source
Creates a survey.
Parameters
- connection (GoogleApi.Surveys.V2.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (Survey):
Returns
{:ok, %GoogleApi.Surveys.V2.Model.Survey{}} on success {:error, info} on failure
surveys_surveys_list(connection, optional_params \\ [], opts \\ []) View Source
Lists the surveys owned by the authenticated user.
Parameters
- connection (GoogleApi.Surveys.V2.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :maxResults (integer()):
- :startIndex (integer()):
- :token (String.t):
Returns
{:ok, %GoogleApi.Surveys.V2.Model.SurveysListResponse{}} on success {:error, info} on failure
surveys_surveys_start(connection, resource_id, optional_params \\ [], opts \\ []) View Source
Begins running a survey.
Parameters
- connection (GoogleApi.Surveys.V2.Connection): Connection to server
- resource_id (String.t):
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (SurveysStartRequest):
Returns
{:ok, %GoogleApi.Surveys.V2.Model.SurveysStartResponse{}} on success {:error, info} on failure
surveys_surveys_stop(connection, resource_id, optional_params \\ [], opts \\ []) View Source
Stops a running survey.
Parameters
- connection (GoogleApi.Surveys.V2.Connection): Connection to server
- resource_id (String.t):
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
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
Updates a survey. Currently the only property that can be updated is the owners property.
Parameters
- connection (GoogleApi.Surveys.V2.Connection): Connection to server
- survey_url_id (String.t): External URL ID for the survey.
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (Survey):
Returns
{:ok, %GoogleApi.Surveys.V2.Model.Survey{}} on success {:error, info} on failure