Update settings

PATCH

settings

Update settings

curl --request PATCH \
  --url https://your_a2_service/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": {
    "access_token": "<string>",
    "token_type": "Bearer"
  },
  "currency": "<string>",
  "external_channel_url": "<string>",
  "language": "<string>",
  "tls_domain": "<string>",
  "tls_enable": true,
  "yield_optimization": {
    "ceiling_cpm": 123,
    "floor_cpm": 123,
    "yield_roas_balance": 0.5
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
'

{
  "access_token": {
    "access_token": "<string>",
    "token_type": "Bearer"
  },
  "currency": "<string>",
  "external_channel_url": "<string>",
  "language": "<string>",
  "tls_domain": "<string>",
  "tls_enable": true,
  "yield_optimization": {
    "ceiling_cpm": 123,
    "floor_cpm": 123,
    "yield_roas_balance": 0.5
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for Setting

access_token

BearerToken · object

required

Access token info

Show child attributes

access_token.access_token

string

required

Access token.

access_token.token_type

string

default:Bearer

currency

string

required

Currency code for the system. It is used for the budget management.

external_channel_url

string | null

required

External channel URL which will be used on budget management.

language

string

required

Language code for the system.

tls_domain

string | null

required

TLS domain name.

tls_enable

boolean

required

Whether TLS is enabled.

yield_optimization

YieldOptimization · object

required

Yield optimization settings

Show child attributes

yield_optimization.ceiling_cpm

number

required

The maximum CPM value for bidding amount.

yield_optimization.floor_cpm

number

required

The minimum CPM value for bidding amount.

yield_optimization.yield_roas_balance

number

required

Set the balance between ROAS and eCPM. Moving the value closer to 0 will favor the advertiser’s ROAS, while moving it closer to 1 will favor higher eCPM.

Required range: 0 <= x <= 1

created_at

string<date-time> | null

The date and time the entity was created.

updated_at

string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Schema for Setting

access_token

BearerToken · object

required

Access token info

Show child attributes

access_token.access_token

string

required

Access token.

access_token.token_type

string

default:Bearer

currency

string

required

Currency code for the system. It is used for the budget management.

external_channel_url

string | null

required

External channel URL which will be used on budget management.

language

string

required

Language code for the system.

tls_domain

string | null

required

TLS domain name.

tls_enable

boolean

required

Whether TLS is enabled.

yield_optimization

YieldOptimization · object

required

Yield optimization settings

Show child attributes

yield_optimization.ceiling_cpm

number

required

The maximum CPM value for bidding amount.

yield_optimization.floor_cpm

number

required

The minimum CPM value for bidding amount.

yield_optimization.yield_roas_balance

number

required

Set the balance between ROAS and eCPM. Moving the value closer to 0 will favor the advertiser’s ROAS, while moving it closer to 1 will favor higher eCPM.

Required range: 0 <= x <= 1

created_at

string<date-time> | null

The date and time the entity was created.

updated_at

string<date-time> | null

The date and time the entity was last updated.

Regenerate access tokenRegenerates a new access token for the system.

⌘I

Update settings

curl --request PATCH \
  --url https://your_a2_service/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": {
    "access_token": "<string>",
    "token_type": "Bearer"
  },
  "currency": "<string>",
  "external_channel_url": "<string>",
  "language": "<string>",
  "tls_domain": "<string>",
  "tls_enable": true,
  "yield_optimization": {
    "ceiling_cpm": 123,
    "floor_cpm": 123,
    "yield_roas_balance": 0.5
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
'

{
  "access_token": {
    "access_token": "<string>",
    "token_type": "Bearer"
  },
  "currency": "<string>",
  "external_channel_url": "<string>",
  "language": "<string>",
  "tls_domain": "<string>",
  "tls_enable": true,
  "yield_optimization": {
    "ceiling_cpm": 123,
    "floor_cpm": 123,
    "yield_roas_balance": 0.5
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Data Management APIs

Decision APIs

Authorizations

Body

Response