One Logo Pool Ball
AdAttributionKit · IOS API REFERENCE

Postback

struct · iOS 17.4+ · SDK 27.1

struct Postback

A structure that provides methods you use to update conversion values for ad attributions.

Members (5)

get · iOS 18.0+

isSupported

TypeScript
static get isSupported(): boolean
Swift declaration
static var isSupported: Bool { get }

A Boolean value that indicates whether the framework supports postbacks on a person's device. Check this value to ensure the current device supports postbacks before calling methods on a `Postback`. - Returns: `true` if the current device supports postbacks; otherwise, `false`.

static · iOS 17.4+

updateConversionValue

TypeScript
static updateConversionValueLockPostback(fineConversionValue: number, lockPostback: boolean): Promise<void>
Swift declaration
static func updateConversionValue(_ fineConversionValue: Int, lockPostback: Bool) async throws

Updates a conversion value with the provided fine and coarse conversion values, and optionally locks the postback, reducing the system time to deliver a signal. - Parameters: - fineConversionValue: An integer the defines the fine conversion value. - lockPostback: A Boolean value that indicates whether the system can lock the postback, reducing the system time to deliver a signal.

static · iOS 17.4+

updateConversionValue

TypeScript
static updateConversionValueCoarseConversionValueLockPostback(fineConversionValue: number, coarseConversionValue: CoarseConversionValue, lockPostback: boolean): Promise<void>
Swift declaration
static func updateConversionValue(_ fineConversionValue: Int, coarseConversionValue: CoarseConversionValue, lockPostback: Bool) async throws

Updates the conversion value with the provided fine and coarse conversion values, and optionally locks the postback, reducing the amount of time the system needs to deliver a signal. - Parameters: - fineConversionValue: An integer that defines the fine conversion value. - coarseConversionValue: One of the ``CoarseConversionValue`` values. - lockPostback: A Boolean value that indicates whether the system can lock the postback, reducing system time to deliver a signal.

static · iOS 18.0+

updateConversionValue

TypeScript
static updateConversionValue(postbackUpdate: PostbackUpdate): Promise<void>
Swift declaration
static func updateConversionValue(_ postbackUpdate: PostbackUpdate) async throws

Updates the conversion value using the given postback update configuration. - Parameters: - postbackUpdate: A `PostbackUpdate` structure that describes the new conversion values and associated conversion types.

get · iOS 18.0+

reengagementOpenURLParameter

TypeScript
static get reengagementOpenURLParameter(): string
Swift declaration
static var reengagementOpenURLParameter: String { get }

A string that represents the query parameter that AdAttributionKit appends to the URL to indicate that a reengagement has occurred. When your advertised app receives a universal link, determine whether it came from an AdAttributionKit reengagement by checking the query parameters for a key containing this string, as the example below shows: ```swift func isAdAttributionKitReengagementURL(url: URL) -> Bool { guard let components = URLComponents(url: url, resolvingAgainstBaseURL: true), let queryItems = components.queryItems else { return false } return queryItems.contains { $0.name == Postback.reengagementOpenURLParameter } } ```

Skipped declarations

No declarations were skipped in this snapshot.

All AdAttributionKit types →