Movatterモバイル変換


[0]ホーム

URL:


surveys

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:14Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package surveys provides access to the Surveys API.

Creating a client

Usage example:

import "google.golang.org/api/surveys/v2"...ctx := context.Background()surveysService, err := surveys.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

surveysService, err := surveys.NewService(ctx, option.WithScopes(surveys.UserinfoEmailScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

surveysService, err := surveys.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)surveysService, err := surveys.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seehttps://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (// View and manage your surveys and resultsSurveysScope = "https://www.googleapis.com/auth/surveys"// View your surveys and survey resultsSurveysReadonlyScope = "https://www.googleapis.com/auth/surveys.readonly"// View your email addressUserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeFieldMask

type FieldMask struct {Fields []*FieldMask `json:"fields,omitempty"`Idint64 `json:"id,omitempty"`// ForceSendFields is a list of field names (e.g. "Fields") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Fields") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*FieldMask)MarshalJSON

func (s *FieldMask) MarshalJSON() ([]byte,error)

typePageInfo

type PageInfo struct {ResultPerPageint64 `json:"resultPerPage,omitempty"`StartIndexint64 `json:"startIndex,omitempty"`TotalResultsint64 `json:"totalResults,omitempty"`// ForceSendFields is a list of field names (e.g. "ResultPerPage") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResultPerPage") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*PageInfo)MarshalJSON

func (s *PageInfo) MarshalJSON() ([]byte,error)

typeResultsGetCall

type ResultsGetCall struct {// contains filtered or unexported fields}

func (*ResultsGetCall)Context

Context sets the context to be used in this call's Do and Downloadmethods. Any pending HTTP request will be aborted if the providedcontext is canceled.

func (*ResultsGetCall)Do

Do executes the "surveys.results.get" call.Exactly one of *SurveyResults or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*SurveyResults.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ResultsGetCall)Download

func (c *ResultsGetCall) Download(opts ...googleapi.CallOption) (*http.Response,error)

Download fetches the API endpoint's "media" value, instead of the normalAPI response value. If the returned error is nil, the Response is guaranteed tohave a 2xx status code. Callers must close the Response.Body as usual.

func (*ResultsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ResultsGetCall)Header

func (c *ResultsGetCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

func (*ResultsGetCall)IfNoneMatch

func (c *ResultsGetCall) IfNoneMatch(entityTagstring) *ResultsGetCall

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeResultsGetRequest

type ResultsGetRequest struct {ResultMask *ResultsMask `json:"resultMask,omitempty"`// ForceSendFields is a list of field names (e.g. "ResultMask") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResultMask") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*ResultsGetRequest)MarshalJSON

func (s *ResultsGetRequest) MarshalJSON() ([]byte,error)

typeResultsMask

type ResultsMask struct {Fields []*FieldMask `json:"fields,omitempty"`Projectionstring `json:"projection,omitempty"`// ForceSendFields is a list of field names (e.g. "Fields") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Fields") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*ResultsMask)MarshalJSON

func (s *ResultsMask) MarshalJSON() ([]byte,error)

typeResultsService

type ResultsService struct {// contains filtered or unexported fields}

funcNewResultsService

func NewResultsService(s *Service) *ResultsService

func (*ResultsService)Get

func (r *ResultsService) Get(surveyUrlIdstring, resultsgetrequest *ResultsGetRequest) *ResultsGetCall

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

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentResults *ResultsServiceSurveys *SurveysService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeSurvey

type Survey struct {// Audience: Targeting-criteria message containing demographic// informationAudience *SurveyAudience `json:"audience,omitempty"`// Cost: Cost to run the survey and collect the necessary number of// responses.Cost *SurveyCost `json:"cost,omitempty"`// CustomerData: Additional information to store on behalf of the API// consumer and associate with this question. This binary blob is// treated as opaque. This field is limited to 64K bytes.CustomerDatastring `json:"customerData,omitempty"`// Description: Text description of the survey.Descriptionstring `json:"description,omitempty"`// Owners: List of email addresses for survey owners. Must contain at// least the address of the user making the API call.Owners []string `json:"owners,omitempty"`// Questions: List of questions defining the survey.Questions []*SurveyQuestion `json:"questions,omitempty"`// RejectionReason: Reason for the survey being rejected. Only present// if the survey state is rejected.RejectionReason *SurveyRejection `json:"rejectionReason,omitempty"`// State: State that the survey is in.Statestring `json:"state,omitempty"`// SurveyUrlId: Unique survey ID, that is viewable in the URL of the// Survey Creator UISurveyUrlIdstring `json:"surveyUrlId,omitempty"`// Title: Optional name that will be given to the survey.Titlestring `json:"title,omitempty"`// WantedResponseCount: Number of responses desired for the survey.WantedResponseCountint64 `json:"wantedResponseCount,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Audience") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Audience") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

Survey: Representation of an individual survey object.

func (*Survey)MarshalJSON

func (s *Survey) MarshalJSON() ([]byte,error)

typeSurveyAudience

type SurveyAudience struct {// Ages: Optional list of age buckets to target. Supported age buckets// are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']Ages []string `json:"ages,omitempty"`// Country: Required country code that surveys should be targeted to.// Accepts standard ISO 3166-1 2 character language codes. For instance,// 'US' for the United States, and 'GB' for the United Kingdom.Countrystring `json:"country,omitempty"`// CountrySubdivision: Country subdivision (states/provinces/etc) that// surveys should be targeted to. For all countries except GB,// ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United// States). For GB, NUTS 1 statistical region codes for the United// Kingdom is required (eg. 'UK-UKC' for North East England).CountrySubdivisionstring `json:"countrySubdivision,omitempty"`// Gender: Optional gender to target.Genderstring `json:"gender,omitempty"`// Languages: Language code that surveys should be targeted to. For// instance, 'en-US'. Surveys may target bilingual users by specifying a// list of language codes (for example, 'de' and 'en-US'). In that case,// all languages will be used for targeting users but the survey content// (which is displayed) must match the first language listed. Accepts// standard BCP47 language codes. See specification.Languages []string `json:"languages,omitempty"`// PopulationSource: Online population source where the respondents are// sampled from.PopulationSourcestring `json:"populationSource,omitempty"`// ForceSendFields is a list of field names (e.g. "Ages") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Ages") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

SurveyAudience: Specifications for the target audience of a surveyrun through the API.

func (*SurveyAudience)MarshalJSON

func (s *SurveyAudience) MarshalJSON() ([]byte,error)

typeSurveyCost

type SurveyCost struct {// CostPerResponseNanos: Cost per survey response in nano units of the// given currency. To get the total cost for a survey, multiply this// value by wanted_response_count.CostPerResponseNanosint64 `json:"costPerResponseNanos,omitempty,string"`// CurrencyCode: Currency code that the cost is given in.CurrencyCodestring `json:"currencyCode,omitempty"`// MaxCostPerResponseNanos: *Deprecated* Threshold to start a survey// automatically if the quoted price is at most this value. When a// survey has a Screener (threshold) question, it must go through an// incidence pricing test to determine the final cost per response.// Typically you will have to make a followup call to start the survey// giving the final computed cost per response. If the survey has no// threshold_answers, setting this property will return an error. By// specifying this property, you indicate the max price per response you// are willing to pay in advance of the incidence test. If the price// turns out to be lower than the specified value, the survey will begin// immediately and you will be charged at the rate determined by the// incidence pricing test. If the price turns out to be greater than the// specified value the survey will not be started and you will instead// be notified what price was determined by the incidence test. At that// point, you must raise the value of this property to be greater than// or equal to that cost before attempting to start the survey again.// This will immediately start the survey as long the incidence test was// run within the last 21 days. This will no longer be available after// June 2018.MaxCostPerResponseNanosint64 `json:"maxCostPerResponseNanos,omitempty,string"`// Nanos: Cost of survey in nano units of the given currency. DEPRECATED// in favor of cost_per_response_nanosNanosint64 `json:"nanos,omitempty,string"`// ForceSendFields is a list of field names (e.g.// "CostPerResponseNanos") to unconditionally include in API requests.// By default, fields with empty values are omitted from API requests.// However, any non-pointer, non-interface field appearing in// ForceSendFields will be sent to the server regardless of whether the// field is empty or not. This may be used to include empty fields in// Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CostPerResponseNanos") to// include in API requests with the JSON null value. By default, fields// with empty values are omitted from API requests. However, any field// with an empty value appearing in NullFields will be sent to the// server as null. It is an error if a field in this list has a// non-empty value. This may be used to include null fields in Patch// requests.NullFields []string `json:"-"`}

SurveyCost: Message defining the cost to run a given survey throughAPI.

func (*SurveyCost)MarshalJSON

func (s *SurveyCost) MarshalJSON() ([]byte,error)

typeSurveyQuestion

type SurveyQuestion struct {// AnswerOrder: The randomization option for multiple choice and// multi-select questions. If not specified, this option defaults to// randomize.AnswerOrderstring `json:"answerOrder,omitempty"`// Answers: Required list of answer options for a question.Answers []string `json:"answers,omitempty"`// HasOther: Option to allow open-ended text box for Single Answer and// Multiple Answer question types. This can be used with SINGLE_ANSWER,// SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and// MULTIPLE_ANSWERS_WITH_IMAGE question types.HasOtherbool `json:"hasOther,omitempty"`// HighValueLabel: For rating questions, the text for the higher end of// the scale, such as 'Best'. For numeric questions, a string// representing a floating-point that is the maximum allowed number for// a response.HighValueLabelstring `json:"highValueLabel,omitempty"`Images []*SurveyQuestionImage `json:"images,omitempty"`// LastAnswerPositionPinned: Currently only support pinning an answer// option to the last position.LastAnswerPositionPinnedbool `json:"lastAnswerPositionPinned,omitempty"`// LowValueLabel: For rating questions, the text for the lower end of// the scale, such as 'Worst'. For numeric questions, a string// representing a floating-point that is the minimum allowed number for// a response.LowValueLabelstring `json:"lowValueLabel,omitempty"`// MustPickSuggestion: Option to force the user to pick one of the open// text suggestions. This requires that suggestions are provided for// this question.MustPickSuggestionbool `json:"mustPickSuggestion,omitempty"`// NumStars: Number of stars to use for ratings questions.NumStarsstring `json:"numStars,omitempty"`// OpenTextPlaceholder: Placeholder text for an open text question.OpenTextPlaceholderstring `json:"openTextPlaceholder,omitempty"`// OpenTextSuggestions: A list of suggested answers for open text// question auto-complete. This is only valid if single_line_response is// true.OpenTextSuggestions []string `json:"openTextSuggestions,omitempty"`// Question: Required question text shown to the respondent.Questionstring `json:"question,omitempty"`// SentimentText: Used by the Rating Scale with Text question type. This// text goes along with the question field that is presented to the// respondent, and is the actual text that the respondent is asked to// rate.SentimentTextstring `json:"sentimentText,omitempty"`// SingleLineResponse: Option to allow multiple line open text responses// instead of a single line response. Note that we don't show// auto-complete suggestions with multiple line responses.SingleLineResponsebool `json:"singleLineResponse,omitempty"`// ThresholdAnswers: The threshold/screener answer options, which will// screen a user into the rest of the survey. These will be a subset of// the answer option strings.ThresholdAnswers []string `json:"thresholdAnswers,omitempty"`// Type: Required field defining the question type. For details about// configuring different type of questions, consult the question// configuration guide.Typestring `json:"type,omitempty"`// UnitOfMeasurementLabel: Optional unit of measurement for display (for// example: hours, people, miles).UnitOfMeasurementLabelstring `json:"unitOfMeasurementLabel,omitempty"`// VideoId: The YouTube video ID to be show in video questions.VideoIdstring `json:"videoId,omitempty"`// ForceSendFields is a list of field names (e.g. "AnswerOrder") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AnswerOrder") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

SurveyQuestion: Message defining the question specifications.

func (*SurveyQuestion)MarshalJSON

func (s *SurveyQuestion) MarshalJSON() ([]byte,error)

typeSurveyQuestionImage

type SurveyQuestionImage struct {// AltText: The alt text property used in image tags is required for all// images.AltTextstring `json:"altText,omitempty"`// Data: Inline jpeg, gif, tiff, bmp, or png image raw bytes for an// image question types.Datastring `json:"data,omitempty"`// Url: The read-only URL for the hosted images.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "AltText") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AltText") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

SurveyQuestionImage: Container object for image data and alt_text.

func (*SurveyQuestionImage)MarshalJSON

func (s *SurveyQuestionImage) MarshalJSON() ([]byte,error)

typeSurveyRejection

type SurveyRejection struct {// Explanation: A human-readable explanation of what was wrong with the// survey.Explanationstring `json:"explanation,omitempty"`// Type: Which category of rejection this was. See the  Google Surveys// Help Center for additional details on each category.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Explanation") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Explanation") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

SurveyRejection: Message representing why the survey was rejectedfrom review, if it was.

func (*SurveyRejection)MarshalJSON

func (s *SurveyRejection) MarshalJSON() ([]byte,error)

typeSurveyResults

type SurveyResults struct {// Status: Human readable string describing the status of the request.Statusstring `json:"status,omitempty"`// SurveyUrlId: External survey ID as viewable by survey owners in the// editor view.SurveyUrlIdstring `json:"surveyUrlId,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Status") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Status") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

SurveyResults: Reference to the current results for a given survey.

func (*SurveyResults)MarshalJSON

func (s *SurveyResults) MarshalJSON() ([]byte,error)

typeSurveysDeleteCall

type SurveysDeleteCall struct {// contains filtered or unexported fields}

func (*SurveysDeleteCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*SurveysDeleteCall)Do

Do executes the "surveys.surveys.delete" call.Exactly one of *SurveysDeleteResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*SurveysDeleteResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*SurveysDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*SurveysDeleteCall)Header

func (c *SurveysDeleteCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

typeSurveysDeleteResponse

type SurveysDeleteResponse struct {// RequestId: Unique request ID used for logging and debugging. Please// include in any error reporting or troubleshooting requests.RequestIdstring `json:"requestId,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "RequestId") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RequestId") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*SurveysDeleteResponse)MarshalJSON

func (s *SurveysDeleteResponse) MarshalJSON() ([]byte,error)

typeSurveysGetCall

type SurveysGetCall struct {// contains filtered or unexported fields}

func (*SurveysGetCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*SurveysGetCall)Do

Do executes the "surveys.surveys.get" call.Exactly one of *Survey or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Survey.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*SurveysGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*SurveysGetCall)Header

func (c *SurveysGetCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

func (*SurveysGetCall)IfNoneMatch

func (c *SurveysGetCall) IfNoneMatch(entityTagstring) *SurveysGetCall

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeSurveysInsertCall

type SurveysInsertCall struct {// contains filtered or unexported fields}

func (*SurveysInsertCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*SurveysInsertCall)Do

Do executes the "surveys.surveys.insert" call.Exactly one of *Survey or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Survey.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*SurveysInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*SurveysInsertCall)Header

func (c *SurveysInsertCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

typeSurveysListCall

type SurveysListCall struct {// contains filtered or unexported fields}

func (*SurveysListCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*SurveysListCall)Do

Do executes the "surveys.surveys.list" call.Exactly one of *SurveysListResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*SurveysListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*SurveysListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*SurveysListCall)Header

func (c *SurveysListCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

func (*SurveysListCall)IfNoneMatch

func (c *SurveysListCall) IfNoneMatch(entityTagstring) *SurveysListCall

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*SurveysListCall)MaxResults

func (c *SurveysListCall) MaxResults(maxResultsint64) *SurveysListCall

MaxResults sets the optional parameter "maxResults":

func (*SurveysListCall)StartIndex

func (c *SurveysListCall) StartIndex(startIndexint64) *SurveysListCall

StartIndex sets the optional parameter "startIndex":

func (*SurveysListCall)Token

func (c *SurveysListCall) Token(tokenstring) *SurveysListCall

Token sets the optional parameter "token":

typeSurveysListResponse

type SurveysListResponse struct {PageInfo *PageInfo `json:"pageInfo,omitempty"`// RequestId: Unique request ID used for logging and debugging. Please// include in any error reporting or troubleshooting requests.RequestIdstring `json:"requestId,omitempty"`// Resources: An individual survey resource.Resources []*Survey `json:"resources,omitempty"`TokenPagination *TokenPagination `json:"tokenPagination,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "PageInfo") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageInfo") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*SurveysListResponse)MarshalJSON

func (s *SurveysListResponse) MarshalJSON() ([]byte,error)

typeSurveysService

type SurveysService struct {// contains filtered or unexported fields}

funcNewSurveysService

func NewSurveysService(s *Service) *SurveysService

func (*SurveysService)Delete

func (r *SurveysService) Delete(surveyUrlIdstring) *SurveysDeleteCall

Delete: Removes a survey from view in all user GET requests.

func (*SurveysService)Get

func (r *SurveysService) Get(surveyUrlIdstring) *SurveysGetCall

Get: Retrieves information about the specified survey.

func (*SurveysService)Insert

func (r *SurveysService) Insert(survey *Survey) *SurveysInsertCall

Insert: Creates a survey.

func (*SurveysService)List

List: Lists the surveys owned by the authenticated user.

func (*SurveysService)Start

func (r *SurveysService) Start(resourceIdstring, surveysstartrequest *SurveysStartRequest) *SurveysStartCall

Start: Begins running a survey.

func (*SurveysService)Stop

func (r *SurveysService) Stop(resourceIdstring) *SurveysStopCall

Stop: Stops a running survey.

func (*SurveysService)Update

func (r *SurveysService) Update(surveyUrlIdstring, survey *Survey) *SurveysUpdateCall

Update: Updates a survey. Currently the only property that can beupdated is the owners property.

typeSurveysStartCall

type SurveysStartCall struct {// contains filtered or unexported fields}

func (*SurveysStartCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*SurveysStartCall)Do

Do executes the "surveys.surveys.start" call.Exactly one of *SurveysStartResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*SurveysStartResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*SurveysStartCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*SurveysStartCall)Header

func (c *SurveysStartCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

typeSurveysStartRequest

type SurveysStartRequest struct {// MaxCostPerResponseNanos: *Deprecated* Threshold to start a survey// automatically if the quoted prices is less than or equal to this// value. See Survey.Cost for more details. This will no longer be// available after June 2018.MaxCostPerResponseNanosint64 `json:"maxCostPerResponseNanos,omitempty,string"`// ForceSendFields is a list of field names (e.g.// "MaxCostPerResponseNanos") to unconditionally include in API// requests. By default, fields with empty values are omitted from API// requests. However, any non-pointer, non-interface field appearing in// ForceSendFields will be sent to the server regardless of whether the// field is empty or not. This may be used to include empty fields in// Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxCostPerResponseNanos")// to include in API requests with the JSON null value. By default,// fields with empty values are omitted from API requests. However, any// field with an empty value appearing in NullFields will be sent to the// server as null. It is an error if a field in this list has a// non-empty value. This may be used to include null fields in Patch// requests.NullFields []string `json:"-"`}

func (*SurveysStartRequest)MarshalJSON

func (s *SurveysStartRequest) MarshalJSON() ([]byte,error)

typeSurveysStartResponse

type SurveysStartResponse struct {// RequestId: Unique request ID used for logging and debugging. Please// include in any error reporting or troubleshooting requests.RequestIdstring `json:"requestId,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "RequestId") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RequestId") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*SurveysStartResponse)MarshalJSON

func (s *SurveysStartResponse) MarshalJSON() ([]byte,error)

typeSurveysStopCall

type SurveysStopCall struct {// contains filtered or unexported fields}

func (*SurveysStopCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*SurveysStopCall)Do

Do executes the "surveys.surveys.stop" call.Exactly one of *SurveysStopResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*SurveysStopResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*SurveysStopCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*SurveysStopCall)Header

func (c *SurveysStopCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

typeSurveysStopResponse

type SurveysStopResponse struct {// RequestId: Unique request ID used for logging and debugging. Please// include in any error reporting or troubleshooting requests.RequestIdstring `json:"requestId,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "RequestId") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RequestId") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*SurveysStopResponse)MarshalJSON

func (s *SurveysStopResponse) MarshalJSON() ([]byte,error)

typeSurveysUpdateCall

type SurveysUpdateCall struct {// contains filtered or unexported fields}

func (*SurveysUpdateCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*SurveysUpdateCall)Do

Do executes the "surveys.surveys.update" call.Exactly one of *Survey or error will be non-nil. Any non-2xx statuscode is an error. Response headers are in either*Survey.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*SurveysUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*SurveysUpdateCall)Header

func (c *SurveysUpdateCall) Header()http.Header

Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.

typeTokenPagination

type TokenPagination struct {NextPageTokenstring `json:"nextPageToken,omitempty"`PreviousPageTokenstring `json:"previousPageToken,omitempty"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*TokenPagination)MarshalJSON

func (s *TokenPagination) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp