martedì 4 agosto 2009

Integrare le funzionalità di Bing nei nostri siti web – Parte 1 - Introduzione

Vorrei inaugurare una serie di post illustrarvi le API di base dei servizi messi a disposizione dal motore di ricerca Bing.

Bing è accessibile attraverso tre differenti protocolli: XML, JSON e SOAP.
Queste tre modalità di accesso ai risultati ci permettono di scegliere il miglior modo per integrare funzionalità di ricerca nella nostra applicazione.

Grazie al protocollo XML, possiamo fare esperimenti sulle API di Bing utilizzando un normale browser.
Per fare questo è necessario recuperare un AppID, un parametro da passare alla richiesta Get che faremo con il browser che permette al sistema di riconoscerci.
Possiamo generare l’AppID andando sul sito per lo sviluppo con Bing (http://search.live.com/developers), loggarci con il nostro Windows Live ID e creare l’AppID utilizzando l’apposito link.
Per la creazione dell’AppID sarà necessario inserire alcune informazioni relative all’applicazione che utilizzerà l’ID generato:

 04-08-2009 8.03

Una volta che abbiamo in mano l’AppID possiamo sperimentare le funzionalità utilizzando un normale browser e una semplice richiesta Get con opportuni parametri in query string.
Gli url che possiamo utilizzare per effettuare dei test sono i seguenti:

http://api.search.live.net/xml.aspx (risultati in XML)

http://api.search.live.net/json.aspx (risultati in JSON)

Per semplicità utilizziamo il primo dei due (ma ciò che diremo vale anche per il secondo).
La richiesta Get va corredata da alcuni parametri in query string (oltre al già citato AppID):

Query : il parametro contiene le parole da ricercare (ad esempio “Bing”);
Sources : indica la sorgente da cui attingere i risultati. I possibili valori per questo parametro sono:

  • Ad : ricerca di inserzioni pubblicitarie;
  • Image  : immagini;
  • InstantAnswer : risposte a domande quali “quanti secondi ci sono in un anno?”, etc., etc.;
  • MobileWeb : contenuti web per dispositivi mobile;
  • News : notizie ;
  • Phonebook : dettagli su attività commerciali;
  • RelatedSearch : contenuti legati alla ricerca effettuata e di possibile interesse;
  • Spell : risultati con uno spelling simile a quello ricercato;
  • Translation : traduzioni tra differenti lingue;
  • Video : video correlati alla ricerca effettuata;
  • Web : classici contenuti web.

e sono valide anche  combinazioni degli stessi, utilizzando il carattere “+”.

La scelta oculata della sorgente dati ci consente di fornire differenti tipologie di risultati per ogni ricerca effettuata dall’utente.

Esistono altri parametri utilizzabili che gestiscono al paginazione dei risultati e che vedremo più avanti.

Tanto per entrare nel vivo, proviamo ad aprire il browser e a digitare il seguente URL:

http://api.search.live.net/xml.aspx?Appid=<appid>&query=Bing&sources=Web

dove <appid> va sostituito con il proprio AppID visto in precedenza.
Il risultato che otteniamo è il seguente:

04-08-2009 7.20

L’Header contiene le parole utilizzate per la ricerca, mentre il Body contiene gli effettivi risultati.

In caso di sorgenti multiple, ad esempio “Web+News+Image”, otteniamo:

04-08-2009 8.14

Per ogni tipologia di sorgente richiesta vengono forniti (con un particolare namespace) il numero totale dei risultati, l’offset (in sostanza la pagina di visualizzazione come vedremo avanti) e l’elenco dei primi n elementi trovati (con n=10 per impostazione predefinita).

Il nodo Total (tipizzato nelle diverse tipologie di sorgenti) rappresenta il numero totale (stimato) dei valori che soddisfano i parametri di ricerca. Questo valore va preso con le pinze in quanto potrebbe non essere esattamente uguale al numero dei risultati effettivi. Si tratta di una stima e come tale va utilizzata.

Il nodo Offset ci dice quale è l’indice del primo nodo risultato riportato nella lista dei risultati. Ci fornisce indicazioni riguardo alla pagina di risultati che stiamo esaminando.

Possiamo variare il numero di elementi di ogni sorgente restituiti per ogni ricerca utilizzando il parametro <sourcetype>.count. In questo modo, se aggiungiamo il parametro web.count=20 alla nostra query, otterremo 20 elementi di ricerca per il web e 10 per tutte le altre eventuali sorgenti richieste.
Facendo dei tentativi empirici si può riscontrare che se mettiamo, ad esempio, Web.count=51 otteniamo un errore che, invece, non otteniamo con Web.count=50.

Per poter lavorare sull’offset dei risultati (ottenendo, quindi le pagine successive dei risultati di ricerca) possiamo agire sul parametro <sourceType>.offset. In questo modo, se mettiamo Web.offset=21 ed eseguiamo la query, otteniamo i risultati a partire dal 21-esimo.

Ovviamente, i parametri visti in precedenza possono lavorare i combinazione per fornirci ampia flessibilità nelle ricerche.

Nel prossimo post analizzeremo i possibili parametri che possono essere utilizzati nelle API di Bing.

     Riferimenti

Per maggiori informazioni potete consultare la documentazione presente ai seguenti link:

Bing API, Version 2
Bing Developer Center

 

Nessun commento: