Recommendations Technical References

bof_profile

string

✔

The user’s ID. Not strictly required, but highly recommended. If not supplied, a session ID will be generated server-side in replacement. This is set automatically by yq.js.

content_id

string

✔

The content ID of the current page. If the current page is non-content, this can either be omitted or set to null (ok, so it’s not strictly required).

href

string

✔

URL of the current page. This is set automatically by yq.js.

alt_href

string

This will override ‘href’. Provides a way to manually set the URL of the current page.

content_type

string

Observed content is handled differently depending on this. If not supplied, defaults to regular articles (“content”). Supported options: [“content”, “classified”, “sponsored”].

idm

object

Object: IDM. This is for recording identity management / user profile information.

observe

array[object]

Object: Observe. Only the first object in the array is used. This object is required to index the current article.

page_hit

object

Object: Page Hit. This object is required to record a page hit for reporting purposes.

suggest

array[object]

Object: Suggest. Only the first object in the array is used. This object is required to request recommendations.

create_date

string

Deprecated: Use the Observe’s ‘create_date’ instead.

image

string

Deprecated: Use the Observe’s ‘image’ instead.

title

string

Deprecated: Use the Observe’s ‘title’ instead.

The article’s categories. The following formats are supported:

• [“sports”, “news”]
• “sports, news”
• [[“sports”], [“news”]]
• [[“basketball”, “sports”], [“local”, “news”]] – Pairs only

Object: Classified.

The publish date (and preferably time) of the article. The format must be supported by .NET’s DateTime.TryParse. Datetimes with a “Z” specifier are treated as UTC; otherwise they are treated as the domain’s local time.

The article’s description.

URL of the article’s primary image.

Article will only be indexed if this is true. If not supplied, defaults to true.

The article’s tags.

The article’s title.

Deprecated: We accept this parameter, but it is never used.

Deprecated: Use ‘content_id’ at the top level instead.

The user’s timezone name. This is set automatically by yq.js, which assigns the value of timezone.olson_tz;

The user’s timezone offset. This is set automatically by yq.js, which assigns the value of timezone.utc_offset.

Deprecated: Use ‘bof_profile’ at the top level instead.

Deprecated: Use ‘href’ at the top level instead. This is set automatically by yq.js, but will be overridden by the top level href, if supplied.

Deprecated: Use ‘content_id’ at the top level instead.

type

string

✔

Always set this to “node”.

If ‘strict_categories’ is set to true in Suggest Options, this list of categories will be used to restrict the content returned in the recommendations.

Oldest publish date of content to include in recommendations.

Newest publish date of content to include in recommendations.

List of domains to draw content from for recommendations. By default, only content from the current domain is used.

Object: Exclusions. List(s) of content to exclude from recommendations.

If false, the current domain will not be included in the list of domains to draw content from.

If true, recommendations will contain content ID, title and URL. Overridden by ‘panel_custom’ and ‘is_panel_detailed’.

If true, recommendations will contain content ID, title, URL, image URL and description. Overridden by ‘panel_custom’.

If true, recommendations will contain URL only. Overridden by ‘panel_custom’, ‘is_panel_detailed’ and ‘is_panel_builder’.

Object: Suggest Options. Additional options for suggest request.

Object: Panel Custom. Use to customize the properties returned for recommendations (i.e. content ID, title, URL, etc.).

Identifies the type/location of panel that the recommendations will be served in. Supported options: [“home_panel”, “category_panel”, “article_panel”, “article_scroll”].

Number of sponsored content recommendations to return. This is a subset of the ‘count’, so if ‘count’ is 6 and ‘sponsored_count’ is 2, it will return 4 “regular” recommendations and 2 sponsored content recommendations.

Specifies which recommender variant will generate recommendations. Defaults to YQ recommendations. Supported options: [“yq”, “trending”, “mostread”].

Deprecated: Use ‘content_id’ at the top level instead.