Method: projects.locations.services.executeGraphqlRead
Stay organized with collections
Save and categorize content based on your preferences.
Execute any GraphQL query against the Firebase Data Connect's generated GraphQL schema. Grants full read to the connected data sources.
services.executeGraphqlRead is identical to services.executeGraphql except it only accepts read-only query.
HTTP request
POST https://firebasedataconnect.googleapis.com/v1beta/{name=projects/*/locations/*/services/*}:executeGraphqlRead
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The relative resource name of Firebase Data Connect service, in the format:
projects/{project}/locations/{location}/services/{service}
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"query": string,
"operationName": string,
"variables": {
object
},
"extensions": {
object (GraphqlRequestExtensions)
}
} |
| Fields |
query |
string
Required. The GraphQL query document source.
|
operationName |
string
Optional. The name of the GraphQL operation name. Required only if query contains multiple operations. See https://graphql.org/learn/queries/#operation-name.
|
variables |
object (Struct format)
Optional. Values for GraphQL variables provided in this request.
|
extensions |
object (GraphqlRequestExtensions)
Optional. Additional GraphQL request information.
|
Response body
If successful, the response body contains an instance of GraphqlResponse.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name resource:
firebasedataconnect.services.executeGraphqlRead
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-20 UTC.
[null,null,["Last updated 2024-09-20 UTC."],[],[],null,["# Method: projects.locations.services.executeGraphqlRead\n\nExecute any GraphQL query against the Firebase Data Connect's generated GraphQL schema. Grants full read to the connected data sources.\n\n`services.executeGraphqlRead` is identical to `services.executeGraphql` except it only accepts read-only query.\n\n### HTTP request\n\n`POST https://firebasedataconnect.googleapis.com/v1beta/{name=projects/*/locations/*/services/*}:executeGraphqlRead`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The relative resource name of Firebase Data Connect service, in the format: projects/{project}/locations/{location}/services/{service} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"query\": string, \"operationName\": string, \"variables\": { object }, \"extensions\": { object (/docs/reference/data-connect/rest/v1beta/GraphqlRequestExtensions) } } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. The GraphQL query document source. |\n| `operationName` | `string` Optional. The name of the GraphQL operation name. Required only if `query` contains multiple operations. See \u003chttps://graphql.org/learn/queries/#operation-name\u003e. |\n| `variables` | `object (`[Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct)` format)` Optional. Values for GraphQL variables provided in this request. |\n| `extensions` | `object (`[GraphqlRequestExtensions](/docs/reference/data-connect/rest/v1beta/GraphqlRequestExtensions)`)` Optional. Additional GraphQL request information. |\n\n### Response body\n\nIf successful, the response body contains an instance of [GraphqlResponse](/docs/reference/data-connect/rest/v1beta/GraphqlResponse).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `firebasedataconnect.services.executeGraphqlRead`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
