Method: projects.locations.dataExchanges.listings.subscribe

Se suscribe a una ficha.

Actualmente, con Analytics Hub, puedes crear fichas que hagan referencia solo a los conjuntos de datos de BigQuery. Cuando se suscribe a una ficha de un conjunto de datos de BigQuery, Analytics Hub crea un conjunto de datos vinculado en el proyecto del suscriptor.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Nombre del recurso de la ficha a la que deseas suscribirte. p. ej., projects/myproject/locations/US/dataExchanges/123/listings/456.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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ón destination. Destino resultante de la ficha a la que te suscribiste. destination puede ser solo uno de los siguientes:
destinationDataset

object (DestinationDataset)

Conjunto de datos de destino de BigQuery que se creará para el suscriptor.

Cuerpo de la respuesta

Mensaje para la respuesta cuando te suscribes a una ficha.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "subscription": {
    object (Subscription)
  }
}
Campos
subscription

object (Subscription)

Objeto de suscripción creado a partir de esta acción de suscripción.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • analyticshub.listings.subscribe

Si deseas obtener más información, consulta la documentación de IAM.

DestinationDataset

Define el conjunto de datos de BigQuery de destino.

Representación JSON 
{
  "datasetReference": {
    object (DestinationDatasetReference)
  },
  "friendlyName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "location": string
}
Campos
datasetReference

object (DestinationDatasetReference)

Obligatorio. Una referencia que identifica el conjunto de datos de destino.
friendlyName

string

Opcional. Es un nombre descriptivo para el conjunto de datos.
description

string

Opcional. Una descripción fácil de usar del conjunto de datos.
labels

map (key: string, value: string)

Opcional. Las etiquetas asociadas a este conjunto de datos. Puedes usarlas para organizar y agrupar tus conjuntos de datos. Puedes configurar esta propiedad cuando insertas o actualizas un conjunto de datos. Consulta https://cloud.google.com/resource-manager/docs/creating-managing-labels para obtener más información.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
location

string

Obligatorio. La ubicación geográfica donde debe residir el conjunto de datos. Consulta https://cloud.google.com/bigquery/docs/locations para conocer las ubicaciones compatibles.

DestinationDatasetReference

Contiene la referencia que identifica un conjunto de datos de BigQuery de destino.

Representación JSON 
{
  "datasetId": string,
  "projectId": string
}
Campos
datasetId

string

Obligatorio. Un ID único para este conjunto de datos, sin el nombre del proyecto. El ID debe contener solo letras (a-z, A-Z), números (0-9) o guiones bajos (_). La longitud máxima es de 1,024 caracteres.
projectId

string

Obligatorio. El ID del proyecto que contiene este conjunto de datos.