Cookie API の概要
この記事では、Cookie データの設定および取得に使用される Microsoft Dynamics 365 Commerce オンライン ソフトウェア開発キット (SDK) のアプリケーション プログラミング インターフェイス (API) の概要を説明します。
Cookie 同意
Cookie を保存する前に、ユーザーは同意を得る必要があります。 Dynamics 365 Commerce オンライン SDKには、Cookie の読み取り/書き込み操作がユーザーの同意に依存することの保証を提供します。
Cookie API
Dynamics 365 Commerce オンライン SDKには、次のインターフェイスに示すように、props.context.request.cookie API 内から Cookie にアクセスする API が用意されています。
export interface ICookieContext {
get<T>(cookieName: string): ICookieValue<T>;
set<T>(cookieName: string, cookieValue: T, options?: ICookieSetOptions): void;
getCartCookie(): string;
setCartCookie(cart: Cart, isAuthenticated: boolean): void;
getCheckoutCartCookie(): string;
setCheckoutCartCookie(cart: Cart, isAuthenticated: boolean): void;
removeCheckoutCartCookie(): void;
remove(cookieName: string): void;
isConsentGiven(): boolean;
setConsentCookie(): void;
deleteConsentCookie(): void;
getTargetIdCookie(): string;
}
ユーザーの同意を得る
setConsentCookie() API は、Cookie が書き込まれる前に、ユーザーの同意を得るために使用されます。
ユーザーの同意が得られているかどうかを示します
isConsentGiven() API は、ユーザーの同意が得されているかどうかを判断するために使用されます。
Cookie の設定
次の例は、Cookie の設定方法を示しています。
this.props.context.request.cookies.set<string>('favoriteColor', 'blue');
API が呼び出される前にユーザーの同意が得ない場合、SDK はすべての設定オプションのキューを保持し、ユーザーが同意した後にのみ Cookie を設定します。
Cookie 値の取得
次の例では、Cookie 値を取得する方法を示します。
const favColor = this.props.context.request.cookies.get<string>('favoriteColor');
追加リソース
コンテキストに基づいてモジュール プロパティを表示するように構成する