Guía para desarrolladores: Java

La API de datos de Blogger permite que las aplicaciones cliente vean y actualicen el contenido de Blogger en forma de feeds de la API de datos de Google.

Tu aplicación cliente puede usar la API de datos de Blogger para crear entradas de blog nuevas, editar o borrar entradas de blog existentes, y consultar entradas de blogs que coincidan con criterios específicos.

Además de proporcionar información sobre las capacidades de la API de datos de Blogger, en este documento, se proporcionan ejemplos de interacciones básicas para la API de datos mediante la biblioteca cliente de Java. Si te interesa obtener más información sobre el protocolo subyacente que usa la biblioteca, consulta la sección Protocolo de esta guía para desarrolladores.

Contenido

Público

Este documento está destinado a programadores que desean escribir aplicaciones cliente de Java que pueden interactuar con Blogger.

En este documento, se supone que comprendes las ideas generales detrás del protocolo de las API de datos de Google.

Para obtener información de referencia sobre las clases y los métodos que proporciona la biblioteca cliente, consulta la referencia de la API de la biblioteca cliente de Java. Para obtener información general sobre la API de datos de Blogger, consulta la guía de referencia del protocolo.

Cómo comenzar

Si deseas obtener ayuda para configurar la biblioteca cliente, consulta la Guía de introducción.

La biblioteca cliente de Java requiere Java 1.5. Después de descargar la biblioteca cliente, encontrarás las clases que necesitas para comenzar en el archivo java/lib/gdataclient-1.0.jar.

Creación de una cuenta de Blogger

Te recomendamos que te registres en una cuenta de Blogger para realizar pruebas. Blogger usa Cuentas de Google, así que si ya tienes una, ya estás listo.

Cómo ejecutar el código de muestra

Un cliente de muestra funcional completo, que contiene todo el código de muestra que se muestra en este documento, está disponible en la distribución de la biblioteca cliente de Java, en el directorio gdata/java/sample/blogger/BloggerClient.java. Las instrucciones de compilación y ejecución se incluyen en el mismo directorio en el archivo README.txt.

El cliente de muestra realiza varias operaciones en el blog proporcionado para demostrar el uso de la API de datos de Blogger.

Para compilar los ejemplos de este documento en tu propio código, necesitarás las siguientes declaraciones import:

import com.google.gdata.client.*;
import com.google.gdata.data.*;
import com.google.gdata.util.*;
import java.io.IOException;
import java.net.URL;

Autenticación en el servicio de Blogger

Puedes acceder a los feeds públicos y privados mediante la API de datos de Blogger. Los feeds públicos no requieren autenticación, pero son de solo lectura. Si deseas modificar los blogs, tu cliente debe autenticarse antes de solicitar los feeds privados. Se puede autenticar mediante cualquiera de estos tres métodos: autenticación OAuth, autenticación del proxy AuthSub o autenticación del nombre de usuario y contraseña de ClientLogin.

Para obtener más información sobre la autenticación con las API de datos de Google en general, consulta la documentación de autenticación.

En la mayoría de los ejemplos de las secciones posteriores de este documento, se supone que tienes un objeto GoogleService autenticado.

Autenticación de OAuth

Para ver la documentación sobre la autenticación OAuth con la biblioteca GData de Java, consulta OAuth en las bibliotecas cliente del protocolo de datos de Google.

Autenticación del proxy de AuthSub

Las aplicaciones web que necesitan autenticar a sus usuarios en Cuentas de Google usan la autenticación del proxy de AuthSub. El operador del sitio web y el código de cliente no tienen acceso al nombre de usuario y la contraseña del usuario de Blogger; en cambio, el cliente obtiene tokens especiales de AuthSub que le permiten al cliente actuar en nombre de un usuario en particular. Para obtener información más detallada, consulta la documentación de AuthSub.

Cuando un usuario visita tu aplicación por primera vez, aún no se autenticó. En este caso, debes mostrar información y un vínculo que dirija al usuario a una página de Google para autenticar tu solicitud de acceso a sus blogs. La biblioteca cliente de Java proporciona una función para generar la URL de la página de Google. El siguiente código recupera la URL de la página AuthSubRequest:

String next = "http://www.example.com/welcome.html";
String scope = "http://www.blogger.com/feeds/";
boolean secure = false;
boolean session = true;
String authSubLogin = AuthSubUtil.getRequestUrl(next, scope, secure, session);

El método getRequestUrl toma los siguientes parámetros (correspondientes a los parámetros de consulta que usa el controlador AuthSubRequest):

siguiente
Es la URL de la página a la que Google debe redireccionar al usuario después de la autenticación.
permiso
Indica que la aplicación solicita un token para acceder a los feeds de Blogger. La string del alcance que se usará es http://www.blogger.com/feeds/ (codificada en la URL, por supuesto).
seguras
Indica si el cliente solicita un token seguro.
sesión
Indica si el token que se muestra se puede intercambiar por un token multiuso (sesión).

En el ejemplo anterior, se muestra una llamada que no solicita un token seguro (el valor de secure es false). La URL de la solicitud resultante podría verse así:

https://www.google.com/accounts/AuthSubRequest?scope=http%3A%2F%2Fwww.blogger.com%2Ffeeds%2F&session=1&secure=0&next=http%3A%2F%2Fwww.example.com%2Fwelcome.html

El usuario sigue el vínculo al sitio de Google y se autentica en su Cuenta de Google.

Después de que el usuario se autentica, el sistema de AuthSub lo redirecciona a la URL que especificaste en el parámetro de búsqueda next de la URL de AuthSubRequest. El sistema AuthSub agrega un token de autenticación a esa URL, como el valor del parámetro de búsqueda token. Por ejemplo:

http://www.example.com/welcome.html?token=yourAuthToken

Este valor de token representa un token de AuthSub de uso único. En este ejemplo, dado que se especificó session = true, este token se puede intercambiar por un token de sesión de AuthSub mediante una llamada al servicio AuthSubSessionToken, de la siguiente manera, en la que urlFromAuthSub es la URL a la que AuthSub le agregó el token:

String token = AuthSubUtil.getTokenFromReply(urlFromAuthSub);
String sessionToken = AuthSubUtil.exchangeForSessionToken(token, null);

Es decir, debes pasar el token de uso único al método exchangeForSessionToken, junto con null (para el modo no registrado) o una clave privada (para el modo registrado), y la interfaz de AuthSub muestra un token de sesión. Para obtener más información sobre las aplicaciones registradas y las claves privadas, consulta la sección Solicitudes de firma de la documentación de AuthSub.

Tu aplicación puede usar el token de sesión en interacciones posteriores con Blogger. Para indicarle a la biblioteca cliente de Java que envíe automáticamente el token de sesión con cada solicitud, llama al método setAuthSubToken del objeto GoogleService:

GoogleService.setAuthSubToken(sessionToken, null);

Después de eso, la biblioteca cliente envía automáticamente el token junto con cada solicitud.

Autenticación de nombre de usuario/contraseña de ClientLogin

Usa la autenticación ClientLogin si tu cliente es un cliente independiente instalado de un solo usuario (como una aplicación de escritorio). Solo debes llamar al método setUserCredentials en tu objeto GoogleService y se autenticarán todas las interacciones posteriores con Blogger:

GoogleService myService = new GoogleService("blogger", "exampleCo-exampleApp-1");
myService.setUserCredentials("user@example.com", "secretPassword");

En el fragmento anterior, pasamos dos parámetros al constructor GoogleService. El primer parámetro es el nombre del servicio con el que queremos interactuar. El segundo parámetro es el nombre de nuestra aplicación con el formato companyName-applicationName-versionID.

Para obtener más información sobre la autenticación de ClientLogin, incluidas las solicitudes y respuestas de muestra, consulta la documentación de Autenticación para aplicaciones instaladas.

Nota: Usa el mismo token para todas las solicitudes de una sesión determinada; no adquieras un token nuevo para cada solicitud de Blogger.

Nota: Como se describe en la documentación de ClientLogin, la solicitud de autenticación puede fallar y solicitar un desafío CAPTCHA. Si deseas que Google emita y maneje la verificación de CAPTCHA, envía al usuario a https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger (en lugar de a la URL de control de CAPTCHA proporcionada en la documentación de ClientLogin).

Cómo recuperar una lista de blogs

La API de datos de Blogger proporciona un feed que enumera los blogs de un usuario en particular. Ese feed se conoce como &meta; metafeed.

El siguiente código de muestra usa un objeto GoogleService autenticado para recuperar el metafeed y, luego, imprimir el título de cada blog.

public static void printUserBlogs(GoogleService myService)
    throws ServiceException, IOException {

  // Request the feed
  final URL feedUrl = new URL("http://www.blogger.com/feeds/default/blogs");
  Feed resultFeed = myService.getFeed(feedUrl, Feed.class);

  // Print the results
  System.out.println(resultFeed.getTitle().getPlainText());
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" + entry.getTitle().getPlainText());
  }
}

Ten en cuenta la URL que usa el método getFeed. Esta es la URL de metafeed predeterminada; se muestra una lista de blogs para el usuario autenticado actualmente. Para acceder a un feed de un usuario diferente, puedes colocar el ID del usuario en lugar de default en la URL del feed de metadatos. El ID del usuario es la string de dígitos que aparece al final de la URL del perfil del usuario.

Crear publicaciones

La API de datos de Blogger te permite crear y publicar entradas de blog nuevas, además de crear borradores de entradas.

Nota: Por el momento, no se admite la configuración de un autor personalizado para las publicaciones. Todas las publicaciones nuevas aparecerán como si fueran creadas por el usuario autenticado actual.

Publicar una entrada de blog

Puedes usar la biblioteca cliente de Java para publicar entradas de blog nuevas.

Primero, crea un objeto Entry para representar la entrada de blog. Luego, puedes configurar el título, el contenido y otros atributos de la entrada de blog. Por último, usa el objeto GoogleService para insertar la publicación. Este es un ejemplo de cómo publicar una entrada de blog nueva:

public static Entry createPost(
    GoogleService myService, String blogID, String title,
    String content, String userName)
    throws ServiceException, IOException {
  // Create the entry to insert
  Entry myEntry = new Entry();
  myEntry.setTitle(new PlainTextConstruct(title));
  myEntry.setContent(new PlainTextConstruct(content));

  // Ask the service to insert the new entry
  URL postUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  return myService.insert(postUrl, myEntry);
}

El método insert toma la URL de publicación del servicio como parámetro. Luego, el método muestra la entrada como la almacenó Blogger. La entrada que se muestra es la misma que enviaste, pero también contiene varios elementos que Blogger agregó, como un ID de entrada.

Si tu solicitud falla por algún motivo, es posible que Blogger muestre un código de estado diferente. Para obtener información sobre los códigos de estado, consulta el documento de referencia del protocolo de la API de datos de Google.

Creando una entrada de blog en borrador

Los borradores de publicaciones se crean de la misma manera que las publicaciones públicas, pero debes configurar el atributo draft del objeto Entry. Puedes crear una entrada de blog como la anterior como borrador si agregas la línea destacada:

public static Entry createPost(GoogleService myService, String blogId,
    String title, String content, String userName,
    Boolean isDraft)
    throws ServiceException, IOException {
  // Create the entry to insert
  Entry myEntry = new Entry();
  myEntry.setTitle(new PlainTextConstruct(title));
  myEntry.setContent(new PlainTextConstruct(content));
  myEntry.setDraft(isDraft);

  // Ask the service to insert the new entry
  URL postUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  return myService.insert(postUrl, myEntry);
}

Puedes convertir un borrador de una entrada de blog en una entrada recuperada, configurar el atributo borrador como falso y, luego, actualizar la entrada. En las siguientes dos secciones, abordaremos cómo recuperar y actualizar las publicaciones.

Recuperando publicaciones

En las siguientes secciones, se describe cómo recuperar una lista de entradas de blog, con y sin parámetros de consulta.

Puedes consultar un feed público de Blogger sin autenticación. Por lo tanto, no es necesario que llames al método setUserCredentials ni realices la autenticación de AuthSub antes de recuperar entradas de un blog público.

Recuperando todas las entradas de blog

Para recuperar las entradas del usuario, llama al mismo método getFeed que se usó para recuperar el metafeed de blogs, pero esta vez envía la URL del feed de entradas de blog:

public static void printAllPosts(
    GoogleService myService, String blogId)
    throws ServiceException, IOException {
  // Request the feed
  URL feedUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  Feed resultFeed = myService.getFeed(feedUrl, Feed.class);

  // Print the results
  System.out.println(resultFeed.getTitle().getPlainText());
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" + entry.getTitle().getPlainText());
  }
  System.out.println();
}

Cómo recuperar publicaciones con parámetros de búsqueda

La API de datos de Blogger te permite solicitar un conjunto de entradas que coincidan con los criterios especificados, como solicitar entradas de blog publicadas o actualizadas en un período determinado. Para ello, crea un objeto Query y pásalo al método GoogleService.getQuery.

Por ejemplo, para enviar una consulta de período, usa los métodos setPublishedMin y setPublishedMax del objeto Query. El siguiente fragmento de código imprime el título de cada entrada de blog publicada entre la hora de inicio y la hora de finalización determinadas:

public static void printDateRangeQueryResults(
    GoogleService myService, String blogId,
    DateTime startTime, DateTime endTime)
    throws ServiceException, IOException {
  // Create query and submit a request
  URL feedUrl = new URL("http://www.blogger.com/feeds/" + blogID + "/posts/default");
  Query myQuery = new Query(feedUrl);
  myQuery.setPublishedMin(startTime);
  myQuery.setPublishedMax(endTime);
  Feed resultFeed = myService.query(myQuery, Feed.class);

  // Print the results
  System.out.println(resultFeed.getTitle().getPlainText() +
      " posts between " + startTime + " and " + endTime);
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" + entry.getTitle().getPlainText());
    System.out.println("\t" + entry.getUpdated().toStringRfc822());
  }
  System.out.println();
}

Ten en cuenta que el objeto Query se construye con la misma URL del feed de entradas que se usó para recuperar las publicaciones.

La API de datos de Blogger admite los siguientes métodos Query:

addCategoryFilter
Especifica las categorías (también conocidas como etiquetas) para filtrar los resultados del feed. Por ejemplo, http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie muestra entradas con las etiquetas Fritz y Laurie.
setMaxResults.
Configura la cantidad máxima de entradas que se mostrarán.
setPublishedMin, setPublishedMax
Establece los límites en las fechas de publicación.
setStartIndex.
Configura el índice basado en 1 del primer resultado que se recuperará (para la paginación).
setUpdatedMin, setUpdatedMax
Establece los límites en las fechas de actualización de las entradas. Estos parámetros de búsqueda se ignoran, a menos que el parámetro orderby esté configurado como updated.

Nota: Por el momento, no hay métodos set para el parámetro de consulta orderby. Sin embargo, puedes usar el método Query.addCustomParameter() si necesitas configurarlo.

Para obtener más información sobre los parámetros de búsqueda, revisa la Guía de referencia de la API de datos de Blogger y la Guía de referencia de las API de datos de Google.

Actualizando entradas

Para actualizar una entrada de blog existente, primero recuperas la entrada que deseas actualizar, la modificas y, luego, la envías a Blogger con el método update. El siguiente fragmento de código modifica el título de una entrada de blog, suponiendo que ya recuperaste la entrada del servidor.

public static Entry updatePostTitle(
    GoogleService myService, Entry entryToUpdate, String newTitle)
    throws ServiceException, IOException {
  entryToUpdate.setTitle(new PlainTextConstruct(newTitle));
  URL editUrl = new URL(entryToUpdate.getEditLink().getHref());
  return myService.update(editUrl, entryToUpdate);
}

El código anterior muestra un Entry que contiene toda la publicación recién actualizada. Para actualizar otras propiedades, solo debes configurarlas en el objeto Entry antes de llamar a update.

Nota: Por el momento, no se admite modificar los datos del autor asociados con las publicaciones.

Eliminando publicaciones

Para borrar una publicación, pasa la URL de edición de la publicación al método delete en tu objeto GoogleService de la siguiente manera:

public static void deletePost(
    GoogleService myService, String editLinkHref)
    throws ServiceException, IOException {
  URL deleteUrl = new URL(editLinkHref);
  myService.delete(deleteUrl);
}

Comentarios

La API de datos de Blogger permite crear, recuperar y eliminar comentarios. La actualización de comentarios no es compatible (ni está disponible en la interfaz web).

Creación de comentarios

Para publicar un comentario, crea un objeto Entry y, luego, insértalo de la siguiente manera:

public static Entry createComment(
    GoogleService myService, String blogID, String postId,
    String commentText)
    throws ServiceException, IOException {
  // Build the comment feed URI
  String commentsFeedUri = "http://www.blogger.com/feeds/" + blogID + "/" + postId + "/comments/default";
  URL feedUrl = new URL(commentsFeedUri);

  // Create a new entry for the comment and submit it to the GoogleService
  Entry myEntry = new Entry();
  myEntry.setContent(new PlainTextConstruct(commentText));
  return myService.insert(feedUrl, myEntry);
}

Nota: Por el momento, solo puedes publicar comentarios en un blog que pertenezca al usuario autenticado.

Nota: Por el momento, no se admite la configuración de un autor personalizado para los comentarios. Todos los comentarios nuevos aparecerán como si los hubiera creado el usuario autenticado actual.

Recuperando comentarios

Puedes recuperar los comentarios de una entrada en particular desde la URL del feed de comentarios de la entrada:

public static void printAllComments(
    GoogleService myService, String blogID, String postId)
    throws ServiceException, IOException {
  // Build comment feed URI and request comments on the specified post
  String commentsFeedUri = "http://www.blogger.com/feeds/" + blogID + "/" + postId + "/comments/default";
  URL feedUrl = new URL(commentsFeedUri);
  Feed resultFeed = myService.getFeed(feedUrl, Feed.class);

  // Display the results
  System.out.println(resultFeed.getTitle().getPlainText());
  for (int i = 0; i < resultFeed.getEntries().size(); i++) {
    Entry entry = resultFeed.getEntries().get(i);
    System.out.println("\t" +
        ((TextContent) entry.getContent()).getContent().getPlainText());
    System.out.println("\t" + entry.getUpdated().toStringRfc822());
  }
  System.out.println();
}

También puedes obtener los comentarios de todas las entradas en la URL del feed de comentarios del blog:

http://www.blogger.com/feeds/blogID/comments/default

Borrando comentarios

Para borrar un comentario, pasa la URL de edición del comentario al método delete en tu objeto GoogleService de la siguiente manera:

public static void deleteComment(GoogleService myService, String editLinkHref)
    throws ServiceException, IOException {
  URL deleteUrl = new URL(editLinkHref);
  myService.delete(deleteUrl);
}

Volver al principio