Batch update banner country pricing from CSV

Reference

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

Batch-updates country-level pricing for the specified banner from a CSV of rows mapping country codes to prices, sent either as the countryPrices file (multipart) or as its text in countryPricesCsv - exactly one of the two. The upload adds and updates prices; prices of countries not in the file are kept. csvErrors and csvWarnings list, by line number, the rows that were not applied - such a row changes nothing, and the rest of the file is still applied. A price may use a decimal comma in a semicolon- or tab-separated file. 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 banner must already have a base pricing record configured. Requires UPDATE permission on the banner's advertiser and MANAGE_PRICING permission.

Path Params

bannerId integer required

ID of the banner to batch-update country pricing for

3001

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

Batch update result: applied and rejected lines, plus the legacy csvErrors and csvWarnings

400

Invalid request or no base pricing yet

401

Authentication error

403

Not enough permissions

404

Banner not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/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/banner/3001/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/banner/3001/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/banner/3001/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/banner/3001/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/banner/3001/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/banner/3001/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/banner/3001/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