Surveys

For a list of methods for this resource, see the end of this page.

Resource representations

Representation of an individual survey object.

{
  "surveyUrlId": string,
  "title": string,
  "owners": [
    string
  ],
  "wantedResponseCount": integer,
  "description": string,
  "customerData": bytes,
  "audience": {
    "country": string,
    "countrySubdivision": string,
    "languages": [
      string
    ],
    "ages": [
      string
    ],
    "gender": string,
    "populationSource": string,
    "mobileAppPanelId": string
  },
  "questions": [
    {
      "answers": [
        string
      ],
      "question": string,
      "type": string,
      "answerOrder": string,
      "thresholdAnswers": [
        string
      ],
      "lastAnswerPositionPinned": boolean,
      "lowValueLabel": string,
      "highValueLabel": string,
      "numStars": string,
      "sentimentText": string,
      "openTextPlaceholder": string,
      "openTextSuggestions": [
        string
      ],
      "singleLineResponse": boolean,
      "mustPickSuggestion": boolean,
      "images": [
        {
          "data": bytes,
          "altText": string,
          "url": string
        }
      ],
      "videoId": string,
      "unitOfMeasurementLabel": string,
      "hasOther": boolean
    }
  ],
  "state": string,
  "rejectionReason": {
    "type": string,
    "explanation": string
  },
  "cost": {
    "nanos": long,
    "currencyCode": string,
    "costPerResponseNanos": long,
    "maxCostPerResponseNanos": long
  }
}
Property name Value Description Notes
audience nested object Targeting-criteria message containing demographic information writable
audience.ages[] list Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+'] writable
audience.country string 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. writable
audience.countrySubdivision string 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). writable
audience.gender string Optional gender to target.

Acceptable values are:
  • "female"
  • "male"
writable
audience.languages[] list 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. writable
audience.mobileAppPanelId string Key for predefined panel that causes survey to be sent to a predefined set of Opinion Rewards App users. You must set PopulationSource to ANDROID_APP_PANEL to use this field. writable
audience.populationSource string Online population source where the respondents are sampled from.

Acceptable values are:
  • "androidAppPanel"
  • "general"
writable
cost nested object Cost to run the survey and collect the necessary number of responses.
cost.costPerResponseNanos long 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.
cost.currencyCode string Currency code that the cost is given in.
cost.maxCostPerResponseNanos long 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.
cost.nanos long Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
customerData bytes 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. writable
description string Text description of the survey. writable
owners[] list List of email addresses for survey owners. Must contain at least the address of the user making the API call. writable
questions[] list List of questions defining the survey. writable
questions[].answerOrder string The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.

Acceptable values are:
  • "randomize"
  • "randomlyReverse"
  • "sorted"
writable
questions[].answers[] list Required list of answer options for a question. writable
questions[].hasOther boolean 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. writable
questions[].highValueLabel string 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. writable
questions[].images[] list
questions[].images[].altText string The alt text property used in image tags is required for all images. writable
questions[].images[].data bytes Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types. writable
questions[].images[].url string The read-only URL for the hosted images.
questions[].lastAnswerPositionPinned boolean Currently only support pinning an answer option to the last position. writable
questions[].lowValueLabel string 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. writable
questions[].mustPickSuggestion boolean Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
questions[].numStars string Number of stars to use for ratings questions.

Acceptable values are:
  • "eleven"
  • "five"
  • "seven"
  • "ten"
writable
questions[].openTextPlaceholder string Placeholder text for an open text question. writable
questions[].openTextSuggestions[] list A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true. writable
questions[].question string Required question text shown to the respondent. writable
questions[].sentimentText string 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. writable
questions[].singleLineResponse boolean 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. writable
questions[].thresholdAnswers[] list 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. writable
questions[].type string Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.

Acceptable values are:
  • "largeImageChoice"
  • "menuWithImage"
  • "multipleAnswers"
  • "multipleAnswersWithImage"
  • "numericOpenEnded"
  • "openEnded"
  • "openEndedWithImage"
  • "ratingScale"
  • "ratingScaleWithImage"
  • "ratingScaleWithText"
  • "sideBySideImages"
  • "singleAnswer"
  • "singleAnswerWithImage"
  • "video"
writable
questions[].unitOfMeasurementLabel string Optional unit of measurement for display (for example: hours, people, miles). writable
questions[].videoId string The YouTube video ID to be show in video questions. writable
rejectionReason nested object Reason for the survey being rejected. Only present if the survey state is rejected.
rejectionReason.explanation string A human-readable explanation of what was wrong with the survey.
rejectionReason.type string Which category of rejection this was. See the Google Surveys Help Center for additional details on each category.

Acceptable values are:
  • "adult": Adult content.
  • "alcohol": Alcohol, tobacco, or drug content.
  • "characterLimit": Exceeds maximum text length for questions (125) or answers (36).
  • "copyright": Infringes on intellectual property or the copyrights of others.
  • "gambling": Promotes online gambling.
  • "hate": Promotes hate or violence.
  • "illegal": Promotes illegal activities.
  • "inappropriateLanguage": Contains offensive language.
  • "medical": Promotes use of health procedures.
  • "personal": Personally identifiable information.
  • "projectedLow": Low-incidence survey in which almost no one would pass the screening question(s).
  • "punctuation": Incorrect or gimmicky punctuation.
  • "pushPoll": Survey tries to influence respondent.
  • "relevanceClarityGeneral": Generally not clear or contains nonsensical "garbage" text.
  • "relevanceClarityImage": Image is confusing or missing.
  • "relevanceClarityNoneAbove": Missing None-of-the-Above answer.
  • "relevanceClarityPartialPin": Question pinning is incorrect.
  • "relevanceClarityRandom": Inappropriate use of answer randomization, causing confusion.
  • "repetitive": Contains repetitive words or slogan.
  • "repulsive": Content is gruesome or disgusting.
  • "sensitive": Violates sensitive demographics.
  • "spellingGrammar": Poor spelling or grammar.
  • "unknown": Not specified.
  • "wrongLanguage": Survey content not in correct language.
state string State that the survey is in.

Acceptable values are:
  • "awaitingReview"
  • "calculatingPriceQuote"
  • "complete"
  • "editable"
  • "error"
  • "paused"
  • "rejected"
  • "running"
  • "unknownState"
surveyUrlId string Unique survey ID, that is viewable in the URL of the Survey Creator UI
title string Optional name that will be given to the survey. writable
wantedResponseCount integer Number of responses desired for the survey. writable

Methods

delete
Removes a survey from view in all user GET requests.
get
Retrieves information about the specified survey.
insert
Creates a survey.
list
Lists the surveys owned by the authenticated user.
start
Begins running a survey.
stop
Stops a running survey.
update
Updates a survey. Currently the only property that can be updated is the owners property.

Send feedback about...

Google Surveys
Google Surveys