View Source GoogleApi.ContentWarehouse.V1.Model.GenericSnippetResponse (google_api_content_warehouse v0.4.0)

The generic version of a snippet response

Attributes

  • debugInfo (type: list(String.t), default: nil) - Per-doc debug information.
  • info (type: GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t, default: nil) - Servlet-specific response info.
  • rankingSnippet (type: String.t, default: nil) - The experimental ranking snippet field. This will be populated only when fastwa_want_ranking_snippet is set in the request.
  • snippet (type: list(String.t), default: nil) - Lines of the snippet HTML. Typically gws concatenates these and lets the browser wrap. The values include trailing spaces, so inserting additional spaces is not necessary. However, for very old browsers, gws may insert break tags after each snippet line. This field is confusing and poorly named; "snippet_line" would be better. In particular, note that this does not return multiple snippets for a result. Nor are these fields the individual tidbits of the snippet.
  • title (type: String.t, default: nil) - The title HTML. It may contain tags to denote query term matches. It may be already truncated and "..." is put instead (note that truncation does not always happen at the very end of the title text). However the existence of "..." does not guarantee that the snippet generation algorithm truncated it; e.g. webmasters themselves can write "...".
  • wwwSnippetResponse (type: GoogleApi.ContentWarehouse.V1.Model.WWWSnippetResponse.t, default: nil) - Snippet-specific members (tag ids 16+, must be optional!) Example: optional NewContentResponse new_response;

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GenericSnippetResponse{
  debugInfo: [String.t()] | nil,
  info: GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,
  rankingSnippet: String.t() | nil,
  snippet: [String.t()] | nil,
  title: String.t() | nil,
  wwwSnippetResponse:
    GoogleApi.ContentWarehouse.V1.Model.WWWSnippetResponse.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.