Administra fichas

Como publicador de Analytics Hub, puedes realizar las siguientes tareas:

  • Crear fichas en un intercambio de datos para el que tengas acceso de publicación.
  • Actualiza, borra, comparte y visualiza métricas de uso para las fichas.
  • Administrar diferentes roles para tus fichas de Analytics Hub, como suscriptores, visualizadores y administradores de fichas.
  • Visualizar todos los suscriptores que se suscribieron a tu ficha.
  • Supervisa el uso de tus fichas.
  • Quitar suscriptores de tu ficha.

Una ficha es una referencia a un conjunto de datos compartidos que un publicador anuncia en un intercambio de datos. Una ficha puede ser de los siguientes dos tipos según la política de Identity and Access Management (IAM) que se configura para la ficha y el tipo de intercambio de datos que contiene la ficha:

  • Ficha pública. Los usuarios de Google Cloud (allAuthenticatedUsers) pueden descubrir las fichas y suscribirse a ellas. Las fichas de un intercambio de datos públicos son públicas. Estas fichas pueden ser referencias a un conjunto de datos público gratuito o a un conjunto de datos comerciales. Si la ficha es de un conjunto de datos comerciales, los suscriptores pueden solicitar acceso a la ficha y el proveedor de datos se comunicará con esos suscriptores.

  • Ficha privada. Se comparte directamente con personas o grupos. Por ejemplo, una ficha privada puede hacer referencia a un conjunto de datos de métricas de marketing que compartes con otros equipos internos dentro de tu organización. Aunque puedes permitir que allAuthenticatedUsers se suscriban a tus fichas, la ficha seguirá siendo privada y no se mostrará como una ficha pública en la página de Analytics Hub. Para compartir esas fichas con los usuarios, comparte la URL de la ficha con ellos. Para hacer que una ficha privada sea detectable, debes hacer que tu intercambio sea público.

Antes de comenzar

Para comenzar a usar Analytics Hub, debes habilitar la API de Analytics Hub dentro de tu proyecto de Google Cloud.

Permisos necesarios

Para habilitar la API de Analytics Hub, necesitas los siguientes permisos de Identity and Access Management (IAM):

  • serviceUsage.services.get
  • serviceUsage.services.list
  • serviceUsage.services.enable

El siguiente rol predefinido de IAM incluye los permisos que necesitas para habilitar la API de Analytics Hub:

  • roles/serviceusage.serviceUsageAdmin

Para obtener más información de los roles de IAM en BigQuery, consulta Funciones y permisos predefinidos.

Habilita la API de Analytics Hub

Para habilitar la API de Analytics Hub, haz lo siguiente:

Consola

Ve a la API de Analytics Hub para tu proyecto de Google Cloud y habilítala.

Habilita la API de Analytics Hub

gcloud

Ejecuta el comando gcloud services enable:

gcloud services enable analyticshub.googleapis.com

Permisos necesarios

Para administrar las fichas y las suscripciones, debes tener una de las siguientes funciones de Analytics Hub:

  • Rol Analytics Hub Publisher (roles/analyticshub.publisher), que te permite crear, actualizar, borrar y configurar políticas de IAM en tus fichas.

  • Rol Analytics Hub Listing Admin (roles/analyticshub.listingAdmin), que te permite actualizar, borrar y configurar políticas de IAM en tus fichas.

  • Rol Analytics Hub Admin (roles/analyticshub.Admin), que te permite crear, actualizar, borrar y configurar políticas de IAM en todas las fichas de tu intercambio de datos.

Para obtener más información, consulta los roles de los usuarios de Analytics Hub. Para obtener información sobre cómo otorgar estos roles a otros usuarios, consulta Crea un administrador de fichas.

Además, a fin de crear fichas, también debes tener el permiso bigquery.datasets.update para los conjuntos de datos en los que deseas crear fichas. Los siguientes roles predefinidos de BigQuery tienen el permiso bigquery.datasets.update:

  • Rol BigQuery Data Owner (roles/bigquery.dataOwner)
  • Rol BigQuery Admin (roles/bigquery.admin)

Para ver todos los intercambios de datos de proyectos en una organización a la que tienes acceso, debes tener el permiso resourcemanager.organizations.get. No hay roles predefinidos de BigQuery que contengan este permiso, por lo que deberías usar un rol personalizado de IAM.

Ve los intercambios de datos

Para ver la lista de intercambios de datos de tu organización a los que tienes acceso, consulta Ver intercambios de datos. Si el intercambio de datos está en otra organización, el administrador de Analytics Hub debe compartir un vínculo a ese intercambio de datos contigo.

Crea una ficha

Una ficha es una referencia a un conjunto de datos compartidos que un publicador anuncia en un intercambio de datos.

Para crear una ficha, sigue estos pasos:

Consola

  1. Ve a la página Analytics Hub.

    Ir a 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 Crear ficha.

  4. En la página Crear ficha, en Nombre visible, ingresa el nombre de la ficha.

  5. Si creas un conjunto de datos comerciales, debes completar el campo Solicitar contacto de acceso. Debes ingresar un correo electrónico o una URL del formulario de admisión para que los suscriptores se comuniquen contigo.

  6. Opcional: Ingresa los siguientes detalles:

    • Contacto principal: Ingresa un correo electrónico o una URL del contacto principal de la ficha.

    • Categoría: Selecciona hasta dos categorías que representen de mejor manera tu ficha. Los suscriptores pueden filtrar fichas según estas categorías.

    • Proveedor: Expande la sección Proveedor y especifica los detalles en los siguientes campos:

      • Nombre del proveedor: el nombre del proveedor del conjunto de datos.
      • Contacto principal del proveedor: Un correo electrónico o una URL del contacto principal del proveedor del conjunto de datos.

      Los suscriptores pueden filtrar las fichas según los proveedores de datos.

    • Publicador: Expande la sección Publicador y especifica los detalles en los siguientes campos:

      • Nombre del publicador: el nombre del publicador que crea la ficha.
      • Contacto principal del publicador: Un correo electrónico o una URL del contacto principal del publicador del conjunto de datos.
    • Ícono: Un ícono para tu ficha. Se admiten los formatos de archivo PNG y JPEG. Los íconos deben tener un tamaño de archivo de menos de 512 KiB y dimensiones de no más de 512 x 512 píxeles.

    • Descripción: Una descripción breve de tu ficha. Los suscriptores pueden buscar fichas según la descripción.

  7. En Conjunto de datos de origen, selecciona el conjunto de datos que deseas publicar en el intercambio de datos. El conjunto de datos de origen debe estar en la misma región que el intercambio de datos. No puedes actualizar este campo después de crear la ficha.

  8. En Salida de datos (vista previa), selecciona la opción de salida de datos adecuada. Solo los suscriptores con ofertas sin edición o la edición Enterprise Plus pueden consultar datos con restricciones de salida de datos.

    • Para aplicar restricciones de salida de datos en tu conjunto de datos compartido, pero no en los resultados de la consulta de tu conjunto de datos compartido, selecciona Inhabilitar la copia y exportación de datos compartidos.
    • Para aplicar restricciones de salida de datos en tu conjunto de datos compartido y en los resultados de las consultas de tu conjunto de datos compartido, selecciona Inhabilitar la copia y exportación de los resultados de las consultas, que también configurará automáticamente la opción Inhabilitar la copia y exportación de datos compartidos.
  9. Opcional: En la sección Documentación > Markdown, puedes ingresar información adicional, como consultas de muestra que puedas ejecutar en el conjunto de datos, vínculos a cualquier documentación relevante y cualquier información adicional que pueda ayudar a los suscriptores a usar tu conjunto de datos.

  10. Haz clic en Guardar.

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: 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 compatibles con Analytics Hub, 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. Si la solicitud se realiza de forma correcta, el cuerpo de la respuesta contendrá detalles de la ficha.

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.

Otorga a los usuarios acceso a una ficha

Si deseas otorgar a los usuarios acceso a una ficha privada, debes configurar una política de IAM para una persona o un grupo para esa ficha. Para una ficha comercial, tu intercambio de datos debe ser público. Las fichas de un intercambio de datos públicos están disponibles en Analytics Hub para todos los usuarios de Google Cloud (allAuthenticatedUsers). Para permitir que los usuarios soliciten acceso a las fichas comerciales, debes otorgarles el rol de visualizador de Analytics Hub.

A fin de otorgar a los usuarios acceso para ver tu ficha o suscribirse a ella, sigue estos pasos:

Consola

  1. Ve a la página Analytics Hub.

    Ir a Analytics Hub

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

  3. Haz clic en la ficha a la que deseas agregar suscriptores.

  4. Haz clic en Establecer permisos.

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

  6. En el campo Principales nuevos, agrega los siguientes detalles según el tipo de ficha:

    • Para una ficha privada, ingresa el correo electrónico de la identidad a la que deseas otorgar acceso.

    • Para una ficha pública, agrega allAuthenticatedUsers.

  7. En Selecciona un rol, mantén el puntero sobre Analytics Hub y, luego, según el tipo de ficha, selecciona uno de los siguientes roles:

    • Para una ficha comercial, selecciona el rol 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 el rol de suscriptor de Analytics Hub. Este rol permite que los usuarios se suscriban a tu ficha.

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

  8. Haz clic en Guardar.

API

  1. Lee la política existente con el método getIamPolicy de la lista a través del 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: 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.

    Analytics Hub muestra la política actual en la respuesta.

  2. Para agregar o quitar miembros y sus funciones asociadas, edita la política con un editor de texto. Usa el siguiente formato para agregar miembros:

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

    Por ejemplo, para otorgar la función 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. Escribe la política actualizada mediante el método projects.locations.dataExchanges.listings.setIamPolicy. En el cuerpo de la solicitud, proporciona 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, proporciona los detalles de la ficha. Si la solicitud se realiza de forma correcta, el cuerpo de la respuesta contendrá detalles de la ficha.

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.

Crea un administrador de fichas

Para permitir que los usuarios administren fichas, debes crear administradores de fichas de Analytics Hub. Para crear administradores de fichas, debes otorgar a los usuarios el rol de publicador de Analytics Hub o administrador de fichas de Analytics Hub a nivel de la ficha. Si deseas obtener más información sobre cómo otorgar estos roles para una ficha, consulta Otorga el rol para una ficha.

Visualiza todas las suscripciones

Para visualizar todas las suscripciones actuales a tu ficha, selecciona una de las siguientes opciones:

Consola

  1. Ve a la página Analytics Hub.

    Ir a 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.

    administrar suscriptores

  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 Explorador, expande tu proyecto y selecciona el conjunto de datos compartido.

  3. En la lista 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                |
+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+

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.

Quita una suscripción

Cuando quitas una suscripción creada antes del 25 de julio de 2023 de tus fichas, el conjunto de datos vinculado se desvincula del conjunto de datos compartido. Los suscriptores aún pueden ver los conjuntos de datos en sus proyectos, pero ya no están vinculados con el conjunto de datos compartido.

Para quitar una suscripción creada antes del 25 de julio de 2023 de tus fichas, sigue estos pasos:

  1. Para enumerar todos los suscriptores de una ficha, sigue las instrucciones de la consola de Google Cloud en Visualiza todas las suscripciones.

  2. Para quitar un suscriptor de una ficha, haz clic en Borrar. Si deseas quitar todas las suscripciones, haz clic en Quitar todas las suscripciones.

  3. En el cuadro de diálogo ¿Deseas quitar la suscripción?, ingresa remove para confirmar.

  4. Haz clic en Quitar.

Para quitar las suscripciones creadas después del 25 de julio de 2023, sigue estos pasos:

Consola

  1. Para enumerar todos los suscriptores de una ficha, sigue las instrucciones de la consola de Google Cloud en Visualiza todas las suscripciones.

  2. Haz clic en la pestaña Suscripciones.

  3. Para quitar un suscriptor de una ficha, selecciona las suscripciones que deseas quitar y haz clic en Quitar suscripciones.

  4. En el cuadro de diálogo ¿Deseas quitar la suscripción?, ingresa remove para confirmar.

  5. Haz clic en Quitar.

API

Usa el método projects.locations.subscriptions.revoke (vista previa).

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

Reemplaza lo siguiente:

  • PROJECT_ID: 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.

Actualiza una ficha

Para actualizar una ficha, sigue estos pasos:

Consola

  1. Ve a la página Analytics Hub.

    Ir a 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 Editar ficha.

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

  6. Para obtener una vista previa de los cambios, haz clic en Vista previa.

  7. Para guardar los cambios, haz clic en Guardar.

API

Usa el 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 UPDATEMASK por la lista de campos que deseas actualizar. Si deseas actualizar varios valores, usa una lista separada por comas. En el cuerpo de la solicitud, especifica los valores actualizados.

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.

Borra una ficha

Cuando borras una ficha, los suscriptores ya no pueden verla. Si borras una ficha, también se borran todos los conjuntos de datos vinculados (se quitan todas las suscripciones) de los proyectos de los suscriptores.

Si borras una ficha, no podrás deshacerlo. Para borrar una ficha, sigue estos pasos:

Consola

  1. Ve a la página Analytics Hub.

    Ir a 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 Borrar.

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

  6. Haz clic en Borrar.

API

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

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

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.

¿Qué sigue?