REST Resource: projects.locations.dataExchanges.listings

Recurso: ficha

Uma listagem é o que é publicado em uma troca de dados em que os assinantes podem se inscrever. Ela contém uma referência à fonte de dados, além de informações descritivas, que ajudarão os assinantes a encontrar e assinar os dados.

Representação 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

Apenas saída. O nome do recurso da listagem. Por exemplo, projects/myproject/locations/US/dataExchanges/123/listings/456
displayName

string

Obrigatório. Nome de exibição legível da listagem. O nome de exibição deve conter apenas letras Unicode, números (0-9), sublinhados (_), traços (-), espaços ( ), "e" comercial (&) e não pode começar ou terminar com espaços. O valor padrão é uma string vazia. Tamanho máximo: 63 bytes.
description

string

Opcional. Breve descrição da listagem. A descrição não pode conter caracteres não Unicode e códigos de controle C0 e C1, exceto tabs (HT), novas linhas (LF), retornos de carro (CR) e quebras de página (FF). O valor padrão é uma string vazia. Tamanho máximo: 2.000 bytes.
primaryContact

string

Opcional. E-mail ou URL do ponto de contato principal da listagem. Tamanho máximo: 1.000 bytes.
documentation

string

Opcional. Documentação que descreve a listagem.
state

enum (State)

Apenas saída. Estado atual da listagem.
icon

string (bytes format)

Opcional. Imagem codificada em Base64 que representa a listagem. Tamanho máximo: 3,0 MiB. As dimensões de imagem esperadas são de 512 x 512 pixels. No entanto, a API só realiza a validação no tamanho dos dados codificados. Observação: para campos de bytes, o conteúdo do campo é codificado em base64 (o que aumenta o tamanho dos dados de 33 a 36%) ao usar JSON na rede.

Uma string codificada em base64.
dataProvider

object (DataProvider)

Opcional. Detalhes do provedor de dados que detém os dados de origem.
categories[]

enum (Category)

Opcional. Categorias da listagem. São permitidas até duas categorias.
publisher

object (Publisher)

Opcional. Detalhes do editor que é o proprietário da listagem e quem pode compartilhar os dados de origem.
requestAccess

string

Opcional. E-mail ou URL da solicitação de acesso à listagem. Os assinantes podem usar essa referência para solicitar acesso. Comprimento máximo: 1.000 bytes.
restrictedExportConfig

object (RestrictedExportConfig)

Opcional. Se definido, a configuração de exportação restrita será propagada e aplicada ao conjunto de dados vinculado.
Campo de união source. Origem da listagem. source pode ser apenas de um dos tipos a seguir:
bigqueryDataset

object (BigQueryDatasetSource)

Obrigatório. Conjunto de dados compartilhado, ou seja, origem do conjunto de dados do BigQuery.

BigQueryDatasetSource

Uma referência a um conjunto de dados compartilhado. É um conjunto de dados do BigQuery com uma coleção de objetos, como tabelas e visualizações, que você quer compartilhar com os assinantes. Quando o assinante se inscreve em uma listagem, o Analytics Hub cria um conjunto de dados vinculado no projeto do assinante. Um conjunto de dados vinculado é um conjunto de dados opaco e somente leitura do BigQuery que serve como um link simbólico para um conjunto de dados compartilhado.

Representação JSON 
{
  "dataset": string
}
Campos
dataset

string

Nome do recurso da origem do conjunto de dados desta listagem. Por exemplo, projects/myproject/datasets/123

Estado

Estado da listagem.

Enums
STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
ACTIVE Estado de assinatura. Os usuários com a permissão dataexchange.listings.subscribe podem se inscrever nesta listagem.

DataProvider

Contém detalhes do provedor de dados.

Representação JSON 
{
  "name": string,
  "primaryContact": string
}
Campos
name

string

Opcional. Nome do provedor de dados.
primaryContact

string

Opcional. E-mail ou URL do provedor de dados. Comprimento máximo: 1.000 bytes.

Categoria

Categorias de listagem.

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

Editor

Contém detalhes do editor da listagem.

Representação JSON 
{
  "name": string,
  "primaryContact": string
}
Campos
name

string

Opcional. Nome do editor da listagem.
primaryContact

string

Opcional. E-mail ou URL do editor da listagem. Comprimento máximo: 1.000 bytes.

RestrictedExportConfig

Configuração de exportação restrita, usada para configurar a exportação restrita no conjunto de dados vinculado.

Representação JSON 
{
  "enabled": boolean,
  "restrictDirectTableAccess": boolean,
  "restrictQueryResult": boolean
}
Campos
enabled

boolean

Opcional. Se verdadeiro, ativar a exportação restrita.
restrictDirectTableAccess

boolean

Apenas saída. Se verdadeiro, restringe o acesso direto à tabela (ler api/tabledata.list) na tabela vinculada.
restrictQueryResult

boolean

Opcional. Se verdadeiro, restringe a exportação do resultado da consulta derivado da tabela de conjunto de dados vinculada restrita.

Métodos

create

 Cria uma nova listagem.

delete

 Exclui uma listagem.

get

 Recebe os detalhes de uma listagem.

getIamPolicy

 Recebe a política do IAM.

list

 Lista todas as listagens em um determinado projeto e local.

listSubscriptions

 Lista todas as assinaturas de uma determinada troca de dados ou listagem.

patch

 Atualiza uma listagem já existente.

setIamPolicy

 Define a política do IAM.

subscribe

 Inscreve-se em uma listagem.

testIamPermissions

 Retorna as permissões do autor da chamada.