Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
HTTP request
POST https://analyticshub.googleapis.com/v1beta1/{name=projects/*/locations/*/dataExchanges/*/listings/*}:subscribe
Required. Resource name of the listing that you want to subscribe to. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.
Request body
The request body contains data with the following structure:
JSON representation
{// Union field destination can be only one of the following:"destinationDataset": {object (DestinationDataset)}// End of list of possible types for union field destination.}
Fields
Union field destination. Resulting destination of the listing that you subscribed to. destination can be only one of the following:
Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
projectId
string
Required. The ID of the project containing this dataset.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[[["\u003cp\u003eThis document describes how to subscribe to a listing in Google Cloud's Analytics Hub, which currently supports subscribing to BigQuery datasets.\u003c/p\u003e\n"],["\u003cp\u003eSubscribing to a listing creates a linked dataset in the subscriber's project, and the subscription is initiated via a POST request to a specified URL that includes path parameters like project, location, and listing identifiers.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain the destination dataset details, defined as a \u003ccode\u003eDestinationDataset\u003c/code\u003e object, that specifies where the linked dataset should be created.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDestinationDataset\u003c/code\u003e requires a \u003ccode\u003edatasetReference\u003c/code\u003e, which includes the \u003ccode\u003edatasetId\u003c/code\u003e and \u003ccode\u003eprojectId\u003c/code\u003e for identifying the destination BigQuery dataset, as well as its location, and can include other details like its name, description, and labels.\u003c/p\u003e\n"],["\u003cp\u003eSubscribing to a listing requires specific OAuth scopes (\u003ccode\u003ehttps://www.googleapis.com/auth/bigquery\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e) and the \u003ccode\u003eanalyticshub.listings.subscribe\u003c/code\u003e IAM permission on the targeted listing resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.dataExchanges.listings.subscribe\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [DestinationDataset](#DestinationDataset)\n - [JSON representation](#DestinationDataset.SCHEMA_REPRESENTATION)\n- [DestinationDatasetReference](#DestinationDatasetReference)\n - [JSON representation](#DestinationDatasetReference.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nSubscribes to a listing.\n\nCurrently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.\n\n### HTTP request\n\n`POST https://analyticshub.googleapis.com/v1beta1/{name=projects/*/locations/*/dataExchanges/*/listings/*}:subscribe`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/bigquery`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `analyticshub.listings.subscribe`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nDestinationDataset\n------------------\n\nDefines the destination bigquery dataset.\n\nDestinationDatasetReference\n---------------------------"]]