Creates a survey.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/consumersurveys
  • https://www.googleapis.com/auth/userinfo.email

If unset, the scope for this method defaults to https://www.googleapis.com/auth/consumersurveys. You can set the scope for this method like this: consumersurveys2 --scope <scope> surveys insert ...

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Survey:
  audience:
    ages: [string]
    country: string
    country-subdivision: string
    gender: string
    languages: [string]
    mobile-app-panel-id: string
    population-source: string
  cost:
    cost-per-response-nanos: string
    currency-code: string
    max-cost-per-response-nanos: string
    nanos: string
  customer-data: string
  description: string
  owners: [string]
  rejection-reason:
    explanation: string
    type: string
  state: string
  survey-url-id: string
  title: string
  wanted-response-count: integer

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .audience ages=takimata
    • No description provided.
    • Each invocation of this argument appends the given value to the array.
  • country=amet.
    • No description provided.
  • country-subdivision=duo
    • No description provided.
  • gender=ipsum
    • No description provided.
  • languages=gubergren
    • No description provided.
    • Each invocation of this argument appends the given value to the array.
  • mobile-app-panel-id=lorem
    • No description provided.

  • population-source=gubergren

    • No description provided.

  • ..cost cost-per-response-nanos=eos

    • No description provided.
  • currency-code=dolor
    • No description provided.
  • max-cost-per-response-nanos=ea
    • No description provided.

  • nanos=ipsum

    • No description provided.

  • .. customer-data=invidunt

    • No description provided.
  • description=amet
    • No description provided.
  • owners=duo
    • No description provided.
    • Each invocation of this argument appends the given value to the array.
  • rejection-reason explanation=ipsum
    • No description provided.

  • type=sed

    • No description provided.

  • .. state=ut

    • No description provided.
  • survey-url-id=gubergren
    • No description provided.
  • title=rebum.
    • No description provided.
  • wanted-response-count=44
    • No description provided.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • -p user-ip=string

    • IP address of the site where the request originates. Use this if you want to enforce per-user limits.