Importante: Esta es una versión anterior de esta página. Para obtener la versión más reciente, usa los vínculos de la barra de navegación izquierda.
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 con la biblioteca cliente de .NET. 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 .NET 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 .NET. 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.
Para usar la biblioteca cliente de .NET, necesitarás el entorno de ejecución de .NET 1.1 y estar actualizado en todos los parches. Después de descargar la biblioteca cliente, encontrarás los DLL que necesitas para comenzar en el subdirectorio lib/Release de la distribución.
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
En el proyecto de la biblioteca cliente de .NET, se encuentra disponible un cliente de muestra completo que contiene todo el código de muestra que se muestra en este documento. La muestra se encuentra en /trunk/clients/cs/samples/blogger/ConsoleSample.cs en la pestaña Fuente del repositorio de SVN.
Antes de compilar y ejecutar esta muestra, actualiza los valores de username, password, blogName y postId con los valores adecuados. Los valores username y password representan las credenciales que se usan para acceder a Blogger. El valor blogName es el inicio de la URL de blogspot de tu blog.
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 using:
using Google.GData.Client; using System.Net; using System.Xml; using System.Text.RegularExpressions;
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 con cualquiera de estos dos métodos: autenticación de proxy AuthSub o autenticación con 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.
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.
Supongamos que el siguiente hipervínculo ASP se define en su página:
<asp:HyperLink ID="GotoAuthSubLink" runat="server"/>
Luego, a fin de construir la URL de AuthSubRequest para tu aplicación, realiza una llamada a la biblioteca cliente de .NET de la siguiente manera:
GotoAuthSubLink.Text = "Login to your Google Account";
GotoAuthSubLink.NavigateUrl =
AuthSubUtil.getRequestUrl("http://www.example.com/RetrieveToken",
"http://www.blogger.com/feeds/",
false,
true);
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 de alcance que se usará es
http://www.blogger.com/feeds/(por supuesto, codificada en URL). - 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 solicitud resultante podría verse de la siguiente manera:
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%2FRetrieveToken
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 lo tanto, se puede acceder al token como una variable en el objeto Request.QueryString de la página de ASP. Se redirecciona al usuario a una URL similar a la siguiente:
http://www.example.com/RetrieveToken?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, de la siguiente manera:
SessionsessionToken = AuthSubUtil.exchangeForSessionToken(Request.QueryStringtoken, 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 valor del token de sesión en interacciones posteriores con Blogger. Para indicarle a la biblioteca cliente de .NET que envíe de forma automática el encabezado de autorización (que contiene el token de sesión) con cada solicitud, haz lo siguiente:
GAuthSubRequestFactory authFactory = new GAuthSubRequestFactory("blogger", "BloggerSampleApp");
authFactory.Token = SessionsessionToken.ToString();
Service service = new Service(authFactory.ApplicationName);
service.RequestFactory = authFactory;
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). Configura las credenciales de tu objeto de servicio de la siguiente manera:
Service service = new Service("blogger", "exampleCo-exampleApp-1");
service.Credentials = new GDataCredentials("user@example.com", "secretPassword");
GDataGAuthRequestFactory factory = (GDataGAuthRequestFactory) service.RequestFactory;
factory.AccountType = "GOOGLE";
En el fragmento anterior, pasamos dos parámetros al constructor Service. 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. También configuramos el Service.RequestFactory a fin de usar solo un tipo de cuenta GOOGLE para permitir la autenticación adecuada para los usuarios de G Suite.
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 Service autenticado para recuperar el metafeed y, luego, imprimir el título de cada blog.
query.Uri = new Uri("http://www.blogger.com/feeds/default/blogs");
AtomFeed feed = null;
try
{
feed = service.Query(query);
foreach (AtomEntry entry in feed.Entries)
{
Console.WriteLine("Blog Title: " + entry.Title.Text);
}
}
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.
En todas las siguientes muestras, se supone que tienes un objeto Service autenticado.
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 .NET para publicar entradas de blog nuevas.
Primero, crea un objeto AtomEntry 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 Service para insertar la publicación. A continuación, te mostramos un ejemplo de cómo publicar una entrada de blog nueva:
AtomEntry newPost = new AtomEntry();
newPost.Title.Text = "Marriage!";
newPost.Content = new AtomContent();
newPost.Content.Content = "<div xmlns='http://www.w3.org/1999/xhtml'>" +
"<p>Mr. Darcy has <em>proposed marriage</em> to me!</p>" +
"<p>He is the last man on earth I would ever desire to marry.</p>" +
"<p>Whatever shall I do?</p>" +
"</div>";
newPost.Content.Type = "xhtml";
Uri blogFeedUri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
AtomEntry createdEntry = service.Insert(blogFeedUri, newPost);
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 AtomEntry. La entrada de blog anterior se puede crear como borrador si se agrega la línea destacada:
AtomEntry newPost = new AtomEntry();
newPost.Title.Text = "Marriage!";
newPost.Content = new AtomContent();
newPost.Content.Content = "<div xmlns='http://www.w3.org/1999/xhtml'>" +
"<p>Mr. Darcy has <em>proposed marriage</em> to me!</p>" +
"<p>He is the last man on earth I would ever desire to marry.</p>" +
"<p>Whatever shall I do?</p>" +
"</div>";
newPost.Content.Type = "xhtml";
newPost.IsDraft = true;
Uri blogFeedUri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
AtomEntry createdEntry = service.Insert(blogFeedUri, newPost);
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 necesitas configurar credenciales ni realizar 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:
query.Uri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
feed = service.Query(query);
Console.WriteLine(feed.Title.Text);
foreach (AtomEntry entry in feed.Entries)
{
Console.WriteLine("Entry Title: " + entry.Title.Text);
}
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 FeedQuery y pásalo al método Service.Query().
Por ejemplo, para enviar una consulta de período, configura los miembros MinPublication y MaxPublication del objeto FeedQuery.
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:
FeedQuery query = new FeedQuery();
query.Uri = new Uri("http://www.blogger.com/feeds/" + blogId + "/posts/default");
query.MinPublication = new DateTime(2006, 1, 1);
query.MaxPublication = new DateTime(2007, 4, 12);
AtomFeed feed = service.Query(query);
foreach (AtomEntry entry in feed.Entries)
{
Console.WriteLine(" Entry Title: " + entry.Title.Text);
}
Ten en cuenta que el objeto FeedQuery 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 parámetros de consulta:
- alt
- El tipo de feed que se mostrará, como
atom(predeterminado) orss. - /category
- 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/Lauriemuestra entradas con las etiquetasFritzyLaurie. - resultados máximos
- La cantidad máxima de entradas que se mostrarán.
- ordenamiento
- El orden en el que se muestran las entradas, como
lastmodified(la opción predeterminada),starttimeoupdated. - mín. publicados, máx. publicados
- Los límites en las fechas de publicación de las entradas
- índice de inicio
- El índice basado en 1 del primer resultado que se recuperará (para la paginación).
- actualizado-min, actualizado-max
- 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
orderbyesté configurado comoupdated.
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() de la entrada. El siguiente fragmento de código modifica el título de una entrada de blog, suponiendo que ya recuperaste la entrada del servidor.
static AtomEntry EditEntry(AtomEntry toEdit)
{
// Edit the entry by changing the Title and calling Update().
if (toEdit != null)
{
toEdit.Title.Text = "Marriage Woes!";
toEdit = toEdit.Update();
}
return toEdit;
}
El código anterior muestra un AtomEntry que contiene toda la publicación recién actualizada. Para actualizar otras propiedades, solo debes configurarlas en el objeto AtomEntry 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, llama al método Delete en un objeto AtomEntry existente de la siguiente manera:
static void DeleteEntry(AtomEntry toDelete)
{
// Delete the edited entry
if (toDelete != null)
{
toDelete.Delete();
}
}
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 AtomEntry y, luego, insértalo de la siguiente manera:
AtomEntry comment;
comment = new AtomEntry();
comment.Title.Text = "This is my first comment";
comment.Content.Content = "This is my first comment";
Uri commentPostUri = new Uri("http://www.blogger.com/feeds/" + blogId + "/" + entryId + "/comments/default");
postedComment = service.Insert(commentPostUri, comment);
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:
static void ListEntryComments(Service service, Uri commentUri)
{
if (commentUri != null)
{
// Retrieve all comments on a blog entry
FeedQuery query = new FeedQuery();
query.Uri = commentUri;
AtomFeed feed = service.Query(query);
foreach (AtomEntry entry in feed.Entries)
{
Console.WriteLine(" Comment Title: " + entry.Title.Text);
}
}
}
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, llama al método Delete() en un objeto AtomEntry de comentario existente de la siguiente manera:
static void DeleteComment(AtomEntry commentEntry)
{
if (commentEntry != null)
{
// Delete the comment.
commentEntry.Delete();
}
}