REST Resource: projects.locations.dataExchanges.listings

Recurso: Ficha

Una ficha es lo que se publica en un intercambio de datos al que se puede suscribir un suscriptor. Contiene una referencia a la fuente de datos junto con información descriptiva que ayudará a los suscriptores a encontrar los datos y suscribirse a ellos.

Representación JSON 
{
  "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.
}
Campos
name

string

Solo salida. El nombre del recurso de la ficha, p. ej., projects/myproject/locations/US/dataExchanges/123/listings/456
displayName

string

Obligatorio. El nombre visible y legible por humanos de la ficha. El nombre visible solo debe contener letras Unicode, números (0-9), guiones bajos (_), guiones (-), espacios ( ), signos de unión (&) y no puede empezar ni terminar con espacios. El valor predeterminado es una cadena vacía. Longitud máxima: 63 bytes.
description

string

Opcional. Descripción breve de la ficha. La descripción no debe contener caracteres Unicode que no sean caracteres ni códigos de control C0 y C1, excepto las pestañas (HT), las líneas nuevas (LF), los retornos de carro (CR) y los saltos de página (FF). El valor predeterminado es una cadena vacía. Longitud máxima: 2,000 bytes.
primaryContact

string

Opcional. Correo electrónico o URL del punto de contacto principal de la ficha. Longitud máxima: 1,000 bytes.
documentation

string

Opcional. Documentación que describe la ficha.
state

enum (State)

Solo salida. Estado actual de la ficha.
icon

string (bytes format)

Opcional. Imagen codificada en base64 que representa la ficha. Tamaño máximo: 3.0 MiB. Las dimensiones de imagen esperadas son de 512 x 512 píxeles. Sin embargo, la API solo realiza validación en función del tamaño de los datos codificados. Nota: Para los campos de bytes, el contenido del campo está codificado en base64 (lo que aumenta el tamaño de los datos en un 33% a 36%) cuando se usa JSON en línea.

String codificada en base64.
dataProvider

object (DataProvider)

Opcional. Detalles del proveedor de datos que posee los datos de origen
categories[]

enum (Category)

Opcional. Categorías de la ficha. Se permiten hasta dos categorías.
publisher

object (Publisher)

Opcional. Detalles del publicador que posee la ficha y puede compartir los datos de origen.
requestAccess

string

Opcional. Correo electrónico o URL de la solicitud de acceso de la ficha. Los suscriptores pueden usar esta referencia para solicitar acceso. Longitud máxima: 1,000 bytes.
restrictedExportConfig

object (RestrictedExportConfig)

Opcional. Si se establece, la configuración de exportación restringida se propagará y se aplicará al conjunto de datos vinculado.
Campo de unión source. Fuente de la ficha. source puede ser solo uno de los siguientes:
bigqueryDataset

object (BigQueryDatasetSource)

Obligatorio. Conjunto de datos compartido, es decir, la fuente del conjunto de datos de BigQuery.

BigQueryDatasetSource

Una referencia a un conjunto de datos compartido. Es un conjunto de datos de BigQuery existente con una colección de objetos, como tablas y vistas, que deseas compartir con los suscriptores. Cuando el suscriptor se suscribe a una ficha, Analytics Hub crea un conjunto de datos vinculado en el proyecto del suscriptor. Un conjunto de datos vinculado es un conjunto de datos de BigQuery opaco y de solo lectura que funciona como un vínculo simbólico a un conjunto de datos compartido.

Representación JSON 
{
  "dataset": string
}
Campos
dataset

string

Nombre del recurso de la fuente del conjunto de datos para esta ficha, p. ej., projects/myproject/datasets/123

Estado

Estado de la ficha.

Enums
STATE_UNSPECIFIED Valor predeterminado Este valor no se usa.
ACTIVE Estado de suscripción. Los usuarios con el permiso dataexchange.listings.subscribe pueden suscribirse a esta ficha.

DataProvider

Contiene detalles del proveedor de datos.

Representación JSON 
{
  "name": string,
  "primaryContact": string
}
Campos
name

string

Opcional. Nombre del proveedor de datos.
primaryContact

string

Opcional. Correo electrónico o URL del proveedor de datos. Longitud máxima: 1,000 bytes.

Categoría

Categorías de fichas.

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

Publicador

Contiene detalles del publicador de la ficha.

Representación JSON 
{
  "name": string,
  "primaryContact": string
}
Campos
name

string

Opcional. Nombre del publicador de la ficha.
primaryContact

string

Opcional. Correo electrónico o URL del publicador de la ficha. Longitud máxima: 1,000 bytes.

RestrictedExportConfig

Configuración de exportación restringida, que se usa para configurar la exportación restringida en el conjunto de datos vinculado.

Representación JSON 
{
  "enabled": boolean,
  "restrictDirectTableAccess": boolean,
  "restrictQueryResult": boolean
}
Campos
enabled

boolean

Opcional. Si es verdadero, habilita la exportación restringida.
restrictDirectTableAccess

boolean

Solo salida. Si es verdadero, restringe el acceso directo a la tabla (api de lectura/tabledata.list) en la tabla vinculada.
restrictQueryResult

boolean

Opcional. Si es verdadero, restringe la exportación del resultado de la consulta derivado de la tabla del conjunto de datos vinculado restringido.

Métodos

create

 Crea una ficha nueva.

delete

 Borra una ficha.

get

 Obtiene los detalles de una ficha.

getIamPolicy

 Obtiene la política de IAM.

list

 Muestra una lista de todas las fichas de un proyecto y una ubicación determinados.

listSubscriptions

 Enumera todas las suscripciones de un intercambio de datos o una ficha determinados.

patch

 Actualiza una ficha existente.

setIamPolicy

 Configura la política de IAM.

subscribe

 Se suscribe a una ficha.

testIamPermissions

 Muestra los permisos que tiene un emisor.