ExternalUserId

@objcMembers
public class ExternalUserId : NSObject, JSONConvertible

Defines the User Id Object from an External Thrid Party Source https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/2.x_official_extensions/eids.md

Properties

  • The source of the external user ID.

    Declaration

    Swift

    public var source: String
  • Array of extended ID UID objects from the given source.

    Declaration

    Swift

    public var uids: [UserUniqueID]
  • ext

    Additional attributes related to the external user ID, represented as an optional dictionary.

    Declaration

    Swift

    public var ext: [String : Any]?
  • The identifier of the external user ID.

    Declaration

    Swift

    @available(*, deprecated, message: "Deprecated. This property will be removed in future releases.")
    public var identifier: String?
  • The type of the external user ID, represented as an optional NSNumber.

    Declaration

    Swift

    @available(*, deprecated, message: "Deprecated. This property will be removed in future releases.")
    public var atype: NSNumber?

Initialization

  • Initializes a new ExternalUserId object.

    Declaration

    Swift

    public init(source: String, uids: [UserUniqueID], ext: [String : Any]? = nil)

    Parameters

    source

    The source of the external user ID (e.g., a third-party provider).

    uids

    A list of UserUniqueID objects representing the user’s unique identifiers.

    ext

    Optional dictionary for additional attributes related to the external user ID. Default is nil.

  • Initialize ExternalUserId Class

    Declaration

    Swift

    @available(*, deprecated, message: "Deprecated. This initializer will be removed in future releases.")
    public init(source: String, identifier: String, atype: NSNumber? = nil, ext: [String : Any]? = nil)

    Parameters

    source

    Source of the External User Id String.

    identifier

    String of the External User Id.

    atype

    (Optional) Int of the External User Id.

    ext

    (Optional) Dictionary of the External User Id.

  • Converts the ExternalUserId instance to a JSON dictionary.

    Declaration

    Swift

    public func toJSONDictionary() -> [String : Any]