pyios-firebase 0.2.0__py3-none-any.whl

pyios_firebase/analytics/names.py

@@ -0,0 +1,251 @@
+"""Names Google Analytics understands, generated from the SDK headers
+(``FIREventNames.h``, ``FIRParameterNames.h``, ``FIRUserPropertyNames.h``).
+
+Use them for the reports Analytics builds from them (e-commerce, levels,
+screens...). Your own names work too.
+"""
+
+from __future__ import annotations
+
+__all__ = ("Event", "Param", "UserProperty")
+
+from typing import Final
+
+
+class Event:
+    """Event names Google Analytics understands (``FIREventNames.h``)."""
+
+    AD_IMPRESSION: Final = "ad_impression"
+    """Ad Impression event."""
+    ADD_PAYMENT_INFO: Final = "add_payment_info"
+    """Add Payment Info event."""
+    ADD_SHIPPING_INFO: Final = "add_shipping_info"
+    """Add Shipping Info event."""
+    ADD_TO_CART: Final = "add_to_cart"
+    """E-Commerce Add To Cart event."""
+    ADD_TO_WISHLIST: Final = "add_to_wishlist"
+    """E-Commerce Add To Wishlist event."""
+    APP_OPEN: Final = "app_open"
+    """App Open event."""
+    BEGIN_CHECKOUT: Final = "begin_checkout"
+    """E-Commerce Begin Checkout event."""
+    CAMPAIGN_DETAILS: Final = "campaign_details"
+    """Campaign Detail event."""
+    EARN_VIRTUAL_CURRENCY: Final = "earn_virtual_currency"
+    """Earn Virtual Currency event."""
+    GENERATE_LEAD: Final = "generate_lead"
+    """Generate Lead event."""
+    IN_APP_PURCHASE: Final = "in_app_purchase"
+    """In-App Purchase event."""
+    JOIN_GROUP: Final = "join_group"
+    """Join Group event."""
+    LEVEL_END: Final = "level_end"
+    """Level End event."""
+    LEVEL_START: Final = "level_start"
+    """Level Start event."""
+    LEVEL_UP: Final = "level_up"
+    """Level Up event."""
+    LOGIN: Final = "login"
+    """Login event."""
+    POST_SCORE: Final = "post_score"
+    """Post Score event."""
+    PURCHASE: Final = "purchase"
+    """E-Commerce Purchase event."""
+    REFUND: Final = "refund"
+    """E-Commerce Refund event."""
+    REMOVE_FROM_CART: Final = "remove_from_cart"
+    """E-Commerce Remove from Cart event."""
+    SCREEN_VIEW: Final = "screen_view"
+    """Screen View event."""
+    SEARCH: Final = "search"
+    """Search event."""
+    SELECT_CONTENT: Final = "select_content"
+    """Select Content event."""
+    SELECT_ITEM: Final = "select_item"
+    """Select Item event."""
+    SELECT_PROMOTION: Final = "select_promotion"
+    """Select promotion event."""
+    SHARE: Final = "share"
+    """Share event."""
+    SIGN_UP: Final = "sign_up"
+    """Sign Up event."""
+    SPEND_VIRTUAL_CURRENCY: Final = "spend_virtual_currency"
+    """Spend Virtual Currency event."""
+    TUTORIAL_BEGIN: Final = "tutorial_begin"
+    """Tutorial Begin event."""
+    TUTORIAL_COMPLETE: Final = "tutorial_complete"
+    """Tutorial End event."""
+    UNLOCK_ACHIEVEMENT: Final = "unlock_achievement"
+    """Unlock Achievement event."""
+    VIEW_CART: Final = "view_cart"
+    """E-commerce View Cart event."""
+    VIEW_ITEM: Final = "view_item"
+    """View Item event."""
+    VIEW_ITEM_LIST: Final = "view_item_list"
+    """View Item List event."""
+    VIEW_PROMOTION: Final = "view_promotion"
+    """View Promotion event."""
+    VIEW_SEARCH_RESULTS: Final = "view_search_results"
+    """View Search Results event."""
+
+
+class Param:
+    """Event parameter names Google Analytics understands (``FIRParameterNames.h``)."""
+
+    ACHIEVEMENT_ID: Final = "achievement_id"
+    """Game achievement ID (String)."""
+    AD_FORMAT: Final = "ad_format"
+    """The ad format (e.g."""
+    AD_NETWORK_CLICK_ID: Final = "aclid"
+    """Ad Network Click ID (String)."""
+    AD_PLATFORM: Final = "ad_platform"
+    """The ad platform (e.g."""
+    AD_SOURCE: Final = "ad_source"
+    """The ad source (e.g."""
+    AD_UNIT_NAME: Final = "ad_unit_name"
+    """The ad unit name (e.g."""
+    AFFILIATION: Final = "affiliation"
+    """A product affiliation to designate a supplying company or brick and mortar store location (String)."""
+    CP1: Final = "cp1"
+    """Campaign custom parameter (String)."""
+    CAMPAIGN: Final = "campaign"
+    """The individual campaign name, slogan, promo code, etc."""
+    CAMPAIGN_ID: Final = "campaign_id"
+    """Campaign ID (String)."""
+    CHARACTER: Final = "character"
+    """Character used in game (String)."""
+    CONTENT: Final = "content"
+    """Campaign content (String)."""
+    CONTENT_TYPE: Final = "content_type"
+    """Type of content selected (String)."""
+    COUPON: Final = "coupon"
+    """Coupon code used for a purchase (String)."""
+    CREATIVE_FORMAT: Final = "creative_format"
+    """Creative Format (String)."""
+    CREATIVE_NAME: Final = "creative_name"
+    """The name of a creative used in a promotional spot (String)."""
+    CREATIVE_SLOT: Final = "creative_slot"
+    """The name of a creative slot (String)."""
+    CURRENCY: Final = "currency"
+    """Currency of the purchase or items associated with the event, in 3-letter <a href='http://en.wikipedia.org/wiki/ISO_4217#Active_codes'> ISO_4217</a> format (String)."""
+    DESTINATION: Final = "destination"
+    """Flight or Travel destination (String)."""
+    DISCOUNT: Final = "discount"
+    """Monetary value of discount associated with a purchase (Double)."""
+    END_DATE: Final = "end_date"
+    """The arrival date, check-out date or rental end date for the item."""
+    EXTEND_SESSION: Final = "extend_session"
+    """Indicates that the associated event should either extend the current session or start a new session if no session was active when the event was logged."""
+    FLIGHT_NUMBER: Final = "flight_number"
+    """Flight number for travel events (String)."""
+    FREE_TRIAL: Final = "free_trial"
+    """Indicates if the user is on a free trial of a subscription."""
+    GROUP_ID: Final = "group_id"
+    """Group/clan/guild ID (String)."""
+    INDEX: Final = "index"
+    """The index of the item in a list (Int)."""
+    ITEM_BRAND: Final = "item_brand"
+    """Item brand (String)."""
+    ITEM_CATEGORY: Final = "item_category"
+    """Item category (context-specific) (String)."""
+    ITEM_CATEGORY2: Final = "item_category2"
+    """Item Category (context-specific) (String)."""
+    ITEM_CATEGORY3: Final = "item_category3"
+    """Item Category (context-specific) (String)."""
+    ITEM_CATEGORY4: Final = "item_category4"
+    """Item Category (context-specific) (String)."""
+    ITEM_CATEGORY5: Final = "item_category5"
+    """Item Category (context-specific) (String)."""
+    ITEM_ID: Final = "item_id"
+    """Item ID (context-specific) (String)."""
+    ITEM_LIST_ID: Final = "item_list_id"
+    """The ID of the list in which the item was presented to the user (String)."""
+    ITEM_LIST_NAME: Final = "item_list_name"
+    """The name of the list in which the item was presented to the user (String)."""
+    ITEM_NAME: Final = "item_name"
+    """Item Name (context-specific) (String)."""
+    ITEM_VARIANT: Final = "item_variant"
+    """Item variant (String)."""
+    ITEMS: Final = "items"
+    """The list of items involved in the transaction expressed as `[[String: Any]]`."""
+    LEVEL: Final = "level"
+    """Level in game (Int)."""
+    LEVEL_NAME: Final = "level_name"
+    """The name of a level in a game (String)."""
+    LOCATION: Final = "location"
+    """Location (String)."""
+    LOCATION_ID: Final = "location_id"
+    """The location associated with the event."""
+    MARKETING_TACTIC: Final = "marketing_tactic"
+    """Marketing Tactic (String)."""
+    MEDIUM: Final = "medium"
+    """The advertising or marketing medium, for example: cpc, banner, email, push."""
+    METHOD: Final = "method"
+    """A particular approach used in an operation; for example, 'facebook' or 'email' in the context of a sign_up or login event."""
+    NUMBER_OF_NIGHTS: Final = "number_of_nights"
+    """Number of nights staying at hotel (Int)."""
+    NUMBER_OF_PASSENGERS: Final = "number_of_passengers"
+    """Number of passengers traveling (Int)."""
+    NUMBER_OF_ROOMS: Final = "number_of_rooms"
+    """Number of rooms for travel events (Int)."""
+    ORIGIN: Final = "origin"
+    """Flight or Travel origin (String)."""
+    PAYMENT_TYPE: Final = "payment_type"
+    """The chosen method of payment (String)."""
+    PRICE: Final = "price"
+    """Purchase price (Double)."""
+    PRICE_IS_DISCOUNTED: Final = "price_is_discounted"
+    """Indicates if an item's price is discounted."""
+    PRODUCT_ID: Final = "product_id"
+    """The ID of a product (String)."""
+    PRODUCT_NAME: Final = "product_name"
+    """The name of a product (String)."""
+    PROMOTION_ID: Final = "promotion_id"
+    """The ID of a product promotion (String)."""
+    PROMOTION_NAME: Final = "promotion_name"
+    """The name of a product promotion (String)."""
+    QUANTITY: Final = "quantity"
+    """Purchase quantity (Int)."""
+    SCORE: Final = "score"
+    """Score in game (Int)."""
+    SCREEN_CLASS: Final = "screen_class"
+    """Current screen class, such as the class name of the UIViewController, logged with screen_view event and added to every event (String)."""
+    SCREEN_NAME: Final = "screen_name"
+    """Current screen name, such as the name of the UIViewController, logged with screen_view event and added to every event (String)."""
+    SEARCH_TERM: Final = "search_term"
+    """The search string/keywords used (String)."""
+    SHIPPING: Final = "shipping"
+    """Shipping cost associated with a transaction (Double)."""
+    SHIPPING_TIER: Final = "shipping_tier"
+    """The shipping tier (e.g."""
+    SOURCE: Final = "source"
+    """The origin of your traffic, such as an Ad network (for example, google) or partner (urban airship)."""
+    SOURCE_PLATFORM: Final = "source_platform"
+    """Source Platform (String)."""
+    START_DATE: Final = "start_date"
+    """The departure date, check-in date or rental start date for the item."""
+    SUBSCRIPTION: Final = "subscription"
+    """Indicates if the purchase is a subscription."""
+    SUCCESS: Final = "success"
+    """The result of an operation."""
+    TAX: Final = "tax"
+    """Tax cost associated with a transaction (Double)."""
+    TERM: Final = "term"
+    """If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword (String)."""
+    TRANSACTION_ID: Final = "transaction_id"
+    """The unique identifier of a transaction (String)."""
+    TRAVEL_CLASS: Final = "travel_class"
+    """Travel class (String)."""
+    VALUE: Final = "value"
+    """A context-specific numeric value which is accumulated automatically for each event type."""
+    VIRTUAL_CURRENCY_NAME: Final = "virtual_currency_name"
+    """Name of virtual currency type (String)."""
+
+
+class UserProperty:
+    """User property names Google Analytics understands (``FIRUserPropertyNames.h``)."""
+
+    ALLOW_AD_PERSONALIZATION_SIGNALS: Final = "allow_personalized_ads"
+    """Indicates whether events logged by Google Analytics can be used to personalize ads for the user."""
+    SIGN_UP_METHOD: Final = "sign_up_method"
+    """The method used to sign in."""