Additional Ad Campaigns Settings

Viewing

campaign/prefs

Options:

  • token - authorization token (string)
  • id - advertising campaign identifier (int)

Method call example:


<?php
$post = array(
    'token' => $token,
    'id' => 999999
);
if ($curl = curl_init()) {
    curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/prefs');
    curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
    curl_setopt($curl, CURLOPT_POST, true);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
    $out = curl_exec($curl);
    echo $out;
    curl_close($curl);
}

// Result:

{
    "ip_limit": "1_30", // execution limit per IP
    "auto_add_visits": 0, // automatically add visits
    "auto_add_limit": 0, // if the remainder is less than
    "timezone": "Europe/Moscow", // time zone
    "scheduled_start": 0, // the time of the scheduled start of the campaign
    "scheduled_stop": 0, // the time of the scheduled stop of the campaign
    "sex": "any", // gender of performers
    "age_min": 0, // minimum age of performers
    "age_max": 0, // maximum age of performers
    "hours_limits": { // execution limits by hours per day
        "0": "33",
        "1": "22",
        "2": "15",
        "3": "8",
        "4": "4",
        "5": "8",
        "6": "15",
        "7": "26",
        "8": "37",
        "9": "51",
        "10": "62",
        "11": "62",
        "12": "66",
        "13": "66",
        "14": "70",
        "15": "73",
        "16": "70",
        "17": "66",
        "18": "55",
        "19": "44",
        "20": "44",
        "21": "40",
        "22": "40",
        "23": "33"
	},
    "days_limits": { // execution limits by days of the week
        "monday": "1000",
        "tuesday": "1000",
        "thursday": "1000",
        "wednesday": "1000",
        "friday": "1000",
        "saturday": "1000",
        "sunday": "1000"
    },
    "days_hours": { // hours per days, when execution is allowed
        "monday": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23",
        "tuesday": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23",
        "thursday": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23",
        "wednesday": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23",
        "friday": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23",
        "saturday": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23",
        "sunday": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23"
    },
    "error_code": 0
}

Editing

campaign/prefs_set

Options:

  • token - authorization token (string)
  • id - advertising campaign identifier (int)
  • ip_limit - execution limit per IP (string).
    • for advertising campaigns with the type paid, paid_inner, paid_adv, paid_prof, paid_se, paid_se_behavioral, paid_se_links, paid_se_tips, paid_se_youtube, paid_se_youtube_5. Values:
      • 50 - 50 times a day
      • 20 - 20 times a day
      • 10 - 10 times a day
      • 5 - 5 times a day
      • 4 - 4 times a day
      • 3 - 3 times a day
      • 2 - 2 times a day
      • 1 - 1 times a day
      • 1_2 - 1 time in 2 days
      • 1_3 - 1 time in 3 days
      • 1_5 - 1 time in 5 days
      • 1_7 - 1 time in 7 days
      • 1_15 - 1 time in 15 days
      • 1_30 - 1 time in 30 days
      • 1_0 - 1 once in all time
    • for advertising campaigns with the type read_telegram, like_telegram, voting_telegram, share_telegram, comment_telegram, like_tiktok, share_tiktok, comment_tiktok, search_like_tiktok, voting_facebook, recommend_facebook, share_event_facebook, comment, comment_auth, other_actions_10min, read_article, other_like, like_yandex, share_yandex, read_yandex, read_like_yandex, read_like_share_yandex, video_like_yandex, video_like_share_yandex, video_like_member_yandex, comment_yandex, video_yandex_efir, share_pinterest, video_twitch, video_15min, video_vimeo, like_twitter, share_twitter, share_site_twitter, comment_twitter, like_youtube, dislike_youtube, share_youtube, comment_youtube, complex_1_youtube, like_post_facebook, share_facebook, comment_facebook, like_instagram, comment_instagram, favorite_instagram, view_stories_instagram, share_stories_instagram, video_rutube, video_5_rutube. Values:
      • 1_0 - 1 once in all time
      • 1 - 1 times a day
      • 1_2 - 1 time in 2 days
      • 1_3 - 1 time in 3 days
      • 1_5 - 1 time in 5 days
      • 1_7 - 1 time in 7 days
      • 1_15 - 1 time in 15 days
      • 1_30 - 1 time in 30 days
    • for advertising campaigns with the type paid_se_favorite_browser, paid_se_activity, social_member_telegram, social_like_vk, social_member_vk, social_share_vk, social_member_share_vk, social_share_link_vk, social_install_vk, social_friends_vk, social_like_wall_vk, social_share_wall_vk, social_comment_vk, social_complex_1_vk, social_complex_2_vk, social_complex_3_vk, social_video_vk, social_video_youtube, social_video_5_youtube, social_like_odnoklassniki, social_member_odnoklassniki, social_share_odnoklassniki, social_install_odnoklassniki, social_like_wall_odnoklassniki, social_share_wall_odnoklassniki, social_share_site_odnoklassniki, social_share_link_odnoklassniki, social_comment_odnoklassniki, social_video_odnoklassniki, social_member_mailru, social_like_wall_mailru, social_visit_quora, friends_odnoklassniki, member_telegram, bot_telegram, bot_fulfill_telegram, app_fulfill_telegram, member_tiktok, like_member_tiktok, friends_facebook, event_facebook, member_recommend_vk, voting_vk, comment_wall_vk, comment_wall_odnoklassniki, voting, voting_auth, voting_registration, voting_registration_email, voting_registration_phone, registration, registration_email, registration_clicks_email, registration_phone, comment_registration, comment_registration_email, comment_registration_phone, review_5star_yandex_browser, member_whatsapp, other_clicks_12, other_clicks_35, other_clicks_610, other_favorite_browser, paid_se_favorite_browser, paid_se_activity, other_subscribe, other_share_soc, other_5min_soc, other_complaint, other_form_10, other_form_30, marketplace_add_to_cart, marketplace_add_to_favorite, marketplace_share_soc, marketplace_activity_5min, marketplace_ask_question, marketplace_subscribe, avito_add_to_cart, avito_add_to_favorite, avito_ask_question, avito_subscribe, avito_contact, avito_complain, ozon_add_to_cart, ozon_add_to_favorite, ozon_ask_question, ozon_subscribe, ozon_add_subscribe, wildberries_add_to_cart, wildberries_add_to_favorite, wildberries_ask_question, market_yandex_add_to_cart, market_yandex_add_to_favorite, market_yandex_ask_question, market_yandex_subscribe, market_yandex_add_subscribe, install_android, install_browser_plugin, install_android_review, member_yandex, read_member_yandex, read_like_member_yandex, video_member_yandex, member_comment_yandex, like_music_yandex, member_pinterest, member_twitter, member_community_twitter, member_youtube, member_search_youtube, like_comment_youtube, complaint_youtube, save_youtube, complex_4_youtube, complex_2_youtube, complex_3_youtube, complex_5_youtube, complex_6_youtube, like_facebook, like_emoji_facebook, share_site_facebook, member_facebook, complex_1_facebook, member_instagram, like_stories_instagram, member_linkedin, like_linkedin, like_reaction_linkedin, like_comment_linkedin, friends_linkedin, comment_linkedin, share_linkedin, member_snapchat, like_snapchat, member_kickcom, member_twitch, member_discord, member_fulfill_discord, member_github, like_github, share_github, member_quora, like_quora, like_answer_quora, member_reddit, like_reddit, like_answer_reddit, member_soundcloud, like_soundcloud, member_rutube, like_rutube, dislike_rutube, like_top_rutube, share_rutube, comment_rutube, complex_2_rutube, complex_3_rutube, voting_registration_moderation, comment_after_order, comment_big, comment_medium, comment_avito, comment_maps_yandex, comment_maps_google, comment_2gis, purchase_50, purchase_70, purchase_80, purchase_100, purchase_300, purchase_500, registration_documents, account_and_credentials, biometric_verification, phone_consultation, install_and_play, install_and_register_and_data, install_and_sign_for_trial, order_bankcard, registration_and_sign_for_trial, share_soc_and_link, webinar_30min, advert_post_in_social, install_ios_vip, install_ios_review_vip, paid_5min. Values:
      • 1_0 - 1 once in all time
  • auto_add_visits - the number of automatically added executions to the RK account from the account account when the balance of executions on the RK account is less than auto_add_limit (int)
  • auto_add_limit - limit of executions on the campaign account, when executions will be automatically added (int)
  • timezone - time zone (string). Values: List of supported timezones
  • scheduled_start - the time of the scheduled start of the campaign (unix timestamp)
  • scheduled_stop - the time of the scheduled stop of the campaign (unix timestamp)
  • sex - gender of performers (string). Values: male, female, any
  • age_min - minimum age of performers (unix timestamp)
  • age_max - maximum age of performers (unix timestamp)

Method call example:

<?php

$post = array(
    'token' => $token,
    'id' => 999999,
    'scheduled_start' => 1575222535
    'scheduled_stop' => 1545722535
);
if ($curl = curl_init()) {
    curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/prefs_set');
    curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
    curl_setopt($curl, CURLOPT_POST, true);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
    $out = curl_exec($curl);
    echo $out;
    curl_close($curl);
}

// Result:

{
    "status": "ok",
    "error_code": 0
}


$post = array(
    'token' => $token,
    'id' => 999999,
    'ip_limit' => '10'
);
if ($curl = curl_init()) {
    curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/prefs_set');
    curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
    curl_setopt($curl, CURLOPT_POST, true);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
    $out = curl_exec($curl);
    echo $out;
    curl_close($curl);
}

// Result:

{
    "error": "Incorrect value of daily site visits from one IP address",
    "error_code": 43,
    "allowed_values": "1_0,1,1_2,1_3,1_5,1_7,1_15,1_30"
}