spreadsheets

Changed on

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the guide and sample code for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The valueInputOption only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.

post/v4/spreadsheets/{spreadsheetId}/values/{range}:append

Request

  • Base URL: https://sheets.googleapis.com
  • URL: https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}:append
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/drive) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/drive)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/drive.file) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/drive.file)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/spreadsheets) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/spreadsheets)

Path parameters

spreadsheetIdstring required

The ID of the spreadsheet to update.

rangestring required

The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table.

Query parameters

includeValuesInResponseboolean

Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.

insertDataOption'OVERWRITE' | 'INSERT_ROWS'

How the input data should be inserted.

responseDateTimeRenderOption'SERIAL_NUMBER' | 'FORMATTED_STRING'

Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

responseValueRenderOption'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA'

Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.

valueInputOption'INPUT_VALUE_OPTION_UNSPECIFIED' | 'RAW' | 'USER_ENTERED'

How the input data should be interpreted.

Request body

majorDimension'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS'

The major dimension of the values. For output, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting range=A1:B2,majorDimension=ROWS will return [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS will return [[1,3],[2,4]]. For input, with range=A1:B2,majorDimension=ROWS then [[1,2],[3,4]] will set A1=1,B1=2,A2=3,B2=4. With range=A1:B2,majorDimension=COLUMNS then [[1,2],[3,4]] will set A1=1,B1=3,A2=2,B2=4. When writing, if this field is not set, it defaults to ROWS.

rangestring

The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.

Response

Successful response

Changes

  • c69ba34ec4e6Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets was removed from the endpoint's security scheme Oauth2c

  • f5bfb17ef851Revision changes
    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets was removed from the endpoint's security scheme Oauth2c