1. JS SDKリファレンス

背景

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Sitecore Searchでは、閲覧されているページと訪問者の両方に依存するパーソナライズされた検索結果を得ることができます。これらの値をContextオブジェクトで送信できます。

!重要JS SDKはJS Dataパッケージの上に構築されています。JS Dataパッケージで利用可能なcontext objectとそのメソッドもJS SDKで利用可能です。

コンテキストオブジェクトに関するドキュメントについては、Search JS Dataパッケージを参照してください。

名称

種類

概要

geo

コンテキストジオ

訪問者の地理的位置情報が含まれています。

ids

アレイ

IDのリスト。

locale

コンテキストロケーション

閲覧されている国と言語に関する情報が含まれています。

page

コンテキストページ

リクエストが行われたページに関する情報が含まれています。

time

コンテキストタイム

申請時期に関する情報が含まれています。

user

コンテキストユーザー

訪問者に関する情報を含む。パーソナライズと正確な分析のために必要。

utm_campaign

Object

UTMキャンペーンパラメータを含みます。

!注特に明記がない限り、すべての値は任意です。

ISearchRequest関連メソッド

以下のコードブロックは、コンテキストに関連してRequestオブジェクトを通じてアクセス可能なさまざまなメソッドを一覧にしています。JS Dataパッケージをプロジェクトにインストールした後、これらのメソッドとそのドキュメントはIDEで利用可能です。

/** context */ getContext(): Context; setContext(value: Context): ISearchRequest; resetContext(): ISearchRequest; updateContext(value: Context): ISearchRequest;

/** context.geo */ getContextGeo(): ContextGeo; setContextGeo(value: ContextGeo): ISearchRequest; resetContextGeo(): ISearchRequest; updateContextGeo(value: ContextGeo): ISearchRequest;

/** context.geo.ip */ getContextGeoIp(): string; setContextGeoIp(value: string): ISearchRequest; resetContextGeoIp(): ISearchRequest;

/** context.geo.location */ getContextGeoLocation(): ContextGeoLocation; setContextGeoLocation(value: ContextGeoLocation): ISearchRequest; resetContextGeoLocation(): ISearchRequest; updateContextGeoLocation(value: ContextGeoLocation): ISearchRequest;

/** context.geo.location.lat */ getContextGeoLocationLat(): number; setContextGeoLocationLat(value: number): ISearchRequest; resetContextGeoLocationLat(): ISearchRequest;

/** context.geo.location.lon */ getContextGeoLocationLon(): number; setContextGeoLocationLon(value: number): ISearchRequest; resetContextGeoLocationLon(): ISearchRequest;

/** context.ids */ getContextIds(): MapModel; setContextIds(value: MapModel): ISearchRequest; resetContextIds(): ISearchRequest;

/** context.ids.__constructor__ */ getContextEntityIds(entity: Entity): Array; setContextEntityIds(entity: Entity, value: Array): ISearchRequest; resetContextEntityIds(entity: Entity): ISearchRequest; addContextEntityId(entity: Entity, value: EntityId): ISearchRequest; removeContextEntityId(entity: Entity, value: EntityId, filter?: (v: any) => boolean): ISearchRequest;

/** context.locale */ getContextLocale(): ContextLocale; setContextLocale(value: ContextLocale): ISearchRequest; resetContextLocale(): ISearchRequest; updateContextLocale(value: ContextLocale): ISearchRequest;

/** context.locale.country */ getContextLocaleCountry(): string; setContextLocaleCountry(value: string): ISearchRequest; resetContextLocaleCountry(): ISearchRequest;

/** context.locale.language */ getContextLocaleLanguage(): string; setContextLocaleLanguage(value: string): ISearchRequest; resetContextLocaleLanguage(): ISearchRequest;

/** context.page */ getContextPage(): ContextPage; setContextPage(value: ContextPage): ISearchRequest; resetContextPage(): ISearchRequest; updateContextPage(value: ContextPage): ISearchRequest;

/** context.page.custom */ getContextPageCustom(): ContextPageCustom; setContextPageCustom(value: ContextPageCustom): ISearchRequest; resetContextPageCustom(): ISearchRequest;

/** context.page.uri */ getContextPageUri(): string; setContextPageUri(value: string): ISearchRequest; resetContextPageUri(): ISearchRequest;

/** context.time */ getContextTime(): ContextTime; setContextTime(value: ContextTime): ISearchRequest; resetContextTime(): ISearchRequest; updateContextTime(value: ContextTime): ISearchRequest;

/** context.time.epoch */ getContextTimeEpoch(): number; setContextTimeEpoch(value: number): ISearchRequest; resetContextTimeEpoch(): ISearchRequest;

/** context.user */ getContextUser(): ContextUser; setContextUser(value: ContextUser): ISearchRequest; resetContextUser(): ISearchRequest; updateContextUser(value: ContextUser): ISearchRequest;

/** context.user.uuid */ getContextUserUuid(): string; setContextUserUuid(value: string): ISearchRequest; resetContextUserUuid(): ISearchRequest;

/** context.utm_source */ context.setUtmSource('utm source');

/** context.utm_medium */ context.setUtmMedium('utm medium');

/** context.utm_campaign */ context.setUtmCampaign('utm campaign');

/** context.utm_term */ context.setUtmTerm('utm term');

/** context.utm_content */ context.setUtmContent('utm content');

この記事を改善するための提案がある場合は、 お知らせください!