Especificación de la visibilidad del producto

Cómo establecer la disponibilidad del producto especificando sus niveles de visibilidad y capacidad de suscripción.

Acerca de esta tarea

La sección de visibilidad de la representación YAML del producto determina quién puede ver y suscribirse a su producto en IBM® API ConnectAI Gateway.

Nota: Todas las claves y valores de enumeración que se especifican en este tema distinguen entre mayúsculas y minúsculas.

Al final de este tema encontrará una sección de visibilidad de ejemplo de una representación YAML de un producto. Se puede encontrar un ejemplo de una representación YAML completa de un producto en «Un ejemplo de representación YAML de un producto ».

Procedimiento

Para completar la sección de visibilidad de la descripción del producto, siga estos pasos:

Título de la sección añadiendo visibility:
En visibility:, especifique quién puede view el producto; utilice la sintaxis siguiente:
```
   view:
      enabled: View_Toggle
      type: View_Audience
      tags: View_Tag
      orgs: View_Organizations
```
donde
- conmutación_de_vista determina si el producto es visible para cualquiera o no. Debe ser true o false. En ese caso false, el producto no aparecerá en el catálogo de consumidores del portal para desarrolladores.
- View_Audience debe ser public, en cuyo caso el producto es visible para cualquier persona que utilice el Catálogo de consumidores del Portal de desarrolladores, authenticated, en cuyo caso el producto es visible para cualquier persona registrada a través del Catálogo de consumidores del Portal de desarrolladores, o custom, en cuyo caso el producto es visible para un grupo específico de usuarios. Puede especificar estos usuarios personalizados como una o varias organizaciones de consumidores en la orgs: sección y como uno o varios grupos de organizaciones de consumidores en la tags: sección.
- View_Tag especifica los grupos de organizaciones de consumidores que pueden ver el producto si View_Audience está establecido en custom. Si View_Audience no está establecido en custom, no incluya tags:. Si View_Audience es custom, puede especificar grupos de la siguiente manera:
```
      tags:
         - Organization group 1
         - Organization group 2
```
  donde las variables Grupo de organización son los nombres de los grupos a los que se permite ver el producto. Tenga en cuenta que cuando se publica un Producto, el nombre de la propiedad tags: pasa a ser group_urls:, y el contenido cambia a URL cadenas.
- View_Organizations especifica las organizaciones de consumidores que pueden ver el producto si View_Audience está establecido en custom. Si View_Audience no está establecido en custom, no incluya orgs:. Si View_Audience es custom, puede especificar organizaciones de la siguiente manera:
```
      orgs:
         - Organization 1
         - Organization 2
```
  donde las variables organización son los nombres de las organizaciones que tienen permiso para ver el producto. Tenga en cuenta que cuando se publica un Producto, el nombre de la propiedad orgs: pasa a ser org_urls:, y el contenido cambia a URL cadenas.
En visibility:, especifique quién puede subscribe en los planes del producto; utilice la sintaxis siguiente:
```
   subscribe:
      enabled: Subscribe_Toggle
      type: Subscribe_Audience
      tags: Subscribe_Tag
      orgs: Subscribe_Organizations
```
donde:
- conmutación_de_suscripción debe ser true o false. Si es false, ningún desarrollador podrá suscribirse al producto.
- La opción «Subscribe_Audience» debe estar configurada authenticatedcomo «», en cuyo caso cualquier persona registrada a través del Catálogo de consumidores del Portal del desarrollador podrá suscribirse a los planes del producto; o bien custom como «», en cuyo caso solo un grupo específico de usuarios podrá suscribirse a los planes del producto.
- Subscribe_Tag especifica los grupos de organizaciones de consumidores que pueden suscribirse a los planes del producto si Subscribe_Audience se establece en custom. Si público_de_suscripción no está establecido en custom, omítalo o establézcalo como []. Si Subscribe_Audience es custom, puede especificar grupos de la siguiente manera:
```
      tags:
         - Organization group 1
         - Organization group 2
```
  donde las variables Grupo de organización son los nombres de los grupos a los que se permite suscribirse al producto. Tenga en cuenta que cuando se publica un Producto, el nombre de la propiedad tags: pasa a ser group_urls:, y el contenido cambia a URL cadenas.
- organizaciones_de_suscripción especifica las organizaciones que se pueden suscribir a los planes del producto si público_de_suscripción está establecido en custom. Si público_de_suscripción no está establecido en custom, omítalo o establézcalo como []. Si Subscribe_Audience es custom, puede especificar organizaciones de la siguiente manera:
```
      orgs:
         - Organization 1
         - Organization 2
```
  donde las variables organización son los nombres de las organizaciones que tienen permiso para suscribirse al producto. Tenga en cuenta que cuando se publica un Producto, el nombre de la propiedad orgs: pasa a ser org_urls:, y el contenido cambia a URL cadenas.
  Nota: Si un producto va a estar disponible para la suscripción, ya debe estar visible. Como resultado, para que el público de suscripción esté authenticated (autenticado), el público de vista no puede ser custom (personalizado).

Resultados

Ha completado la sección de visibilidad de la representación YAML del producto. Debe tener el formato siguiente:

visibility:
   view:
      enabled: View_Toggle
      type: View_Audience
      tags:
         - View_Tag_1
         - View_Tag_2 
      orgs:
         - Organization_1
         - Organization_2

   subscribe:
      enabled: Subscribe_Toggle
      type: Subscribe_Audience
      tags:
         - Subscribe_Tag_1
         - Subscribe_Tag_2
      orgs: 
         - Organization_1
         - Organization_2

donde todas las variables son las descritas anteriormente en este tema. La sangría debe ser como en el ejemplo.

Qué hacer a continuación

También puede definir la visibilidad del producto a nivel de catálogo o de espacio. Para obtener más información, consulte Configuración de la visibilidad del producto a nivel de catálogo o espacio.