/** * #telemetry.ts * * Code generated by ts-proto. DO NOT EDIT. * @packageDocumentation */ /** Machine-readable status for a telemetry event attempt. */ export declare enum JourneyReceiptStatus { /** JOURNEY_RECEIPT_UNSPECIFIED - Status was not provided. */ JOURNEY_RECEIPT_UNSPECIFIED = 0, /** JOURNEY_RECEIPT_VALID - Event was valid and sent to the telemetry pipeline. */ JOURNEY_RECEIPT_VALID = 1, /** JOURNEY_RECEIPT_DENIED_NOT_ALLOWLISTED - Event was valid, but not sent because the app is not allowlisted. */ JOURNEY_RECEIPT_DENIED_NOT_ALLOWLISTED = 2, /** JOURNEY_RECEIPT_DENIED_RATE_LIMITED - Event was valid, but not sent because the app exceeded rate limits. */ JOURNEY_RECEIPT_DENIED_RATE_LIMITED = 3, /** JOURNEY_RECEIPT_DENIED_DUPLICATE - Event was valid, but not sent because it was a duplicate. */ JOURNEY_RECEIPT_DENIED_DUPLICATE = 4, /** JOURNEY_RECEIPT_INVALID - Event was invalid and not sent to the telemetry pipeline. */ JOURNEY_RECEIPT_INVALID = 5, UNRECOGNIZED = -1 } /** Request to start a new telemetry journey. */ export type StartJourneyRequest = {}; /** Response for starting a journey. */ export type StartJourneyResponse = { /** * Unique identifier for the journey. * Example: "journey_1234567890" */ journeyId: string; receipt?: JourneyReceipt | undefined; }; /** Structured receipt for a telemetry event attempt. */ export type JourneyReceipt = { /** * Machine-readable status for tooling and tests. * Example: JOURNEY_RECEIPT_VALID */ status: JourneyReceiptStatus; /** * Human-readable status for developers. * Example: "Event is valid, but your app is not allowlisted for Journey telemetry yet, so it was not ingested." */ message: string; }; /** Request to record progress within a journey. */ export type JourneyProgressRequest = { /** * Unique identifier for the journey. * Example: "journey_1234567890" */ journeyId: string; /** * Normalized progress value between 0.0 and 1.0. * Example: 0.5 */ progress: number; /** * The action that occurred during the progress update. * Example: "level_complete" */ action?: string | undefined; /** * Additional details about the action. * Example: "level_3" */ actionDetails?: string | undefined; }; /** Response for recording journey progress. */ export type JourneyProgressResponse = { receipt?: JourneyReceipt | undefined; }; /** Request to record an interaction within a journey. */ export type JourneyInteractionRequest = { /** * Unique identifier for the journey. * Example: "journey_1234567890" */ journeyId: string; /** * The action that occurred during the interaction. * Example: "word_complete" */ action: string; /** * Additional details about the action. * Example: "apple" */ actionDetails: string; }; /** Response for recording a journey interaction. */ export type JourneyInteractionResponse = { receipt?: JourneyReceipt | undefined; }; /** Game-specific result data for journey completion. */ export type GameResult = { /** * Indicates if the user won the game. * Example: true */ win: boolean; /** * The final score achieved in the game. * Example: 1000 */ score: number; }; /** Request to end a telemetry journey. */ export type EndJourneyRequest = { /** * Unique identifier for the journey. * Example: "journey_1234567890" */ journeyId: string; /** * Indicates if the journey objective was completed. * Example: true */ complete: boolean; /** Game-specific result data. Only applicable for game journeys. */ game?: GameResult | undefined; }; /** Response for ending a journey. */ export type EndJourneyResponse = { receipt?: JourneyReceipt | undefined; }; /** Request to signal that the app is ready. */ export type AppReadyRequest = { /** * Milliseconds elapsed from runtime initialization to app ready, measured by the platform runtime. * Example: 350 */ startupTimeMs: number; }; /** Response for the app ready signal. */ export type AppReadyResponse = { receipt?: JourneyReceipt | undefined; }; //# sourceMappingURL=telemetry.d.ts.map