Anchor to section titled 'undefined'

pubSubServerPixelUpdate
mutation

Requires write_pixels access scope. Also: The app must have the read_customer_events and write_server_pixels access scopes.

Updates the server pixel to connect to a Google PubSub endpoint. Running this mutation deletes any previous subscriptions for the server pixel.

Anchor to section titled 'Arguments'

Arguments

Anchor to pubSubProject
pubSubProject
String!
required

The Google PubSub project ID.

Anchor to pubSubTopic
pubSubTopic
String!
required

The Google PubSub topic ID.

Was this section helpful?
Anchor to section titled 'PubSubServerPixelUpdatePayload returns'

PubSubServerPixelUpdatePayload returns

Anchor to PubSubServerPixelUpdatePayload.serverPixel
serverPixel
ServerPixel

The server pixel as configured by the mutation.

Anchor to PubSubServerPixelUpdatePayload.userErrors
userErrors
[ErrorsServerPixelUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation pubSubServerPixelUpdate($pubSubProject: String!, $pubSubTopic: String!) {
  pubSubServerPixelUpdate(pubSubProject: $pubSubProject, pubSubTopic: $pubSubTopic) {
    serverPixel {
      # ServerPixel fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "pubSubProject": "<your-pubSubProject>",
  "pubSubTopic": "<your-pubSubTopic>"
}