google_api_consumer_surveys v0.0.1 GoogleApi.ConsumerSurveys.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
consumersurveys_surveys_delete(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.ConsumerSurveys.V2.Model.SurveysDeleteResponse.t} | {:error, Tesla.Env.t}
Removes a survey from view in all user GET requests.
Parameters
- connection (GoogleApi.ConsumerSurveys.V2.Connection): Connection to server
- survey_url_id (String): External URL ID for the survey.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.ConsumerSurveys.V2.Model.SurveysDeleteResponse{}} on success {:error, info} on failure
consumersurveys_surveys_get(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.ConsumerSurveys.V2.Model.Survey.t} | {:error, Tesla.Env.t}
Retrieves information about the specified survey.
Parameters
- connection (GoogleApi.ConsumerSurveys.V2.Connection): Connection to server
- survey_url_id (String): External URL ID for the survey.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.ConsumerSurveys.V2.Model.Survey{}} on success {:error, info} on failure
consumersurveys_surveys_insert(Tesla.Env.client, keyword) :: {:ok, GoogleApi.ConsumerSurveys.V2.Model.Survey.t} | {:error, Tesla.Env.t}
Creates a survey.
Parameters
- connection (GoogleApi.ConsumerSurveys.V2.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (Survey):
Returns
{:ok, %GoogleApi.ConsumerSurveys.V2.Model.Survey{}} on success {:error, info} on failure
consumersurveys_surveys_list(Tesla.Env.client, keyword) :: {:ok, GoogleApi.ConsumerSurveys.V2.Model.SurveysListResponse.t} | {:error, Tesla.Env.t}
Lists the surveys owned by the authenticated user.
Parameters
- connection (GoogleApi.ConsumerSurveys.V2.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :max_results (Integer):
- :start_index (Integer):
- :token (String):
Returns
{:ok, %GoogleApi.ConsumerSurveys.V2.Model.SurveysListResponse{}} on success {:error, info} on failure
consumersurveys_surveys_start(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.ConsumerSurveys.V2.Model.SurveysStartResponse.t} | {:error, Tesla.Env.t}
Begins running a survey.
Parameters
- connection (GoogleApi.ConsumerSurveys.V2.Connection): Connection to server
- resource_id (String):
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (SurveysStartRequest):
Returns
{:ok, %GoogleApi.ConsumerSurveys.V2.Model.SurveysStartResponse{}} on success {:error, info} on failure
consumersurveys_surveys_stop(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.ConsumerSurveys.V2.Model.SurveysStopResponse.t} | {:error, Tesla.Env.t}
Stops a running survey.
Parameters
- connection (GoogleApi.ConsumerSurveys.V2.Connection): Connection to server
- resource_id (String):
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.ConsumerSurveys.V2.Model.SurveysStopResponse{}} on success {:error, info} on failure
consumersurveys_surveys_update(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.ConsumerSurveys.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 (GoogleApi.ConsumerSurveys.V2.Connection): Connection to server
- survey_url_id (String): External URL ID for the survey.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (Survey):
Returns
{:ok, %GoogleApi.ConsumerSurveys.V2.Model.Survey{}} on success {:error, info} on failure