listings_subscriptions

Creates, updates, deletes, gets or lists a listings_subscriptions resource.

Overview

Name	listings_subscriptions
Type	Resource
Id	google.analyticshub.listings_subscriptions

Fields

The following fields are returned by SELECT queries:

projects_locations_data_exchanges_listings_list_subscriptions

Name	Datatype	Description
name	string	Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123.
commercialInfo	object	Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing. (id: GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfo)
creationTime	string (google-datetime)	Output only. Timestamp when the subscription was created.
dataExchange	string	Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
destinationDataset	object	Optional. BigQuery destination dataset to create for the subscriber. (id: DestinationDataset)
lastModifyTime	string (google-datetime)	Output only. Timestamp when the subscription was last modified.
linkedDatasetMap	object	Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
linkedResources	array	Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
listing	string	Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
logLinkedDatasetQueryUserEmail	boolean	Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
organizationDisplayName	string	Output only. Display name of the project of this subscription.
organizationId	string	Output only. Organization of the project this subscription belongs to.
resourceType	string	Output only. Listing shared asset type. (SHARED_RESOURCE_TYPE_UNSPECIFIED, BIGQUERY_DATASET, PUBSUB_TOPIC)
state	string	Output only. Current state of the subscription. (STATE_UNSPECIFIED, STATE_ACTIVE, STATE_STALE, STATE_INACTIVE)
subscriberContact	string	Output only. Email of the subscriber.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_data_exchanges_listings_list_subscriptions	select	projectsId, locationsId, dataExchangesId, listingsId	includeDeletedSubscriptions, pageSize, pageToken	Lists all subscriptions on a given Data Exchange or Listing.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dataExchangesId	string
listingsId	string
locationsId	string
projectsId	string
includeDeletedSubscriptions	boolean
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_data_exchanges_listings_list_subscriptions

Lists all subscriptions on a given Data Exchange or Listing.

SELECT
name,
commercialInfo,
creationTime,
dataExchange,
destinationDataset,
lastModifyTime,
linkedDatasetMap,
linkedResources,
listing,
logLinkedDatasetQueryUserEmail,
organizationDisplayName,
organizationId,
resourceType,
state,
subscriberContact
FROM google.analyticshub.listings_subscriptions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataExchangesId = '{{ dataExchangesId }}' -- required
AND listingsId = '{{ listingsId }}' -- required
AND includeDeletedSubscriptions = '{{ includeDeletedSubscriptions }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;