conversion Object – API Help Center

Related Entities

Endpoints Using the conversion Object

conversionActivity Resource

Parent Objects

conversionActivity Object

conversion Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of the entity.	String	Required	Conversion
conversionCountingGroup	Determines method in which conversion is counted.	String	Required	View values Always: (Counter type) Counts conversion every time the activity is triggered. Once per day: (Counter type) Counts conversion once in a 24-hour period. Once per browser session : (Counter type) Counts conversion once in a browser session. Once per order ID/Once per session (no order ID): (Sales type) If the advertiser passes the order ID to AAS in the Tag Manager, AAS uses this value. Otherwise, AAS counts the conversion according to the browser session.
currency	Calculates the conversion revenue in AAS reports.	currency Object	Required
conversionGroup1	Categorizes your activities in groups.	String	Optional
value	Determines how much revenue each conversion is worth.	Integer	Optional	For counter type conversions.

Object JSON Example

...
        "conversion": {
            "type": "Conversion",
            "conversionCountingGroup": "Always",
            "currency": {
                "type": "Currency",
                "id": 1,
                "name": "USD",
                "currencyLetters": "USD",
                "value": null
            },
            "conversionGroup1": "111",
            "conversionGroup2": "222",
            "conversionGroup3": null,
            "conversionGroup4": null,
            "conversionGroup5": null,
            "value": 3
        },
...

currency Object

currency Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

type

Type of entity.

String

Required

Currency

id

ID of currency.

Integer

Required

ID	NAME	CURRENCY LETTERS
1	United States Dollar	USD
2	Australian Dollar	AUD
3	Great British Pound	GBP
4	European Union Euro	EUR
5	New Israeli Shekel	ILS
6	Japanese Yen	JPY
7	Danish Korona	DKK
8	Brazilian Real	BRL
9	New Zealand Dollar	NZD
10	Canadian Dollar	CAD
17	Singapore Dollar	SGD
19	Indian Rupee	INR
20	United Arab Emirates Dirham	AED
21	Czech Koruna	CZK
22	Pakistani Rupee	PKR
23	Polish Zloty	PLN
24	Hungarian Forint	HUF
25	Swiss Franc	CHF
26	Swedish Krona	SEK
27	Norwegian Krone	NOK
32	Mexican Peso	MXN
34	Hong Kong Dollar	HKD
35	South African Rand	ZAR
36	Thai Baht	THB
37	South Korean Won	KRW
38	New Taiwan Dollar	TWD
39	Turkish Lira	TRY
40	Romanian Leu	RON
41	Slovak Koruna	SKK
42	Croatia Kuna	HRK
43	Bulgarian Lev	BGN
44	People's Republic of China Renminbi	CNY
45	Argentine Peso	ARS
46	Philippine Peso	PHP
47	Russian Ruble	RUB
48	Malaysian Ringgit	MYR
49	Columbian Peso	COP
50	Chilean Peso	CLP
51	Vietnamese Dong	VND
52	Indonesian Rupiah	IDR
53	Serbian Dinar	RSD

name

Name of currency.

String

Required

currencyLetters

Abbreviation of the currency.

String

Required

value

Determines how much revenue each conversion is worth.

Integer

Optional

For sales type conversion.

Object JSON Example

Related Entities

Endpoints Using the conversion Object

Parent Objects

conversion Object Definition

Note

Object JSON Example

currency Object

currency Object Definition

Note

Object JSON Example

Comments