Introducción: API degadgets

¡Te damos la bienvenida al API de gadgets!

Esta guía de desarrolladores está basada en la versión gadgets.* del API de JavaScript de gadgets. Se ha cambiado el espacio de nombres del API de gadgets por el espacio de nombres JavaScript de gadgets.*, lo que proporcionará un API más limpia en la que programar y trabajar. Para obtener más información sobre el API de gadgets.*, consulta la documentación de referencia aquí. Aunque el API de gadgets.* coincide en gran parte con el API de gadgets heredada, también existen diferencias importantes.

Actualmente, sólo algunos contenedores (un contenedor es un sitio o una aplicación que ejecuta gadgets) admiten el gadgets.* API. Para obtener una lista de contenedores que admiten el gadgets.* API, consulta la lista de contenedores de OpenSocial. Algunos contenedores más antiguos sólo admiten el API de gadgets heredada, así que no olvides consultar en la documentación de tu contenedor qué API son compatibles. Para obtener más información sobre los distintos tipos de gadgets y dónde se pueden ejecutar, consulta Aspectos generales del API de gadgets.

Todos los contenedores admiten el API heredada, independientemente de que admitan el API de gadgets.*. No obstante, el API de gadgets.* ofrece muchas nuevas funciones que no existen en el API heredada, por lo que deberás utilizarla si puedes.

Esta guía del desarrollador está destinada a aquellos usuarios que deseen crear gadgets con el API de gadgets. Los gadgets son tan fáciles de crear que son un punto de partida idóneo si estás aprendiendo programación web.

Contenido

  1. "Hello, World"
  2. ¿Qué es un gadget?
  3. Más información

"Hello, World"

El gadget más simple está formado por unas cuantas líneas de código. Este gadget muestra el mensaje "Hello, world!":

<?xml version="1.0" encoding="UTF-8" ?> 
<Module>
<ModulePrefs title="hello world example" />
<Content type="html">
<![CDATA[ Hello, world! ]]> </Content>
</Module>

Ten en cuenta los siguientes datos sobre el ejemplo "Hello World":

  • Los gadgets se especifican utilizando el lenguaje XML. La primera línea es la forma estándar de comenzar un archivo XML. Esta debe ser la primera línea del archivo.
  • La etiqueta <Module> indica que este archivo XML contiene un gadget.
  • La etiqueta <ModulePrefs> contiene información sobre el gadget, como el título, la descripción, el autor y otras funciones opcionales.
  • La línea <Content type="html"> indica que el tipo de contenido del gadget es HTML.
  • <![CDATA[ ...insert HTML here... ]]> se utiliza para indicar que el tipo de contenido del gadget es html. Indica al analizador del gadget que el texto incluido en la sección CDATA no se debe tratar como XML. La sección CDATA normalmente contiene HTML y JavaScript.
  • </Content> indica el final de la sección de contenido.
  • </Module> indica el final de la definición del gadget.

¿Qué es un gadget?

El API de gadgets consiste en unos simples componentes básicos: XML, HTML y JavaScript. Para comenzar, lo único que necesitas son algunas nociones básicas sobre HTML. Te enseñaremos todo lo que necesitas saber sobre XML para crear gadgets. Más adelante, cuando ya seas capaz de crear gadgets más sofisticados, probablemente querrás aprender algo sobre JavaScript si aún no estás familiarizado con este lenguaje.

XML es un lenguaje de marcado para uso general. Describe datos estructurados de tal forma que tanto los humanos como los ordenadores puedan leerlos y escribirlos.

El lenguaje XML permite crear las especificaciones de gadgets. Un gadget es simplemente un archivo XML ubicado en algún lugar de Internet donde Google puede encontrarlo. El archivo XML que especifica un gadget contiene instrucciones sobre cómo procesar y representar el gadget. El archivo XML puede contener todos los datos y códigos del gadget, o bien puede tener referencias (direcciones URL) que indican dónde encontrar el resto de los elementos.

HTML es el lenguaje de marcado utilizado para dar formato a las páginas de Internet. El contenido estático de un gadget se suele escribir en HTML. El lenguaje HTML es similar al XML, pero se utiliza para dar formato a documentos web en lugar de para describir datos estructurados.

JavaScript es un lenguaje de secuencias de comandos que se utiliza para añadir comportamientos dinámicos a tus gadgets.

Más información

Cada contenedor que ejecuta gadgets sociales presenta características ligeramente diferentes. En los siguientes sitios podrás empezar a practicar el desarrollo de gadgets sociales:

Para obtener información general de programación de gadgets, consulta Creación de gadgets propios. Desde aquí podrás acceder a Principios de programación o volver a la página principal de la documentación, donde dispones de una descripción general sobre las distintas secciones y temas.

Volver al principio