api: google.golang.org/api/surveys/v2 Index | Files

package surveys

import "google.golang.org/api/surveys/v2"

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, 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:

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)))

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

Index

Package Files

surveys-gen.go

Constants

const (
    // View and manage your surveys and results
    SurveysScope = "https://www.googleapis.com/auth/surveys"

    // View your surveys and survey results
    SurveysReadonlyScope = "https://www.googleapis.com/auth/surveys.readonly"

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

OAuth2 scopes used by this API.

type FieldMask Uses

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 Uses

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

type PageInfo Uses

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 Uses

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

type ResultsGetCall Uses

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

func (*ResultsGetCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

type ResultsMask Uses

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 Uses

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

type ResultsService Uses

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

func NewResultsService Uses

func NewResultsService(s *Service) *ResultsService

func (*ResultsService) Get Uses

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 Uses

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

    Results *ResultsService

    Surveys *SurveysService
    // contains filtered or unexported fields
}

func New Uses

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 Uses

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

NewService creates a new Service.

type Survey Uses

type Survey struct {
    // Audience: Targeting-criteria message containing demographic
    // information
    Audience *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.
    CustomerData string `json:"customerData,omitempty"`

    // Description: Text description of the survey.
    Description string `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.
    State string `json:"state,omitempty"`

    // SurveyUrlId: Unique survey ID, that is viewable in the URL of the
    // Survey Creator UI
    SurveyUrlId string `json:"surveyUrlId,omitempty"`

    // Title: Optional name that will be given to the survey.
    Title string `json:"title,omitempty"`

    // WantedResponseCount: Number of responses desired for the survey.
    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:"-"`
}

Survey: Representation of an individual survey object.

func (*Survey) MarshalJSON Uses

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

type SurveyAudience Uses

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.
    Country string `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).
    CountrySubdivision string `json:"countrySubdivision,omitempty"`

    // Gender: Optional gender to target.
    Gender string `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.
    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:"-"`
}

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

func (*SurveyAudience) MarshalJSON Uses

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

type SurveyCost Uses

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.
    CostPerResponseNanos int64 `json:"costPerResponseNanos,omitempty,string"`

    // CurrencyCode: Currency code that the cost is given in.
    CurrencyCode string `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.
    MaxCostPerResponseNanos int64 `json:"maxCostPerResponseNanos,omitempty,string"`

    // Nanos: Cost of survey in nano units of the given currency. DEPRECATED
    // in favor of cost_per_response_nanos
    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:"-"`
}

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

func (*SurveyCost) MarshalJSON Uses

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

type SurveyQuestion Uses

type SurveyQuestion struct {
    // AnswerOrder: The randomization option for multiple choice and
    // multi-select questions. If not specified, this option defaults to
    // randomize.
    AnswerOrder string `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.
    HasOther bool `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.
    HighValueLabel string `json:"highValueLabel,omitempty"`

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

    // LastAnswerPositionPinned: Currently only support pinning an answer
    // option to the last position.
    LastAnswerPositionPinned bool `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.
    LowValueLabel string `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.
    MustPickSuggestion bool `json:"mustPickSuggestion,omitempty"`

    // NumStars: Number of stars to use for ratings questions.
    NumStars string `json:"numStars,omitempty"`

    // OpenTextPlaceholder: Placeholder text for an open text question.
    OpenTextPlaceholder string `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.
    Question string `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.
    SentimentText string `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.
    SingleLineResponse bool `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.
    Type string `json:"type,omitempty"`

    // UnitOfMeasurementLabel: Optional unit of measurement for display (for
    // example: hours, people, miles).
    UnitOfMeasurementLabel string `json:"unitOfMeasurementLabel,omitempty"`

    // VideoId: The YouTube video ID to be show in video questions.
    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:"-"`
}

SurveyQuestion: Message defining the question specifications.

func (*SurveyQuestion) MarshalJSON Uses

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

type SurveyQuestionImage Uses

type SurveyQuestionImage struct {
    // AltText: The alt text property used in image tags is required for all
    // images.
    AltText string `json:"altText,omitempty"`

    // Data: Inline jpeg, gif, tiff, bmp, or png image raw bytes for an
    // image question types.
    Data string `json:"data,omitempty"`

    // Url: The read-only URL for the hosted images.
    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:"-"`
}

SurveyQuestionImage: Container object for image data and alt_text.

func (*SurveyQuestionImage) MarshalJSON Uses

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

type SurveyRejection Uses

type SurveyRejection struct {
    // Explanation: A human-readable explanation of what was wrong with the
    // survey.
    Explanation string `json:"explanation,omitempty"`

    // Type: Which category of rejection this was. See the  Google Surveys
    // Help Center for additional details on each category.
    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:"-"`
}

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

func (*SurveyRejection) MarshalJSON Uses

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

type SurveyResults Uses

type SurveyResults struct {
    // Status: Human readable string describing the status of the request.
    Status string `json:"status,omitempty"`

    // SurveyUrlId: External survey ID as viewable by survey owners in the
    // editor view.
    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:"-"`
}

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

func (*SurveyResults) MarshalJSON Uses

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

type SurveysDeleteCall Uses

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

func (*SurveysDeleteCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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 Uses

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

type SurveysGetCall Uses

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

func (*SurveysGetCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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 Uses

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

func (*SurveysInsertCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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

func (*SurveysListCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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 Uses

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

MaxResults sets the optional parameter "maxResults":

func (*SurveysListCall) StartIndex Uses

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

StartIndex sets the optional parameter "startIndex":

func (*SurveysListCall) Token Uses

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

Token sets the optional parameter "token":

type SurveysListResponse Uses

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 Uses

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

type SurveysService Uses

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

func NewSurveysService Uses

func NewSurveysService(s *Service) *SurveysService

func (*SurveysService) Delete Uses

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

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

func (*SurveysService) Get Uses

func (r *SurveysService) Get(surveyUrlId string) *SurveysGetCall

Get: Retrieves information about the specified survey.

func (*SurveysService) Insert Uses

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

Insert: Creates a survey.

func (*SurveysService) List Uses

func (r *SurveysService) List() *SurveysListCall

List: Lists the surveys owned by the authenticated user.

func (*SurveysService) Start Uses

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

Start: Begins running a survey.

func (*SurveysService) Stop Uses

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

Stop: Stops a running survey.

func (*SurveysService) Update Uses

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 Uses

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

func (*SurveysStartCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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.
    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 Uses

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

type SurveysStartResponse Uses

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 Uses

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

type SurveysStopCall Uses

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

func (*SurveysStopCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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 Uses

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

type SurveysUpdateCall Uses

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

func (*SurveysUpdateCall) Context Uses

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 Uses

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

Do executes the "surveys.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 Uses

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 Uses

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 Uses

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 Uses

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

Package surveys imports 14 packages (graph). Updated 2019-09-20. Refresh now. Tools for package owners.