Console
    Start free

    Subscription

    A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "creationTime" 
 : 
 string 
 , 
 "lastModifyTime" 
 : 
 string 
 , 
 "organizationId" 
 : 
 string 
 , 
 "organizationDisplayName" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "linkedDatasetMap" 
 : 
 { 
 string 
 : 
 { 
 object (  LinkedResource 
 
) 
 } 
 , 
 ... 
 } 
 , 
 "subscriberContact" 
 : 
 string 
 , 
 "linkedResources" 
 : 
 [ 
 { 
 object (  LinkedResource 
 
) 
 } 
 ] 
 , 
 "resourceType" 
 : 
 enum (  SharedResourceType 
 
) 
 , 
 "commercialInfo" 
 : 
 { 
 object (  CommercialInfo 
 
) 
 } 
 , 
 "destinationDataset" 
 : 
 { 
 object (  DestinationDataset 
 
) 
 } 
 , 
 // Union field resource_name 
can be only one of the following: 
 "listing" 
 : 
 string 
 , 
 "dataExchange" 
 : 
 string 
 // End of list of possible types for union field resource_name 
. 
 "logLinkedDatasetQueryUserEmail" 
 : 
 boolean 
 }
    Fields
    name

    string

    Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123 .

    creationTime

    string ( Timestamp format)

    Output only. Timestamp when the subscription was created.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    lastModifyTime

    string ( Timestamp format)

    Output only. Timestamp when the subscription was last modified.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    organizationId

    string

    Output only. Organization of the project this subscription belongs to.

    organizationDisplayName

    string

    Output only. Display name of the project of this subscription.

    state

    enum ( State )

    Output only. Current state of the subscription.

    linkedDatasetMap

    map (key: string, value: object ( LinkedResource ))

    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.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    subscriberContact

    string

    Output only. Email of the subscriber.

    linkedResources[]

    object ( LinkedResource )

    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.

    resourceType

    enum ( SharedResourceType )

    Output only. Listing shared asset type.

    commercialInfo

    object ( CommercialInfo )

    Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.

    destinationDataset

    object ( DestinationDataset )

    Optional. BigQuery destination dataset to create for the subscriber.

    Union field resource_name .

    resource_name can be only one of the following:

    listing

    string

    Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789

    dataExchange

    string

    Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456

    logLinkedDatasetQueryUserEmail

    boolean

    Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.

    LinkedResource

    Reference to a linked resource tracked by this Subscription.

    JSON representation 
     { 
 "listing" 
 : 
 string 
 , 
 // Union field reference 
can be only one of the following: 
 "linkedDataset" 
 : 
 string 
 , 
 "linkedPubsubSubscription" 
 : 
 string 
 // End of list of possible types for union field reference 
. 
 }
    Fields
    listing

    string

    Output only. Listing for which linked resource is created.

    Union field reference .

    reference can be only one of the following:

    linkedDataset

    string

    Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset

    linkedPubsubSubscription

    string

    Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id

    CommercialInfo

    Commercial info metadata for this subscription.

    JSON representation 
     { 
 "cloudMarketplace" 
 : 
 { 
 object (  GoogleCloudMarketplaceInfo 
 
) 
 } 
 }
    Fields
    cloudMarketplace

    object ( GoogleCloudMarketplaceInfo )

    Output only. This is set when the subscription is commercialised via Cloud Marketplace.

    GoogleCloudMarketplaceInfo

    Cloud Marketplace commercial metadata for this subscription.

    JSON representation 
     { 
 "order" 
 : 
 string 
 }
    Fields
    order

    string

    Resource name of the Marketplace Order.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: