You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

73 lines
2.6 KiB

  1. /*
  2. * Copyright 2018 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. /// @file FIRInteropParameterNames.h
  18. ///
  19. /// Predefined event parameter names used by Firebase. This file is a subset of the
  20. /// FirebaseAnalytics FIRParameterNames.h public header.
  21. ///
  22. /// The origin of your traffic, such as an Ad network (for example, google) or partner (urban
  23. /// airship). Identify the advertiser, site, publication, etc. that is sending traffic to your
  24. /// property. Highly recommended (NSString).
  25. /// <pre>
  26. /// NSDictionary *params = @{
  27. /// kFIRParameterSource : @"InMobi",
  28. /// // ...
  29. /// };
  30. /// </pre>
  31. static NSString *const kFIRIParameterSource NS_SWIFT_NAME(AnalyticsParameterSource) = @"source";
  32. /// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended
  33. /// (NSString).
  34. /// <pre>
  35. /// NSDictionary *params = @{
  36. /// kFIRParameterMedium : @"email",
  37. /// // ...
  38. /// };
  39. /// </pre>
  40. static NSString *const kFIRIParameterMedium NS_SWIFT_NAME(AnalyticsParameterMedium) = @"medium";
  41. /// The individual campaign name, slogan, promo code, etc. Some networks have pre-defined macro to
  42. /// capture campaign information, otherwise can be populated by developer. Highly Recommended
  43. /// (NSString).
  44. /// <pre>
  45. /// NSDictionary *params = @{
  46. /// kFIRParameterCampaign : @"winter_promotion",
  47. /// // ...
  48. /// };
  49. /// </pre>
  50. static NSString *const kFIRIParameterCampaign NS_SWIFT_NAME(AnalyticsParameterCampaign) =
  51. @"campaign";
  52. /// Message identifier.
  53. static NSString *const kFIRIParameterMessageIdentifier = @"_nmid";
  54. /// Message name.
  55. static NSString *const kFIRIParameterMessageName = @"_nmn";
  56. /// Message send time.
  57. static NSString *const kFIRIParameterMessageTime = @"_nmt";
  58. /// Message device time.
  59. static NSString *const kFIRIParameterMessageDeviceTime = @"_ndt";
  60. /// Topic message.
  61. static NSString *const kFIRIParameterTopic = @"_nt";
  62. /// Stores the message_id of the last notification opened by the app.
  63. static NSString *const kFIRIUserPropertyLastNotification = @"_ln";