Method: projects.topics.publish

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

HTTP request

POST https://pubsub.googleapis.com/v1/{topic}:publish

Path parameters

Parameters
topic

string

The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "messages": [
    {
      object(PubsubMessage)
    }
  ],
}
Fields
messages[]

object(PubsubMessage)

The messages to publish.

Response body

If successful, the response body contains data with the following structure:

Response for the topics.publish method.

JSON representation
{
  "messageIds": [
    string
  ],
}
Fields
messageIds[]

string

The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Try it!

Send feedback about...

Cloud Pub/Sub