Function logEvent

logEvent(
    analytics: Analytics,
    name: "add_payment_info",
    params?: {
        coupon?: string;
        currency?: string;
        items?: Item[];
        payment_type?: string;
        value?: number;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "add_payment_info"
- Optionalparams: {
      coupon?: string;
      currency?: string;
      items?: Item[];
      payment_type?: string;
      value?: number;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:84
logEvent(
    analytics: Analytics,
    name: "add_shipping_info",
    params?: {
        coupon?: string;
        currency?: string;
        items?: Item[];
        shipping_tier?: string;
        value?: number;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "add_shipping_info"
- Optionalparams: {
      coupon?: string;
      currency?: string;
      items?: Item[];
      shipping_tier?: string;
      value?: number;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:97
logEvent(
    analytics: Analytics,
    name: "add_to_cart",
    params?: { currency?: string; items?: Item[]; value?: number },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "add_to_cart"
- Optionalparams: { currency?: string; items?: Item[]; value?: number }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:110
logEvent(
    analytics: Analytics,
    name: "add_to_wishlist",
    params?: { currency?: string; items?: Item[]; value?: number },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "add_to_wishlist"
- Optionalparams: { currency?: string; items?: Item[]; value?: number }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:121
logEvent(
    analytics: Analytics,
    name: "begin_checkout",
    params?: {
        coupon?: string;
        currency?: string;
        items?: Item[];
        value?: number;
        [key: string]: any;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "begin_checkout"
- Optionalparams: {
      coupon?: string;
      currency?: string;
      items?: Item[];
      value?: number;
      [key: string]: any;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:132
logEvent(
    analytics: Analytics,
    name: "checkout_progress",
    params?: {
        checkout_option?: string;
        checkout_step?: number;
        [key: string]: any;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "checkout_progress"
- Optionalparams: { checkout_option?: string; checkout_step?: number; [key: string]: any }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:145
logEvent(
    analytics: Analytics,
    name: "exception",
    params?: { description?: string; fatal?: boolean; [key: string]: any },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "exception"
- Optionalparams: { description?: string; fatal?: boolean; [key: string]: any }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:156
logEvent(
    analytics: Analytics,
    name: "generate_lead",
    params?: { currency?: string; value?: number },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "generate_lead"
- Optionalparams: { currency?: string; value?: number }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:167
logEvent(
    analytics: Analytics,
    name: "login",
    params: { method: string | undefined },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "login"
- params: { method: string | undefined }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:177
logEvent(
    analytics: Analytics,
    name: "page_view",
    params?: {
        page_location?: string;
        page_path?: string;
        page_title?: string;
        [key: string]: any;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "page_view"
- Optionalparams: {
      page_location?: string;
      page_path?: string;
      page_title?: string;
      [key: string]: any;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:186
logEvent(
    analytics: Analytics,
    name: "purchase",
    params?: {
        affiliation?: string;
        coupon?: string;
        currency?: string;
        items?: Item[];
        shipping?: number;
        tax?: number;
        transaction_id?: string;
        value?: number;
        [key: string]: any;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "purchase"
- Optionalparams: {
      affiliation?: string;
      coupon?: string;
      currency?: string;
      items?: Item[];
      shipping?: number;
      tax?: number;
      transaction_id?: string;
      value?: number;
      [key: string]: any;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:198
logEvent(
    analytics: Analytics,
    name: "refund",
    params?: {
        affiliation?: string;
        coupon?: string;
        currency?: string;
        items?: Item[];
        shipping?: number;
        tax?: number;
        transaction_id?: string;
        value?: number;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "refund"
- Optionalparams: {
      affiliation?: string;
      coupon?: string;
      currency?: string;
      items?: Item[];
      shipping?: number;
      tax?: number;
      transaction_id?: string;
      value?: number;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:215
logEvent(
    analytics: Analytics,
    name: "remove_from_cart",
    params?: { currency?: string; items?: Item[]; value?: number },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "remove_from_cart"
- Optionalparams: { currency?: string; items?: Item[]; value?: number }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:231
logEvent(
    analytics: Analytics,
    name: "screen_view",
    params?: {
        screen_class?: unknown;
        screen_name?: string;
        [key: string]: any;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "screen_view"
- Optionalparams: { screen_class?: unknown; screen_name?: string; [key: string]: any }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:242
logEvent(
    analytics: Analytics,
    name: "search",
    params: {
        destination?: string;
        end_date?: string;
        number_of_nights?: number;
        number_of_passengers?: number;
        number_of_rooms?: number;
        origin?: string;
        search_term: string | undefined;
        start_date?: string;
        travel_class?: string;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "search"
- params: {
      destination?: string;
      end_date?: string;
      number_of_nights?: number;
      number_of_passengers?: number;
      number_of_rooms?: number;
      origin?: string;
      search_term: string | undefined;
      start_date?: string;
      travel_class?: string;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:253
logEvent(
    analytics: Analytics,
    name: "select_content",
    params: { content_type: string | undefined; item_id: string | undefined },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "select_content"
- params: { content_type: string | undefined; item_id: string | undefined }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:270
logEvent(
    analytics: Analytics,
    name: "select_item",
    params: {
        content_type: string | undefined;
        item_list_id: string | undefined;
        item_list_name: string | undefined;
        items?: Item[];
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "select_item"
- params: {
      content_type: string | undefined;
      item_list_id: string | undefined;
      item_list_name: string | undefined;
      items?: Item[];
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:280
logEvent(
    analytics: Analytics,
    name: "select_promotion",
    params: {
        creative_name: string;
        creative_slot: string;
        items?: Item[];
        location_id: string;
        promotion_id: string | undefined;
        promotion_name: string | undefined;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "select_promotion"
- params: {
      creative_name: string;
      creative_slot: string;
      items?: Item[];
      location_id: string;
      promotion_id: string | undefined;
      promotion_name: string | undefined;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:292
logEvent(
    analytics: Analytics,
    name: "set_checkout_option",
    params?: {
        checkout_option?: string;
        checkout_step?: number;
        [key: string]: any;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "set_checkout_option"
- Optionalparams: { checkout_option?: string; checkout_step?: number; [key: string]: any }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:306
logEvent(
    analytics: Analytics,
    name: "share",
    params: {
        content_type: string | undefined;
        item_id: string | undefined;
        method: string | undefined;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "share"
- params: {
      content_type: string | undefined;
      item_id: string | undefined;
      method: string | undefined;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:317
logEvent(
    analytics: Analytics,
    name: "sign_up",
    params: { method: string | undefined },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "sign_up"
- params: { method: string | undefined }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:328
logEvent(
    analytics: Analytics,
    name: "timing_complete",
    params?: { [key: string]: any },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "timing_complete"
- Optionalparams: { [key: string]: any }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:337
logEvent(
    analytics: Analytics,
    name: "view_cart",
    params?: { currency?: string; items?: Item[]; value?: number },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "view_cart"
- Optionalparams: { currency?: string; items?: Item[]; value?: number }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:346
logEvent(
    analytics: Analytics,
    name: "view_item",
    params?: { currency?: string; items?: Item[]; value?: number },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "view_item"
- Optionalparams: { currency?: string; items?: Item[]; value?: number }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:357
logEvent(
    analytics: Analytics,
    name: "view_item_list",
    params?: { item_list_id?: string; item_list_name?: string; items?: Item[] },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "view_item_list"
- Optionalparams: { item_list_id?: string; item_list_name?: string; items?: Item[] }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:368
logEvent(
    analytics: Analytics,
    name: "view_promotion",
    params?: {
        creative_name?: string;
        creative_slot?: string;
        items?: Item[];
        location_id?: string;
        promotion_id?: string;
        promotion_name?: string;
    },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "view_promotion"
- Optionalparams: {
      creative_name?: string;
      creative_slot?: string;
      items?: Item[];
      location_id?: string;
      promotion_id?: string;
      promotion_name?: string;
  }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:379
logEvent(
    analytics: Analytics,
    name: "view_search_results",
    params: { search_term: string | undefined },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Parameters
- analytics: Analytics
- name: "view_search_results"
- params: { search_term: string | undefined }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:393
logEvent<T extends string>(
    analytics: Analytics,
    name: CustomEventName<T>,
    params?: { [key: string]: any },
    options?: AnalyticsCallOptions,
): Promise<void>
Log a custom event with optional params.
Type Parameters
- T extends string
Parameters
- analytics: Analytics
- name: CustomEventName<T>
- Optionalparams: { [key: string]: any }
- Optionaloptions: AnalyticsCallOptions
Returns Promise<void>
- Defined in modular.ts:403

Function logEvent

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<void>

Settings