Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132073100.2 KB
projects

Creates a new listing.

post/v1/{+parent}/listings

Path parameters

parentstring required

Required. The parent resource path of the listing. e.g. projects/myproject/locations/us/dataExchanges/123.

Query parameters

listingIdstring

Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.

Request body

resourceType'SHARED_RESOURCE_TYPE_UNSPECIFIED' | 'BIGQUERY_DATASET' | 'PUBSUB_TOPIC'

Output only. Listing shared asset type.

displayNamestring

Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.

descriptionstring

Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

categoriesstring[]

Optional. Categories of the listing. Up to five categories are allowed.

primaryContactstring

Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

iconstring byte

Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.

logLinkedDatasetQueryUserEmailboolean

Optional. By default, false. If true, the Listing has an email sharing mandate enabled.

documentationstring

Optional. Documentation describing the listing.

requestAccessstring

Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

allowOnlyMetadataSharingboolean

Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.

state'STATE_UNSPECIFIED' | 'ACTIVE'

Output only. Current state of the listing.

discoveryType'DISCOVERY_TYPE_UNSPECIFIED' | 'DISCOVERY_TYPE_PRIVATE' | 'DISCOVERY_TYPE_PUBLIC'

Optional. Type of discovery of the listing on the discovery page.

namestring

Output only. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456

Response

Successful response