Returns the paginated list of reviews for all specified locations. This operation is only valid if the specified locations are verified. <aside class="note"><b>Note:</b> Reviews are limited to a batch size of 200 location_names per call.</aside>

Required Scalar Argument

  • <name> (string)
    • The name of the account from which to retrieve a list of reviews across multiple locations.

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:

BatchGetReviewsRequest:
  ignore-rating-only-reviews: boolean
  location-names: [string]
  order-by: string
  page-size: integer
  page-token: string

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 . ignore-rating-only-reviews=true
    • Whether to ignore rating-only reviews.
  • location-names=stet
    • A collection of locations to fetch reviews for, specified by their names.
    • Each invocation of this argument appends the given value to the array.
  • order-by=kasd
    • Optional. Specifies the field to sort reviews by. If unspecified, the order of reviews returned will default to update_time desc. Valid orders to sort by are rating, rating desc and update_time desc. rating will return reviews in ascending order. update_time(i.e. ascending order) is not supported.
  • page-size=77
    • How many reviews to fetch per page. The default value is 200.
  • page-token=sed
    • If specified, it fetches the next page of reviews.

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 $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

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

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").