Advertising - Attribute Install

Service:

Client

API Version:

240426

Attributes an install for advertisment.

POST https://titleId.playfabapi.com/Client/AttributeInstall

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Request Body

Name	Type	Description
Adid	string	The adid for this device.
Idfa	string	The IdentifierForAdvertisers for iOS Devices.

Responses

Name	Type	Description
200 OK	AttributeInstallResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
AttributeInstallRequest	If you have an ad attribution partner enabled, this will post an install to their service to track the device. It uses the given device id to match based on clicks on ads.
AttributeInstallResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

AttributeInstallRequest

If you have an ad attribution partner enabled, this will post an install to their service to track the device. It uses the given device id to match based on clicks on ads.

Name	Type	Description
Adid	string	The adid for this device.
Idfa	string	The IdentifierForAdvertisers for iOS Devices.

AttributeInstallResult

Error Codes

Name	Code
NoPartnerEnabled	1192