consumersurveys

package
v0.196.2 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2024 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Overview

Package consumersurveys provides access to the Consumer Surveys API.

Creating a client

Usage example: 

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

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

For information on how to create and obtain Application Default Credentials, see https://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: 

consumersurveysService, err := consumersurveys.NewService(ctx, option.WithScopes(consumersurveys.UserinfoEmailScope))

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

consumersurveysService, err := consumersurveys.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, ...)
consumersurveysService, err := consumersurveys.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source 
const (
	// View and edit your surveys and results
	ConsumersurveysScope = "https://www.googleapis.com/auth/consumersurveys"

	// View the results for your surveys
	ConsumersurveysReadonlyScope = "https://www.googleapis.com/auth/consumersurveys.readonly"

	// View your email address
	UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type FieldMask 

type FieldMask struct {
	Fields []*FieldMask `json:"fields,omitempty"`

	Id int64 `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)

type MobileAppPanel 

type MobileAppPanel struct {
	Country string `json:"country,omitempty"`

	IsPublicPanel bool `json:"isPublicPanel,omitempty"`

	Language string `json:"language,omitempty"`

	MobileAppPanelId string `json:"mobileAppPanelId,omitempty"`

	Name string `json:"name,omitempty"`

	Owners []string `json:"owners,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Country") 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. "Country") 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 (*MobileAppPanel) MarshalJSON 

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

type MobileAppPanelsListResponse 

type MobileAppPanelsListResponse struct {
	PageInfo *PageInfo `json:"pageInfo,omitempty"`

	// RequestId: Unique request ID used for logging and debugging. Please
	// include in any error reporting or troubleshooting requests.
	RequestId string `json:"requestId,omitempty"`

	// Resources: An individual predefined panel of Opinion Rewards mobile
	// users.
	Resources []*MobileAppPanel `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 (*MobileAppPanelsListResponse) MarshalJSON 

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

type MobileapppanelsGetCall 

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

func (*MobileapppanelsGetCall) Context 

func (c *MobileapppanelsGetCall) Context(ctx context.Context) *MobileapppanelsGetCall

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

func (*MobileapppanelsGetCall) Do 

func (c *MobileapppanelsGetCall) Do(opts ...googleapi.CallOption) (*MobileAppPanel, error)

Do executes the "consumersurveys.mobileapppanels.get" call. Exactly one of *MobileAppPanel or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *MobileAppPanel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MobileapppanelsGetCall) Fields 

func (c *MobileapppanelsGetCall) Fields(s ...googleapi.Field) *MobileapppanelsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MobileapppanelsGetCall) Header 

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

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

func (*MobileapppanelsGetCall) IfNoneMatch 

func (c *MobileapppanelsGetCall) IfNoneMatch(entityTag string) *MobileapppanelsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type MobileapppanelsListCall 

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

func (*MobileapppanelsListCall) Context 

func (c *MobileapppanelsListCall) Context(ctx context.Context) *MobileapppanelsListCall

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

func (*MobileapppanelsListCall) Do 

func (c *MobileapppanelsListCall) Do(opts ...googleapi.CallOption) (*MobileAppPanelsListResponse, error)

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

func (*MobileapppanelsListCall) Fields 

func (c *MobileapppanelsListCall) Fields(s ...googleapi.Field) *MobileapppanelsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MobileapppanelsListCall) Header 

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

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

func (*MobileapppanelsListCall) IfNoneMatch 

func (c *MobileapppanelsListCall) IfNoneMatch(entityTag string) *MobileapppanelsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*MobileapppanelsListCall) MaxResults 

func (c *MobileapppanelsListCall) MaxResults(maxResults int64) *MobileapppanelsListCall

MaxResults sets the optional parameter "maxResults":

func (*MobileapppanelsListCall) StartIndex 

func (c *MobileapppanelsListCall) StartIndex(startIndex int64) *MobileapppanelsListCall

StartIndex sets the optional parameter "startIndex":

func (*MobileapppanelsListCall) Token 

func (c *MobileapppanelsListCall) Token(token string) *MobileapppanelsListCall

Token sets the optional parameter "token":

type MobileapppanelsService 

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

func NewMobileapppanelsService 

func NewMobileapppanelsService(s *Service) *MobileapppanelsService

func (*MobileapppanelsService) Get 

func (r *MobileapppanelsService) Get(panelId string) *MobileapppanelsGetCall

Get: Retrieves a MobileAppPanel that is available to the authenticated user.

func (*MobileapppanelsService) List 

func (r *MobileapppanelsService) List() *MobileapppanelsListCall

List: Lists the MobileAppPanels available to the authenticated user.

func (*MobileapppanelsService) Update 

func (r *MobileapppanelsService) Update(panelId string, mobileapppanel *MobileAppPanel) *MobileapppanelsUpdateCall

Update: Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.

type MobileapppanelsUpdateCall 

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

func (*MobileapppanelsUpdateCall) Context 

func (c *MobileapppanelsUpdateCall) Context(ctx context.Context) *MobileapppanelsUpdateCall

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

func (*MobileapppanelsUpdateCall) Do 

func (c *MobileapppanelsUpdateCall) Do(opts ...googleapi.CallOption) (*MobileAppPanel, error)

Do executes the "consumersurveys.mobileapppanels.update" call. Exactly one of *MobileAppPanel or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *MobileAppPanel.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MobileapppanelsUpdateCall) Fields 

func (c *MobileapppanelsUpdateCall) Fields(s ...googleapi.Field) *MobileapppanelsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MobileapppanelsUpdateCall) Header 

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

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

type PageInfo 

type PageInfo struct {
	ResultPerPage int64 `json:"resultPerPage,omitempty"`

	StartIndex int64 `json:"startIndex,omitempty"`

	TotalResults int64 `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)

type ResultsGetCall 

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

func (*ResultsGetCall) Context 

func (c *ResultsGetCall) Context(ctx context.Context) *ResultsGetCall

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

func (*ResultsGetCall) Do 

func (c *ResultsGetCall) Do(opts ...googleapi.CallOption) (*SurveyResults, error)

Do executes the "consumersurveys.results.get" call. Exactly one of *SurveyResults or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SurveyResults.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because 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 normal API response value. If the returned error is nil, the Response is guaranteed to have a 2xx status code. Callers must close the Response.Body as usual.

func (*ResultsGetCall) Fields 

func (c *ResultsGetCall) Fields(s ...googleapi.Field) *ResultsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ResultsGetCall) Header 

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

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

func (*ResultsGetCall) IfNoneMatch 

func (c *ResultsGetCall) IfNoneMatch(entityTag string) *ResultsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ResultsGetRequest 

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)

type ResultsMask 

type ResultsMask struct {
	Fields []*FieldMask `json:"fields,omitempty"`

	Projection string `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)

type ResultsService 

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

func NewResultsService 

func NewResultsService(s *Service) *ResultsService

func (*ResultsService) Get 

func (r *ResultsService) Get(surveyUrlId string, 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" to the URL as an argument to get results.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Mobileapppanels *MobileapppanelsService

	Results *ResultsService

	Surveys *SurveysService
	// contains filtered or unexported fields
}

func New deprecated 

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.

func NewService 

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

NewService creates a new Service.

type Survey 

type Survey struct {
	Audience *SurveyAudience `json:"audience,omitempty"`

	Cost *SurveyCost `json:"cost,omitempty"`

	CustomerData string `json:"customerData,omitempty"`

	Description string `json:"description,omitempty"`

	Owners []string `json:"owners,omitempty"`

	Questions []*SurveyQuestion `json:"questions,omitempty"`

	RejectionReason *SurveyRejection `json:"rejectionReason,omitempty"`

	State string `json:"state,omitempty"`

	SurveyUrlId string `json:"surveyUrlId,omitempty"`

	Title string `json:"title,omitempty"`

	WantedResponseCount int64 `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:"-"`
}

func (*Survey) MarshalJSON 

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

type SurveyAudience 

type SurveyAudience struct {
	Ages []string `json:"ages,omitempty"`

	Country string `json:"country,omitempty"`

	CountrySubdivision string `json:"countrySubdivision,omitempty"`

	Gender string `json:"gender,omitempty"`

	Languages []string `json:"languages,omitempty"`

	MobileAppPanelId string `json:"mobileAppPanelId,omitempty"`

	PopulationSource string `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:"-"`
}

func (*SurveyAudience) MarshalJSON 

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

type SurveyCost 

type SurveyCost struct {
	CostPerResponseNanos int64 `json:"costPerResponseNanos,omitempty,string"`

	CurrencyCode string `json:"currencyCode,omitempty"`

	MaxCostPerResponseNanos int64 `json:"maxCostPerResponseNanos,omitempty,string"`

	Nanos int64 `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:"-"`
}

func (*SurveyCost) MarshalJSON 

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

type SurveyQuestion 

type SurveyQuestion struct {
	AnswerOrder string `json:"answerOrder,omitempty"`

	Answers []string `json:"answers,omitempty"`

	HasOther bool `json:"hasOther,omitempty"`

	HighValueLabel string `json:"highValueLabel,omitempty"`

	Images []*SurveyQuestionImage `json:"images,omitempty"`

	LastAnswerPositionPinned bool `json:"lastAnswerPositionPinned,omitempty"`

	LowValueLabel string `json:"lowValueLabel,omitempty"`

	MustPickSuggestion bool `json:"mustPickSuggestion,omitempty"`

	NumStars string `json:"numStars,omitempty"`

	OpenTextPlaceholder string `json:"openTextPlaceholder,omitempty"`

	OpenTextSuggestions []string `json:"openTextSuggestions,omitempty"`

	Question string `json:"question,omitempty"`

	SentimentText string `json:"sentimentText,omitempty"`

	SingleLineResponse bool `json:"singleLineResponse,omitempty"`

	ThresholdAnswers []string `json:"thresholdAnswers,omitempty"`

	Type string `json:"type,omitempty"`

	UnitOfMeasurementLabel string `json:"unitOfMeasurementLabel,omitempty"`

	VideoId string `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:"-"`
}

func (*SurveyQuestion) MarshalJSON 

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

type SurveyQuestionImage 

type SurveyQuestionImage struct {
	AltText string `json:"altText,omitempty"`

	Data string `json:"data,omitempty"`

	Url string `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:"-"`
}

func (*SurveyQuestionImage) MarshalJSON 

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

type SurveyRejection 

type SurveyRejection struct {
	Explanation string `json:"explanation,omitempty"`

	Type string `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:"-"`
}

func (*SurveyRejection) MarshalJSON 

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

type SurveyResults 

type SurveyResults struct {
	Status string `json:"status,omitempty"`

	SurveyUrlId string `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:"-"`
}

func (*SurveyResults) MarshalJSON 

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

type SurveysDeleteCall 

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

func (*SurveysDeleteCall) Context 

func (c *SurveysDeleteCall) Context(ctx context.Context) *SurveysDeleteCall

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

func (*SurveysDeleteCall) Do 

func (c *SurveysDeleteCall) Do(opts ...googleapi.CallOption) (*SurveysDeleteResponse, error)

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

func (*SurveysDeleteCall) Fields 

func (c *SurveysDeleteCall) Fields(s ...googleapi.Field) *SurveysDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SurveysDeleteCall) Header 

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

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

type SurveysDeleteResponse 

type SurveysDeleteResponse struct {
	// RequestId: Unique request ID used for logging and debugging. Please
	// include in any error reporting or troubleshooting requests.
	RequestId string `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)

type SurveysGetCall 

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

func (*SurveysGetCall) Context 

func (c *SurveysGetCall) Context(ctx context.Context) *SurveysGetCall

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

func (*SurveysGetCall) Do 

func (c *SurveysGetCall) Do(opts ...googleapi.CallOption) (*Survey, error)

Do executes the "consumersurveys.surveys.get" call. Exactly one of *Survey or error will be non-nil. Any non-2xx status code 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 to check whether the returned error was because http.StatusNotModified was returned.

func (*SurveysGetCall) Fields 

func (c *SurveysGetCall) Fields(s ...googleapi.Field) *SurveysGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SurveysGetCall) Header 

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

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

func (*SurveysGetCall) IfNoneMatch 

func (c *SurveysGetCall) IfNoneMatch(entityTag string) *SurveysGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type SurveysInsertCall 

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

func (*SurveysInsertCall) Context 

func (c *SurveysInsertCall) Context(ctx context.Context) *SurveysInsertCall

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

func (*SurveysInsertCall) Do 

func (c *SurveysInsertCall) Do(opts ...googleapi.CallOption) (*Survey, error)

Do executes the "consumersurveys.surveys.insert" call. Exactly one of *Survey or error will be non-nil. Any non-2xx status code 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 to check whether the returned error was because http.StatusNotModified was returned.

func (*SurveysInsertCall) Fields 

func (c *SurveysInsertCall) Fields(s ...googleapi.Field) *SurveysInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SurveysInsertCall) Header 

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

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

type SurveysListCall 

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

func (*SurveysListCall) Context 

func (c *SurveysListCall) Context(ctx context.Context) *SurveysListCall

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

func (*SurveysListCall) Do 

func (c *SurveysListCall) Do(opts ...googleapi.CallOption) (*SurveysListResponse, error)

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

func (*SurveysListCall) Fields 

func (c *SurveysListCall) Fields(s ...googleapi.Field) *SurveysListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SurveysListCall) Header 

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

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

func (*SurveysListCall) IfNoneMatch 

func (c *SurveysListCall) IfNoneMatch(entityTag string) *SurveysListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*SurveysListCall) MaxResults 

func (c *SurveysListCall) MaxResults(maxResults int64) *SurveysListCall

MaxResults sets the optional parameter "maxResults":

func (*SurveysListCall) StartIndex 

func (c *SurveysListCall) StartIndex(startIndex int64) *SurveysListCall

StartIndex sets the optional parameter "startIndex":

func (*SurveysListCall) Token 

func (c *SurveysListCall) Token(token string) *SurveysListCall

Token sets the optional parameter "token":

type SurveysListResponse 

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.
	RequestId string `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)

type SurveysService 

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

func NewSurveysService 

func NewSurveysService(s *Service) *SurveysService

func (*SurveysService) Delete 

func (r *SurveysService) Delete(surveyUrlId string) *SurveysDeleteCall

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

func (*SurveysService) Get 

func (r *SurveysService) Get(surveyUrlId string) *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 

func (r *SurveysService) List() *SurveysListCall

List: Lists the surveys owned by the authenticated user.

func (*SurveysService) Start 

func (r *SurveysService) Start(resourceId string, surveysstartrequest *SurveysStartRequest) *SurveysStartCall

Start: Begins running a survey.

func (*SurveysService) Stop 

func (r *SurveysService) Stop(resourceId string) *SurveysStopCall

Stop: Stops a running survey.

func (*SurveysService) Update 

func (r *SurveysService) Update(surveyUrlId string, survey *Survey) *SurveysUpdateCall

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

type SurveysStartCall 

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

func (*SurveysStartCall) Context 

func (c *SurveysStartCall) Context(ctx context.Context) *SurveysStartCall

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

func (*SurveysStartCall) Do 

func (c *SurveysStartCall) Do(opts ...googleapi.CallOption) (*SurveysStartResponse, error)

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

func (*SurveysStartCall) Fields 

func (c *SurveysStartCall) Fields(s ...googleapi.Field) *SurveysStartCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SurveysStartCall) Header 

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

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

type SurveysStartRequest 

type SurveysStartRequest struct {
	// MaxCostPerResponseNanos: Threshold to start a survey automically if
	// the quoted prices is less than or equal to this value. See
	// Survey.Cost for more details.
	MaxCostPerResponseNanos int64 `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)

type SurveysStartResponse 

type SurveysStartResponse struct {
	// RequestId: Unique request ID used for logging and debugging. Please
	// include in any error reporting or troubleshooting requests.
	RequestId string `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)

type SurveysStopCall 

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

func (*SurveysStopCall) Context 

func (c *SurveysStopCall) Context(ctx context.Context) *SurveysStopCall

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

func (*SurveysStopCall) Do 

func (c *SurveysStopCall) Do(opts ...googleapi.CallOption) (*SurveysStopResponse, error)

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

func (*SurveysStopCall) Fields 

func (c *SurveysStopCall) Fields(s ...googleapi.Field) *SurveysStopCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SurveysStopCall) Header 

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

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

type SurveysStopResponse 

type SurveysStopResponse struct {
	// RequestId: Unique request ID used for logging and debugging. Please
	// include in any error reporting or troubleshooting requests.
	RequestId string `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)

type SurveysUpdateCall 

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

func (*SurveysUpdateCall) Context 

func (c *SurveysUpdateCall) Context(ctx context.Context) *SurveysUpdateCall

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

func (*SurveysUpdateCall) Do 

func (c *SurveysUpdateCall) Do(opts ...googleapi.CallOption) (*Survey, error)

Do executes the "consumersurveys.surveys.update" call. Exactly one of *Survey or error will be non-nil. Any non-2xx status code 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 to check whether the returned error was because http.StatusNotModified was returned.

func (*SurveysUpdateCall) Fields 

func (c *SurveysUpdateCall) Fields(s ...googleapi.Field) *SurveysUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SurveysUpdateCall) Header 

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

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

type TokenPagination 

type TokenPagination struct {
	NextPageToken string `json:"nextPageToken,omitempty"`

	PreviousPageToken string `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 or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.