Method: projects.locations.dataExchanges.listings.subscribe

Inscreve-se em uma listagem.

No momento, com o Analytics Hub, você pode criar listagens que se referem apenas aos conjuntos de dados do BigQuery. Após a assinatura de uma listagem de um conjunto de dados do BigQuery, o Analytics Hub cria um conjunto de dados vinculado no projeto do assinante.

Solicitação HTTP

POST https://analyticshub.googleapis.com/v1/{name=projects/*/locations/*/dataExchanges/*/listings/*}:subscribe

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Nome do recurso da listagem em que você quer se inscrever. Por exemplo, projects/myproject/locations/US/dataExchanges/123/listings/456.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{

  // Union field destination can be only one of the following:
  "destinationDataset": {
    object (DestinationDataset)
  }
  // End of list of possible types for union field destination.
}
Campos
Campo de união destination. Destino resultante da listagem em que você se inscreveu. destination pode ser apenas de um dos tipos a seguir:
destinationDataset

object (DestinationDataset)

o conjunto de dados de destino do BigQuery a ser criado para o assinante.

Corpo da resposta

Mensagem de resposta quando você se inscreve em uma listagem.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "subscription": {
    object (Subscription)
  }
}
Campos
subscription

object (Subscription)

Objeto de assinatura criado a partir desta ação de inscrição.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • analyticshub.listings.subscribe

Para mais informações, consulte a documentação do IAM.

DestinationDataset

Define o conjunto de dados de destino do BigQuery.

Representação JSON 
{
  "datasetReference": {
    object (DestinationDatasetReference)
  },
  "friendlyName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "location": string
}
Campos
datasetReference

object (DestinationDatasetReference)

Obrigatório. Uma referência que identifica o conjunto de dados de destino.
friendlyName

string

Opcional. Um nome descritivo do conjunto de dados.
description

string

Opcional. Uma descrição fácil de usar do conjunto de dados.
labels

map (key: string, value: string)

Opcional. Os rótulos associados a este conjunto de dados. Você pode usá-los para organizar e agrupar seus conjuntos de dados. Você pode definir essa propriedade ao inserir ou atualizar um conjunto de dados. Consulte https://cloud.google.com/resource-manager/docs/creating-managing-labels para saber mais informações.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
location

string

Obrigatório. A localização geográfica em que o conjunto de dados deve residir. Acesse https://cloud.google.com/bigquery/docs/locations para ver os locais compatíveis.

DestinationDatasetReference

Contém a referência que identifica um conjunto de dados de destino do BigQuery.

Representação JSON 
{
  "datasetId": string,
  "projectId": string
}
Campos
datasetId

string

Obrigatório. Um ID exclusivo deste conjunto de dados, sem o nome do projeto. O ID precisa conter apenas letras (a-z, A-Z), números (0-9) ou sublinhados (_). O comprimento máximo é de 1.024 caracteres.
projectId

string

Obrigatório. O ID do projeto que contém esse conjunto de dados.