Administra fichas

Console

Ve a la página de la API de Analytics Hub y habilita la API de Analytics Hub para tu proyecto Cloud de Confiance .

Habilita la API de Analytics Hub

gcloud

Ejecuta el comando gcloud services enable:

gcloud services enable analyticshub.googleapis.com

Console

1. Ve a la página Uso compartido (Analytics Hub).

   Ir a Uso compartido (Analytics Hub)

   Aparecerá una página que enumera todos los intercambios de datos a los que puedes acceder.

2. Haz clic en el nombre del intercambio de datos en el que deseas crear la ficha.

3. Haz clic en add_box Crear ficha.

4. En la sección Configurar datos, en el menú Tipo de recurso, selecciona Conjunto de datos de BigQuery o Tema de Pub/Sub.

   • Si seleccionas Conjunto de datos de BigQuery, haz lo siguiente:

     1. En el menú Conjunto de datos compartido, selecciona un conjunto de datos existente o haz clic en Crear un conjunto de datos para crear uno. El conjunto de datos debe estar en la misma región que el intercambio de datos. No puedes cambiar el conjunto de datos compartido después de crear la ficha. Cuando los suscriptores visualizan los metadatos de su conjunto de datos vinculado, BigQuery sharing devuelve el nombre del conjunto de datos de origen y el ID del proyecto que contiene el conjunto de datos.
     2. Opcional: Para permitir que los suscriptores compartan un procedimiento almacenado en SQL en varias fichas, selecciona Permitir el uso compartido de procedimientos almacenados (versión preliminar).
     3. Para que el conjunto de datos compartido esté disponible en regiones adicionales, expande el menú Disponibilidad de datos por región. En el menú, se muestran las regiones que tienen réplicas de conjuntos de datos existentes etiquetadas como Listo para usar. Antes de configurar la ficha para varias regiones, verifica que hayas habilitado la replicación de conjuntos de datos en varias regiones en el conjunto de datos compartido. Solo puedes seleccionar regiones en las que esté activada la replicación de conjuntos de datos entre regiones. Todas las demás regiones se etiquetan como No disponibles. Si no seleccionas ninguna región adicional, la ficha se establecerá de forma predeterminada en la región principal del conjunto de datos compartido, que se etiqueta como Principal del proveedor.

     4. En Controles de salida de datos, selecciona la opción de salida de datos adecuada:

        • Para restringir la copia y exportación de datos en tu conjunto de datos compartido y, al mismo tiempo, permitir la exportación de los resultados de las consultas, selecciona Inhabilitar la copia y exportación de datos compartidos.
        • Para restringir la copia y exportación de datos tanto en tu conjunto de datos compartido como en los resultados de las consultas, selecciona Inhabilitar la copia y exportación de los resultados de las consultas. Esta opción también selecciona Inhabilitar la copia y exportación de datos compartidos.
        • Para restringir la copia y exportación de tablas a través de las APIs en tu conjunto de datos compartido, selecciona Inhabilita la copia y exportación de tablas a través de las APIs. Esta opción también selecciona Inhabilitar la copia y exportación de datos compartidos.

        Para obtener más información sobre los controles de salida de datos, incluidas las restricciones, consulta Opciones de salida de datos (solo para conjuntos de datos compartidos de BigQuery).

   • Si seleccionas Tema de Pub/Sub, en el menú Tema compartido, selecciona un tema de Pub/Sub existente o haz clic en Crear un tema para crear uno.

5. En la sección Detalles de la ficha, en Nombre visible, ingresa un nombre para la ficha.

6. Ingresa los siguientes detalles opcionales:

   • Categoría: Selecciona hasta dos categorías que representen de mejor manera tu ficha. Los suscriptores pueden filtrar fichas con las categorías que seleccionaste.
   • Afinidad de datos: Especifica las regiones que usas para publicar datos. Este parámetro de configuración de ubicación ayuda a los suscriptores a minimizar o evitar los costos de salida de red de Pub/Sub leyendo los datos de la misma región. Para obtener más información sobre los costos de salida, consulta Costos de transferencia de datos.
   • Ícono: Sube un ícono para tu ficha. Se admiten los formatos de archivo PNG y JPEG. Los íconos deben tener un tamaño inferior a 512 KiB y dimensiones máximas de 512 × 512 píxeles.
   • Descripción: Ingresa una breve descripción de tu ficha. Los suscriptores pueden buscar fichas por texto de descripción.

   • Visibilidad pública: Activa este parámetro de configuración para que tu ficha sea visible públicamente en el catálogo de BigQuery sharing. Si habilitas esta opción, otorga el rol Analytics Hub Viewer (roles/analyticshub.viewer) a allUsers o allAuthenticatedUsers. Para obtener más información, consulta Otorga el rol para una ficha. Si el intercambio ya es público, la ficha hereda esos permisos y no requiere ninguna otra acción.

     Los intercambios detectables de forma pública no pueden tener fichas privadas debido a la herencia de permisos, pero los intercambios privados pueden tener fichas públicas. Para crear una ficha pública, el proyecto que la contiene debe tener una organización y una cuenta de facturación asociadas. Si creas una ficha comercial integrada en Cloud Marketplace, te recomendamos que actives la visibilidad pública.

   • Registro de correos electrónicos de los suscriptores: Activa este parámetro de configuración para registrar los identificadores principales de todos los usuarios que ejecutan trabajos y consultas en conjuntos de datos vinculados. Si activas esta opción, se habilitará el registro de correo electrónico del suscriptor en todas las suscripciones futuras que se creen a partir de esta ficha. Los datos registrados están disponibles en la columna job_principal_subject de la vista INFORMATION_SCHEMA.SHARED_DATASET_USAGE.

   • Documentación > Markdown: Ingresa documentación, vínculos o instrucciones complementarias en formato Markdown para ayudar a los suscriptores a usar tu conjunto de datos.

7. En la sección Información de contacto de la ficha, ingresa los siguientes detalles opcionales:

   • Contacto principal: Ingresa la dirección de correo electrónico o la URL del contacto principal de la ficha.
   • Solicitar contacto de acceso: Ingresa la dirección de correo electrónico o la URL de tu formulario de admisión para que los suscriptores puedan comunicarse contigo y solicitar acceso.

   • Proveedor: Expande la sección Proveedor y, luego, ingresa los detalles en los siguientes campos:

     • Nombre del proveedor: Es el nombre del proveedor de datos.
     • Contacto principal del proveedor: Es la dirección de correo electrónico o la URL del contacto principal del proveedor de datos.

     Los suscriptores pueden filtrar las fichas por proveedor de datos.

   • Publicador: Expande la sección Publicador y, luego, ingresa los detalles en los siguientes campos:

     • Nombre del publicador: El nombre del publicador que crea la ficha.
     • Contacto principal del publicador: Es la dirección de correo electrónico o la URL del contacto principal del publicador.

8. Revisa la sección Vista previa de la ficha.

9. Para publicar la ficha, haz clic en Publicar.

API

Usa el método projects.locations.dataExchanges.listings.create:

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings?listingId=LISTING_ID

Reemplaza lo siguiente:

• PROJECT_ID: Es el ID del proyecto que contiene el intercambio de datos en el que deseas crear la ficha.
• LOCATION: La ubicación de tu intercambio de datos. Para obtener más información sobre las ubicaciones que admiten el uso compartido de BigQuery, consulta Regiones admitidas.
• DATAEXCHANGE_ID: el ID del intercambio de datos.
• LISTING_ID: el ID de la ficha.

En el cuerpo de la solicitud, proporciona los detalles de la ficha.

Para crear una ficha en varias regiones, especifica esas regiones en el campo bigqueryDataset.replicaLocations del cuerpo de la solicitud. Antes de configurar la ficha para varias regiones, verifica que hayas habilitado la replicación de conjuntos de datos en varias regiones en el conjunto de datos compartido. Solo puedes seleccionar regiones en las que esté habilitada la replicación de conjuntos de datos entre regiones. Si omites este campo opcional, la ficha usará la región principal del conjunto de datos compartido.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta mostrará los detalles de la ficha. Si activas el registro de correos electrónicos de los suscriptores configurando el campo logLinkedDatasetQueryUserEmail como true, la respuesta de la ficha devolverá log_linked_dataset_query_user_email: true. Los datos registrados están disponibles en la columna job_principal_subject de la vista INFORMATION_SCHEMA.SHARED_DATASET_USAGE.

Para obtener más información sobre las tareas que puedes realizar en las fichas mediante las API, consulta Métodos projects.locations.dataExchanges.listings.

Console

1. Ve a la página Uso compartido (Analytics Hub).

   Ir a Uso compartido (Analytics Hub)

2. Haz clic en el nombre del intercambio de datos que contiene la ficha.

3. Haz clic en la ficha que quieras compartir.

4. Haz clic en person Establecer permisos.

5. Para agregar principales, haz clic en person_add Agregar principal.

6. En el campo Principales nuevas, ingresa los principales según el tipo de ficha:

   • Para una ficha privada, ingresa las direcciones de correo electrónico de las identidades a las que deseas otorgar acceso.

   • Para una ficha pública, ingresa allAuthenticatedUsers.

   • Para una ficha pública que sea detectable para todos, incluidos los usuarios que no son deCloud de Confiance by S3NS, ingresa allUsers.

7. En el menú Selecciona un rol, apunta a Analytics Hub y, luego, selecciona un rol según el tipo de ficha:

   • Para una ficha comercial (incluidas las fichas integradas en Cloud Marketplace), selecciona Analytics Hub Viewer. Este rol permite a los usuarios ver la ficha y solicitar acceso.

   • Para una ficha pública privada o no comercial, selecciona Suscriptor de Analytics Hub. Este rol permite que los usuarios se suscriban a tu ficha.

   • En el caso de las fichas integradas en Cloud Marketplace, no es necesario que otorgues el rol Analytics Hub Subscriber (roles/analyticshub.subscriber). Las suscripciones se administran automáticamente según el pedido de Cloud Marketplace.

   Para obtener más información, consulta los roles de suscriptor y visualizador de Analytics Hub.

8. Para guardar los permisos, haz clic en Guardar.

API

1. Lee la política existente llamando al método projects.locations.dataExchanges.listings.getIamPolicy:

   POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID:getIamPolicy
   

   Reemplaza lo siguiente:

   • PROJECT_ID: Es el ID del proyecto, por ejemplo, my-project-1.
   • LOCATION: Es la ubicación del intercambio de datos que contiene la ficha.
   • DATAEXCHANGE_ID: el ID del intercambio de datos.
   • LISTING_ID: el ID de la ficha.

   El uso compartido muestra la política actual en la respuesta.

2. Para agregar o quitar miembros y sus roles asociados, edita el JSON de la política con un editor de texto. Especifica los miembros con los siguientes formatos:

   • user:test-user@gmail.com
   • group:admins@example.com
   • serviceAccount:test123@example.domain.com
   • domain:example.domain.com

   Por ejemplo, para otorgar el rol roles/analyticshub.subscriber a group:subscribers@example.com, agrega la siguiente vinculación a la política:

   {
   "members": [
    "group:subscribers@example.com"
   ],
   "role":"roles/analyticshub.subscriber"
   }
   

3. Actualiza la política llamando al método projects.locations.dataExchanges.listings.setIamPolicy. En el cuerpo de la solicitud, pasa la política de IAM actualizada del paso anterior.

   POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID:setIamPolicy
   

   En el cuerpo de la solicitud, pasa los detalles de la ficha. Si la solicitud se realiza correctamente, el cuerpo de la respuesta muestra los detalles de la ficha con la política actualizada.

Para obtener más información sobre las tareas que puedes realizar en las fichas mediante las API, consulta Métodos projects.locations.dataExchanges.listings.

Console

1. Ve a la página Uso compartido (Analytics Hub).

   Ir a Uso compartido (Analytics Hub)

2. Haz clic en el nombre del intercambio de datos que contiene la ficha para la que deseas administrar las suscripciones.

3. Haz clic en la ficha para la que deseas enumerar todos los suscriptores.

4. Para ver todos los suscriptores de tu ficha, haz clic en Administrar suscripciones:

   

5. Opcional: Puedes filtrar los resultados por detalles del suscriptor.

De forma alternativa, si tienes acceso al conjunto de datos compartido, puedes seguir estos pasos para enumerar los suscriptores:

1. Ve a la página de BigQuery.

   Ir a BigQuery

2. En el panel de la izquierda, haz clic en explore Explorar.

   

   Si no ves el panel izquierdo, haz clic en last_page Expandir panel izquierdo para abrirlo.

3. En el panel Explorador, expande el nombre de tu proyecto, haz clic en Conjuntos de datos y, luego, haz clic en el nombre del conjunto de datos compartido.

4. En la lista person_add Uso compartido, selecciona Administrar suscripciones.

SQL

En el siguiente ejemplo, se usa la vista INFORMATION_SCHEMA.SCHEMATA_LINKS para enumerar todos los conjuntos de datos vinculados a un conjunto de datos compartido en myproject que se encuentran en la región us:

SELECT * FROM `myproject`.`region-us`.INFORMATION_SCHEMA.SCHEMATA_LINKS;

El resultado es similar al siguiente. Algunas columnas se omiten para simplificar el resultado.

+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+
|  catalog_name  | schema_name | linked_schema_catalog_name | linked_schema_catalog_number | linked_schema_name | linked_schema_org_display_name |
+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+
| myproject      | myschema1   | subscriptionproject1       |                 974999999291 | subscriptionld1    | subscriptionorg                |
| myproject      | myschema2   | subscriptionproject2       |                 974999999292 | subscriptionld2    | subscriptionorg                |
| myproject      | myschema3   | subscriptionproject3       |                 974999999293 | subscriptionld3    | subscriptionorg                |
+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+

En el caso de una ficha con varias regiones, puedes ver las suscripciones en diferentes regiones reemplazando la región us por la ubicación de la réplica deseada. Por ejemplo, para ver los conjuntos de datos vinculados a un conjunto de datos compartido en myproject que se encuentran en la región eu, usa la siguiente consulta:

SELECT * FROM `myproject`.`region-eu`.INFORMATION_SCHEMA.SCHEMATA_LINKS;

API

Usa el método projects.locations.dataExchanges.listings.listSubscriptions.

GET https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID:listSubscriptions

Reemplaza lo siguiente:

• PROJECT_ID: el ID del proyecto de la ficha a la que deseas suscribirte.
• LOCATION: la ubicación de la ficha a la que deseas suscribirte.
• DATAEXCHANGE_ID: el ID del intercambio de datos que contiene la ficha a la que deseas suscribirte.
• LISTING_ID: el ID de la ficha a la que deseas suscribirte.

Console

1. Para enumerar los suscriptores de una ficha, sigue las instrucciones de Visualiza todas las suscripciones para la consola de Cloud de Confiance .

2. Haz clic en Suscripciones.

3. Para seleccionar las suscripciones que deseas quitar, marca las casillas de verificación junto a ellas y, luego, haz clic en delete Quitar suscripciones.

4. En el cuadro de diálogo ¿Quitar suscripción?, escribe remove para confirmar la eliminación.

5. Haz clic en Quitar.

API

Realiza una llamada al método projects.locations.subscriptions.revoke.

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/subscriptions/SUBSCRIPTION_ID:revoke

Reemplaza lo siguiente:

• PROJECT_ID: Es el ID del proyecto de la suscripción que deseas quitar.
• LOCATION: la ubicación de la suscripción que deseas quitar.
• SUBSCRIPTION: el ID de la suscripción que deseas quitar.

Console

1. Ve a la página Uso compartido (Analytics Hub).

   Ir a Uso compartido (Analytics Hub)

2. Haz clic en el nombre del intercambio de datos que contiene la ficha.

3. Haz clic en la ficha que deseas actualizar.

4. Haz clic en mode_edit Editar ficha.

5. Modifica los valores en los campos. Puedes modificar todos los valores, excepto el conjunto de datos compartido de la ficha.

6. Opcional: Actualiza la configuración y la disponibilidad de la ficha:

   • Para habilitar la visibilidad pública, otorga el rol Analytics Hub Viewer (roles/analyticshub.viewer) a allUsers o allAuthenticatedUsers. Si quieres obtener instrucciones para otorgar roles en una ficha, consulta Otorga el rol para una ficha.
   • Para inhabilitar la visibilidad pública de una ficha en un intercambio privado, quita el rol Analytics Hub Viewer (roles/analyticshub.viewer) de allUsers y allAuthenticatedUsers. Si el intercambio ya es público, los permisos de la lista ya están heredados y no es necesario realizar ninguna otra acción.
   • Después de activar y guardar el registro de los correos electrónicos de los suscriptores, no podrás editar este parámetro de configuración. Para desactivar el registro de correos electrónicos, borra la ficha y, luego, vuelve a crearla sin seleccionar Registro de correos electrónicos de suscriptores.
   • Para agregar o quitar regiones, actualiza tu selección de regiones. Antes de agregar varias regiones, verifica que hayas habilitado la replicación de conjuntos de datos entre regiones en el conjunto de datos compartido. Antes de quitar una región, borra la réplica del conjunto de datos compartido en esa región.

7. Revisa la vista previa de la ficha.

8. Para guardar los cambios, haz clic en Guardar. Si actualizas una ficha integrada en Cloud Marketplace, recibirás una notificación que te solicitará que actualices también la ficha del producto de datos de Cloud Marketplace.

API

Realiza una llamada al método projects.locations.dataExchanges.listings.patch:

PATCH https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID?updateMask=UPDATEMASK

Reemplaza lo siguiente:

• PROJECT_ID: Es el ID del proyecto que contiene el intercambio de datos en el que deseas crear la ficha.
• LOCATION: La ubicación del intercambio de datos.
• DATAEXCHANGE_ID: Es el ID del intercambio de datos.
• LISTING_ID: Es el ID de la ficha que se actualizará.
• UPDATEMASK: la lista de campos que deseas actualizar. Si deseas actualizar varios valores, usa una lista separada por comas. Por ejemplo, para actualizar el nombre visible y el contacto principal de un intercambio de datos, ingresa displayName,primaryContact.

En el cuerpo de la solicitud, especifica los valores actualizados para los campos de la máscara de actualización:

• displayName
• description
• primaryContact
• documentation
• icon
• categories[]
• discoveryType
• logLinkedDatasetQueryUserEmail
• bigqueryDataset.replicaLocations

Para obtener detalles sobre estos campos, consulta Recurso: Listing.

Cuando actualices las regiones de réplica de tu ficha, especifica todas las regiones aplicables. Antes de actualizar la ficha, verifica que hayas habilitado la replicación de conjuntos de datos en varias regiones en el conjunto de datos compartido. Solo puedes agregar regiones en las que el conjunto de datos compartido tenga una réplica. Antes de quitar una región de la ficha, borra la réplica del conjunto de datos compartido en esa región. También puedes convertir las fichas de una sola región en fichas multirregionales.

Para obtener más información sobre las tareas que puedes realizar en las fichas mediante las API, consulta Métodos projects.locations.dataExchanges.listings.

Console

1. Ve a la página Uso compartido (Analytics Hub).

   Ir a Uso compartido (Analytics Hub)

2. Haz clic en el nombre del intercambio de datos que contiene la ficha.

3. Haz clic en la ficha que deseas borrar.

4. Haz clic en delete Borrar.

5. En el cuadro de diálogo ¿Borrar ficha?, escribe delete para confirmar la eliminación.

6. Haz clic en Borrar.

API

Realiza una llamada al método projects.locations.dataExchanges.listings.delete.

DELETE https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID

Reemplaza lo siguiente:

• PROJECT_ID: Es el ID del proyecto que contiene el intercambio de datos.
• LOCATION: La ubicación del intercambio de datos.
• DATAEXCHANGE_ID: Es el ID del intercambio de datos.
• LISTING_ID: Es el ID de la ficha que se borrará.

Para obtener más información sobre las tareas que puedes realizar en las fichas mediante las API, consulta Métodos projects.locations.dataExchanges.listings.