Method: projects.locations.services.connectors.executeQuery

Execute a predefined query in a Connector.

HTTP request

POST https://firebasedataconnect.googleapis.com/v1beta/{name=projects/*/locations/*/services/*/connectors/*}:executeQuery

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the connector to find the predefined query, in the format:

projects/{project}/locations/{location}/services/{service}/connectors/{connector}

Request body

The request body contains data with the following structure:

JSON representation
{
  "operationName": string,
  "variables": {
    object
  }
}
Fields
operationName

string

Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name.

variables

object (Struct format)

Optional. Values for GraphQL variables provided in this request.

Response body

The connectors.executeQuery response from Firebase Data Connect.

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

JSON representation
{
  "data": {
    object
  },
  "errors": [
    {
      object (GraphqlError)
    }
  ]
}
Fields
data

object (Struct format)

The result of executing the requested operation.

errors[]

object (GraphqlError)

Errors of this response.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.