Contents

Get a Signed Web Ad Impression Payload

An endpoint you provide to receive requests from devices to serve signed ad interactions.

URL

POST https://example.com/.well-known/skadnetwork/get-signed-payload

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AdImpressionResponse

The response you provide that contains a signed payload for the clicked web ad.

Mentioned in

Discussion

You implement this endpoint on your server to provide signed SKAdNetwork ad payloads for web ads that users tap. The device calls this endpoint when a user taps an SKAdNetwork-attributable web ad.

To receive requests at this endpoint, your server needs to support the Transport Layer Security (TLS) 1.2 protocol or later.

The following is an example of an AdImpressionRequest payload:

{
    "source_domain": "example.com",
    "source_engagement_type": "click_to_App_Store",
    "source_nonce": "t8naKxXHTzuTJhNfljADPQ",
    "version": "4.0"
}

A corresponding AdImpressionResponse to send in response to this payload is as follows:

{
    "version": "4.0",
    "ad_network_id": "com.apple.test-1",
    "source_identifier": 3120,
    "itunes_item_id": 525463029,
    "nonce": "b7c9da2b-15c7-4f3b-9326-135f9630033d",
    "source_domain": "example.com",
    "timestamp": 1676057605705,
    "signature": "MEUCID/KZzaGxpa9jv9P1thWn8cHzcDq8ebDWEoarV1JrjNcAiEA6d9IqYErxFCrD96oR0rRftjVW6PRx37MC9QPS88OeE4="
}

The device uses the same encoding as attributionSourceNonce for the source_nonce value in the AdImpressionRequest. However, you use the dash-separated string representation of the UUID for the nonce value in an AdImpressionResponse.

HTTP Body

The request that devices send to this endpoint, asking for the web ad impression from the ad network’s server.

See Also

Receiving a request for a web ad payload