REST Resource: projects.locations.dataExchanges.listings

Ressource: Eintrag

Ein Eintrag wird in einem Datenpool veröffentlicht, den ein Abonnent abonnieren kann. Er enthält einen Verweis auf die Datenquelle sowie beschreibende Informationen, damit Abonnenten die Daten leichter finden und abonnieren können.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "description": string,
  "primaryContact": string,
  "documentation": string,
  "state": enum (State),
  "icon": string,
  "dataProvider": {
    object (DataProvider)
  },
  "categories": [
    enum (Category)
  ],
  "publisher": {
    object (Publisher)
  },
  "requestAccess": string,
  "restrictedExportConfig": {
    object (RestrictedExportConfig)
  },

  // Union field source can be only one of the following:
  "bigqueryDataset": {
    object (BigQueryDatasetSource)
  }
  // End of list of possible types for union field source.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname des Eintrags. z.B. projects/myproject/locations/US/dataExchanges/123/listings/456

displayName

string

Erforderlich. Für Menschen lesbarer Anzeigename des Eintrags. Der Anzeigename darf nur Unicode-Buchstaben, Ziffern (0–9), Unterstriche (_), Bindestriche (-), Leerzeichen ( ), Und-Zeichen (&) enthalten und darf nicht mit Leerzeichen beginnen oder enden. Der Standardwert ist ein leerer String. Maximale Länge: 63 Bytes

description

string

Optional. Kurze Beschreibung des Eintrags. Die Beschreibung darf keine Unicode-Nicht-Zeichen sowie C0- und C1-Steuercodes enthalten, mit Ausnahme von Tabulatoren (HT), neuen Zeilen (LF), Zeilenumbrüchen (CR) und Seitenumbrüchen (FF). Der Standardwert ist ein leerer String. Maximale Länge: 2.000 Byte.

primaryContact

string

Optional. E-Mail-Adresse oder URL des primären Ansprechpartners für den Eintrag. Maximale Länge: 1.000 Bytes.

documentation

string

Optional. Dokumentation zur Beschreibung des Eintrags.

state

enum (State)

Nur Ausgabe. Aktueller Status des Eintrags.

icon

string (bytes format)

Optional. Base64-codiertes Bild, das den Eintrag darstellt. Maximale Größe: 3,0 MiB Die erwarteten Bildabmessungen sind 512 x 512 Pixel, aber die API führt nur eine Validierung der Größe der codierten Daten durch. Hinweis: Bei Bytefeldern ist der Inhalt des Felds bei Verwendung von JSON über die Übertragung base64-codiert, wodurch die Größe der Daten um 33–36 % erhöht wird.

Ein base64-codierter String.

dataProvider

object (DataProvider)

Optional. Details zum Datenanbieter, dem die Quelldaten gehören.

categories[]

enum (Category)

Optional. Kategorien des Eintrags. Es sind bis zu zwei Kategorien zulässig.

publisher

object (Publisher)

Optional. Details zum Publisher, der Inhaber des Eintrags ist und der die Quelldaten freigeben kann.

requestAccess

string

Optional. E-Mail-Adresse oder URL der Anfrage für den Zugriff auf den Eintrag. Abonnenten können diese Referenz verwenden, um Zugriff anzufordern. Maximale Länge: 1.000 Bytes.

restrictedExportConfig

object (RestrictedExportConfig)

Optional. Wenn diese Option festgelegt ist, wird die Konfiguration für den eingeschränkten Export übernommen und für das verknüpfte Dataset erzwungen.

Union-Feld source. Eintragsquelle. Für source ist nur einer der folgenden Werte zulässig:
bigqueryDataset

object (BigQueryDatasetSource)

Erforderlich. Freigegebenes Dataset d.h. BigQuery-Dataset-Quelle.

BigQueryDatasetSource

Ein Verweis auf ein freigegebenes Dataset. Es ist ein vorhandenes BigQuery-Dataset mit einer Sammlung von Objekten wie Tabellen und Ansichten, die Sie für Abonnenten freigeben möchten. Wenn der Abonnent einen Eintrag abonniert, erstellt Analytics Hub ein verknüpftes Dataset im Projekt des Abonnenten. Ein verknüpftes Dataset ist ein undurchsichtiges, schreibgeschütztes BigQuery-Dataset, das als symbolischer Link zu einem freigegebenen Dataset dient.

JSON-Darstellung
{
  "dataset": string
}
Felder
dataset

string

Ressourcenname der Dataset-Quelle für diesen Eintrag. z.B. projects/myproject/datasets/123

Status

Status des Eintrags.

Enums
STATE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
ACTIVE Abostatus. Nutzer mit der Berechtigung „dataexchange.listings.subscribe“ können diesen Eintrag abonnieren.

DataProvider

Enthält Details zum Datenanbieter.

JSON-Darstellung
{
  "name": string,
  "primaryContact": string
}
Felder
name

string

Optional. Name des Datenanbieters.

primaryContact

string

Optional. E-Mail-Adresse oder URL des Datenanbieters. Maximale Länge: 1.000 Bytes.

Kategorie

Eintragskategorien.

Enums
CATEGORY_UNSPECIFIED
CATEGORY_OTHERS
CATEGORY_ADVERTISING_AND_MARKETING
CATEGORY_COMMERCE
CATEGORY_CLIMATE_AND_ENVIRONMENT
CATEGORY_DEMOGRAPHICS
CATEGORY_ECONOMICS
CATEGORY_EDUCATION
CATEGORY_ENERGY
CATEGORY_FINANCIAL
CATEGORY_GAMING
CATEGORY_GEOSPATIAL
CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE
CATEGORY_MEDIA
CATEGORY_PUBLIC_SECTOR
CATEGORY_RETAIL
CATEGORY_SPORTS
CATEGORY_SCIENCE_AND_RESEARCH
CATEGORY_TRANSPORTATION_AND_LOGISTICS
CATEGORY_TRAVEL_AND_TOURISM

Microsoft Publisher

Enthält Details zum Eintrags-Publisher.

JSON-Darstellung
{
  "name": string,
  "primaryContact": string
}
Felder
name

string

Optional. Name des Eintrags-Publishers.

primaryContact

string

Optional. E-Mail-Adresse oder URL des Eintrags-Publishers. Maximale Länge: 1.000 Bytes.

RestrictedExportConfig

Konfiguration für den eingeschränkten Export, die zur Konfiguration des eingeschränkten Exports für das verknüpfte Dataset verwendet wird.

JSON-Darstellung
{
  "enabled": boolean,
  "restrictDirectTableAccess": boolean,
  "restrictQueryResult": boolean
}
Felder
enabled

boolean

Optional. Wenn der Wert "true" ist, aktivieren Sie den eingeschränkten Export.

restrictDirectTableAccess

boolean

Nur Ausgabe. Wenn "true", beschränken Sie den direkten Tabellenzugriff(read api/tabledata.list) für die verknüpfte Tabelle.

restrictQueryResult

boolean

Optional. Wenn "true", wird der Export von Abfrageergebnissen eingeschränkt, die aus einer eingeschränkten Dataset-Tabelle abgeleitet wurden.

Methoden

create

Erstellt einen neuen Eintrag.

delete

Löscht einen Eintrag.

get

Ruft die Details eines Eintrags ab.

getIamPolicy

Ruft die IAM-Richtlinie ab.

list

Listet alle Einträge in einem angegebenen Projekt und an einem angegebenen Standort auf.

listSubscriptions

Listet alle Abos in einem bestimmten Data Exchange oder Eintrag auf.

patch

Aktualisiert einen vorhandenen Eintrag.

setIamPolicy

Legt die IAM-Richtlinie fest.

subscribe

Abonniert einen Eintrag.

testIamPermissions

Gibt die Berechtigungen des Aufrufers zurück.