Google Sheets component

The google-sheets component reads, writes, appends and clears cell values in Google Sheets spreadsheets, and creates and updates spreadsheets, over the Sheets v4 REST API.

Scheme: google-sheets: · Crate: cameleer-cloud · Cargo feature: cloud · Consumer: no (see google-sheets-stream) · Producer: yes · Apache Camel: Google Sheets

When to use it

• Use a spreadsheet as a lightweight database for an AI agent: one tool appends rows, another reads them back, and people can see and edit the data in the browser.
• Append form submissions, orders or leads to a sheet that a business team already uses.
• Export a report into a shared sheet on a schedule (data/update or data/batchUpdate).
• Create spreadsheets and add or rename tabs (spreadsheets/create, spreadsheets/batchUpdate).

URI format

google-sheets://apiName/methodName[?options]

apiName/methodName is one of data/get, data/update, data/append, data/clear, data/batchGet, data/batchUpdate, data/batchClear, spreadsheets/get, spreadsheets/create or spreadsheets/batchUpdate. Any other value fails when the endpoint is created.

Example

Two HTTP tools for an agent that keeps its leads in a sheet. POST /tools/save-lead with {"name": "Ada", "email": "ada@example.com", "score": 92} appends one row to the Leads tab; GET /tools/list-leads returns all rows as JSON.

- route:
    id: save-lead
    from:
      uri: "platform-http:/tools/save-lead?httpMethodRestrict=POST"
      steps:
        - unmarshal:
            json: {}
        - setBody:
            simple: '[["${body[name]}", "${body[email]}", "${body[score]}"]]'
        - to: "google-sheets://data/append?spreadsheetId={{env:SHEET_ID}}&range=Leads!A:C&valueInputOption=RAW"
        - marshal:
            json: {}
- route:
    id: list-leads
    from:
      uri: "platform-http:/tools/list-leads?httpMethodRestrict=GET"
      steps:
        - to: "google-sheets://data/get?spreadsheetId={{env:SHEET_ID}}&range=Leads!A2:C1000"
        - marshal:
            json: {}

The append returns the update result (updatedRange, updatedRows, updatedCells, ...). The get returns the rows as a list of lists of strings, for example [["Ada","ada@example.com","92"]]. The values are built with a Simple template here, so a name that contains a double quote would break the JSON; build the row in a processor or send a JSON array from the client when the input is untrusted.

Rust DSL

ctx.add_routes(|b| {
    b.from("platform-http:/tools/save-lead?httpMethodRestrict=POST")
        .unmarshal("json")
        .set_body(simple(r#"[["${body[name]}", "${body[email]}", "${body[score]}"]]"#))
        .to("google-sheets://data/append?spreadsheetId={{env:SHEET_ID}}&range=Leads!A:C&valueInputOption=RAW")
        .marshal("json");
    b.from("platform-http:/tools/list-leads?httpMethodRestrict=GET")
        .to("google-sheets://data/get?spreadsheetId={{env:SHEET_ID}}&range=Leads!A2:C1000")
        .marshal("json");
})?;

What each method does

Values for data/update and data/append come from the CamelGoogleSheets.values header, or else the body. Accepted shapes: a list of rows (lists), a single flat list (one row), a ValueRange map with a values field, or JSON text of any of these.

Options

applicationName, scopes, splitResult, inBody and includeGridData are accepted for compatibility with Camel and ignored. The OAuth scope is always https://www.googleapis.com/auth/spreadsheets.

Message headers

Every option above that the methods read (spreadsheetId, range, ranges, valueInputOption, majorDimension, title) can also be set per message as a CamelGoogleSheets.<option> header, which wins over the URI option.

Run it with Docker

Share the spreadsheet with the service account's e-mail address (Editor), then:

docker run --rm -p 8080:8080 \
  -e SHEET_ID=1AbC...xyz \
  -e GOOGLE_APPLICATION_CREDENTIALS=/secrets/key.json \
  -v "$PWD/key.json:/secrets/key.json:ro" \
  -v "$PWD:/routes:ro" pmsudhi/cameleer run /routes/leads.camel.yaml

Common questions

How do I append a row to a Google Sheet?

Send a list (one row) or a list of lists (several rows) to google-sheets://data/append?spreadsheetId=...&range=Sheet1!A:C. Rows are added after the last row of the table found in the range.

Why does Sheets return "The caller does not have permission"?

The service account is a separate Google identity. Share the spreadsheet with its e-mail address (...@...iam.gserviceaccount.com), or use clientId/clientSecret/refreshToken to act as a user.

How do I add a new tab?

Call spreadsheets/batchUpdate with the body [{"addSheet": {"properties": {"title": "2026"}}}]. Requests are passed through to the API unchanged.

How do I get notified of new rows?

Use the google-sheets-stream consumer, which emits only the rows appended since the previous poll.

Related

• google-sheets-stream: consume new rows.
• google-drive, google-mail, google-calendar.
• Apache Camel Google Sheets component

Found a problem?

If something on this page doesn't match what Cameleer does, or you hit a bug while building with it, please help fix it, whether you are a person or a coding agent: open an issue that describes what you saw, then fork the repository, fix it, add or update a test, run cargo test --workspace, and open a pull request. CONTRIBUTING.md explains the ground rules.