POST Ad Functions

Overview

The following table contains important information about the POST method in regards to the managing process.

POST Ad Function
Method	POST
URL or Endpoint	/api/projects/`projectId`/ad-functions
Parameters	projectId, api-version
Body	Check the request body below.

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	No	string	Unique id of the project.
api-version	No	string	The correct api version to use.

Request Body

{
  "name": "string",
  "key": "string",
  "dynamicKey": true,
  "dynamicValue": true,
  "value": "string"
}

Information about the fields that appear when you receive the response are displayed in the table below.

Parameter Name	Mandatory	Type	Description
name	Yes	string	The name of the ad function.
key	Yes	string	The key of the ad function.
dynamicKey	Yes	bool	Indicates whether the ad function contains a dynamic key or not.
dynamicValue	Yes	bool	Indicates whether the ad function contains a dynamic value or not.
value	Yes	string	The value of the ad function.

{
  "id": 0,
  "name": "string",
  "key": "string",
  "dynamicKey": true,
  "dynamicValue": true,
  "value": "string"
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
id	integer	The id of the ad function.
name	Yes	string	The name of the ad function.
key	Yes	string	The key of the ad function.
dynamicKey	Yes	bool	Indicates whether the ad function contains a dynamic key or not.
dynamicValue	Yes	bool	Indicates whether the ad function contains a dynamic value or not.
value	Yes	string	The value of the ad function.

If the action is successful, the service sends back an HTTP 200 or 201 response.

For information about the errors that are common to all actions, see Common Errors: