Upload placement country pricing CSV

Imports country prices into the placement's fixed pricing from a CSV, the same file the console's Pricing card takes under Upload CSV.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/pricing/batch.do

Imports country prices into the placement's fixed pricing from a CSV, the same file the console's Pricing card takes under Upload CSV. Send it either as the countryPrices file (multipart) or as its text in countryPricesCsv - exactly one of the two. The layout follows the placement's pricing type. CPM and CPC: a header row "Country,Price" and one row per country, e.g. "US,1.50". CPA: a header row starting with "_" and one column per conversion action (its name as shown in the console, or "All" for every action), then one row per country with a price in each column. Comma, semicolon and tab separators are accepted; a country of "*" sets the global price (or, in an action column, the action's price for every country). The upload adds and updates prices; prices of countries not in the file are kept. Rows that cannot be applied are listed in csvErrors and csvWarnings - the rest of the file is still applied. applied lists every price that was stored as {line, country, actionId (CPA action columns only), price}; rejected lists every line, or part of a line, that was not, as {line, reason} (line 1 is the header). The placement must already have fixed pricing (see POST /rest-api/placements/{placementId}/pricing.do). Requires ENABLED level on the SITE_PAYMENT_MODEL and MANAGE_PRICING permissions and update access to the placement's site.

Path Params

placementId integer required

Unique numeric ID of the placement

4001

Query Params

countryPricesCsv string

The CSV's text, for a client that cannot upload a file; send this or countryPrices

 Country,Price
US,1.50
DE,0.90

Body

A multipart form: countryPrices (file).

Responses

200

CSV applied; applied and rejected list the stored prices and the refused lines

400

No CSV or both forms sent, a header that matches no layout for the pricing type, or the placement has no fixed pricing

401

Authentication error

403

Missing SITE_PAYMENT_MODEL or MANAGE_PRICING permission, or no update access to the site

404

Placement not found or deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --form 'countryPrices=@data.csv'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do", headers={"X-Api-Key": "YOUR_API_KEY"}, files={"countryPrices": open("data.csv", "rb")})
print(response.json())

Node Request

import fs from 'node:fs/promises';

const form = new FormData();
form.append('countryPrices', new Blob([await fs.readFile('data.csv')]), 'data.csv');

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  body: form,
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    // multipart upload: build the body with your HTTP library of choice
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
var form = new MultipartFormDataContent();
form.Add(new ByteArrayContent(File.ReadAllBytes("data.csv")), "countryPrices", "data.csv");
request.Content = form;

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	// multipart upload: build the body with mime/multipart

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, ["countryPrices" => new CURLFile("data.csv")]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/pricing/batch.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request.set_form([['countryPrices', File.open('data.csv')]], 'multipart/form-data')

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body