/

Browse the help center

Create advertiser date/time targeting

Creates a date/time targeting rule for the specified advertiser.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/{advertiserId}/targeting/date-time/create.do

Creates a date/time targeting rule for the specified advertiser. The rule restricts ad delivery to specific days of the week and time ranges. Times are in 24-hour hh:MM format and can optionally use the viewer's local timezone instead of UTC. Requires UPDATE permission on the advertiser and MANAGE_DEMAND_TARGETING user permission.

Path Params

advertiserId integer required

Unique numeric ID of the advertiser

1234

Form Params

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

timeFrom string required

Time range start in HH:mm format

09:00

timeTo string required

Time range end in HH:mm format

17:00

dayOfWeek array<string>

Days of week to target; omitted, the rule applies on every day

MONDAY

clientLocalTime boolean

When true, use client's local time zone for time range evaluation

false

Responses

200

Success

400

Invalid targeting value

401

Unauthorized

403

Forbidden

404

Advertiser not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/date-time/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'timeFrom=09:00' \
  --data-urlencode 'timeTo=17:00' \
  --data-urlencode 'dayOfWeek=MONDAY' \
  --data-urlencode 'clientLocalTime=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/date-time/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"rule": "INCLUDE", "timeFrom": "09:00", "timeTo": "17:00", "dayOfWeek": "MONDAY", "clientLocalTime": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/date-time/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"rule":"INCLUDE","timeFrom":"09:00","timeTo":"17:00","dayOfWeek":"MONDAY","clientLocalTime":"false"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/date-time/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("rule=INCLUDE&timeFrom=09%3A00&timeTo=17%3A00&dayOfWeek=MONDAY&clientLocalTime=false"))
    .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/advertiser/1234/targeting/date-time/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["rule"] = "INCLUDE", ["timeFrom"] = "09:00", ["timeTo"] = "17:00", ["dayOfWeek"] = "MONDAY", ["clientLocalTime"] = "false" });

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/date-time/create.do", strings.NewReader(`rule=INCLUDE&timeFrom=09%3A00&timeTo=17%3A00&dayOfWeek=MONDAY&clientLocalTime=false`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/advertiser/1234/targeting/date-time/create.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'rule=INCLUDE&timeFrom=09%3A00&timeTo=17%3A00&dayOfWeek=MONDAY&clientLocalTime=false');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1234/targeting/date-time/create.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('rule' => "INCLUDE", 'timeFrom' => "09:00", 'timeTo' => "17:00", 'dayOfWeek' => "MONDAY", 'clientLocalTime' => "false")

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