Integrare le funzionalità di Bing nei nostri siti web – Parte 5 – JSON & SOAP

In questo post della serie riservata a Bing diamo, rapidamente, un’occhiata agli entry point delle API che si basano sui protocolli JSON e SOAP. Le precedenti puntate sono disponibili ai seguenti link: Parte 1, Parte 2, Parte 3 e Parte 4.

     JSON

L’entry point per ottenere una risposta alla nostra ricerca con la serializzazione JSON è il seguente:

http://api.search.live.net/json.aspx

Tutti i discorsi visti nei precedenti posts relativi ai parametri di configurazione della ricerca sono ancora validi, per questo motivo, se effettuiamo una richiesta Get al seguente indirizzo:

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

otteniamo:

     Parametro JsonType

Nelle richieste JSON è possibile specificare il formato con cui restituire i risultati della ricerca tramite il parametro JsonType.
I possibili valori per JsonType sono:

raw : i risultati di ricerca sono restituiti in puro JSON;

callback : i risultati di ricerca vengono restituiti come argomento della funzione javascript indicata nel parametro JsonCallback;

function : viene restituita una funzione Javascript la cui chiamata restituisce i risultati di ricerca.

Se il parametro non viene assegnato, viene preso il valore raw per default.

     SOAP

Le funzionalità di ricerca di Bing sono utilizzabili anche tramite il protocollo SOAP referenziando il wsdl presente all’indirizzo:

http://api.bing.net/search.wsdl?AppID=<appid>&Version=2.2

Nella seguente figura riportiamo uno scorcio del wsdl:

Per informazioni sull’utilizzo dei servizi web service esposti in formato SOAP e delle classi proxy che vengono generate dalla reference al WSDL, vi consiglio di guardare la documentazione ufficiale al seguente link.

La seguente funzione permette di effettuare la ricerca dei video presenti in rete che rispondono ai criteri di ricerca passati per argomento:

Public Function Search(ByVal text As String, _

                       ByVal recordCount As UInteger, _

                       ByRef totalPage As UInteger, _

                       Optional ByVal pageNumber As UInteger = 0, _

                       Optional ByVal market As String = "it-IT") As List(Of BingAPI.VideoResult)

        Dim retList As List(Of BingAPI.VideoResult) = Nothing

        If Not String.IsNullOrEmpty(text) Then

            Dim startIndex = recordCount * pageNumber

            Dim parameters = New BingAPI.SearchRequest()

            parameters.Video = New BingAPI.VideoRequest()

            parameters.Video.Count = recordCount

            parameters.Video.Offset = startIndex

            parameters.Market = market

            parameters.Query = text

            Using srv As New BingAPI.BingPortTypeClient()

                Try

                    Dim response = Me._Service.Search(parameters)

                    retList = response.Video.Results.ToList()

                    totalPage = CUInt(Math.Truncate(response.Video.Total / recordCount + 0.5))

                Catch ex As Exception

                    Throw

                End Try

            End Using

        Else

            retList = New List(Of BingAPI.VideoResult)

        End If

        Return retList

    End Function

La funzione accetta un testo di ricerca, un numero di record per pagina, il numero di pagina da restituire (opzionale), il market (opzionale) e restituisce il numero totale (approssimato) di elementi della ricerca e la lista dei risultati.

La classe VideoResult è una delle classi wrapper generate dalla reference al servizio SOAP di Bing:

La classe BingPointPortClient è, invece, la classe per l’accesso al servizio di ricerca:

 

Il protocollo SOAP è, decisamente, più semplice da utilizzare, fornendo in maniera automatica le wrapper classi per la gestione dei risultati.

     Riferimenti

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

Bing API, Version 2


Bing Developer Center

 

Technorati Tag: Bing,Bing API,Search Engine,Using Bing