|
| 1 | +## API Report File for "@firebase/analytics-exp" |
| 2 | + |
| 3 | +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
| 4 | +
|
| 5 | +```ts |
| 6 | + |
| 7 | +import { Analytics } from '@firebase/analytics-types-exp'; |
| 8 | +import { AnalyticsCallOptions } from '@firebase/analytics-types-exp'; |
| 9 | +import { ControlParams } from '@firebase/analytics-types-exp'; |
| 10 | +import { CustomParams } from '@firebase/analytics-types-exp'; |
| 11 | +import { EventNameString } from '@firebase/analytics-types-exp'; |
| 12 | +import { EventParams } from '@firebase/analytics-types-exp'; |
| 13 | +import { FirebaseApp } from '@firebase/app-types-exp'; |
| 14 | +import { Item } from '@firebase/analytics-types-exp'; |
| 15 | +import { Promotion } from '@firebase/analytics-types-exp'; |
| 16 | +import { SettingsOptions } from '@firebase/analytics-types-exp'; |
| 17 | + |
| 18 | +export { Analytics } |
| 19 | + |
| 20 | +export { ControlParams } |
| 21 | + |
| 22 | +// @public |
| 23 | +export type CustomEventName<T> = T extends EventNameString ? never : T; |
| 24 | + |
| 25 | +export { CustomParams } |
| 26 | + |
| 27 | +export { EventParams } |
| 28 | + |
| 29 | +// @public |
| 30 | +export function getAnalytics(app: FirebaseApp): Analytics; |
| 31 | + |
| 32 | +// @public |
| 33 | +export function isSupported(): Promise<boolean>; |
| 34 | + |
| 35 | +export { Item } |
| 36 | + |
| 37 | +// @public |
| 38 | +export function logEvent(analyticsInstance: Analytics, eventName: 'add_payment_info', eventParams?: { |
| 39 | + coupon?: EventParams['coupon']; |
| 40 | + currency?: EventParams['currency']; |
| 41 | + items?: EventParams['items']; |
| 42 | + payment_type?: EventParams['payment_type']; |
| 43 | + value?: EventParams['value']; |
| 44 | + [key: string]: any; |
| 45 | +}, options?: AnalyticsCallOptions): void; |
| 46 | + |
| 47 | +// @public |
| 48 | +export function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_info', eventParams: { |
| 49 | + coupon?: EventParams['coupon']; |
| 50 | + currency?: EventParams['currency']; |
| 51 | + items?: EventParams['items']; |
| 52 | + shipping_tier?: EventParams['shipping_tier']; |
| 53 | + value?: EventParams['value']; |
| 54 | + [key: string]: any; |
| 55 | +}, options?: AnalyticsCallOptions): void; |
| 56 | + |
| 57 | +// @public |
| 58 | +export function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams: { |
| 59 | + currency?: EventParams['currency']; |
| 60 | + value?: EventParams['value']; |
| 61 | + items?: EventParams['items']; |
| 62 | + [key: string]: any; |
| 63 | +}, options?: AnalyticsCallOptions): void; |
| 64 | + |
| 65 | +// @public |
| 66 | +export function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkout', eventParams: { |
| 67 | + currency?: EventParams['currency']; |
| 68 | + coupon?: EventParams['coupon']; |
| 69 | + value?: EventParams['value']; |
| 70 | + items?: EventParams['items']; |
| 71 | + [key: string]: any; |
| 72 | +}, options?: AnalyticsCallOptions): void; |
| 73 | + |
| 74 | +// @public |
| 75 | +export function logEvent(analyticsInstance: Analytics, eventName: 'checkout_progress', eventParams: { |
| 76 | + currency?: EventParams['currency']; |
| 77 | + coupon?: EventParams['coupon']; |
| 78 | + value?: EventParams['value']; |
| 79 | + items?: EventParams['items']; |
| 80 | + checkout_step?: EventParams['checkout_step']; |
| 81 | + checkout_option?: EventParams['checkout_option']; |
| 82 | + [key: string]: any; |
| 83 | +}, options?: AnalyticsCallOptions): void; |
| 84 | + |
| 85 | +// @public |
| 86 | +export function logEvent(analyticsInstance: Analytics, eventName: 'exception', eventParams: { |
| 87 | + description?: EventParams['description']; |
| 88 | + fatal?: EventParams['fatal']; |
| 89 | + [key: string]: any; |
| 90 | +}, options?: AnalyticsCallOptions): void; |
| 91 | + |
| 92 | +// @public |
| 93 | +export function logEvent(analyticsInstance: Analytics, eventName: 'generate_lead', eventParams: { |
| 94 | + value?: EventParams['value']; |
| 95 | + currency?: EventParams['currency']; |
| 96 | + transaction_id?: EventParams['transaction_id']; |
| 97 | + [key: string]: any; |
| 98 | +}, options?: AnalyticsCallOptions): void; |
| 99 | + |
| 100 | +// @public |
| 101 | +export function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams: { |
| 102 | + method?: EventParams['method']; |
| 103 | + [key: string]: any; |
| 104 | +}, options?: AnalyticsCallOptions): void; |
| 105 | + |
| 106 | +// @public |
| 107 | +export function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams: { |
| 108 | + page_title?: string; |
| 109 | + page_location?: string; |
| 110 | + page_path?: string; |
| 111 | + [key: string]: any; |
| 112 | +}, options?: AnalyticsCallOptions): void; |
| 113 | + |
| 114 | +// @public |
| 115 | +export function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams: { |
| 116 | + value?: EventParams['value']; |
| 117 | + currency?: EventParams['currency']; |
| 118 | + transaction_id: EventParams['transaction_id']; |
| 119 | + tax?: EventParams['tax']; |
| 120 | + shipping?: EventParams['shipping']; |
| 121 | + items?: EventParams['items']; |
| 122 | + coupon?: EventParams['coupon']; |
| 123 | + affiliation?: EventParams['affiliation']; |
| 124 | + [key: string]: any; |
| 125 | +}, options?: AnalyticsCallOptions): void; |
| 126 | + |
| 127 | +// @public |
| 128 | +export function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams: { |
| 129 | + app_name: string; |
| 130 | + screen_name: EventParams['screen_name']; |
| 131 | + app_id?: string; |
| 132 | + app_version?: string; |
| 133 | + app_installer_id?: string; |
| 134 | + [key: string]: any; |
| 135 | +}, options?: AnalyticsCallOptions): void; |
| 136 | + |
| 137 | +// @public |
| 138 | +export function logEvent(analyticsInstance: Analytics, eventName: 'search' | 'view_search_results', eventParams: { |
| 139 | + search_term?: EventParams['search_term']; |
| 140 | + [key: string]: any; |
| 141 | +}, options?: AnalyticsCallOptions): void; |
| 142 | + |
| 143 | +// @public |
| 144 | +export function logEvent(analyticsInstance: Analytics, eventName: 'select_content', eventParams: { |
| 145 | + items?: EventParams['items']; |
| 146 | + promotions?: EventParams['promotions']; |
| 147 | + content_type?: EventParams['content_type']; |
| 148 | + content_id?: EventParams['content_id']; |
| 149 | + [key: string]: any; |
| 150 | +}, options?: AnalyticsCallOptions): void; |
| 151 | + |
| 152 | +// @public |
| 153 | +export function logEvent(analyticsInstance: Analytics, eventName: 'select_item', eventParams: { |
| 154 | + items?: EventParams['items']; |
| 155 | + item_list_name?: EventParams['item_list_name']; |
| 156 | + item_list_id?: EventParams['item_list_id']; |
| 157 | + [key: string]: any; |
| 158 | +}, options?: AnalyticsCallOptions): void; |
| 159 | + |
| 160 | +// @public |
| 161 | +export function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams: { |
| 162 | + items?: EventParams['items']; |
| 163 | + promotion_id?: EventParams['promotion_id']; |
| 164 | + promotion_name?: EventParams['promotion_name']; |
| 165 | + [key: string]: any; |
| 166 | +}, options?: AnalyticsCallOptions): void; |
| 167 | + |
| 168 | +// @public |
| 169 | +export function logEvent(analyticsInstance: Analytics, eventName: 'set_checkout_option', eventParams: { |
| 170 | + checkout_step?: EventParams['checkout_step']; |
| 171 | + checkout_option?: EventParams['checkout_option']; |
| 172 | + [key: string]: any; |
| 173 | +}, options?: AnalyticsCallOptions): void; |
| 174 | + |
| 175 | +// @public |
| 176 | +export function logEvent(analyticsInstance: Analytics, eventName: 'share', eventParams: { |
| 177 | + method?: EventParams['method']; |
| 178 | + content_type?: EventParams['content_type']; |
| 179 | + content_id?: EventParams['content_id']; |
| 180 | + [key: string]: any; |
| 181 | +}, options?: AnalyticsCallOptions): void; |
| 182 | + |
| 183 | +// @public |
| 184 | +export function logEvent(analyticsInstance: Analytics, eventName: 'sign_up', eventParams: { |
| 185 | + method?: EventParams['method']; |
| 186 | + [key: string]: any; |
| 187 | +}, options?: AnalyticsCallOptions): void; |
| 188 | + |
| 189 | +// @public |
| 190 | +export function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams: { |
| 191 | + name: string; |
| 192 | + value: number; |
| 193 | + event_category?: string; |
| 194 | + event_label?: string; |
| 195 | + [key: string]: any; |
| 196 | +}, options?: AnalyticsCallOptions): void; |
| 197 | + |
| 198 | +// @public |
| 199 | +export function logEvent(analyticsInstance: Analytics, eventName: 'view_cart' | 'view_item', eventParams: { |
| 200 | + currency?: EventParams['currency']; |
| 201 | + items?: EventParams['items']; |
| 202 | + value?: EventParams['value']; |
| 203 | + [key: string]: any; |
| 204 | +}, options?: AnalyticsCallOptions): void; |
| 205 | + |
| 206 | +// @public |
| 207 | +export function logEvent(analyticsInstance: Analytics, eventName: 'view_item_list', eventParams: { |
| 208 | + items?: EventParams['items']; |
| 209 | + item_list_name?: EventParams['item_list_name']; |
| 210 | + item_list_id?: EventParams['item_list_id']; |
| 211 | + [key: string]: any; |
| 212 | +}, options?: AnalyticsCallOptions): void; |
| 213 | + |
| 214 | +// @public |
| 215 | +export function logEvent<T extends string>(analyticsInstance: Analytics, eventName: CustomEventName<T>, eventParams?: { |
| 216 | + [key: string]: any; |
| 217 | +}, options?: AnalyticsCallOptions): void; |
| 218 | + |
| 219 | +export { Promotion } |
| 220 | + |
| 221 | +// @public |
| 222 | +export function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void; |
| 223 | + |
| 224 | +// @public |
| 225 | +export function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void; |
| 226 | + |
| 227 | +// @public |
| 228 | +export function settings(options: SettingsOptions): void; |
| 229 | + |
| 230 | +export { SettingsOptions } |
| 231 | + |
| 232 | +// @public |
| 233 | +export function setUserId(analyticsInstance: Analytics, id: string, options?: AnalyticsCallOptions): void; |
| 234 | + |
| 235 | +// @public |
| 236 | +export function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void; |
| 237 | + |
| 238 | + |
| 239 | +// (No @packageDocumentation comment for this package) |
| 240 | + |
| 241 | +``` |
0 commit comments