Questa pagina è stata tradotta dall'API Cloud Translation.

Guida per gli sviluppatori: Java

Importante: questa è una versione precedente di questa pagina. Per la versione più recente, utilizza i link nella barra di navigazione a sinistra.

L'API Blogger Data consente alle applicazioni client di visualizzare e aggiornare i contenuti di Blogger sotto forma di feed dell'API di dati di Google.

L'applicazione client può utilizzare l'API Blogger Data per creare nuovi post del blog, modificare o eliminare quelli esistenti e eseguire query sui post del blog che soddisfano determinati criteri.

Oltre a fornire alcune informazioni sulle funzionalità dell'API di dati di Blogger, questo documento fornisce esempi di interazioni di base con l'API di dati utilizzando la libreria client Java. Se vuoi saperne di più sul protocollo di base utilizzato dalla libreria, consulta la sezione Protocollo di questa guida per gli sviluppatori.

Sommario

Pubblico

Questo documento è rivolto ai programmatori che vogliono scrivere applicazioni client Java in grado di interagire con Blogger.

Questo documento presuppone che tu comprenda le idee generali alla base del protocollo delle API di dati di Google.

Per informazioni di riferimento sulle classi e sui metodi forniti dalla libreria client, consulta il riferimento all'API della libreria client Java. Per informazioni di riferimento generale sull'API Blogger Data, consulta la guida di riferimento del protocollo.

Per iniziare

Per assistenza sulla configurazione della libreria client, consulta la Guida introduttiva.

La libreria client Java richiede Java 1.5. Dopo aver scaricato la libreria client, troverai i classi necessari per iniziare nel java/lib/gdataclient-1.0.jar file.

Creare un account Blogger

Ti consigliamo di creare un account Blogger a scopo di test. Blogger utilizza gli Account Google, quindi se hai già un Account Google, non devi fare altro.

Eseguire il codice di esempio

Un client di esempio completamente funzionante, contenente tutto il codice di esempio mostrato in questo documento, è disponibile nella distribuzione della libreria client Java, nella directory gdata/java/sample/blogger/BloggerClient.java. Le istruzioni di compilazione e esecuzione sono incluse nella stessa directory nel file README.txt.

Il client di esempio esegue diverse operazioni sul blog fornito per dimostrare l'utilizzo dell'API Blogger Data.

Per compilare gli esempi in questo documento nel tuo codice, ti serviranno le seguenti istruzioni import:

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

Autenticazione al servizio Blogger

Puoi accedere ai feed pubblici e privati utilizzando l'API Blogger Data. I feed pubblici non richiedono alcuna autenticazione, ma sono di sola lettura. Se vuoi modificare i blog, il tuo cliente deve autenticarsi prima di richiedere i feed privati. Può eseguire l'autenticazione utilizzando uno dei due approcci: autenticazione proxy AuthSub o autenticazione nome utente/password ClientLogin.

Per ulteriori informazioni sull'autenticazione con le API di dati di Google in generale, consulta la documentazione sull'autenticazione.

La maggior parte degli esempi nelle sezioni successive di questo documento presuppone che tu abbia un oggetto GoogleService autenticato.

Autenticazione proxy AuthSub

L'autenticazione proxy AuthSub viene utilizzata dalle applicazioni web che devono autenticare i propri utenti negli Account Google. L'operatore del sito web e il codice client non hanno accesso al nome utente e alla password dell'utente di Blogger. Il client ottiene invece token AuthSub speciali che gli consentono di agire per conto di un determinato utente. Per informazioni più dettagliate, consulta la documentazione di AuthSub.

Quando un utente visita per la prima volta la tua applicazione, non è ancora stato autenticato. In questo caso, devi mostrare alcune informazioni e un link che indirizzi l'utente a una pagina di Google per autenticare la tua richiesta di accesso ai suoi blog. La libreria client Java fornisce una funzione per generare l'URL della pagina Google. Il codice seguente recupera l'URL della pagina 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);

Il metodo getRequestUrl accetta i seguenti parametri (corrispondenti ai parametri di query utilizzati dall'handler AuthSubRequest):

avanti: L'URL della pagina a cui Google deve reindirizzare l'utente dopo l'autenticazione.
ambito: Indica che l'applicazione sta richiedendo un token per accedere ai feed di Blogger. La stringa di ambito da utilizzare è http://www.blogger.com/feeds/ (ovviamente codificata come URL).
sicuro: Indica se il client richiede un token sicuro.
sessione: Indica se il token restituito può essere scambiato con un token multiuso (di sessione).

L'esempio riportato sopra mostra una chiamata che non richiede un token sicuro (il valore di secure è false). L'URL della richiesta risultante potrebbe avere il seguente aspetto:

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

L'utente segue il link al sito di Google e si autentica nel proprio Account Google.

Dopo che l'utente ha eseguito l'autenticazione, il sistema AuthSub lo reindirizza all'URL specificato nel parametro di query next dell'URL AuthSubRequest. Il sistema AuthSub aggiunge un token di autenticazione a quell'URL come valore del parametro di query token. Ad esempio:

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

Questo valore del token rappresenta un token AuthSub monouso. In questo esempio, poiché è stato specificato session = true, questo token può essere scambiato con un token di sessione AuthSub chiamando il servizio AuthSubSessionToken, come segue, dove urlFromAuthSub è l'URL a cui AuthSub ha aggiunto il token:

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

In altre parole, passi il token monouso al metodo exchangeForSessionToken, insieme a null (per la modalità non registrata) o a una chiave privata (per la modalità registrata) e l'interfaccia AuthSub restituisce un token di sessione. Per ulteriori informazioni sulle applicazioni e sulle chiavi private registrate, consulta la sezione "Firma delle richieste" della documentazione di AuthSub.

La tua applicazione potrà quindi utilizzare il token di sessione nelle interazioni successive con Blogger. Per indicare alla libreria client Java di inviare automaticamente il token di sessione con ogni richiesta, chiama il metodo setAuthSubToken dell'oggetto GoogleService:

GoogleService.setAuthSubToken(sessionToken, null);

Dopodiché, la libreria client invia automaticamente il token con ogni richiesta.

Autenticazione tramite nome utente/password ClientLogin

Utilizza l'autenticazione ClientLogin se il client è un client "installato" autonomo per un solo utente (ad esempio un'applicazione desktop). Basta chiamare il metodo setUserCredentials sull'oggetto GoogleService e tutte le interazioni successive con Blogger verranno autenticate:

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

Nello snippet riportato sopra, passiamo due parametri al constructor GoogleService. Il primo parametro è il nome del servizio con cui vogliamo interagire. Il secondo parametro è il nome della nostra applicazione nel formato companyName-applicationName-versionID.

Per ulteriori informazioni sull'autenticazione ClientLogin, incluse richieste e risposte di esempio, consulta la documentazione sull'autenticazione per le applicazioni installate.

Nota: utilizza lo stesso token per tutte le richieste in una determinata sessione; non acquisire un nuovo token per ogni richiesta di Blogger.

Nota: come descritto nella documentazione di ClientLogin, la richiesta di autenticazione potrebbe non riuscire e richiedere una verifica CAPTCHA. Se vuoi che sia Google a emettere e gestire la verifica CAPTCHA, indirizza l'utente all'URL https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger (anziché all'URL di gestione del CAPTCHA indicato nella documentazione di ClientLogin).

Recupero di un elenco di blog

L'API Blogger Data fornisce un feed che elenca i blog di un determinato utente; questo feed è noto come "metafeed".

Il seguente codice di esempio utilizza un oggetto GoogleService autenticato per recuperare il metafeed e poi stampa il titolo di ogni 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());
  }
}

Prendi nota dell'URL utilizzato dal metodo getFeed. Si tratta dell'URL del metafeed predefinito; restituisce un elenco di blog per l'utente autenticato corrente. Per accedere a un feed per un utente diverso, puoi inserire l'ID utente al posto di default nell'URL del metafeed. L'ID utente è la stringa di cifre alla fine dell'URL del profilo dell'utente.

Creare post

L'API Blogger Data consente di creare e pubblicare nuove voci del blog, nonché bozze di voci.

Nota: l'impostazione di un autore personalizzato per i post non è attualmente supportata. Tutti i nuovi post verranno visualizzati come se fossero stati creati dall'utente attualmente autenticato.

Pubblicazione di un post del blog

Puoi utilizzare la libreria client Java per pubblicare nuove voci del blog.

Per prima cosa, crea un oggetto Entry per rappresentare il post del blog. Poi puoi impostare il titolo, i contenuti e altri attributi del post del blog. Infine, utilizza l'oggetto GoogleService per inserire il post. Ecco un esempio di come pubblicare un nuovo post del blog:

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);
}

Il metodo insert prende come parametro l'URL del post del servizio. Il metodo restituisce la voce così come è stata memorizzata da Blogger. La voce riportata è la stessa che hai inviato, ma contiene anche vari elementi aggiunti da Blogger, ad esempio un ID post.

Se la richiesta non va a buon fine per qualche motivo, Blogger potrebbe restituire un codice stato diverso. Per informazioni sui codici di stato, consulta il documento di riferimento del protocollo dell'API Google Data.

Creare una bozza di un post del blog

I post in bozza vengono creati nello stesso modo dei post pubblici, ma devi impostare l'attributo draft dell'oggetto Entry. Puoi creare un post del blog come quello riportato sopra come bozza aggiungendo la riga evidenziata:

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);
}

Puoi trasformare una bozza di post del blog esistente in un post pubblicato recuperandola, impostando l'attributo bozza su false e aggiornando il post. Tratteremo il recupero e l'aggiornamento dei post nelle due sezioni successive.

Recupero dei post

Le sezioni seguenti descrivono come recuperare un elenco di post del blog, con e senza parametri di query.

Puoi eseguire query su un feed pubblico di Blogger senza autenticazione. Pertanto, non è necessario chiamare il metodo setUserCredentials o eseguire l'autenticazione AuthSub prima di recuperare i post da un blog pubblico.

Recupero di tutti i post del blog

Per recuperare i post dell'utente, chiama lo stesso metodo getFeed utilizzato per recuperare il metafeed dei blog, ma questa volta invia l'URL del feed dei post del 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();
}

Recupero dei post utilizzando i parametri di query

L'API Blogger Data ti consente di richiedere un insieme di voci che corrispondono a criteri specificati, ad esempio richiedere post del blog pubblicati o aggiornati in un determinato intervallo di date. A questo scopo, crea un oggetto Query e passalo al metodo GoogleService.getQuery.

Ad esempio, per inviare una query sull'intervallo di date, utilizza i metodi setPublishedMin e setPublishedMax dell'oggetto Query. Il seguente snippet di codice stampa il titolo di ogni post del blog pubblicato tra le ore di inizio e di fine specificate:

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();
}

Tieni presente che l'oggetto Query viene creato utilizzando lo stesso URL del feed dei post utilizzato per recuperare i post.

L'API Blogger Data supporta i seguenti metodi Query:

addCategoryFilter: Specifica le categorie (dette anche etichette) per filtrare i risultati del feed. Ad esempio, http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie restituisce voci con le etichette Fritz e Laurie.
setMaxResults: Imposta il numero massimo di voci da restituire.
setPublishedMin, setPublishedMax: Imposta i limiti per le date di pubblicazione delle voci.
setStartIndex: Imposta l'indice basato su 1 del primo risultato da recuperare (per la paginazione).
setUpdatedMin, setUpdatedMax: Imposta i limiti per le date di aggiornamento delle voci. Questi parametri di query vengono ignorati a meno che il parametro orderby non sia impostato su updated.

Nota: al momento non sono disponibili setter per il parametro di query orderby. Tuttavia, se devi impostarlo, puoi comunque utilizzare il metodo Query.addCustomParameter().

Per ulteriori informazioni sui parametri di query, consulta la Guida di riferimento dell'API di dati di Blogger e la Guida di riferimento delle API di dati di Google.

Aggiornamento dei post

Per aggiornare un post del blog esistente, devi prima recuperare la voce da aggiornare, poi modificarla e infine inviarla a Blogger utilizzando il metodo update. Il seguente snippet di codice modifica il titolo di un post del blog, supponendo che tu abbia già recuperato il post dal server.

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);
}

Il codice riportato sopra restituisce un Entry contenente l'intero post appena aggiornato. Per aggiornare altre proprietà, impostale nell'oggetto Entry prima di chiamare update.

Nota: la modifica dei dati dell'autore associati ai post non è attualmente supportata.

Eliminare i post

Per eliminare un post, passa l'URL di modifica del post al metodo delete nell'oggetto GoogleService, come segue:

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

Commenti

L'API Blogger Data consente di creare, recuperare ed eliminare i commenti. L'aggiornamento dei commenti non è supportato (e non è disponibile nell'interfaccia web).

Creazione di commenti

Per pubblicare un commento, crea un oggetto Entry e inseriscilo come segue:

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: al momento puoi pubblicare commenti solo su un blog di proprietà dell'utente autenticato.

Nota: l'impostazione di un autore personalizzato per i commenti al momento non è supportata. Tutti i nuovi commenti verranno visualizzati come se fossero stati creati dall'utente attualmente autenticato.

Recupero dei commenti

Puoi recuperare i commenti di un determinato post dall'URL del feed dei commenti del post:

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();
}

In alternativa, puoi recuperare i commenti di tutti i post utilizzando l'URL del feed commenti del blog:

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

Eliminazione dei commenti

Per eliminare un commento, passa l'URL di modifica del commento al metodo delete nell'oggetto GoogleService come segue:

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

Torna all'inizio