node-vk-sdk
Version:
VK API SDK for Node.js
1,987 lines • 400 kB
JSON
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "objects",
"definitions": {
"account_account_counters": {
"type": "object",
"properties": {
"app_requests": {
"type": "integer",
"description": "New app requests number",
"minimum": 1
},
"events": {
"type": "integer",
"description": "New events number",
"minimum": 1
},
"faves": {
"type": "integer",
"description": "New faves number",
"minimum": 1
},
"friends": {
"type": "integer",
"description": "New friends requests number",
"minimum": 1
},
"friends_suggestions": {
"type": "integer",
"description": "New friends suggestions number",
"minimum": 1
},
"friends_recommendations": {
"type": "integer",
"description": "New friends recommendations number",
"minimum": 1
},
"gifts": {
"type": "integer",
"description": "New gifts number",
"minimum": 1
},
"groups": {
"type": "integer",
"description": "New groups number",
"minimum": 1
},
"menu_discover_badge": {
"type": "integer",
"description": ""
},
"menu_clips_badge": {
"type": "integer"
},
"messages": {
"type": "integer",
"description": "New messages number",
"minimum": 1
},
"memories": {
"type": "integer",
"description": "New memories number",
"minimum": 1
},
"notes": {
"type": "integer",
"description": "New notes number",
"minimum": 1
},
"notifications": {
"type": "integer",
"description": "New notifications number",
"minimum": 1
},
"photos": {
"type": "integer",
"description": "New photo tags number",
"minimum": 1
},
"sdk": {
"type": "integer",
"description": "New sdk number",
"minimum": 1
}
}
},
"account_info": {
"type": "object",
"properties": {
"wishlists_ae_promo_banner_show": {
"$ref": "objects.json#/definitions/base_bool_int"
},
"2fa_required": {
"description": "Two factor authentication is enabled",
"$ref": "objects.json#/definitions/base_bool_int"
},
"country": {
"type": "string",
"description": "Country code"
},
"https_required": {
"description": "Information whether HTTPS-only is enabled",
"$ref": "objects.json#/definitions/base_bool_int"
},
"intro": {
"description": "Information whether user has been processed intro",
"$ref": "objects.json#/definitions/base_bool_int"
},
"show_vk_apps_intro": {
"type": "boolean"
},
"mini_apps_ads_slot_id": {
"description": "Ads slot id for MyTarget",
"minimum": 0,
"type": "integer"
},
"qr_promotion": {
"type": "integer",
"minimum": 0
},
"link_redirects": {
"type": "object"
},
"lang": {
"type": "integer",
"description": "Language ID"
},
"no_wall_replies": {
"description": "Information whether wall comments should be hidden",
"$ref": "objects.json#/definitions/base_bool_int"
},
"own_posts_default": {
"description": "Information whether only owners posts should be shown",
"$ref": "objects.json#/definitions/base_bool_int"
},
"subscriptions": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"additionalProperties": false
},
"account_name_request": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "First name in request"
},
"id": {
"type": "integer",
"description": "Request ID needed to cancel the request"
},
"last_name": {
"type": "string",
"description": "Last name in request"
},
"status": {
"$ref": "objects.json#/definitions/account_name_request_status"
},
"lang": {
"type": "string",
"description": "Text to display to user"
},
"link_href": {
"type": "string",
"description": "href for link in lang field"
},
"link_label": {
"type": "string",
"description": "label to display for link in lang field"
}
}
},
"account_name_request_status": {
"type": "string",
"description": "Request status",
"enum": [
"success",
"processing",
"declined",
"was_accepted",
"was_declined",
"declined_with_link",
"response",
"response_with_link"
]
},
"account_offer": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Offer description"
},
"id": {
"type": "integer",
"description": "Offer ID"
},
"img": {
"type": "string",
"format": "uri",
"description": "URL of the preview image"
},
"instruction": {
"type": "string",
"description": "Instruction how to process the offer"
},
"instruction_html": {
"type": "string",
"description": "Instruction how to process the offer (HTML format)"
},
"price": {
"type": "integer",
"description": "Offer price"
},
"short_description": {
"type": "string",
"description": "Offer short description"
},
"tag": {
"type": "string",
"description": "Offer tag"
},
"title": {
"type": "string",
"description": "Offer title"
},
"currency_amount": {
"type": "number",
"description": "Currency amount"
},
"link_id": {
"type": "integer",
"description": "Link id"
},
"link_type": {
"type": "string",
"description": "Link type",
"enum": [
"profile",
"group",
"app"
]
}
},
"additionalProperties": false
},
"account_push_conversations": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 0,
"description": "Items count"
},
"items": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_conversations_item"
}
}
}
},
"account_push_conversations_item": {
"type": "object",
"properties": {
"disabled_until": {
"type": "integer",
"description": "Time until that notifications are disabled in seconds"
},
"peer_id": {
"type": "integer",
"description": "Peer ID"
},
"sound": {
"description": "Information whether the sound are enabled",
"$ref": "objects.json#/definitions/base_bool_int"
}
},
"required": [
"peer_id",
"sound",
"disabled_until"
]
},
"account_push_params": {
"type": "object",
"properties": {
"msg": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_mode"
}
},
"chat": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_mode"
}
},
"like": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_settings"
}
},
"repost": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_settings"
}
},
"comment": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_settings"
}
},
"mention": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_settings"
}
},
"reply": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"new_post": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"wall_post": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"wall_publish": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"friend": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"friend_found": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"friend_accepted": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"group_invite": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"group_accepted": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"birthday": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"event_soon": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"app_request": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
},
"sdk_open": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/account_push_params_onoff"
}
}
}
},
"account_push_params_mode": {
"type": "string",
"description": "Settings parameters",
"enum": [
"on",
"off",
"no_sound",
"no_text"
]
},
"account_push_params_onoff": {
"type": "string",
"description": "Settings parameters",
"enum": [
"on",
"off"
]
},
"account_push_params_settings": {
"type": "string",
"description": "Settings parameters",
"enum": [
"on",
"off",
"fr_of_fr"
]
},
"account_push_settings": {
"type": "object",
"properties": {
"disabled": {
"description": "Information whether notifications are disabled",
"$ref": "objects.json#/definitions/base_bool_int"
},
"disabled_until": {
"type": "integer",
"description": "Time until that notifications are disabled in Unixtime"
},
"settings": {
"$ref": "objects.json#/definitions/account_push_params"
},
"conversations": {
"$ref": "objects.json#/definitions/account_push_conversations"
}
}
},
"account_user_settings": {
"type": "object",
"allOf": [
{
"$ref": "objects.json#/definitions/users_user_min"
},
{
"$ref": "objects.json#/definitions/users_user_settings_xtr"
},
{
"properties": {
"photo_200": {
"type": "string",
"format": "uri",
"description": "URL of square photo of the user with 200 pixels in width"
},
"is_service_account": {
"type": "boolean",
"description": "flag about service account"
}
}
}
]
},
"account_user_settings_interest": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"title",
"value"
]
},
"account_user_settings_interests": {
"type": "object",
"properties": {
"activities": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"interests": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"music": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"tv": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"movies": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"books": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"games": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"quotes": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
},
"about": {
"$ref": "objects.json#/definitions/account_user_settings_interest"
}
}
},
"addresses_fields": {
"type": "string",
"enum": [
"id",
"title",
"address",
"additional_address",
"country_id",
"city_id",
"metro_station_id",
"latitude",
"longitude",
"distance",
"work_info_status",
"timetable",
"phone",
"time_offset"
]
},
"ads_access_role": {
"type": "string",
"description": "Current user's role",
"enum": [
"admin",
"manager",
"reports"
]
},
"ads_access_role_public": {
"type": "string",
"description": "Current user's role",
"enum": [
"manager",
"reports"
]
},
"ads_accesses": {
"type": "object",
"properties": {
"client_id": {
"type": "string",
"description": "Client ID"
},
"role": {
"$ref": "objects.json#/definitions/ads_access_role"
}
}
},
"ads_account": {
"type": "object",
"properties": {
"access_role": {
"$ref": "objects.json#/definitions/ads_access_role"
},
"account_id": {
"type": "integer",
"description": "Account ID"
},
"account_status": {
"description": "Information whether account is active",
"$ref": "objects.json#/definitions/base_bool_int"
},
"account_type": {
"$ref": "objects.json#/definitions/ads_account_type"
},
"account_name": {
"type": "string",
"description": "Account name"
},
"can_view_budget": {
"type": "boolean",
"description": "Can user view account budget"
}
},
"required": [
"account_id",
"account_type",
"account_status",
"access_role",
"account_name",
"can_view_budget"
],
"additionalProperties": false
},
"ads_account_type": {
"type": "string",
"description": "Account type",
"enum": [
"general",
"agency"
]
},
"ads_ad": {
"type": "object",
"properties": {
"ad_format": {
"type": "integer",
"description": "Ad format"
},
"ad_platform": {
"type": [
"integer",
"string"
],
"description": "Ad platform"
},
"all_limit": {
"type": "integer",
"description": "Total limit"
},
"approved": {
"$ref": "objects.json#/definitions/ads_ad_approved"
},
"campaign_id": {
"type": "integer",
"description": "Campaign ID"
},
"category1_id": {
"type": "integer",
"description": "Category ID"
},
"category2_id": {
"type": "integer",
"description": "Additional category ID"
},
"cost_type": {
"$ref": "objects.json#/definitions/ads_ad_cost_type"
},
"cpc": {
"type": "integer",
"description": "Cost of a click, kopecks"
},
"cpm": {
"type": "integer",
"description": "Cost of 1000 impressions, kopecks"
},
"cpa": {
"type": "integer",
"description": "Cost of an action, kopecks"
},
"ocpm": {
"type": "integer",
"description": "Cost of 1000 impressions optimized, kopecks"
},
"autobidding_max_cost": {
"type": "integer",
"description": "Max cost of target actions for autobidding, kopecks"
},
"disclaimer_medical": {
"description": "Information whether disclaimer is enabled",
"$ref": "objects.json#/definitions/base_bool_int"
},
"disclaimer_specialist": {
"description": "Information whether disclaimer is enabled",
"$ref": "objects.json#/definitions/base_bool_int"
},
"disclaimer_supplements": {
"description": "Information whether disclaimer is enabled",
"$ref": "objects.json#/definitions/base_bool_int"
},
"id": {
"type": "integer",
"description": "Ad ID"
},
"impressions_limit": {
"type": "integer",
"description": "Impressions limit"
},
"impressions_limited": {
"$ref": "objects.json#/definitions/base_bool_int",
"description": "Information whether impressions are limited"
},
"name": {
"type": "string",
"description": "Ad title"
},
"status": {
"$ref": "objects.json#/definitions/ads_ad_status"
},
"video": {
"description": "Information whether the ad is a video",
"$ref": "objects.json#/definitions/base_bool_int"
}
},
"required": [
"id",
"campaign_id",
"ad_format",
"cost_type",
"all_limit",
"status",
"name",
"approved"
],
"additionalProperties": false
},
"ads_ad_approved": {
"type": "integer",
"description": "Review status",
"enum": [
0,
1,
2,
3
],
"enumNames": [
"not moderated",
"pending moderation",
"approved",
"rejected"
]
},
"ads_ad_cost_type": {
"type": "integer",
"description": "Cost type",
"enum": [
0,
1,
2,
3
],
"enumNames": [
"per clicks",
"per impressions",
"per actions",
"per impressions optimized"
]
},
"ads_ad_layout": {
"type": "object",
"properties": {
"ad_format": {
"type": "integer",
"description": "Ad format"
},
"campaign_id": {
"type": "integer",
"description": "Campaign ID"
},
"cost_type": {
"$ref": "objects.json#/definitions/ads_ad_cost_type"
},
"description": {
"type": "string",
"description": "Ad description"
},
"id": {
"type": "integer",
"description": "Ad ID"
},
"image_src": {
"type": "string",
"format": "uri",
"description": "Image URL"
},
"image_src_2x": {
"type": "string",
"format": "uri",
"description": "URL of the preview image in double size"
},
"link_domain": {
"type": "string",
"description": "Domain of advertised object"
},
"link_url": {
"type": "string",
"format": "uri",
"description": "URL of advertised object"
},
"preview_link": {
"type": [
"integer",
"string"
],
"description": "link to preview an ad as it is shown on the website"
},
"title": {
"type": "string",
"description": "Ad title"
},
"video": {
"description": "Information whether the ad is a video",
"$ref": "objects.json#/definitions/base_bool_int"
}
},
"required": [
"id",
"campaign_id",
"ad_format",
"cost_type",
"title",
"description",
"link_url",
"image_src"
],
"additionalProperties": false
},
"ads_ad_status": {
"type": "integer",
"description": "Ad atatus",
"enum": [
0,
1,
2
],
"enumNames": [
"stopped",
"started",
"deleted"
]
},
"ads_campaign": {
"type": "object",
"properties": {
"all_limit": {
"type": "string",
"description": "Campaign's total limit, rubles"
},
"day_limit": {
"type": "string",
"description": "Campaign's day limit, rubles"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"name": {
"type": "string",
"description": "Campaign title"
},
"start_time": {
"type": "integer",
"description": "Campaign start time, as Unixtime"
},
"status": {
"$ref": "objects.json#/definitions/ads_campaign_status"
},
"stop_time": {
"type": "integer",
"description": "Campaign stop time, as Unixtime"
},
"type": {
"$ref": "objects.json#/definitions/ads_campaign_type"
}
},
"required": [
"id",
"type",
"name",
"status",
"day_limit",
"all_limit",
"start_time",
"stop_time"
],
"additionalProperties": false
},
"ads_campaign_status": {
"type": "integer",
"description": "Campaign status",
"enum": [
0,
1,
2
],
"enumNames": [
"stopped",
"started",
"deleted"
]
},
"ads_campaign_type": {
"type": "string",
"description": "Campaign type",
"enum": [
"normal",
"vk_apps_managed",
"mobile_apps",
"promoted_posts"
]
},
"ads_category": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Category ID",
"minimum": 1
},
"name": {
"type": "string",
"description": "Category name"
},
"subcategories": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/base_object_with_name"
}
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"ads_client": {
"type": "object",
"properties": {
"all_limit": {
"type": "string",
"description": "Client's total limit, rubles"
},
"day_limit": {
"type": "string",
"description": "Client's day limit, rubles"
},
"id": {
"type": "integer",
"description": "Client ID"
},
"name": {
"type": "string",
"description": "Client name"
}
},
"required": [
"id",
"name",
"day_limit",
"all_limit"
],
"additionalProperties": false
},
"ads_criteria": {
"type": "object",
"properties": {
"age_from": {
"type": "integer",
"description": "Age from",
"minimum": 0
},
"age_to": {
"type": "integer",
"description": "Age to",
"minimum": 0
},
"apps": {
"type": "string",
"description": "Apps IDs"
},
"apps_not": {
"type": "string",
"description": "Apps IDs to except"
},
"birthday": {
"type": "integer",
"description": "Days to birthday"
},
"cities": {
"type": "string",
"description": "Cities IDs"
},
"cities_not": {
"type": "string",
"description": "Cities IDs to except"
},
"country": {
"type": "integer",
"description": "Country ID",
"minimum": 0
},
"districts": {
"type": "string",
"description": "Districts IDs"
},
"groups": {
"type": "string",
"description": "Communities IDs"
},
"interest_categories": {
"type": "string",
"description": "Interests categories IDs"
},
"interests": {
"type": "string",
"description": "Interests"
},
"paying": {
"description": "Information whether the user has proceeded VK payments before",
"$ref": "objects.json#/definitions/base_bool_int"
},
"positions": {
"type": "string",
"description": "Positions IDs"
},
"religions": {
"type": "string",
"description": "Religions IDs"
},
"retargeting_groups": {
"type": "string",
"description": "Retargeting groups IDs"
},
"retargeting_groups_not": {
"type": "string",
"description": "Retargeting groups IDs to except"
},
"school_from": {
"type": "integer",
"description": "School graduation year from"
},
"school_to": {
"type": "integer",
"description": "School graduation year to"
},
"schools": {
"type": "string",
"description": "Schools IDs"
},
"sex": {
"$ref": "objects.json#/definitions/ads_criteria_sex"
},
"stations": {
"type": "string",
"description": "Stations IDs"
},
"statuses": {
"type": "string",
"description": "Relationship statuses"
},
"streets": {
"type": "string",
"description": "Streets IDs"
},
"travellers": {
"description": "Travellers only",
"$ref": "objects.json#/definitions/base_property_exists"
},
"uni_from": {
"type": "integer",
"description": "University graduation year from"
},
"uni_to": {
"type": "integer",
"description": "University graduation year to"
},
"user_browsers": {
"type": "string",
"description": "Browsers"
},
"user_devices": {
"type": "string",
"description": "Devices"
},
"user_os": {
"type": "string",
"description": "Operating systems"
}
},
"additionalProperties": false
},
"ads_criteria_sex": {
"type": "integer",
"description": "Sex",
"enum": [
0,
1,
2
],
"enumNames": [
"any",
"male",
"female"
]
},
"ads_demo_stats": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object ID"
},
"stats": {
"$ref": "objects.json#/definitions/ads_demostats_format"
},
"type": {
"$ref": "objects.json#/definitions/ads_object_type"
}
},
"additionalProperties": false
},
"ads_demostats_format": {
"type": "object",
"properties": {
"age": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_stats_age"
}
},
"cities": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_stats_cities"
}
},
"day": {
"type": "string",
"description": "Day as YYYY-MM-DD"
},
"month": {
"type": "string",
"description": "Month as YYYY-MM"
},
"overall": {
"type": "integer",
"description": "1 if period=overall"
},
"sex": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_stats_sex"
}
},
"sex_age": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_stats_sex_age"
}
}
},
"additionalProperties": false
},
"ads_flood_stats": {
"type": "object",
"properties": {
"left": {
"type": "integer",
"description": "Requests left"
},
"refresh": {
"type": "integer",
"description": "Time to refresh in seconds"
}
},
"required": [
"left",
"refresh"
],
"additionalProperties": false
},
"ads_link_status": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Reject reason"
},
"redirect_url": {
"type": "string",
"format": "uri",
"description": "URL"
},
"status": {
"type": "string",
"description": "Link status"
}
},
"required": [
"status",
"description",
"redirect_url"
],
"additionalProperties": false
},
"ads_lookalike_request": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Lookalike request ID",
"minimum": 1
},
"create_time": {
"type": "integer",
"description": "Lookalike request create time, as Unixtime"
},
"update_time": {
"type": "integer",
"description": "Lookalike request update time, as Unixtime"
},
"scheduled_delete_time": {
"type": "integer",
"description": "Time by which lookalike request would be deleted, as Unixtime"
},
"status": {
"type": "string",
"enum": [
"search_in_progress",
"search_failed",
"search_done",
"save_in_progress",
"save_failed",
"save_done"
],
"description": "Lookalike request status"
},
"source_type": {
"type": "string",
"enum": [
"retargeting_group"
],
"description": "Lookalike request source type"
},
"source_retargeting_group_id": {
"type": "integer",
"minimum": 1,
"description": "Retargeting group id, which was used as lookalike seed"
},
"source_name": {
"type": "string",
"description": "Lookalike request seed name (retargeting group name)"
},
"audience_count": {
"type": "integer",
"minimum": 0,
"description": "Lookalike request seed audience size"
},
"save_audience_levels": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_lookalike_request_save_audience_level"
}
}
},
"required": [
"id",
"create_time",
"update_time",
"status",
"source_type"
],
"additionalProperties": false
},
"ads_lookalike_request_save_audience_level": {
"type": "object",
"properties": {
"level": {
"type": "integer",
"minimum": 1,
"description": "Save audience level id, which is used in save audience queries"
},
"audience_count": {
"type": "integer",
"minimum": 0,
"description": "Saved audience audience size for according level"
}
}
},
"ads_musician": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Targeting music artist ID",
"minimum": 1
},
"name": {
"type": "string",
"description": "Music artist name"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"ads_object_type": {
"type": "string",
"description": "Object type",
"enum": [
"ad",
"campaign",
"client",
"office"
]
},
"ads_paragraphs": {
"type": "object",
"properties": {
"paragraph": {
"type": "string",
"description": "Rules paragraph"
}
}
},
"ads_promoted_post_reach": {
"type": "object",
"properties": {
"hide": {
"type": "integer",
"description": "Hides amount"
},
"id": {
"type": "integer",
"description": "Object ID from 'ids' parameter"
},
"join_group": {
"type": "integer",
"description": "Community joins"
},
"links": {
"type": "integer",
"description": "Link clicks"
},
"reach_subscribers": {
"type": "integer",
"description": "Subscribers reach"
},
"reach_total": {
"type": "integer",
"description": "Total reach"
},
"report": {
"type": "integer",
"description": "Reports amount"
},
"to_group": {
"type": "integer",
"description": "Community clicks"
},
"unsubscribe": {
"type": "integer",
"description": "'Unsubscribe' events amount"
},
"video_views_100p": {
"type": "integer",
"description": "Video views for 100 percent"
},
"video_views_25p": {
"type": "integer",
"description": "Video views for 25 percent"
},
"video_views_3s": {
"type": "integer",
"description": "Video views for 3 seconds"
},
"video_views_50p": {
"type": "integer",
"description": "Video views for 50 percent"
},
"video_views_75p": {
"type": "integer",
"description": "Video views for 75 percent"
},
"video_views_start": {
"type": "integer",
"description": "Video starts"
}
},
"required": [
"id",
"reach_subscribers",
"reach_total",
"links",
"to_group",
"join_group",
"report",
"hide",
"unsubscribe"
],
"additionalProperties": false
},
"ads_reject_reason": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Comment text"
},
"rules": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_rules"
}
}
},
"additionalProperties": false
},
"ads_rules": {
"type": "object",
"properties": {
"paragraphs": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_paragraphs"
}
},
"title": {
"type": "string",
"description": "Comment"
}
}
},
"ads_stats": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object ID"
},
"stats": {
"$ref": "objects.json#/definitions/ads_stats_format"
},
"type": {
"$ref": "objects.json#/definitions/ads_object_type"
},
"views_times": {
"$ref": "objects.json#/definitions/ads_stats_views_times"
}
},
"additionalProperties": false
},
"ads_stats_age": {
"type": "object",
"properties": {
"clicks_rate": {
"type": "number",
"description": "Clicks rate"
},
"impressions_rate": {
"type": "number",
"description": "Impressions rate"
},
"value": {
"type": "string",
"description": "Age interval"
}
}
},
"ads_stats_cities": {
"type": "object",
"properties": {
"clicks_rate": {
"type": "number",
"description": "Clicks rate"
},
"impressions_rate": {
"type": "number",
"description": "Impressions rate"
},
"name": {
"type": "string",
"description": "City name"
},
"value": {
"type": "integer",
"description": "City ID"
}
}
},
"ads_stats_format": {
"type": "object",
"properties": {
"clicks": {
"type": "integer",
"description": "Clicks number"
},
"day": {
"type": "string",
"description": "Day as YYYY-MM-DD"
},
"impressions": {
"type": "integer",
"description": "Impressions number"
},
"join_rate": {
"type": "integer",
"description": "Events number"
},
"month": {
"type": "string",
"description": "Month as YYYY-MM"
},
"overall": {
"type": "integer",
"description": "1 if period=overall"
},
"reach": {
"type": "integer",
"description": "Reach "
},
"spent": {
"type": "integer",
"description": "Spent funds"
},
"video_clicks_site": {
"type": "integer",
"description": "Clickthoughs to the advertised site"
},
"video_views": {
"type": "integer",
"description": "Video views number"
},
"video_views_full": {
"type": "integer",
"description": "Video views (full video)"
},
"video_views_half": {
"type": "integer",
"description": "Video views (half of video)"
}
}
},
"ads_stats_sex": {
"type": "object",
"properties": {
"clicks_rate": {
"type": "number",
"description": "Clicks rate"
},
"impressions_rate": {
"type": "number",
"description": "Impressions rate"
},
"value": {
"$ref": "objects.json#/definitions/ads_stats_sex_value"
}
}
},
"ads_stats_sex_age": {
"type": "object",
"properties": {
"clicks_rate": {
"type": "number",
"description": "Clicks rate"
},
"impressions_rate": {
"type": "number",
"description": "Impressions rate"
},
"value": {
"type": "string",
"description": "Sex and age interval"
}
}
},
"ads_stats_sex_value": {
"type": "string",
"description": "Sex",
"enum": [
"f",
"m"
],
"enumNames": [
"female",
"male"
]
},
"ads_stats_views_times": {
"type": "object",
"properties": {
"views_ads_times_1": {
"type": "integer"
},
"views_ads_times_2": {
"type": "integer"
},
"views_ads_times_3": {
"type": "integer"
},
"views_ads_times_4": {
"type": "integer"
},
"views_ads_times_5": {
"type": "string"
},
"views_ads_times_6": {
"type": "integer"
},
"views_ads_times_7": {
"type": "integer"
},
"views_ads_times_8": {
"type": "integer"
},
"views_ads_times_9": {
"type": "integer"
},
"views_ads_times_10": {
"type": "integer"
},
"views_ads_times_11_plus": {
"type": "integer"
}
}
},
"ads_targ_settings": {
"type": "object",
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"description": "Ad ID"
},
"campaign_id": {
"type": "integer",
"description": "Campaign ID"
}
}
},
{
"$ref": "objects.json#/definitions/ads_criteria"
}
]
},
"ads_targ_stats": {
"type": "object",
"properties": {
"audience_count": {
"type": "integer",
"description": "Audience"
},
"recommended_cpc": {
"type": "number",
"description": "Recommended CPC value for 50% reach (old format)"
},
"recommended_cpm": {
"type": "number",
"description": "Recommended CPM value for 50% reach (old format)"
},
"recommended_cpc_50": {
"type": "number",
"description": "Recommended CPC value for 50% reach"
},
"recommended_cpm_50": {
"type": "number",
"description": "Recommended CPM value for 50% reach"
},
"recommended_cpc_70": {
"type": "number",
"description": "Recommended CPC value for 70% reach"
},
"recommended_cpm_70": {
"type": "number",
"description": "Recommended CPM value for 70% reach"
},
"recommended_cpc_90": {
"type": "number",
"description": "Recommended CPC value for 90% reach"
},
"recommended_cpm_90": {
"type": "number",
"description": "Recommended CPM value for 90% reach"
}
},
"required": [
"audience_count"
],
"additionalProperties": false
},
"ads_targ_suggestions": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object ID"
},
"name": {
"type": "string",
"description": "Object name"
}
},
"additionalProperties": false
},
"ads_targ_suggestions_cities": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object ID"
},
"name": {
"type": "string",
"description": "Object name"
},
"parent": {
"type": "string",
"description": "Parent object"
}
},
"additionalProperties": false
},
"ads_targ_suggestions_regions": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object ID"
},
"name": {
"type": "string",
"description": "Object name"
},
"type": {
"type": "string",
"description": "Object type"
}
},
"additionalProperties": false
},
"ads_targ_suggestions_schools": {
"type": "object",
"properties": {
"desc": {
"type": "string",
"description": "Full school title"
},
"id": {
"type": "integer",
"description": "School ID"
},
"name": {
"type": "string",
"description": "School title"
},
"parent": {
"type": "string",
"description": "City name"
},
"type": {
"$ref": "objects.json#/definitions/ads_targ_suggestions_schools_type"
}
},
"additionalProperties": false
},
"ads_targ_suggestions_schools_type": {
"type": "string",
"description": "School type",
"enum": [
"school",
"university",
"faculty",
"chair"
]
},
"ads_target_group": {
"type": "object",
"properties": {
"audience_count": {
"type": "integer",
"description": "Audience"
},
"domain": {
"type": "string",
"description": "Site domain"
},
"id": {
"type": "integer",
"description": "Group ID"
},
"lifetime": {
"type": "integer",
"description": "Number of days for user to be in group"
},
"name": {
"type": "string",
"description": "Group name"
},
"pixel": {
"type": "string",
"description": "Pixel code"
}
},
"additionalProperties": false
},
"ads_updateOfficeUsers_result": {
"type": "object",
"properties": {
"user_id": {
"name": "user_id",
"type": "integer",
"minimum": 0
},
"is_success": {
"type": "boolean",
"default": true
},
"error": {
"$ref": "objects.json#/definitions/base_error"
}
},
"required": [
"user_id",
"is_success"
]
},
"ads_user_specification": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"minimum": 0
},
"role": {
"$ref": "objects.json#/definitions/ads_access_role_public"
},
"grant_access_to_all_clients": {
"type": "boolean",
"default": false
},
"client_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0
}
},
"view_budget": {
"type": "boolean",
"default": null
}
},
"required": [
"user_id",
"role"
]
},
"ads_user_specification_cutted": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"minimum": 0
},
"role": {
"$ref": "objects.json#/definitions/ads_access_role_public"
},
"client_id": {
"type": "integer",
"minimum": 0
},
"view_budget": {
"type": "boolean",
"default": null
}
},
"required": [
"user_id",
"role"
]
},
"ads_users": {
"type": "object",
"properties": {
"accesses": {
"type": "array",
"items": {
"$ref": "objects.json#/definitions/ads_accesses"
}
},
"user_id": {
"type": "integer",
"description": "User ID"
}
},
"required": [
"user_id",
"accesses"
],
"additionalProperties": false
},
"adsweb_getAdCategories_response_categories_category": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"adsweb_getAdUnits_response_ad_units_ad_unit": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"site_id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"site_id"
]
},
"adsweb_getFraudHistory_response_entries_entry": {
"type": "object",
"properties": {
"site_id": {
"type": "integer"
},
"day": {
"type": "string"
}
},
"required": [
"site_id",
"day"
]
},
"adsweb_getSites_response_sites_site": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"status_user": {
"type": "string"
},
"status_moder": {
"type": "string"
},
"domains": {
"type": "string"
}
},
"required": [
"id"
]
},
"adsweb_getStatistics_response_items_item": {
"type": "object",
"properties": {
"site_id": {
"type": "integer"
},
"ad_unit_id": {
"type": "integer"
},
"overall_count": {
"type": "integer"
},
"months_count": {
"type": "integer"
},
"month_min": {
"type": "string"
},
"month_max": {
"type": "