Adding custom parameters/queries/headers to a Google Cloud function

Question

I am basically wondering if I can have an https Google Cloud function execute differently based on what I pass to it as a parameter (like any normal function with parameters). Possibly with a simple query inside the URL or any other method that works.

As an example, taking a look at the basic starter function in any tutorial:

exports.helloWorld = functions.https.onRequest((req, res) => {
  res.status(200).send('Hello, World!');
});

I would like to do something like:

exports.helloWorld = functions.https.onRequest((req, res) => {
  let name = req.query;
  res.status(200).send(`Hello, ${name}!`);
});

I hope this makes sense. Any help would be appreciated.

Deniss T. · Accepted Answer · 2019-10-09 13:32:41Z

6

Indeed it is possible to pass various parameters to your Cloud Function.

Here's a simple example for your reference:

index.js

exports.helloWorld = (req, res) => {
  let name = req.body.name || req.query.name;
  res.status(200).send(`Hello ${name}!`);
};

I can call it via the URL provided for triggering the function, by appending that URL with /?name=<desired-name>:

https://<function-region>-<project-name>.cloudfunctions.net/<function-name>/?name=Christiaan

Alternatively, it can also be called using curl:

curl --data "name=Christiaan" https://<functions-region>-<project-name>.cloudfunctions.net/<function-name>

Output:

Hello Christiaan!

answered Oct 9, 2019 at 13:32

Deniss T.

2,64211 silver badges22 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Tobias Schäfer · Accepted Answer · 2019-10-09 11:03:10Z

0

Hello since HTTPS Cloud Functions are POST requests, you can pass parameters of any kind in the request body.

Example:
Cloud Function:

exports.helloWorld = functions.https.onRequest((req, res) => {
  let name = req.body.name;
  res.status(200).send(`Hello, {name}!`);
});

Client:

fetch('https://firebase.url/helloWorld ', {
    method: 'post',
    body: {name: "Name"},
  }).then(function(response) {
    return response.json();
  }).then(function(data) {
    console.log(data)
  });

You can use any request method here.

Hope this helps.

answered Oct 9, 2019 at 11:03

Tobias Schäfer

1,3683 gold badges17 silver badges39 bronze badges

4 Comments

Deniss T. Over a year ago

You would also need to add '$' to interpolate a variable in a JS string: res.status(200).send(`Hello, ${name}!`);

Christiaan Louw Over a year ago

I tried doing this using Cloud Scheduler, by inserting {name: "Name"} into the body of a job there. But this returns undefined then. Any advice on that?

Tobias Schäfer Over a year ago

Eventually you need to add it like that: {"name": "Name"}

Christiaan Louw Over a year ago

Thanks. Got it now. I also have to parse it to JSON in my code, as it just returns a string.

Collectives™ on Stack Overflow

Adding custom parameters/queries/headers to a Google Cloud function

2 Answers 2

Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related