Worum handelt es sich bei der Projekt-URL-Vorschau?What is Project URL Preview?

Der URL-Vorschau-Endpunkt nutzt einen URL-Abfrageparameter und gibt eine JSON-Antwort mit dem Namen der Zielressource, einer kurzen Beschreibung und einem Link zu einem Bild, das in einer Vorschau angezeigt wird, zurück.The URL Preview endpoint takes a URL query parameter and returns a JSON response with the name of the target resource, a brief description, and a link to an image to display in a preview. Die Antwort hat außerdem das isFamilyFriendly-Flag, das angibt, ob die URL jugendgefährdende, raubkopierte oder andere illegale Inhalte enthält.The response also includes the isFamilyFriendly flag that indicates whether the URL contains adult, pirated, or other illegal content.

Um Ergebnisse für die URL-Vorschau abzurufen, senden Sie eine GET-Anforderung, und fügen Sie den Header Ocp-Apim-Subscription-Key mit einem gültigen Token ein:To get URL preview results, submit a GET request, and include the Ocp-Apim-Subscription-Key header with a valid token:

https://api.labs.cognitive.microsoft.com/urlpreview/v7.0/search?q=https://swiftkey.com

Die Antwort:The response:

HTTP Headers:
BingAPIs-TraceId: 3CC74C94769440C0851D9DF0869FCE7F
BingAPIs-SessionId: 52219085A6364692958C9C83983A0DBA
X-MSEdge-ClientID: 13D44DC2DE946B4B0F25460CDF036AD6
BingAPIs-Market: en-US
X-MSEdge-Ref: Ref A: 3CC74C94769440C0851D9DF0869FCE7F Ref B: CO1EDGE0315 Ref C: 2018-04-11T18:47:40Z
{
  "_type": "WebPage",
  "name": "SwiftKey - Smart prediction technology for easier mobile typing",
  "url": "https:\/\/swiftkey.com\/en",
  "description": "Discover the best Android and iPhone and iPad apps for faster, easier typing with emoji, colorful themes and more - download SwiftKey Keyboard free today.",
  "isFamilyFriendly": true,
  "primaryImageOfPage": {
    "contentUrl": "https:\/\/swiftkey.com\/images\/og\/default.jpg"
  }
}

SzenarienScenarios

Die URL-Vorschau-API unterstützt kurze Beschreibungen von Webressourcen.The URL Preview API supports brief descriptions of Web resources. Mit ihr erstellen Entwickler umfangreiche Vorschauen.Developers use it to build rich preview experiences. Benutzer können Webseiten, News, Blogs, Foren usw. freigeben oder als Lesezeichen speichern. Außerdem lässt sich diese API für die Inhaltsmoderation verwenden.Users can share or bookmark webpages, news, blogs, forums, etc. This API can also be used for content moderation.

Anwendungen verwenden die URL-Vorschau, um Webanforderungen an den Endpunkt zu senden, mit einer der URL zugewiesenen Abfrage für die Vorschau.Applications use URL Preview to send Web requests to the endpoint with a query assigned to the URL to preview. Die JSON-Antwort enthält die Vorschauinformationen: Name, Beschreibung der Ressource, familyFriendly-Flag und Links, die Zugriff auf ein repräsentatives Bild und die vollständige Ressource online bereitstellen.The JSON response contains the preview information: name, description of the resource, familyFriendly flag, and links that provide access to a representative image and to the complete resource online.

NutzungsbedingungenTerms of use

Verwenden Sie nur die Daten aus der Projekt-URL-Vorschau, um Vorschauausschnitte und durch Links mit ihren Quellwebsites verbundene Miniaturansichten in einer vom Endbenutzer initiierten URL-Freigabe in sozialen Medien, Chatbots oder ähnlichen Angeboten anzuzeigen.Use only the data from Project URL Preview to display preview snippets and thumbnail images hyperlinked to their source sites, in end user-initiated URL sharing on social media, chat bot or similar offerings. Kopieren, speichern oder zwischenspeichern Sie keine Daten, die Sie aus der Projekt-URL-Vorschau erhalten.D not copy, store, or cache any data you receive from Project URL Preview. Sie müssen allen Anforderungen zum Deaktivieren von Vorschauen nachkommen, die Sie von Website- oder Inhaltsbesitzern erhalten.Honor any requests to disable previews that you may receive from website or content owners.

Sie oder ein Dritter in Ihrem Namen dürfen Daten aus der URL-Vorschau-API nicht für Tests, Entwicklung, Aus- und Weiterbildung, Verteilung oder Bereitstellung eines Nicht-Microsoft-Diensts oder einer Nicht-Microsoft-Funktion verwenden, beibehalten, speichern, zwischenspeichern, freigeben oder verteilen.You, or a third party on your behalf, may not use, retain, store, cache, share, or distribute any data from the URL Preview API for testing, developing, training, distributing or making available any non-Microsoft service or feature.

DrosselungsanforderungenThrottling requests

Der Dienst und Ihr Abonnementtyp bestimmen die zulässige Anzahl von Abfragen pro Sekunde (Queries Per Second, QPS).The service and your subscription type determine the number of queries per second (QPS) that you can make. Stellen Sie sicher, dass Ihre Anwendung die erforderliche Logik enthält, um das Kontingent nicht zu überschreiten.Make sure your application includes the logic to stay within your quota. Wenn der QPS-Grenzwert erreicht oder überschritten wird, ist die Anforderung nicht erfolgreich, und es wird ein HTTP 429-Statuscode zurückgegeben.If the QPS limit is met or exceeded, the request fails and an HTTP 429 status code is returned. Die Antwort enthält den Header Retry-After, der angibt, wie lange bis zum Senden einer weiteren Anforderung gewartet werden muss.The response includes the Retry-After header, which indicates how long you must wait before sending another request.

Denial-of-Service im Vergleich zur DrosselungDenial-of-service versus throttling

Der Dienst unterscheidet zwischen einem DoS-Angriff (Denial-of-Service) und einem QPS-Verstoß.The service makes a differentiation between a denial-of-service (DoS) attack and a QPS violation. Wenn der Dienst einen DoS-Angriff vermutet, ist die Anforderung erfolgreich (HTTP-Statuscode: 200 OK).If the service suspects a DoS attack, the request succeeds (HTTP status code is 200 OK). Der Antworttext ist jedoch leer.However, the body of the response is empty.

Nächste SchritteNext steps